@huma-finance/soroban-pool 0.0.8-beta.2

package/dist/types/index.d.ts

@@ -0,0 +1,421 @@
+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: "CC2GGLIHX5E75QIXB7G27EOC47V74PXA33KGYDQH4DFISIVZPWQRBVJV";
+    };
+};
+export type ClientDataKey = {
+    tag: 'HumaConfig';
+    values: void;
+} | {
+    tag: 'PoolStorage';
+    values: void;
+} | {
+    tag: 'Credit';
+    values: void;
+} | {
+    tag: 'PoolManager';
+    values: void;
+};
+/**
+ * Event for the distribution of profit in the pool.
+ * # Fields:
+ * * `profit` - The amount of profit distributed.
+ * * `senior_total_assets` - The total amount of senior assets post profit distribution.
+ * * `junior_total_assets` - The total amount of junior assets post profit distribution.
+ */
+export interface ProfitDistributedEvent {
+    junior_total_assets: u128;
+    profit: u128;
+    senior_total_assets: u128;
+}
+/**
+ * Event for the distribution of loss in the pool.
+ * # Fields:
+ * * `loss` - The amount of loss distributed.
+ * * `senior_total_assets` - The total amount of senior assets post loss distribution.
+ * * `junior_total_assets` - The total amount of junior assets post loss distribution.
+ * * `senior_total_loss` - The total amount of loss the senior tranche suffered post loss distribution.
+ * * `junior_total_loss` - The total amount of loss the junior tranche suffered post loss distribution.
+ */
+export interface LossDistributedEvent {
+    junior_total_assets: u128;
+    junior_total_loss: u128;
+    loss: u128;
+    senior_total_assets: u128;
+    senior_total_loss: u128;
+}
+/**
+ * Event for the distribution of loss recovery in the pool.
+ * # Fields:
+ * * `loss_recovery` - The amount of loss recovery distributed.
+ * * `senior_total_assets` - The total amount of senior assets post loss recovery distribution.
+ * * `junior_total_assets` - The total amount of junior assets post loss recovery distribution.
+ * * `senior_total_loss` - The remaining amount of loss the senior tranche suffered post loss recovery distribution.
+ * * `junior_total_loss` - The remaining amount of loss the junior tranche suffered post loss recovery distribution.
+ */
+export interface LossRecoveryDistributedEvent {
+    junior_total_assets: u128;
+    junior_total_loss: u128;
+    loss_recovery: u128;
+    senior_total_assets: u128;
+    senior_total_loss: u128;
+}
+export interface TranchesPolicyTypeChangedEvent {
+    policy_type: TranchesPolicyType;
+}
+/**
+ * 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 TranchesPolicyType = {
+    tag: 'FixedSeniorYield';
+    values: void;
+} | {
+    tag: 'RiskAdjusted';
+    values: void;
+};
+export interface TrancheLosses {
+    losses: Array<u128>;
+}
+export interface AccruedIncomes {
+    ea_income: u128;
+    pool_owner_income: u128;
+    protocol_income: u128;
+}
+export type PayPeriodDuration = {
+    tag: 'Monthly';
+    values: void;
+} | {
+    tag: 'Quarterly';
+    values: void;
+} | {
+    tag: 'SemiAnnually';
+    values: void;
+};
+export interface PoolSettings {
+    default_grace_period_days: u32;
+    late_payment_grace_period_days: u32;
+    max_credit_line: u128;
+    min_deposit_amount: u128;
+    pay_period_duration: PayPeriodDuration;
+    principal_only_payment_allowed: boolean;
+}
+export interface LPConfig {
+    fixed_senior_yield_bps: u32;
+    liquidity_cap: u128;
+    max_senior_junior_ratio: u32;
+    tranches_risk_adjustment_bps: u32;
+    withdrawal_lockout_period_days: u32;
+}
+export interface FeeStructure {
+    front_loading_fee_bps: u32;
+    front_loading_fee_flat: u128;
+    late_fee_bps: u32;
+    yield_bps: u32;
+}
+export type PoolStatus = {
+    tag: 'Off';
+    values: void;
+} | {
+    tag: 'On';
+    values: void;
+} | {
+    tag: 'Closed';
+    values: void;
+};
+export interface CurrentEpoch {
+    end_time: u64;
+    id: u64;
+}
+export interface AdminRnR {
+    liquidity_rate_bps_ea: u32;
+    liquidity_rate_bps_pool_owner: u32;
+    reward_rate_bps_ea: u32;
+    reward_rate_bps_pool_owner: u32;
+}
+export interface TrancheAddresses {
+    addrs: Array<Option<string>>;
+}
+export interface TrancheAssets {
+    assets: Array<u128>;
+}
+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: ({ huma_config, pool_manager, pool_storage, credit, tranches_policy, }: {
+        huma_config: string;
+        pool_manager: string;
+        pool_storage: string;
+        credit: string;
+        tranches_policy: 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 set_huma_config 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_huma_config: ({ addr, caller }: {
+        addr: string;
+        caller: 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_storage 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_storage: ({ addr, caller }: {
+        addr: string;
+        caller: 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_credit 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_credit: ({ addr, caller }: {
+        addr: string;
+        caller: 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_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.
+     */
+    set_pool_manager: ({ addr, caller }: {
+        addr: string;
+        caller: 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_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: ({ caller, policy_type, }: {
+        caller: string;
+        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 distribute_profit 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: ({ profit }: {
+        profit: 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 distribute_loss 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_loss: ({ loss }: {
+        loss: 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 distribute_loss_recovery 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_loss_recovery: ({ loss_recovery }: {
+        loss_recovery: 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_protocol_income_accrued 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_protocol_income_accrued: (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<u128>>;
+    /**
+     * Construct and simulate a get_pool_owner_income_accrued 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_pool_owner_income_accrued: (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<u128>>;
+    /**
+     * Construct and simulate a get_ea_income_accrued 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_ea_income_accrued: (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<u128>>;
+}
+export declare class Client extends ContractClient {
+    readonly options: ContractClientOptions;
+    constructor(options: ContractClientOptions);
+    readonly fromJSON: {
+        initialize: (json: string) => AssembledTransaction<null>;
+        set_huma_config: (json: string) => AssembledTransaction<null>;
+        set_pool_storage: (json: string) => AssembledTransaction<null>;
+        set_credit: (json: string) => AssembledTransaction<null>;
+        set_pool_manager: (json: string) => AssembledTransaction<null>;
+        set_tranches_policy_type: (json: string) => AssembledTransaction<null>;
+        distribute_profit: (json: string) => AssembledTransaction<null>;
+        distribute_loss: (json: string) => AssembledTransaction<null>;
+        distribute_loss_recovery: (json: string) => AssembledTransaction<null>;
+        get_protocol_income_accrued: (json: string) => AssembledTransaction<bigint>;
+        get_pool_owner_income_accrued: (json: string) => AssembledTransaction<bigint>;
+        get_ea_income_accrued: (json: string) => AssembledTransaction<bigint>;
+    };
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "version": "0.0.8-beta.2+79432b6",
+  "name": "@huma-finance/soroban-pool",
+  "dependencies": {
+    "@stellar/freighter-api": "2.0.0",
+    "@stellar/stellar-sdk": "11.3.0",
+    "buffer": "6.0.3"
+  },
+  "scripts": {
+    "build": "node ./scripts/build.mjs"
+  },
+  "exports": {
+    "require": "./dist/cjs/index.js",
+    "import": "./dist/esm/index.js"
+  },
+  "typings": "dist/types/index.d.ts",
+  "devDependencies": {
+    "typescript": "5.3.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "79432b60d3d0c755634737e635699aab90be53f0"
+}

package/scripts/build.mjs

@@ -0,0 +1,37 @@
+import { spawnSync } from "node:child_process"
+import fs from "node:fs"
+import path from "node:path"
+
+const buildDir = "./dist"
+
+const { error, stderr } = spawnSync("tsc", ["-b", "./scripts/tsconfig.cjs.json", "./scripts/tsconfig.esm.json", "./scripts/tsconfig.types.json"], { stdio: "inherit" })
+
+if (error) {
+  console.error(stderr)
+  console.error(error)
+  throw error
+}
+
+function createEsmModulePackageJson() {
+  fs.readdir(buildDir, function (err, dirs) {
+    if (err) {
+      throw err
+    }
+    dirs.forEach(function (dir) {
+      if (dir === "esm") {
+        // 1. add package.json file with "type": "module"
+        var packageJsonFile = path.join(buildDir, dir, "/package.json")
+        if (!fs.existsSync(packageJsonFile)) {
+          fs.writeFileSync(
+            packageJsonFile,
+            '{"type": "module"}',
+            'utf8',
+            err => { if (err) throw err }
+          )
+        }
+      }
+    })
+  })
+}
+
+createEsmModulePackageJson()

package/scripts/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/cjs",
+    "module": "commonjs"
+  }
+}

package/scripts/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/esm",
+    "module": "esnext"
+  }
+}

package/scripts/tsconfig.types.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/types",
+    "declaration": true,
+    "emitDeclarationOnly": true
+  }
+}