@sanctumso/inf1 0.0.1-dev-1 → 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,
@@ -15,6 +16,7 @@ import {
 } from "@solana/kit";
 import {
   accountsToUpdateForTrade,
+  init,
   initPks,
   quoteTradeExactIn,
   tradeExactInIx,
@@ -22,14 +24,23 @@ import {
   type AccountMap,
   type SplPoolAccounts,
 } from "@sanctumso/inf1";
+import initSdk from "@sanctumso/inf1";
+
+// The SDK needs to be initialized once globally before it can be used (idempotent).
+// For nodejs environments, use
+// `import { initSyncEmbed } from "@sanctumso/inf1"; initSyncEmbed();`
+// instead
+await initSdk();
 
 const LAINESOL = "LAinEtNLgpmCP9Rvsf5Hn8W6EhNiKLZQti1xfWMLy6X";
 const WSOL = "So11111111111111111111111111111111111111112";
-const SPL_POOL_ACCOUNTS: SplPoolAccounts = {
+const SPL_POOL_ACCOUNTS: SplPoolAccounts = new Map(Object.entries({
   [LAINESOL]: "2qyEeSAWKfU18AFthrF7JA8z8ZCi1yt76Tqs917vwQTV",
   // ...populate rest of `spl lst mint: stake pool addr` data
-  // for every single spl lst mint in the INF pool (all 3 spl program deploys)
-};
+  // for every spl lst mints in the INF pool (all 3 spl program deploys).
+  // To support SPL LSTs that are added later on, the `appendSplLsts` fn
+  // can be used to add data
+}));
 
 // If out === INF mint, then below code will work the same,
 // but the quote and instruction will be for AddLiquidity instead of SwapExactIn.
@@ -42,34 +53,23 @@ 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");
 
 // init
-const { poolState: poolStateAddr, lstStateList: lstStateListAddr } = initPks();
-const initAccs = await fetchAccountMap(rpc, [poolStateAddr, lstStateListAddr]);
+const ipks = initPks();
+const initAccs = await fetchAccountMap(rpc, ipks);
 const inf = init(
-  {
-    poolState: initAccs.get(poolStateAddr)!,
-    lstStateList: initAccs.get(lstStateListAddr)!,
-  },
+  initAccs,
   SPL_POOL_ACCOUNTS
 );
 

package/index.d.ts

@@ -1,19 +1,73 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * @throws
+ */
 export function tradeExactInIx(inf: Inf, arg1: TradeArgs): Instruction;
+/**
+ * @throws
+ */
 export function tradeExactOutIx(inf: Inf, arg1: TradeArgs): Instruction;
-export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
-export function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
-export function initPks(): InitPks;
-export function init(arg0: InitAccounts, arg1: SplPoolAccounts): Inf;
 /**
- * Update SPL LSTs auxiliary data to support new SPL LSTs that may have previously not been covered
+ * Add SPL LSTs auxiliary data to support new SPL LSTs that may have previously not been covered
+ */
+export function appendSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
+/**
+ * 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.
+ */
+export function hasSplData(inf: Inf, mints: Bs58Array[]): Uint8Array;
+/**
+ * Returned accounts are deduped
+ *
+ * @throws
  */
-export function updateSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
-export function quoteTradeExactIn(inf: Inf, arg1: QuoteArgs): Quote;
-export function quoteTradeExactOut(arg0: Inf, arg1: QuoteArgs): Quote;
 export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
+/**
+ * @throws
+ */
 export function updateForTrade(inf: Inf, arg1: PkPair, arg2: AccountMap): void;
+/**
+ * @throws
+ */
+export function quoteTradeExactIn(inf: Inf, arg1: QuoteArgs): Quote;
+/**
+ * @throws
+ */
+export function quoteTradeExactOut(inf: Inf, arg1: QuoteArgs): Quote;
+/**
+ * Returns the array of all possible {@link InfErr}s
+ */
+export function allInfErrs(): AllInfErrs;
+/**
+ * @throws if not valid PDA found
+ */
+export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
+/**
+ * @throws if not valid PDA found
+ */
+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 init(arg0: AccountMap, arg1: SplPoolAccounts): Inf;
 export interface TradeArgs {
     amt: bigint;
     limit: bigint;
@@ -22,60 +76,6 @@ export interface TradeArgs {
     tokenAccs: PkPair;
 }
 
-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 FoundPda = [B58PK, number];
-
-export interface Account {
-    data: Uint8Array;
-    owner: B58PK;
-}
-
-/**
- * Map of `mint: stake pool account` for spl (all deploys) LSTs.
- *
- * This data is required to determine how to properly initialize the corresponding
- * sol value calculator data since which stake pool account corresponds to which mint
- * is not available onchain (yet)
- */
-export type SplPoolAccounts = Map<B58PK, B58PK>;
-
-export type AccountMap = Map<B58PK, Account>;
-
-export type B58PK = Bs58Array;
-
-export interface Pair<T> {
-    inp: T;
-    out: T;
-}
-
-export type PkPair = Pair<B58PK>;
-
-export interface Init<T> {
-    poolState: T;
-    lstStateList: T;
-}
-
-export type InitPks = Init<B58PK>;
-
-export type InitAccounts = Init<Account>;
-
 export type FeeMint = "inp" | "out";
 
 export interface QuoteArgs {
@@ -116,9 +116,126 @@ 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;
+}
+
+/**
+ * Map of `mint: stake pool account` for spl (all deploys) LSTs.
+ *
+ * This data is required to determine how to properly initialize the corresponding
+ * sol value calculator data since which stake pool account corresponds to which mint
+ * is not available onchain (yet)
+ */
+export type SplPoolAccounts = Map<B58PK, B58PK>;
+
+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 {
   private constructor();
   free(): void;
 }
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+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 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 __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_drop_slice: (a: number, b: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;
+
+/**
+ * Instantiates this `module` using the embedded
+ * {@link WASM_BIN_B64}. This is what works for nodejs envs.
+ *
+ * @returns {InitOutput}
+ */
+export function initSyncEmbed(): InitOutput;
+
+/**
+ * Embedded base64-encoded wasm binary bytes
+ */
+export const WASM_BIN_B64: string;