@exponent-labs/exponent-sdk 0.0.3

package/build/vault.d.ts

@@ -0,0 +1,289 @@
+/// <reference types="bn.js" />
+import { BN, web3 } from "@coral-xyz/anchor";
+import { ClaimAmount } from "@exponent-labs/exponent-ix";
+import { Environment } from "./environment";
+import { InstructionAccounts } from "./utils";
+import { ExponentPDA } from "@exponent-labs/exponent-pda";
+import { VaultEmission, VaultJson, VaultState, AnchorizedPNum, CpiAccountsRaw } from "@exponent-labs/exponent-types";
+export type CollectTreasuryEmissionKind = {
+    yieldPosition: {};
+} | {
+    treasuryEmission: {};
+};
+export type CollectTreasuryInterestKind = {
+    yieldPosition: {};
+} | {
+    treasuryInterest: {};
+};
+/** Emission info for SY program */
+interface SyEmission {
+    /** Token account that holds emission tokens */
+    escrowAccountAddress: web3.PublicKey;
+    /** Mint for the emission token */
+    mint: web3.PublicKey;
+    /** Token program ID for the emission token */
+    tokenProgramAddress: web3.PublicKey;
+    /** How many emissions have been claimed by SY holders */
+    totalClaimed: BN;
+    /** How many emissions have been earned by the SY robot over its lifetime */
+    lastSeenTotalAccruedEmissions: BN;
+    /** Global index for sharing out rewards to SY holders */
+    index: AnchorizedPNum;
+}
+export declare class Vault {
+    state: VaultState;
+    selfAddress: web3.PublicKey;
+    env: Environment;
+    connection: web3.Connection;
+    private coreProgram;
+    constructor(state: VaultState, selfAddress: web3.PublicKey, env: Environment, connection: web3.Connection);
+    static loadFromJson(v: VaultJson, address: web3.PublicKey, env: Environment, connection: web3.Connection): Vault;
+    static load(env: Environment, connection: web3.Connection, address: web3.PublicKey): Promise<Vault>;
+    reload(conn?: web3.Connection): Promise<Vault>;
+    toJson(): VaultJson;
+    get pda(): ExponentPDA;
+    get syBalance(): bigint;
+    get mintSy(): web3.PublicKey;
+    getAdminStatePda(): web3.PublicKey;
+    get mintPt(): web3.PublicKey;
+    get mintYt(): web3.PublicKey;
+    get flavor(): import("@exponent-labs/exponent-types").Flavor;
+    get cpiAccounts(): CpiAccountsRaw;
+    get authority(): web3.PublicKey;
+    get escrowSy(): web3.PublicKey;
+    get addressLookupTable(): web3.PublicKey;
+    get eventAuthority(): web3.PublicKey;
+    /** Emission metadata from SY program */
+    get syEmissions(): SyEmission[];
+    /** Emissions from the vault */
+    get vaultEmissions(): VaultEmission[];
+    /** Get the escrow token account addresses for the emissions, in order */
+    get vaultEmissionTokenAccounts(): web3.PublicKey[];
+    get currentSyExchangeRate(): number;
+    get escrowYt(): web3.PublicKey;
+    /** UNIX Timestamp (seconds) at which the vault expires */
+    get expirationTimestamp(): number;
+    /** Date at which the vault expires */
+    get expirationDate(): Date;
+    /** Collect an emission earned with a YT position */
+    ixCollectEmission({ owner, emissionIndex, amount, emissionDst, }: {
+        owner: web3.PublicKey;
+        emissionIndex: number;
+        amount: ClaimAmount;
+        emissionDst?: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    /** Strip SY into PT & YT */
+    ixStrip({ syIn, depositor, ptDst, ytDst, sySrc, }: {
+        syIn: bigint;
+        depositor: web3.PublicKey;
+        ptDst?: web3.PublicKey;
+        ytDst?: web3.PublicKey;
+        sySrc?: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    ixStripFromBase({ owner, amountBase, baseSrc, sySrc, ptDst, ytDst, }: {
+        owner: web3.PublicKey;
+        amountBase: bigint;
+        baseSrc?: web3.PublicKey;
+        sySrc?: web3.PublicKey;
+        ptDst?: web3.PublicKey;
+        ytDst?: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    ixMergeToBase({ owner, amountPy, ptSrc, ytSrc, syDst, baseDst, }: {
+        owner: web3.PublicKey;
+        amountPy: bigint;
+        ptSrc?: web3.PublicKey;
+        ytSrc?: web3.PublicKey;
+        syDst?: web3.PublicKey;
+        baseDst?: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    /** Merge PT & YT into SY */
+    ixMerge({ pyIn, depositor, ptSrc, ytSrc, syDst, }: {
+        pyIn: bigint;
+        depositor: web3.PublicKey;
+        ptSrc?: web3.PublicKey;
+        ytSrc?: web3.PublicKey;
+        syDst?: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    /** Initialize the yield position for a vault */
+    ixInitializeYieldPosition({ owner }: {
+        owner: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    /** Collect interest (as SY) from a yield position */
+    ixCollectInterest({ owner, amount, syDst }: {
+        owner: web3.PublicKey;
+        amount: ClaimAmount;
+        syDst?: web3.PublicKey;
+    }): Promise<web3.TransactionInstruction>;
+    /** Administrative action to configure a vault */
+    /** Administrative action to configure a vault */
+    ixConfigureVault({ signer, action, }: {
+        signer: web3.PublicKey;
+        action: AdminAction;
+    }): Promise<web3.TransactionInstruction>;
+    collectEmissionAccounts({ emissionIndex, owner, emissionDst, }: {
+        emissionIndex: number;
+        owner: web3.PublicKey;
+        emissionDst?: web3.PublicKey;
+    }): InstructionAccounts<CollectEmissionAccounts>;
+    stripAccounts({ depositor, ptDst, ytDst, sySrc, }: {
+        depositor: web3.PublicKey;
+        ptDst?: web3.PublicKey;
+        ytDst?: web3.PublicKey;
+        sySrc?: web3.PublicKey;
+    }): InstructionAccounts<StripAccounts>;
+    ixCollectTreasuryInterest({ signer, syDst, amount, kind, }: {
+        signer: web3.PublicKey;
+        syDst: web3.PublicKey;
+        amount: ClaimAmount;
+        kind: CollectTreasuryInterestKind;
+    }): Promise<web3.TransactionInstruction>;
+    ixCollectTreasuryEmission({ index, amount, emissionDst, signer, kind, }: {
+        index: number;
+        amount: ClaimAmount;
+        emissionDst: web3.PublicKey;
+        signer: web3.PublicKey;
+        kind: CollectTreasuryEmissionKind;
+    }): Promise<web3.TransactionInstruction>;
+    ixAddStandaloneEmission({ signer, emissionMint, emissionTokenProgram, treasuryTokenAccountEmission, treasuryFeeBps, altAddresses, cpiAccounts, }: {
+        signer: web3.PublicKey;
+        emissionMint: web3.PublicKey;
+        emissionTokenProgram?: web3.PublicKey;
+        treasuryTokenAccountEmission: web3.PublicKey;
+        treasuryFeeBps: number;
+        altAddresses: web3.PublicKey[];
+        cpiAccounts: CpiAccountsRaw;
+    }): Promise<{
+        extendAddressLookupTableExtensionAccounts: web3.PublicKey[];
+        ix: web3.TransactionInstruction;
+    }>;
+    collectInterestAccounts({ owner, syDst, }: {
+        owner: web3.PublicKey;
+        syDst?: web3.PublicKey;
+    }): InstructionAccounts<CollectInterestAccounts>;
+    /** Construct accounts for Merge instruction */
+    mergeAccounts({ owner, ptSrc, ytSrc, syDst, }: {
+        owner: web3.PublicKey;
+        ptSrc?: web3.PublicKey;
+        ytSrc?: web3.PublicKey;
+        syDst?: web3.PublicKey;
+    }): InstructionAccounts<MergeAccounts>;
+    initializeYieldPositionAccounts({ owner, }: {
+        owner: web3.PublicKey;
+    }): InstructionAccounts<InitializeYieldPositionAccounts>;
+    /** Construct accounts for Merge instruction */
+    configureVaultAccounts({ signer }: {
+        signer: web3.PublicKey;
+    }): InstructionAccounts<ConfigureVaultAccounts>;
+}
+export interface CollectInterestAccounts {
+    vault: web3.PublicKey;
+    owner: web3.PublicKey;
+    authority: web3.PublicKey;
+    escrowSy: web3.PublicKey;
+    tokenSyDst: web3.PublicKey;
+    tokenProgram: web3.PublicKey;
+    yieldPosition: web3.PublicKey;
+    addressLookupTable: web3.PublicKey;
+    syProgram: web3.PublicKey;
+    treasurySyTokenAccount: web3.PublicKey;
+    eventAuthority: web3.PublicKey;
+    program: web3.PublicKey;
+}
+export interface CollectEmissionAccounts {
+    owner: web3.PublicKey;
+    vault: web3.PublicKey;
+    position: web3.PublicKey;
+    syProgram: web3.PublicKey;
+    addressLookupTable: web3.PublicKey;
+    authority: web3.PublicKey;
+    emissionEscrow: web3.PublicKey;
+    emissionDst: web3.PublicKey;
+    treasuryEmissionTokenAccount: web3.PublicKey;
+    tokenProgram: web3.PublicKey;
+    eventAuthority: web3.PublicKey;
+    program: web3.PublicKey;
+}
+/** Accounts used by Merge */
+export interface MergeAccounts {
+    owner: web3.PublicKey;
+    authority: web3.PublicKey;
+    vault: web3.PublicKey;
+    escrowSy: web3.PublicKey;
+    ytSrc: web3.PublicKey;
+    ptSrc: web3.PublicKey;
+    syDst: web3.PublicKey;
+    mintPt: web3.PublicKey;
+    mintYt: web3.PublicKey;
+    addressLookupTable: web3.PublicKey;
+    syProgram: web3.PublicKey;
+    tokenProgram: web3.PublicKey;
+    yieldPosition: web3.PublicKey;
+    eventAuthority: web3.PublicKey;
+    program: web3.PublicKey;
+}
+/** Accounts used by Strip */
+export interface StripAccounts {
+    depositor: web3.PublicKey;
+    authority: web3.PublicKey;
+    vault: web3.PublicKey;
+    sySrc: web3.PublicKey;
+    escrowSy: web3.PublicKey;
+    ytDst: web3.PublicKey;
+    ptDst: web3.PublicKey;
+    mintYt: web3.PublicKey;
+    mintPt: web3.PublicKey;
+    tokenProgram: web3.PublicKey;
+    addressLookupTable: web3.PublicKey;
+    syProgram: web3.PublicKey;
+    yieldPosition: web3.PublicKey;
+    eventAuthority: web3.PublicKey;
+    program: web3.PublicKey;
+}
+/** Accounts used by Initialize Yield Position */
+export interface InitializeYieldPositionAccounts {
+    owner: web3.PublicKey;
+    vault: web3.PublicKey;
+    yieldPosition: web3.PublicKey;
+    systemProgram: web3.PublicKey;
+    eventAuthority: web3.PublicKey;
+    program: web3.PublicKey;
+}
+/** Accounts used by Configure Vault */
+export interface ConfigureVaultAccounts {
+    vault: web3.PublicKey;
+    signer: web3.PublicKey;
+    adminState: web3.PublicKey;
+    systemProgram: web3.PublicKey;
+}
+export type AdminAction = {
+    setVaultStatus: [number];
+} | {
+    changeVaultBpsFee: [number];
+} | {
+    changeVaultTreasuryTokenAccount: [web3.PublicKey];
+} | {
+    changeEmissionTreasuryTokenAccount: {
+        emissionIndex: number;
+        newTokenAccount: web3.PublicKey;
+    };
+} | {
+    changeMinOperationSize: {
+        isStrip: boolean;
+        newSize: BN;
+    };
+} | {
+    changeEmissionBpsFee: {
+        emissionIndex: number;
+        newFeeBps: number;
+    };
+} | {
+    changeClaimLimits: {
+        maxClaimAmountPerWindow: BN;
+        claimWindowDurationSeconds: number;
+    };
+} | {
+    changeMaxPySupply: {
+        newMaxPySupply: BN;
+    };
+};
+export {};