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

package/index.d.ts

@@ -1,13 +1,44 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
+ * Returned accounts are deduped
+ *
  * @throws
  */
-export function tradeExactInIx(inf: Inf, arg1: TradeArgs): Instruction;
+export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
 /**
  * @throws
  */
-export function tradeExactOutIx(inf: Inf, arg1: TradeArgs): Instruction;
+export function updateForTrade(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;
+/**
+ * Returned accounts are deduped
+ *
+ * @throws
+ */
+export function accountsToUpdateForRebalance(inf: Inf, arg1: PkPair): Bs58Array[];
+/**
+ * @throws
+ */
+export function updateForRebalance(inf: Inf, arg1: PkPair, account_map: AccountMap): void;
+/**
+ * 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;
 /**
  * Add SPL LSTs auxiliary data to support new SPL LSTs that may have previously not been covered
  */
@@ -25,57 +56,126 @@ export function appendSplLsts(inf: Inf, arg1: SplPoolAccounts): void;
  */
 export function hasSplData(inf: Inf, mints: Bs58Array[]): Uint8Array;
 /**
- * Returned accounts are deduped
- *
  * @throws
  */
-export function accountsToUpdateForTrade(inf: Inf, arg1: PkPair): Bs58Array[];
+export function quoteTradeExactIn(inf: Inf, arg1: QuoteArgs): Quote;
 /**
  * @throws
  */
-export function updateForTrade(inf: Inf, arg1: PkPair, arg2: AccountMap): void;
+export function quoteTradeExactOut(inf: Inf, arg1: QuoteArgs): Quote;
 /**
- * @throws
+ * @throws if no valid PDA found
  */
-export function quoteTradeExactIn(inf: Inf, arg1: QuoteArgs): Quote;
+export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
+/**
+ * @throws if no valid PDA found
+ */
+export function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
 /**
  * @throws
  */
-export function quoteTradeExactOut(inf: Inf, arg1: QuoteArgs): Quote;
+export function tradeExactInIx(inf: Inf, arg1: TradeArgs): Instruction;
 /**
- * Returns the array of all possible {@link InfErr}s
+ * @throws
  */
-export function allInfErrs(): AllInfErrs;
+export function tradeExactOutIx(inf: Inf, arg1: TradeArgs): Instruction;
 /**
- * @throws if not valid PDA found
+ * @throws
  */
-export function findPoolReservesAta(arg0: Bs58Array): FoundPda;
+export function rebalanceIxs(inf: Inf, arg1: RebalanceArgs): RebalanceIxs;
+export interface Account {
+    data: Uint8Array;
+    owner: B58PK;
+}
+
 /**
- * @throws if not valid PDA found
+ * 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 function findProtocolFeeAccumulatorAta(arg0: Bs58Array): FoundPda;
+export type SplPoolAccounts = Map<B58PK, B58PK>;
+
+export type AccountMap = Map<B58PK, Account>;
+
+export interface PkPair {
+    inp: B58PK;
+    out: B58PK;
+}
+
+export type B58PK = Bs58Array;
+
+
+export type ERR_CODE_MSG_SEP = ":";
+
 /**
- * Returns the pubkeys of the accounts that need ot be fetched to initialize
- * a new {@link Inf} object
+ * All {@link Error} objects thrown by the SDK have messages of this format
  */
-export function initPks(): Bs58Array[];
+export type InfErrMsg = `${InfErr}${ERR_CODE_MSG_SEP}${string}`;
+
+
 /**
- * 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
+ * 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 function init(arg0: AccountMap, arg1: SplPoolAccounts): Inf;
-export interface TradeArgs {
-    amt: bigint;
-    limit: bigint;
+export type InfErr = "AccDeserErr" | "InternalErr" | "MissingAccErr" | "MissingSplDataErr" | "MissingSvcDataErr" | "NoValidPdaErr" | "PoolErr" | "UnknownPpErr" | "UnknownSvcErr" | "UnsupportedMintErr" | "SizeTooSmallErr" | "SizeTooLargeErr";
+
+export type AllInfErrs = [
+        "AccDeserErr",
+        "InternalErr",
+        "MissingAccErr",
+        "MissingSplDataErr",
+        "MissingSvcDataErr",
+        "NoValidPdaErr",
+        "PoolErr",
+        "UnknownSvcErr",
+        "UnsupportedMintErr",
+        "SizeTooSmallErr",
+        "SizeTooLargeErr",
+    ];
+
+export interface RebalanceQuoteArgs {
+    /**
+     * Amount of output tokens that will leave the pool in StartRebalance
+     */
+    out: bigint;
     mints: PkPair;
-    signer: B58PK;
-    tokenAccs: PkPair;
 }
 
+export interface RebalanceQuote {
+    /**
+     * Amount of input tokens that needs to enter the pool by EndRebalance
+     */
+    inp: bigint;
+    /**
+     * 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
+     */
+    role: 0 | 1 | 2 | 3;
+}
+
+export interface Instruction {
+    data: Uint8Array;
+    accounts: AccountMeta[];
+    programAddress: B58PK;
+}
+
+export type FoundPda = [B58PK, number];
+
 export type FeeMint = "inp" | "out";
 
 export interface QuoteArgs {
@@ -116,58 +216,25 @@ 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;
+export interface TradeArgs {
+    amt: bigint;
+    limit: bigint;
+    mints: PkPair;
+    signer: B58PK;
+    tokenAccs: PkPair;
 }
 
-/**
- * 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 RebalanceArgs {
+    out: bigint;
+    minStartingOutLst: bigint;
+    maxStartingInpLst: bigint;
+    mints: PkPair;
+    withdrawTo: B58PK;
 }
 
-export interface Instruction {
-    data: Uint8Array;
-    accounts: AccountMeta[];
-    programAddress: B58PK;
+export interface RebalanceIxs {
+    start: Instruction;
+    end: Instruction;
 }
 
 export type Bs58Array = string
@@ -181,28 +248,32 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 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 allInfErrs: () => any;
+  readonly quoteRebalance: (a: number, b: any) => [number, number, number];
+  readonly accountsToUpdateForRebalance: (a: number, b: any) => [number, number, number, number];
+  readonly updateForRebalance: (a: number, b: any, c: any) => [number, number];
+  readonly initPks: () => [number, number];
+  readonly init: (a: any, b: any) => [number, number, number];
+  readonly appendSplLsts: (a: number, b: any) => void;
+  readonly hasSplData: (a: number, b: number, c: number) => [number, number];
+  readonly __wbg_inf_free: (a: number, b: number) => void;
   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 tradeExactInIx: (a: number, b: any) => [number, number, number];
+  readonly tradeExactOutIx: (a: number, b: any) => [number, number, number];
+  readonly rebalanceIxs: (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 __wbindgen_free: (a: number, b: number, c: number) => void;
   readonly __externref_drop_slice: (a: number, b: number) => void;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
   readonly __wbindgen_start: () => void;
 }