@huma-finance/soroban-pool-storage 0.0.8-beta.2 → 0.0.11-beta.7

package/README.md

@@ -8,7 +8,7 @@ This library was automatically generated by Soroban CLI using a command similar
 soroban contract bindings ts \
   --rpc-url https://soroban-testnet.stellar.org:443 \
   --network-passphrase "Test SDF Network ; September 2015" \
-  --contract-id CAKPKH2G3ALGKW2E5BJFUJ6WR3RXJVGIXEAPVI5S6Q4HKSDCMKEYJSBR \
+  --contract-id CDL3YWC2SMRK363QPS4AR5TGVFESE3FMIPOGHEQBMJJA3RTQQ2ALW73U \
   --output-dir ./path/to/tb-poolStorage
 ```
 
@@ -30,7 +30,7 @@ However, we've actually encountered [frustration](https://github.com/stellar/sor
 
 ```json
 "scripts": {
-  "postinstall": "soroban contract bindings ts --rpc-url https://soroban-testnet.stellar.org:443 --network-passphrase \"Test SDF Network ; September 2015\" --id CAKPKH2G3ALGKW2E5BJFUJ6WR3RXJVGIXEAPVI5S6Q4HKSDCMKEYJSBR --name tb-poolStorage"
+  "postinstall": "soroban contract bindings ts --rpc-url https://soroban-testnet.stellar.org:443 --network-passphrase \"Test SDF Network ; September 2015\" --id CDL3YWC2SMRK363QPS4AR5TGVFESE3FMIPOGHEQBMJJA3RTQQ2ALW73U --name tb-poolStorage"
 }
 ```
 

package/dist/cjs/index.d.ts

@@ -1,39 +1,69 @@
-import { AssembledTransaction, ContractClient, ContractClientOptions } from '@stellar/stellar-sdk/lib/contract_client/index.js';
-import type { u32, u64, u128, Option } from '@stellar/stellar-sdk/lib/contract_client';
-export * from '@stellar/stellar-sdk';
-export * from '@stellar/stellar-sdk/lib/contract_client/index.js';
-export * from '@stellar/stellar-sdk/lib/rust_types/index.js';
+/// <reference types="node" />
+import { Buffer } from "buffer";
+import { AssembledTransaction, ContractClient, ContractClientOptions } from "@stellar/stellar-sdk/lib/contract_client/index.js";
+import type { u32, u64, u128, Option } from "@stellar/stellar-sdk/lib/contract_client";
+export * from "@stellar/stellar-sdk";
+export * from "@stellar/stellar-sdk/lib/contract_client/index.js";
+export * from "@stellar/stellar-sdk/lib/rust_types/index.js";
 export declare const networks: {
     readonly testnet: {
         readonly networkPassphrase: "Test SDF Network ; September 2015";
-        readonly contractId: "CAKPKH2G3ALGKW2E5BJFUJ6WR3RXJVGIXEAPVI5S6Q4HKSDCMKEYJSBR";
+        readonly contractId: "CDL3YWC2SMRK363QPS4AR5TGVFESE3FMIPOGHEQBMJJA3RTQQ2ALW73U";
     };
 };
 export declare const Errors: {
-    8: {
+    201: {
         message: string;
     };
-    1: {
+    202: {
         message: string;
     };
-    96: {
-        message: string;
-    };
-    97: {
-        message: string;
-    };
-    79: {
+    203: {
         message: string;
     };
 };
+/**
+ * The senior yield tracker has been refreshed.
+ * # Fields:
+ * * `total_assets` - The total assets in the senior tranche after the refresh.
+ * * `unpaid_yield` - The amount of unpaid yield to the senior tranche after the refresh.
+ * * `last_updated_date` - The last time the tracker was updated after the refresh.
+ */
+export interface YieldTrackerRefreshedEvent {
+    last_updated_date: u64;
+    total_assets: u128;
+    unpaid_yield: u128;
+}
+export type FixedSeniorYieldTranchesPolicyDataKey = {
+    tag: "SeniorYieldTracker";
+    values: void;
+};
+export interface SeniorYieldTracker {
+    last_updated_date: u64;
+    total_assets: u128;
+    unpaid_yield: u128;
+}
+export interface FixedSeniorYieldTranchesPolicy {
+    placeholder: boolean;
+}
+export interface RiskAdjustedTranchesPolicy {
+    placeholder: boolean;
+}
 export type PayPeriodDuration = {
-    tag: 'Monthly';
+    tag: "Monthly";
     values: void;
 } | {
-    tag: 'Quarterly';
+    tag: "Quarterly";
     values: void;
 } | {
-    tag: 'SemiAnnually';
+    tag: "SemiAnnually";
+    values: void;
+};
+export type TranchesPolicyType = {
+    tag: "FixedSeniorYield";
+    values: void;
+} | {
+    tag: "RiskAdjusted";
     values: void;
 };
 export interface PoolSettings {
@@ -58,16 +88,16 @@ export interface FeeStructure {
     yield_bps: u32;
 }
 export type PoolStatus = {
-    tag: 'Off';
+    tag: "Off";
     values: void;
 } | {
-    tag: 'On';
+    tag: "On";
     values: void;
 } | {
-    tag: 'Closed';
+    tag: "Closed";
     values: void;
 };
-export interface CurrentEpoch {
+export interface Epoch {
     end_time: u64;
     id: u64;
 }
@@ -87,11 +117,11 @@ export interface Client {
     /**
      * Construct and simulate a initialize transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    initialize: ({ addrs, protocol_on, pool_status, tranche_addrs, }: {
+    initialize: ({ addrs, protocol_on, tranche_addrs, tranches_policy, }: {
         addrs: Array<string>;
         protocol_on: boolean;
-        pool_status: PoolStatus;
         tranche_addrs: Array<Option<string>>;
+        tranches_policy: TranchesPolicyType;
     }, options?: {
         /**
          * The fee to pay for the transaction. Default: BASE_FEE
@@ -107,10 +137,12 @@ export interface Client {
         simulate?: boolean;
     }) => Promise<AssembledTransaction<null>>;
     /**
-     * Construct and simulate a set_pool_manager transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Construct and simulate a set_contract_addrs transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    set_pool_manager: ({ addr }: {
-        addr: string;
+    set_contract_addrs: ({ pool, pool_manager, credit, }: {
+        pool: string;
+        pool_manager: string;
+        credit: string;
     }, options?: {
         /**
          * The fee to pay for the transaction. Default: BASE_FEE
@@ -148,11 +180,47 @@ export interface Client {
         simulate?: boolean;
     }) => Promise<AssembledTransaction<null>>;
     /**
-     * Construct and simulate a set_admins transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Construct and simulate a set_pool_owner transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    set_admins: ({ pool_owner, pool_owner_treasury, ea, }: {
+    set_pool_owner: ({ pool_owner }: {
         pool_owner: string;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a set_pool_owner_treasury transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    set_pool_owner_treasury: ({ pool_owner_treasury }: {
         pool_owner_treasury: string;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a set_evaluation_agent transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    set_evaluation_agent: ({ ea }: {
         ea: string;
     }, options?: {
         /**
@@ -231,7 +299,7 @@ export interface Client {
      * Construct and simulate a set_epoch transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
     set_epoch: ({ epoch }: {
-        epoch: CurrentEpoch;
+        epoch: Epoch;
     }, options?: {
         /**
          * The fee to pay for the transaction. Default: BASE_FEE
@@ -337,6 +405,25 @@ export interface Client {
          */
         simulate?: boolean;
     }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a set_tranches_policy_type transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    set_tranches_policy_type: ({ policy_type }: {
+        policy_type: TranchesPolicyType;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
     /**
      * Construct and simulate a send_tokens transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -401,7 +488,8 @@ export interface Client {
     /**
      * Construct and simulate a update_assets transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    update_assets: ({ junior_assets, senior_assets, }: {
+    update_assets: ({ caller, junior_assets, senior_assets, }: {
+        caller: string;
         junior_assets: u128;
         senior_assets: u128;
     }, options?: {
@@ -418,6 +506,62 @@ export interface Client {
          */
         simulate?: boolean;
     }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a distribute_profit_to_tranches transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    distribute_profit_to_tranches: ({ profit, admin_fees }: {
+        profit: u128;
+        admin_fees: u128;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<readonly [u128, u128]>>;
+    /**
+     * Construct and simulate a refresh_yield_tracker transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    refresh_yield_tracker: ({ tranche_assets }: {
+        tranche_assets: TrancheAssets;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a get_huma_owner transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    get_huma_owner: (options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<string>>;
     /**
      * Construct and simulate a get_pool_settings transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -487,9 +631,9 @@ export interface Client {
         simulate?: boolean;
     }) => Promise<AssembledTransaction<AdminRnR>>;
     /**
-     * Construct and simulate a pool_owner transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Construct and simulate a get_pool_owner transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    pool_owner: (options?: {
+    get_pool_owner: (options?: {
         /**
          * The fee to pay for the transaction. Default: BASE_FEE
          */
@@ -593,9 +737,9 @@ export interface Client {
         simulate?: boolean;
     }) => Promise<AssembledTransaction<string>>;
     /**
-     * Construct and simulate a pool_owner_treasury transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Construct and simulate a get_pool_owner_treasury transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    pool_owner_treasury: (options?: {
+    get_pool_owner_treasury: (options?: {
         /**
          * The fee to pay for the transaction. Default: BASE_FEE
          */
@@ -642,7 +786,7 @@ export interface Client {
          * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
          */
         simulate?: boolean;
-    }) => Promise<AssembledTransaction<CurrentEpoch>>;
+    }) => Promise<AssembledTransaction<Epoch>>;
     /**
      * Construct and simulate a get_tranche_assets_by_addr transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -717,6 +861,46 @@ export interface Client {
          */
         simulate?: boolean;
     }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a check_pool_owner_liquidity_req transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    check_pool_owner_liquidity_req: ({ tranche_vault, balance }: {
+        tranche_vault: string;
+        balance: u128;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a check_ea_liquidity_req transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    check_ea_liquidity_req: ({ tranche_vault, balance }: {
+        tranche_vault: string;
+        balance: u128;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
     /**
      * Construct and simulate a get_underlying_token transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -754,8 +938,7 @@ export interface Client {
     /**
      * Construct and simulate a reduce_admin_fees_reserve transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
-    reduce_admin_fees_reserve: ({ caller, amount, increase, }: {
-        caller: string;
+    reduce_admin_fees_reserve: ({ amount, increase }: {
         amount: u128;
         increase: boolean;
     }, options?: {
@@ -772,15 +955,36 @@ export interface Client {
          */
         simulate?: boolean;
     }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a upgrade transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    upgrade: ({ new_wasm_hash }: {
+        new_wasm_hash: Buffer;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
 }
 export declare class Client extends ContractClient {
     readonly options: ContractClientOptions;
     constructor(options: ContractClientOptions);
     readonly fromJSON: {
         initialize: (json: string) => AssembledTransaction<null>;
-        set_pool_manager: (json: string) => AssembledTransaction<null>;
+        set_contract_addrs: (json: string) => AssembledTransaction<null>;
         set_huma_config: (json: string) => AssembledTransaction<null>;
-        set_admins: (json: string) => AssembledTransaction<null>;
+        set_pool_owner: (json: string) => AssembledTransaction<null>;
+        set_pool_owner_treasury: (json: string) => AssembledTransaction<null>;
+        set_evaluation_agent: (json: string) => AssembledTransaction<null>;
         set_tranche_addresses: (json: string) => AssembledTransaction<null>;
         set_pool_operator: (json: string) => AssembledTransaction<null>;
         set_pool_status: (json: string) => AssembledTransaction<null>;
@@ -789,29 +993,36 @@ export declare class Client extends ContractClient {
         set_pool_settings: (json: string) => AssembledTransaction<null>;
         set_lp_config: (json: string) => AssembledTransaction<null>;
         set_fee_structure: (json: string) => AssembledTransaction<null>;
+        set_tranches_policy_type: (json: string) => AssembledTransaction<null>;
         send_tokens: (json: string) => AssembledTransaction<null>;
         add_tranche_assets: (json: string) => AssembledTransaction<null>;
         reduce_tranche_assets: (json: string) => AssembledTransaction<null>;
         update_assets: (json: string) => AssembledTransaction<null>;
+        distribute_profit_to_tranches: (json: string) => AssembledTransaction<readonly [bigint, bigint]>;
+        refresh_yield_tracker: (json: string) => AssembledTransaction<null>;
+        get_huma_owner: (json: string) => AssembledTransaction<string>;
         get_pool_settings: (json: string) => AssembledTransaction<PoolSettings>;
         get_lp_config: (json: string) => AssembledTransaction<LPConfig>;
         get_fee_structure: (json: string) => AssembledTransaction<FeeStructure>;
         get_admin_rnr: (json: string) => AssembledTransaction<AdminRnR>;
-        pool_owner: (json: string) => AssembledTransaction<string>;
+        get_pool_owner: (json: string) => AssembledTransaction<string>;
         is_pool_owner_or_huma_owner: (json: string) => AssembledTransaction<boolean>;
         is_pool_operator: (json: string) => AssembledTransaction<boolean>;
         is_protocol_and_pool_on: (json: string) => AssembledTransaction<boolean>;
         get_evaluation_agent: (json: string) => AssembledTransaction<string>;
         get_sentinel: (json: string) => AssembledTransaction<string>;
-        pool_owner_treasury: (json: string) => AssembledTransaction<string>;
+        get_pool_owner_treasury: (json: string) => AssembledTransaction<string>;
         get_pool_status: (json: string) => AssembledTransaction<PoolStatus>;
-        get_current_epoch: (json: string) => AssembledTransaction<CurrentEpoch>;
+        get_current_epoch: (json: string) => AssembledTransaction<Epoch>;
         get_tranche_assets_by_addr: (json: string) => AssembledTransaction<bigint>;
         get_tranche_assets: (json: string) => AssembledTransaction<TrancheAssets>;
         get_tranche_addresses: (json: string) => AssembledTransaction<TrancheAddresses>;
         check_liquidity_requirements: (json: string) => AssembledTransaction<null>;
+        check_pool_owner_liquidity_req: (json: string) => AssembledTransaction<null>;
+        check_ea_liquidity_req: (json: string) => AssembledTransaction<null>;
         get_underlying_token: (json: string) => AssembledTransaction<string>;
         get_available_balance: (json: string) => AssembledTransaction<bigint>;
         reduce_admin_fees_reserve: (json: string) => AssembledTransaction<null>;
+        upgrade: (json: string) => AssembledTransaction<null>;
     };
 }