@sanctumso/inf1 0.0.2-dev-1 → 0.0.2-dev-3

package/index.d.ts

@@ -1,41 +1,41 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Returned accounts are deduped
- *
- * @throws
+ * Returns the pubkeys of the accounts that need to be fetched to initialize
+ * a new {@link Inf} object
  */
-export function accountsToUpdateForRebalance(inf: Inf, arg1: PkPair): Bs58Array[];
+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 updateForRebalance(inf: Inf, arg1: PkPair, account_map: AccountMap): void;
+export function init(arg0: AccountMap, arg1: SplPoolAccounts): Inf;
 /**
- * Add SPL LSTs auxiliary data to support new SPL LSTs that may have previously not been covered
+ * Same as {@link init}, but instead of using accounts fetched from RPC,
+ * uses the accounts' js objects
+ *
+ * @throws
  */
-export function appendSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
+export function initObj(pool: PoolStateV2, lst_state_list: LstState[], arg2: SplPoolAccounts): Inf;
+export function cloneInf(src: Inf): Inf;
 /**
- * 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}
+ * Returned accounts are deduped
  *
- * This fn returns a byte array instead of `boolean` array because wasm_bindgen's type
- * conversion doesnt work with bool arrays.
+ * @throws
  */
-export function hasSplData(inf: Inf, mints: Bs58Array[]): Uint8Array;
+export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
 /**
- * @throws if no valid PDA found
+ * @throws
  */
-export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
+export function updateForTrade(inf: Inf, arg1: PkPair, account_map: AccountMap): void;
 /**
- * @deprecated Protocol fee accumulator token accounts are no longer used in v2
- *
- * @throws if no valid PDA found
+ * @throws
  */
-export function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
+export function rebalanceIxs(inf: Inf, arg1: RebalanceArgs): RebalanceIxs;
 /**
  * @throws
  */
@@ -45,18 +45,13 @@ export function quoteTradeExactIn(inf: Inf, arg1: QuoteArgs): Quote;
  */
 export function quoteTradeExactOut(inf: Inf, arg1: QuoteArgs): Quote;
 /**
- * @throws
- */
-export function tradeExactInIx(inf: Inf, arg1: TradeArgs): Instruction;
-/**
- * @throws
+ * @throws if lookahead was set and failed
  */
-export function tradeExactOutIx(inf: Inf, arg1: TradeArgs): Instruction;
-export function getPoolState(inf: Inf): PoolStateV2;
+export function getPoolState(inf: Inf, lookahead?: SlotLookahead | null): PoolStateV2;
 /**
  * Sets the `PoolState` account data
  */
-export function setPoolState(inf: Inf, arg1: PoolStateV2): void;
+export function setPoolState(inf: Inf, intf: PoolStateV2): void;
 /**
  * Returns serialized `PoolState` account data
  */
@@ -82,40 +77,84 @@ export function serLstStateList(inf: Inf): Uint8Array;
  */
 export function deserLstStateList(inf: Inf, lst_state_list_data: Uint8Array): void;
 /**
- * Returns the array of all possible {@link InfErr}s
+ * @throws if no valid PDA found
  */
-export function allInfErrs(): AllInfErrs;
-export function quoteRebalance(inf: Inf, arg1: RebalanceQuoteArgs): RebalanceQuote;
+export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
 /**
- * Returns the pubkeys of the accounts that need to be fetched to initialize
- * a new {@link Inf} object
+ * @deprecated Protocol fee accumulator token accounts are no longer used in v2
+ *
+ * @throws if no valid PDA found
  */
-export function initPks(): Bs58Array[];
+export function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
 /**
- * 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 appendSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
+/**
+ * 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 cloneInf(src: Inf): Inf;
+export function hasSplData(inf: Inf, mints: Bs58Array[]): Uint8Array;
 /**
  * Returned accounts are deduped
  *
  * @throws
  */
-export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
+export function accountsToUpdateForRebalance(inf: Inf, arg1: PkPair): Bs58Array[];
 /**
  * @throws
  */
-export function updateForTrade(inf: Inf, arg1: PkPair, account_map: AccountMap): void;
+export function updateForRebalance(inf: Inf, arg1: PkPair, account_map: AccountMap): void;
+/**
+ * Returns the array of all possible {@link InfErr}s
+ */
+export function allInfErrs(): AllInfErrs;
+export function quoteRebalance(inf: Inf, arg1: RebalanceQuoteArgs): RebalanceQuote;
 /**
  * @throws
  */
-export function rebalanceIxs(inf: Inf, arg1: RebalanceArgs): RebalanceIxs;
-export type FoundPda = [B58PK, number];
+export function tradeExactInIx(inf: Inf, arg1: TradeArgs): Instruction;
+/**
+ * @throws
+ */
+export function tradeExactOutIx(inf: Inf, arg1: TradeArgs): Instruction;
+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 interface RebalanceArgs {
+    out: bigint;
+    minStartingOutLst: bigint;
+    maxStartingInpLst: bigint;
+    mints: PkPair;
+    withdrawTo: B58PK;
+}
+
+export interface RebalanceIxs {
+    start: Instruction;
+    end: Instruction;
+}
 
 export type FeeMint = "inp" | "out";
 
@@ -136,6 +175,13 @@ export interface Quote {
      * will leave the user\'s wallet.
      */
     inp: bigint;
+    /**
+     * SOL value of `inp` input tokens.
+     *
+     * SOL value of `out` output tokens
+     * = inp_sol_val - fee
+     */
+    inpSolVal: bigint;
     /**
      * Amount of output tokens returned by the pool to the user,
      * after fees. This is exactly the amount of tokens that
@@ -150,13 +196,7 @@ export interface Quote {
     mints: PkPair;
 }
 
-export interface TradeArgs {
-    amt: bigint;
-    limit: bigint;
-    mints: PkPair;
-    signer: B58PK;
-    tokenAccs: PkPair;
-}
+export type FoundPda = [B58PK, number];
 
 
 export type ERR_CODE_MSG_SEP = ":";
@@ -193,26 +233,17 @@ export interface RebalanceQuote {
      * Amount of output tokens that will leave the pool in StartRebalance
      */
     out: bigint;
-    mints: PkPair;
-}
-
-export interface AccountMeta {
-    address: B58PK;
     /**
-     * Represents the role of an account in a transaction:
-     * - Readonly: 0
-     * - Writable: 1
-     * - ReadonlySigner: 2
-     * - WritableSigner: 3
+     * SOL value of `out` output tokens.
+     *
+     * SOL value of `inp` input tokens
+     * should be the same, barring rounding
      */
-    role: 0 | 1 | 2 | 3;
+    outSolVal: bigint;
+    mints: PkPair;
 }
 
-export interface Instruction {
-    data: Uint8Array;
-    accounts: AccountMeta[];
-    programAddress: B58PK;
-}
+export type SlotLookahead = { abs: bigint } | { rel: bigint };
 
 export interface LstState {
     isInputDisabled: number;
@@ -264,17 +295,12 @@ export interface PkPair {
 
 export type B58PK = Bs58Array;
 
-export interface RebalanceArgs {
-    out: bigint;
-    minStartingOutLst: bigint;
-    maxStartingInpLst: bigint;
+export interface TradeArgs {
+    amt: bigint;
+    limit: bigint;
     mints: PkPair;
-    withdrawTo: B58PK;
-}
-
-export interface RebalanceIxs {
-    start: Instruction;
-    end: Instruction;
+    signer: B58PK;
+    tokenAccs: PkPair;
 }
 
 export type Bs58Array = string
@@ -288,17 +314,16 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
-  readonly accountsToUpdateForRebalance: (a: number, b: any) => [number, number, number, number];
-  readonly updateForRebalance: (a: number, b: any, c: any) => [number, number];
-  readonly appendSplLsts: (a: number, b: any) => void;
-  readonly hasSplData: (a: number, b: number, c: number) => [number, number];
-  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 initObj: (a: any, b: number, c: number, d: any) => [number, number, number];
+  readonly cloneInf: (a: number) => number;
+  readonly accountsToUpdateForTrade: (a: number, b: any) => [number, number, number, number];
+  readonly updateForTrade: (a: number, b: any, c: any) => [number, number];
+  readonly rebalanceIxs: (a: number, b: any) => [number, number, number];
   readonly quoteTradeExactIn: (a: number, b: any) => [number, number, number];
   readonly quoteTradeExactOut: (a: number, b: any) => [number, number, number];
-  readonly tradeExactInIx: (a: number, b: any) => [number, number, number];
-  readonly tradeExactOutIx: (a: number, b: any) => [number, number, number];
-  readonly getPoolState: (a: number) => any;
+  readonly getPoolState: (a: number, b: number) => [number, number, number];
   readonly setPoolState: (a: number, b: any) => void;
   readonly serPoolState: (a: number) => [number, number];
   readonly deserPoolState: (a: number, b: number, c: number) => [number, number];
@@ -306,23 +331,25 @@ export interface InitOutput {
   readonly setLstStateList: (a: number, b: number, c: number) => void;
   readonly serLstStateList: (a: number) => [number, number];
   readonly deserLstStateList: (a: number, b: number, c: number) => [number, number];
+  readonly findPoolReservesAta: (a: any) => [number, number, number];
+  readonly findProtocolFeeAccumulatorAta: (a: any) => [number, number, number];
+  readonly appendSplLsts: (a: number, b: any) => void;
+  readonly hasSplData: (a: number, b: number, c: number) => [number, number];
+  readonly accountsToUpdateForRebalance: (a: number, b: any) => [number, number, number, number];
+  readonly updateForRebalance: (a: number, b: any, c: any) => [number, number];
+  readonly __wbg_inf_free: (a: number, b: number) => void;
   readonly allInfErrs: () => any;
   readonly quoteRebalance: (a: number, b: any) => [number, number, number];
-  readonly __wbg_inf_free: (a: number, b: number) => void;
-  readonly initPks: () => [number, number];
-  readonly init: (a: any, b: any) => [number, number, number];
-  readonly cloneInf: (a: number) => number;
-  readonly accountsToUpdateForTrade: (a: number, b: any) => [number, number, number, number];
-  readonly updateForTrade: (a: number, b: any, c: any) => [number, number];
-  readonly rebalanceIxs: (a: number, b: any) => [number, number, number];
+  readonly tradeExactInIx: (a: number, b: any) => [number, number, number];
+  readonly tradeExactOutIx: (a: number, 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_table_dealloc: (a: number) => void;
   readonly __wbindgen_start: () => void;
 }