@sanctumso/inf1 0.0.1-dev-2 → 0.0.1-dev-3

package/README.md

@@ -6,8 +6,9 @@ Typescript + WASM SDK for Sanctum Infinity program V1.
 
 ```ts
 import {
+  assertAccountsExist,
   createSolanaRpc,
-  getBase64Encoder,
+  fetchEncodedAccounts,
   type Address,
   type IInstruction,
   type Rpc,
@@ -52,22 +53,14 @@ async function fetchAccountMap(
   rpc: Rpc<SolanaRpcApi>,
   accounts: string[]
 ): Promise<AccountMap> {
-  const map = new Map<string, Account>();
-  await Promise.all(
-    accounts.map(async (account) => {
-      const accountInfo = await rpc
-        .getAccountInfo(account as Address, {
-          encoding: "base64",
-        })
-        .send();
-      const acc = accountInfo.value!;
-      map.set(account, {
-        data: new Uint8Array(getBase64Encoder().encode(acc.data[0])),
-        owner: acc.owner,
-      });
-    })
+  const fetched = await fetchEncodedAccounts(rpc, accounts);
+  assertAccountsExist(fetched);
+  return new Map(
+    fetched.map(({ address, data, programAddress }) => [
+      address,
+      { data, owner: programAddress },
+    ])
   );
-  return map;
 }
 
 const rpc = createSolanaRpc("https://api.mainnet-beta.solana.com");

package/index.d.ts

@@ -9,27 +9,31 @@ export function tradeExactInIx(inf: Inf, arg1: TradeArgs): Instruction;
  */
 export function tradeExactOutIx(inf: Inf, arg1: TradeArgs): Instruction;
 /**
- * Returns the pubkeys of the accounts that need ot be fetched to initialize
- * a new {@link Inf} object
+ * Add SPL LSTs auxiliary data to support new SPL LSTs that may have previously not been covered
  */
-export function initPks(): Bs58Array[];
+export function appendSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
 /**
- * Initialize a new {@link Inf} object.
+ * Returns if the given SPL LST mints have their {@link SplPoolAccounts} present in the object.
  *
- * The returned object must be updated for a mint pair before it is ready to
- * quote and operate for trades involving that pair
+ * Returns a byte array where ret[i] corresponds to the result for `mints[i]`.
+ * 0 - false, 1 - true.
  *
- * @throws
+ * If false is returned, then the data needs to be added via {@link appendSplLsts}
+ *
+ * This fn returns a byte array instead of `boolean` array because wasm_bindgen's type
+ * conversion doesnt work with bool arrays.
  */
-export function init(arg0: AccountMap, arg1: SplPoolAccounts): Inf;
+export function hasSplData(inf: Inf, mints: Bs58Array[]): Uint8Array;
 /**
- * @throws if not valid PDA found
+ * Returned accounts are deduped
+ *
+ * @throws
  */
-export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
+export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
 /**
- * @throws if not valid PDA found
+ * @throws
  */
-export function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
+export function updateForTrade(inf: Inf, arg1: PkPair, arg2: AccountMap): void;
 /**
  * @throws
  */
@@ -39,31 +43,31 @@ export function quoteTradeExactIn(inf: Inf, arg1: QuoteArgs): Quote;
  */
 export function quoteTradeExactOut(inf: Inf, arg1: QuoteArgs): Quote;
 /**
- * Add SPL LSTs auxiliary data to support new SPL LSTs that may have previously not been covered
+ * Returns the array of all possible {@link InfErr}s
  */
-export function appendSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
+export function allInfErrs(): AllInfErrs;
 /**
- * Returns if the given SPL LST mints have their {@link SplPoolAccounts} present in the object.
- *
- * Returns a byte array where ret[i] corresponds to the result for `mints[i]`.
- * 0 - false, 1 - true.
- *
- * If false is returned, then the data needs to be added via {@link appendSplLsts}
- *
- * This fn returns a byte array instead of `boolean` array because wasm_bindgen's type
- * conversion doesnt work with bool arrays.
+ * @throws if not valid PDA found
  */
-export function hasSplData(inf: Inf, mints: Bs58Array[]): Uint8Array;
+export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
 /**
- * Returned accounts are deduped
- *
- * @throws
+ * @throws if not valid PDA found
  */
-export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
+export function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
 /**
+ * Returns the pubkeys of the accounts that need ot be fetched to initialize
+ * a new {@link Inf} object
+ */
+export function initPks(): Bs58Array[];
+/**
+ * Initialize a new {@link Inf} object.
+ *
+ * The returned object must be updated for a mint pair before it is ready to
+ * quote and operate for trades involving that pair
+ *
  * @throws
  */
-export function updateForTrade(inf: Inf, arg1: PkPair, arg2: AccountMap): void;
+export function init(arg0: AccountMap, arg1: SplPoolAccounts): Inf;
 export interface TradeArgs {
     amt: bigint;
     limit: bigint;
@@ -72,33 +76,6 @@ export interface TradeArgs {
     tokenAccs: PkPair;
 }
 
-export type FoundPda = [B58PK, number];
-
-export interface Pair<T> {
-    inp: T;
-    out: T;
-}
-
-export type PkPair = Pair<B58PK>;
-
-export interface AccountMeta {
-    address: B58PK;
-    /**
-     * Represents the role of an account in a transaction:
-     * - Readonly: 0
-     * - Writable: 1
-     * - ReadonlySigner: 2
-     * - WritableSigner: 3
-     */
-    role: 0 | 1 | 2 | 3;
-}
-
-export interface Instruction {
-    data: Uint8Array;
-    accounts: AccountMeta[];
-    programAddress: B58PK;
-}
-
 export type FeeMint = "inp" | "out";
 
 export interface QuoteArgs {
@@ -139,6 +116,13 @@ export interface Quote {
     mints: PkPair;
 }
 
+export interface Pair<T> {
+    inp: T;
+    out: T;
+}
+
+export type PkPair = Pair<B58PK>;
+
 export interface Account {
     data: Uint8Array;
     owner: B58PK;
@@ -157,6 +141,35 @@ export type AccountMap = Map<B58PK, Account>;
 
 export type B58PK = Bs58Array;
 
+/**
+ * All {@link Error} objects thrown by SDK functions will start with
+ * `{InfErr}:`, so that the `InfErr` error code can be
+ * extracted by splitting on the first colon `:`
+ */
+export type InfErr = "AccDeserErr" | "InternalErr" | "MissingAccErr" | "MissingSplDataErr" | "MissingSvcDataErr" | "NoValidPdaErr" | "PoolErr" | "UnknownSvcErr" | "UnsupportedMintErr" | "UserErr";
+
+export type AllInfErrs = InfErr[];
+
+export type FoundPda = [B58PK, number];
+
+export interface AccountMeta {
+    address: B58PK;
+    /**
+     * Represents the role of an account in a transaction:
+     * - Readonly: 0
+     * - Writable: 1
+     * - ReadonlySigner: 2
+     * - WritableSigner: 3
+     */
+    role: 0 | 1 | 2 | 3;
+}
+
+export interface Instruction {
+    data: Uint8Array;
+    accounts: AccountMeta[];
+    programAddress: B58PK;
+}
+
 export type Bs58Array = string
 
 export class Inf {
@@ -170,25 +183,26 @@ export interface InitOutput {
   readonly memory: WebAssembly.Memory;
   readonly tradeExactInIx: (a: number, b: any) => [number, number, number];
   readonly tradeExactOutIx: (a: number, b: any) => [number, number, number];
-  readonly initPks: () => [number, number];
-  readonly init: (a: any, b: any) => [number, number, number];
-  readonly findPoolReservesAta: (a: any) => [number, number, number];
-  readonly findProtocolFeeAccumulatorAta: (a: any) => [number, number, number];
-  readonly quoteTradeExactIn: (a: number, b: any) => [number, number, number];
-  readonly quoteTradeExactOut: (a: number, b: any) => [number, number, number];
   readonly appendSplLsts: (a: number, b: any) => void;
   readonly hasSplData: (a: number, b: number, c: number) => [number, number];
   readonly accountsToUpdateForTrade: (a: number, b: any) => [number, number, number, number];
   readonly updateForTrade: (a: number, b: any, c: any) => [number, number];
+  readonly quoteTradeExactIn: (a: number, b: any) => [number, number, number];
+  readonly quoteTradeExactOut: (a: number, b: any) => [number, number, number];
   readonly __wbg_inf_free: (a: number, b: number) => void;
+  readonly allInfErrs: () => any;
+  readonly findPoolReservesAta: (a: any) => [number, number, number];
+  readonly findProtocolFeeAccumulatorAta: (a: any) => [number, number, number];
+  readonly initPks: () => [number, number];
+  readonly init: (a: any, b: any) => [number, number, number];
   readonly __wbindgen_malloc: (a: number, b: number) => number;
   readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
   readonly __wbindgen_exn_store: (a: number) => void;
   readonly __externref_table_alloc: () => number;
   readonly __wbindgen_export_4: WebAssembly.Table;
   readonly __externref_table_dealloc: (a: number) => void;
-  readonly __externref_drop_slice: (a: number, b: number) => void;
   readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_drop_slice: (a: number, b: number) => void;
   readonly __wbindgen_start: () => void;
 }