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

package/dist/types/index.d.ts

@@ -0,0 +1,401 @@
+/// <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: "CBI7LGEWCJFO2APREGBRTUXB5JMZHJOVD76MESEB7V6W4IJ4ZLQJILDB";
+    };
+};
+export type ClientDataKey = {
+    tag: 'Pool';
+    values: void;
+} | {
+    tag: 'PoolStorage';
+    values: void;
+} | {
+    tag: 'CreditStorage';
+    values: void;
+} | {
+    tag: 'UnderlyingToken';
+    values: void;
+};
+export declare const Errors: {
+    51: {
+        message: string;
+    };
+    55: {
+        message: string;
+    };
+    71: {
+        message: string;
+    };
+    222: {
+        message: string;
+    };
+    202: {
+        message: string;
+    };
+    203: {
+        message: string;
+    };
+    204: {
+        message: string;
+    };
+    215: {
+        message: string;
+    };
+    205: {
+        message: string;
+    };
+    206: {
+        message: string;
+    };
+    207: {
+        message: string;
+    };
+    219: {
+        message: string;
+    };
+    101: {
+        message: string;
+    };
+};
+/**
+ * Account billing info refreshed with the updated due amount and date.
+ * # Fields:
+ * * `credit_hash` - The hash of the credit.
+ * * `new_due_date` - The updated due date of the bill.
+ * * `next_due` - The amount of next due on the bill.
+ * * `total_past_due` - The total amount of past due on the bill.
+ */
+export interface BillRefreshedEvent {
+    credit_hash: Buffer;
+    new_due_date: u64;
+    next_due: u128;
+    total_past_due: u128;
+}
+/**
+ * A credit has been borrowed from.
+ * # Fields:
+ * * `borrower` - The address of the borrower.
+ * * `borrow_amount` - The amount the user has borrowed.
+ * * `net_amount_to_borrower` - The borrowing amount minus the fees that are charged upfront.
+ */
+export interface DrawdownMadeEvent {
+    borrow_amount: u128;
+    borrower: string;
+    net_amount_to_borrower: u128;
+}
+/**
+ * A payment has been made against the credit.
+ * # Fields:
+ * * `borrower` - The address of the borrower.
+ * * `amount` - The payback amount.
+ * * `next_due_date` - The due date of the next payment.
+ * * `yield_due` - The yield due on the credit after processing the payment.
+ * * `principal_due` - The principal due on the credit after processing the payment.
+ * * `yield_due_paid` - The amount of this payment applied to yield due in the current billing cycle.
+ * * `principal_due_paid` - The amount of this payment applied to principal due in the current billing cycle.
+ * * `unbilled_principal_paid` - The amount of this payment applied to unbilled principal.
+ * * `yield_past_due_paid` - The amount of this payment applied to yield past due.
+ * * `late_fee_paid` - The amount of this payment applied to late fee.
+ * * `principal_past_due_paid` - The amount of this payment applied to principal past due.
+ */
+export interface PaymentMadeEvent {
+    amount: u128;
+    borrower: string;
+    late_fee_paid: u128;
+    next_due_date: u64;
+    principal_due: u128;
+    principal_due_paid: u128;
+    principal_past_due_paid: u128;
+    unbilled_principal_paid: u128;
+    yield_due: u128;
+    yield_due_paid: u128;
+    yield_past_due_paid: u128;
+}
+/**
+ * A principal payment has been made against the credit.
+ * # Fields:
+ * * `borrower` - The address of the borrower.
+ * * `payer` - The address from which the money is coming.
+ * * `amount` - The payback amount.
+ * * `next_due_date` - The due date of the next payment.
+ * * `principal_due` - The principal due on the credit after processing the payment.
+ * * `unbilled_principal` - The unbilled principal on the credit after processing the payment.
+ * * `principal_due_paid` - The amount of this payment applied to principal due.
+ * * `unbilled_principal_paid` - The amount of this payment applied to unbilled principal.
+ */
+export interface PrincipalPaymentMadeEvent {
+    amount: u128;
+    borrower: string;
+    next_due_date: u64;
+    principal_due: u128;
+    principal_due_paid: u128;
+    unbilled_principal: u128;
+    unbilled_principal_paid: u128;
+}
+/**
+ * An existing credit has been closed.
+ * # Fields:
+ * * `credit_hash` - The credit hash.
+ */
+export interface CreditClosedAfterPayOffEvent {
+    credit_hash: Buffer;
+}
+export type PayPeriodDuration = {
+    tag: 'Monthly';
+    values: void;
+} | {
+    tag: 'Quarterly';
+    values: void;
+} | {
+    tag: 'SemiAnnually';
+    values: void;
+};
+export type CreditState = {
+    tag: 'Deleted';
+    values: void;
+} | {
+    tag: 'Approved';
+    values: void;
+} | {
+    tag: 'GoodStanding';
+    values: void;
+} | {
+    tag: 'Delayed';
+    values: void;
+} | {
+    tag: 'Defaulted';
+    values: void;
+};
+/**
+ * `CreditConfig` keeps track of the static settings of a credit.
+ * A `CreditConfig` is created after the approval of each credit.
+ * # Fields:
+ * * `credit_limit` - The maximum amount that can be borrowed.
+ * * `committed_amount` - The amount that the borrower has committed to use. If the used credit
+ * is less than this amount, the borrower will be charged yield using this amount.
+ * * `pay_period_duration` - The duration of each pay period, e.g., monthly, quarterly, or semi-annually.
+ * * `num_of_periods` - The number of periods before the credit expires.
+ * * `yield_bps` - The expected yield expressed in basis points, where 1% is 100, and 100% is 10,000. It means different things
+ * for different credit types:
+ * 1. For credit line, it is APR.
+ * 2. For factoring, it is factoring fee for the given period.
+ * 3. For dynamic yield credit, it is the estimated APY.
+ * * `revolving` - A flag indicating if repeated borrowing is allowed.
+ */
+export interface CreditConfig {
+    committed_amount: u128;
+    credit_limit: u128;
+    num_periods: u32;
+    pay_period_duration: PayPeriodDuration;
+    revolving: boolean;
+    yield_bps: u32;
+}
+export interface CreditRecord {
+    missed_periods: u32;
+    next_due: u128;
+    next_due_date: u64;
+    remaining_periods: u32;
+    state: CreditState;
+    total_past_due: u128;
+    unbilled_principal: u128;
+    yield_due: u128;
+}
+export interface DueDetail {
+    accrued: u128;
+    committed: u128;
+    late_fee: u128;
+    late_fee_updated_date: u64;
+    paid: u128;
+    principal_past_due: u128;
+    yield_past_due: u128;
+}
+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: ({ pool, pool_storage, credit_storage, underlying_token, }: {
+        pool: string;
+        pool_storage: string;
+        credit_storage: string;
+        underlying_token: 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 get_due_info 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_due_info: ({ borrower }: {
+        borrower: 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<readonly [CreditRecord, DueDetail]>>;
+    /**
+     * Construct and simulate a get_next_bill_refresh_date 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_next_bill_refresh_date: ({ borrower }: {
+        borrower: 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<u64>>;
+    /**
+     * Construct and simulate a drawdown 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.
+     */
+    drawdown: ({ borrower, amount }: {
+        borrower: string;
+        amount: 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 make_payment 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.
+     */
+    make_payment: ({ caller, borrower, amount, }: {
+        caller: string;
+        borrower: string;
+        amount: 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, boolean]>>;
+    /**
+     * Construct and simulate a make_principal_payment 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.
+     */
+    make_principal_payment: ({ borrower, amount }: {
+        borrower: string;
+        amount: 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, boolean]>>;
+}
+export declare class Client extends ContractClient {
+    readonly options: ContractClientOptions;
+    constructor(options: ContractClientOptions);
+    readonly fromJSON: {
+        initialize: (json: string) => AssembledTransaction<null>;
+        get_due_info: (json: string) => AssembledTransaction<readonly [CreditRecord, DueDetail]>;
+        get_next_bill_refresh_date: (json: string) => AssembledTransaction<bigint>;
+        drawdown: (json: string) => AssembledTransaction<null>;
+        make_payment: (json: string) => AssembledTransaction<readonly [bigint, boolean]>;
+        make_principal_payment: (json: string) => AssembledTransaction<readonly [bigint, boolean]>;
+    };
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "version": "0.0.8-beta.2+79432b6",
+  "name": "@huma-finance/soroban-pool-credit",
+  "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
+  }
+}