@huma-finance/soroban-sdk 0.0.11-beta.17 → 0.0.11-beta.19

package/README.md

@@ -14,3 +14,4 @@ For extensive documentation on the different functions offered please refer to t
 
 - Helpers
   - `CreditContractHelper` helper function for interacting with Huma's pool contracts, including drawdown and payback
+  - `Sep41ContractHelper` helper function for interacting with Sep41 token contract (ERC20 equivalent)

package/dist/cjs/helpers/CreditContractHelper.d.ts

@@ -0,0 +1,88 @@
+import { Client as PoolCreditClient, CreditRecord, SentTransaction } from '@huma-finance/soroban-pool-credit';
+import { StellarWallet } from '../services/StellarWallet';
+import { POOL_NAME, StellarNetwork } from '../utils/network';
+/**
+ * Returns an soroban contract client instance for the credit line contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @returns {PoolCreditClient | undefined} A contract client instance for the CreditLine contract or undefined if it could not be found.
+ */
+export declare function getCreditLineClient(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet): PoolCreditClient | undefined;
+/**
+ * Returns the current pool balance available for borrowing
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ */
+export declare function getAvailableBalanceForPool(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet): Promise<bigint>;
+/**
+ * Returns the credit record of the borrower
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {string} borrower - The address of the borrower to check the credit record for.
+ */
+export declare function getCreditRecordForPool(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet, borrower: string): Promise<CreditRecord>;
+/**
+ * Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
+ * currently available for borrowing as the credit limit might exceed the available pool balance. Use
+ * getPoolBalance() to get the current available pool balance.
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {string} borrower - The address of the borrower to check the available credit for.
+ */
+export declare function getAvailableCreditForPool(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet, borrower: string): Promise<bigint>;
+/**
+ * Returns borrower's total due amount in bigint format
+ * associated with the given pool name on the current chain.
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {string} borrower - The address of the borrower to check the available credit for.
+ * @returns {bigint | null} The account's total due amount in bigint format
+ */
+export declare function getTotalDue(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet, borrower: string): Promise<bigint | null>;
+/**
+ * Approve allowance for sentinel if not enough allowance is approved.
+ *
+ * @async
+ * @function
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @returns {Promise<SentTransaction>} - A Promise of the SentTransaction.
+ */
+export declare function approveAllowanceForSentinel(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet): Promise<SentTransaction<null> | null>;
+/**
+ * Draws down from a pool.
+ *
+ * @async
+ * @function
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {BigNumberish} drawdownAmount - The amount to drawdown.
+ * @returns {Promise<SentTransaction>} - A Promise of the SentTransaction.
+ */
+export declare function drawdown(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet, drawdownAmount: bigint): Promise<SentTransaction<null>>;
+/**
+ * Makes a payment.
+ *
+ * @async
+ * @function
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {bigint} paymentAmount - The amount to payback.
+ * @param {boolean} principalOnly - Whether this payment should ONLY apply to the principal
+ * @returns {Promise<AssembledTransaction>} - A Promise of the AssembledTransaction.
+ */
+export declare function makePayment(poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet, paymentAmount: bigint, principalOnly: boolean): Promise<SentTransaction<readonly [bigint, boolean]>>;

package/dist/cjs/helpers/CreditContractHelper.js

@@ -0,0 +1,219 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makePayment = exports.drawdown = exports.approveAllowanceForSentinel = exports.getTotalDue = exports.getAvailableCreditForPool = exports.getCreditRecordForPool = exports.getAvailableBalanceForPool = exports.getCreditLineClient = void 0;
+const client_1 = require("../utils/client");
+const Sep41ContractHelper_1 = require("./Sep41ContractHelper");
+/**
+ * Returns an soroban contract client instance for the credit line contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @returns {PoolCreditClient | undefined} A contract client instance for the CreditLine contract or undefined if it could not be found.
+ */
+function getCreditLineClient(poolName, network, wallet) {
+    return (0, client_1.getPoolCreditClient)(poolName, network, wallet);
+}
+exports.getCreditLineClient = getCreditLineClient;
+/**
+ * Returns the current pool balance available for borrowing
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ */
+async function getAvailableBalanceForPool(poolName, network, wallet) {
+    const poolStorageClient = (0, client_1.getPoolStorageClient)(poolName, network, wallet);
+    if (!poolStorageClient) {
+        throw new Error('Could not find credit contract for pool');
+    }
+    const { result } = await poolStorageClient.get_available_balance();
+    return result;
+}
+exports.getAvailableBalanceForPool = getAvailableBalanceForPool;
+/**
+ * Returns the credit record of the borrower
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {string} borrower - The address of the borrower to check the credit record for.
+ */
+async function getCreditRecordForPool(poolName, network, wallet, borrower) {
+    const creditStorageClient = (0, client_1.getCreditStorageClient)(poolName, network, wallet);
+    if (!creditStorageClient) {
+        throw new Error('Could not find credit storage contract for pool');
+    }
+    const { result: creditHash } = await creditStorageClient.get_credit_hash({
+        borrower,
+    });
+    if (!creditHash) {
+        throw new Error('Could not find credit hash');
+    }
+    const { result: creditRecord } = await creditStorageClient.get_credit_record({
+        credit_hash: creditHash,
+    });
+    if (!creditRecord) {
+        throw new Error('Could not find credit record');
+    }
+    return creditRecord;
+}
+exports.getCreditRecordForPool = getCreditRecordForPool;
+/**
+ * Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
+ * currently available for borrowing as the credit limit might exceed the available pool balance. Use
+ * getPoolBalance() to get the current available pool balance.
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {string} borrower - The address of the borrower to check the available credit for.
+ */
+async function getAvailableCreditForPool(poolName, network, wallet, borrower) {
+    const creditStorageClient = (0, client_1.getCreditStorageClient)(poolName, network, wallet);
+    if (!creditStorageClient) {
+        throw new Error('Could not find credit storage contract for pool');
+    }
+    const { result: creditHash } = await creditStorageClient.get_credit_hash({
+        borrower,
+    });
+    if (!creditHash) {
+        throw new Error('Could not find credit hash');
+    }
+    const [{ result: creditConfig }, { result: creditRecord }] = await Promise.all([
+        creditStorageClient.get_credit_config({
+            credit_hash: creditHash,
+        }),
+        creditStorageClient.get_credit_record({
+            credit_hash: creditHash,
+        }),
+    ]);
+    if (!creditConfig || !creditRecord) {
+        throw new Error('Could not find credit config or credit record');
+    }
+    return creditConfig.credit_limit - creditRecord.unbilled_principal;
+}
+exports.getAvailableCreditForPool = getAvailableCreditForPool;
+/**
+ * Returns borrower's total due amount in bigint format
+ * associated with the given pool name on the current chain.
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {string} borrower - The address of the borrower to check the available credit for.
+ * @returns {bigint | null} The account's total due amount in bigint format
+ */
+async function getTotalDue(poolName, network, wallet, borrower) {
+    const creditRecord = await getCreditRecordForPool(poolName, network, wallet, borrower);
+    if (!creditRecord) {
+        return null;
+    }
+    return creditRecord.next_due + creditRecord.total_past_due;
+}
+exports.getTotalDue = getTotalDue;
+/**
+ * Approve allowance for sentinel if not enough allowance is approved.
+ *
+ * @async
+ * @function
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @returns {Promise<SentTransaction>} - A Promise of the SentTransaction.
+ */
+async function approveAllowanceForSentinel(poolName, network, wallet) {
+    const totalDue = await getTotalDue(poolName, network, wallet, wallet.userInfo.publicKey);
+    if (totalDue === null) {
+        throw new Error('Could not find total due');
+    }
+    const poolStorageClient = (0, client_1.getPoolStorageClient)(poolName, network, wallet);
+    if (!poolStorageClient) {
+        throw new Error('Could not find pool storage contract for pool');
+    }
+    const [{ result: underlyingToken }, { result: sentinel }] = await Promise.all([
+        poolStorageClient.get_underlying_token(),
+        poolStorageClient.get_sentinel(),
+    ]);
+    const tx = await (0, Sep41ContractHelper_1.approveSep41AllowanceIfInsufficient)(network, wallet, underlyingToken, sentinel, totalDue);
+    return tx;
+}
+exports.approveAllowanceForSentinel = approveAllowanceForSentinel;
+/**
+ * Draws down from a pool.
+ *
+ * @async
+ * @function
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {BigNumberish} drawdownAmount - The amount to drawdown.
+ * @returns {Promise<SentTransaction>} - A Promise of the SentTransaction.
+ */
+async function drawdown(poolName, network, wallet, drawdownAmount) {
+    const poolCreditClient = (0, client_1.getPoolCreditClient)(poolName, network, wallet);
+    if (!poolCreditClient) {
+        throw new Error('Could not find credit contract for pool');
+    }
+    await approveAllowanceForSentinel(poolName, network, wallet);
+    const tx = await poolCreditClient.drawdown({
+        borrower: wallet.userInfo.publicKey,
+        amount: drawdownAmount,
+    }, {
+        timeoutInSeconds: 30,
+    });
+    const result = await tx.signAndSend();
+    return result;
+}
+exports.drawdown = drawdown;
+/**
+ * Makes a payment.
+ *
+ * @async
+ * @function
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The stellar wallet.
+ * @param {bigint} paymentAmount - The amount to payback.
+ * @param {boolean} principalOnly - Whether this payment should ONLY apply to the principal
+ * @returns {Promise<AssembledTransaction>} - A Promise of the AssembledTransaction.
+ */
+async function makePayment(poolName, network, wallet, paymentAmount, principalOnly) {
+    const poolCreditClient = (0, client_1.getPoolCreditClient)(poolName, network, wallet);
+    if (!poolCreditClient) {
+        throw new Error('Could not find credit contract for pool');
+    }
+    const poolStorageClient = (0, client_1.getPoolStorageClient)(poolName, network, wallet);
+    if (!poolStorageClient) {
+        throw new Error('Could not find pool storage contract for pool');
+    }
+    await approveAllowanceForSentinel(poolName, network, wallet);
+    const [{ result: underlyingToken }, { result: sentinel }] = await Promise.all([
+        poolStorageClient.get_underlying_token(),
+        poolStorageClient.get_sentinel(),
+    ]);
+    let tx;
+    tx = await (0, Sep41ContractHelper_1.approveSep41AllowanceIfInsufficient)(network, wallet, underlyingToken, sentinel, paymentAmount);
+    if (principalOnly) {
+        tx = await poolCreditClient.make_principal_payment({
+            borrower: wallet.userInfo.publicKey,
+            amount: paymentAmount,
+        }, {
+            timeoutInSeconds: 30,
+        });
+    }
+    else {
+        tx = await poolCreditClient.make_payment({
+            caller: wallet.userInfo.publicKey,
+            borrower: wallet.userInfo.publicKey,
+            amount: paymentAmount,
+        }, {
+            timeoutInSeconds: 30,
+        });
+    }
+    const result = await tx.signAndSend();
+    return result;
+}
+exports.makePayment = makePayment;
+//# sourceMappingURL=CreditContractHelper.js.map

package/dist/cjs/helpers/CreditContractHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/CreditContractHelper.ts"],"names":[],"mappings":";;;AAOA,4CAIwB;AAExB,+DAA2E;AAE3E;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CACjC,QAAmB,EACnB,OAAuB,EACvB,MAAqB;IAErB,OAAO,IAAA,4BAAmB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;AACvD,CAAC;AAND,kDAMC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,OAAuB,EACvB,MAAqB;IAErB,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACzE,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;KAC3D;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,iBAAiB,CAAC,qBAAqB,EAAE,CAAA;IAClE,OAAO,MAAM,CAAA;AACf,CAAC;AAZD,gEAYC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,sBAAsB,CAC1C,QAAmB,EACnB,OAAuB,EACvB,MAAqB,EACrB,QAAgB;IAEhB,MAAM,mBAAmB,GAAG,IAAA,+BAAsB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC7E,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,mBAAmB,CAAC,eAAe,CAAC;QACvE,QAAQ;KACT,CAAC,CAAA;IACF,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;KAC9C;IAED,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,mBAAmB,CAAC,iBAAiB,CAAC;QAC3E,WAAW,EAAE,UAAU;KACxB,CAAC,CAAA;IACF,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AA1BD,wDA0BC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,yBAAyB,CAC7C,QAAmB,EACnB,OAAuB,EACvB,MAAqB,EACrB,QAAgB;IAEhB,MAAM,mBAAmB,GAAG,IAAA,+BAAsB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC7E,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,mBAAmB,CAAC,eAAe,CAAC;QACvE,QAAQ;KACT,CAAC,CAAA;IACF,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;KAC9C;IAED,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GACxD,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,mBAAmB,CAAC,iBAAiB,CAAC;YACpC,WAAW,EAAE,UAAU;SACxB,CAAC;QACF,mBAAmB,CAAC,iBAAiB,CAAC;YACpC,WAAW,EAAE,UAAU;SACxB,CAAC;KACH,CAAC,CAAA;IAEJ,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,kBAAkB,CAAA;AACpE,CAAC;AAjCD,8DAiCC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAC/B,QAAmB,EACnB,OAAuB,EACvB,MAAqB,EACrB,QAAgB;IAEhB,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAC/C,QAAQ,EACR,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAA;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,YAAY,CAAC,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAA;AAC5D,CAAC;AAlBD,kCAkBC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,2BAA2B,CAC/C,QAAmB,EACnB,OAAuB,EACvB,MAAqB;IAErB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAChC,QAAQ,EACR,OAAO,EACP,MAAM,EACN,MAAM,CAAC,QAAQ,CAAC,SAAS,CAC1B,CAAA;IACD,IAAI,QAAQ,KAAK,IAAI,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;KAC5C;IACD,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACzE,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,MAAM,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAC3E;QACE,iBAAiB,CAAC,oBAAoB,EAAE;QACxC,iBAAiB,CAAC,YAAY,EAAE;KACjC,CACF,CAAA;IAED,MAAM,EAAE,GAAG,MAAM,IAAA,yDAAmC,EAClD,OAAO,EACP,MAAM,EACN,eAAe,EACf,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,OAAO,EAAE,CAAA;AACX,CAAC;AAnCD,kEAmCC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,QAAQ,CAC5B,QAAmB,EACnB,OAAuB,EACvB,MAAqB,EACrB,cAAsB;IAEtB,MAAM,gBAAgB,GAAG,IAAA,4BAAmB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACvE,IAAI,CAAC,gBAAgB,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;KAC3D;IAED,MAAM,2BAA2B,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC5D,MAAM,EAAE,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CACxC;QACE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACnC,MAAM,EAAE,cAAc;KACvB,EACD;QACE,gBAAgB,EAAE,EAAE;KACrB,CACF,CAAA;IACD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,WAAW,EAAE,CAAA;IACrC,OAAO,MAAM,CAAA;AACf,CAAC;AAvBD,4BAuBC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,WAAW,CAC/B,QAAmB,EACnB,OAAuB,EACvB,MAAqB,EACrB,aAAqB,EACrB,aAAsB;IAEtB,MAAM,gBAAgB,GAAG,IAAA,4BAAmB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACvE,IAAI,CAAC,gBAAgB,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;KAC3D;IACD,MAAM,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACzE,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,MAAM,2BAA2B,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC5D,MAAM,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAC3E;QACE,iBAAiB,CAAC,oBAAoB,EAAE;QACxC,iBAAiB,CAAC,YAAY,EAAE;KACjC,CACF,CAAA;IAED,IAAI,EAAE,CAAA;IACN,EAAE,GAAG,MAAM,IAAA,yDAAmC,EAC5C,OAAO,EACP,MAAM,EACN,eAAe,EACf,QAAQ,EACR,aAAa,CACd,CAAA;IAED,IAAI,aAAa,EAAE;QACjB,EAAE,GAAG,MAAM,gBAAgB,CAAC,sBAAsB,CAChD;YACE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;YACnC,MAAM,EAAE,aAAa;SACtB,EACD;YACE,gBAAgB,EAAE,EAAE;SACrB,CACF,CAAA;KACF;SAAM;QACL,EAAE,GAAG,MAAM,gBAAgB,CAAC,YAAY,CACtC;YACE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;YACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;YACnC,MAAM,EAAE,aAAa;SACtB,EACD;YACE,gBAAgB,EAAE,EAAE;SACrB,CACF,CAAA;KACF;IAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,WAAW,EAAE,CAAA;IACrC,OAAO,MAAM,CAAA;AACf,CAAC;AA1DD,kCA0DC"}

package/dist/cjs/helpers/Sep41ContractHelper.d.ts

@@ -0,0 +1,17 @@
+import { SentTransaction } from '@huma-finance/soroban-pool-credit';
+import { StellarWallet } from '../services';
+import { StellarNetwork } from '../utils';
+/**
+ * Approves an Sep41 allowance for a spender address, if the current allowance is insufficient.
+ * Allowance is required to do certain actions on the Huma protocol (e.g. makePayment for Autopay)
+ *
+ * @async
+ * @function
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The wallet used to send the transaction.
+ * @param {string} tokenAddress - The address of the Sep41 token to approve.
+ * @param {string} spenderAddress - The address of the spender to approve an allowance for.
+ * @param {bigint} allowanceAmount - The amount of tokens to approve, if applicable. Denominated in the Sep41 tokens.
+ * @returns {Promise<SentTransaction<null> | null>} - A Promise of the transaction response, or null if the allowance was already sufficient.
+ */
+export declare function approveSep41AllowanceIfInsufficient(network: StellarNetwork, wallet: StellarWallet, tokenAddress: string, spenderAddress: string, allowanceAmount: bigint): Promise<SentTransaction<null> | null>;

package/dist/cjs/helpers/Sep41ContractHelper.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.approveSep41AllowanceIfInsufficient = void 0;
+const utils_1 = require("../utils");
+/**
+ * Approves an Sep41 allowance for a spender address, if the current allowance is insufficient.
+ * Allowance is required to do certain actions on the Huma protocol (e.g. makePayment for Autopay)
+ *
+ * @async
+ * @function
+ * @param {StellarNetwork} network - The stellar network.
+ * @param {StellarWallet} wallet - The wallet used to send the transaction.
+ * @param {string} tokenAddress - The address of the Sep41 token to approve.
+ * @param {string} spenderAddress - The address of the spender to approve an allowance for.
+ * @param {bigint} allowanceAmount - The amount of tokens to approve, if applicable. Denominated in the Sep41 tokens.
+ * @returns {Promise<SentTransaction<null> | null>} - A Promise of the transaction response, or null if the allowance was already sufficient.
+ */
+async function approveSep41AllowanceIfInsufficient(network, wallet, tokenAddress, spenderAddress, allowanceAmount) {
+    const tokenClient = (0, utils_1.getUnderlyingTokenClient)(tokenAddress, network, wallet);
+    const [{ result: allowance }, { result: decimals }] = await Promise.all([
+        tokenClient.allowance({
+            from: wallet.userInfo.publicKey,
+            spender: spenderAddress,
+        }),
+        tokenClient.decimals(),
+    ]);
+    if (allowance < allowanceAmount) {
+        const latestLedger = await (0, utils_1.getLatestLedger)(network);
+        // @TODO find a better to advance the ledger number
+        const advanceLedgerNum = 3000000;
+        const tx = await tokenClient.approve({
+            from: wallet.userInfo.publicKey,
+            spender: spenderAddress,
+            amount: BigInt(1000000000 * Math.pow(10, Number(decimals))),
+            expiration_ledger: latestLedger.sequence + advanceLedgerNum,
+        }, {
+            timeoutInSeconds: 30,
+        });
+        const result = await tx.signAndSend();
+        return result;
+    }
+    return null;
+}
+exports.approveSep41AllowanceIfInsufficient = approveSep41AllowanceIfInsufficient;
+//# sourceMappingURL=Sep41ContractHelper.js.map

package/dist/cjs/helpers/Sep41ContractHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sep41ContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/Sep41ContractHelper.ts"],"names":[],"mappings":";;;AAGA,oCAIiB;AAEjB;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,mCAAmC,CACvD,OAAuB,EACvB,MAAqB,EACrB,YAAoB,EACpB,cAAsB,EACtB,eAAuB;IAEvB,MAAM,WAAW,GAAG,IAAA,gCAAwB,EAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAE3E,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACtE,WAAW,CAAC,SAAS,CAAC;YACpB,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;YAC/B,OAAO,EAAE,cAAc;SACxB,CAAC;QACF,WAAW,CAAC,QAAQ,EAAE;KACvB,CAAC,CAAA;IAEF,IAAI,SAAS,GAAG,eAAe,EAAE;QAC/B,MAAM,YAAY,GAAG,MAAM,IAAA,uBAAe,EAAC,OAAO,CAAC,CAAA;QACnD,mDAAmD;QACnD,MAAM,gBAAgB,GAAG,OAAS,CAAA;QAClC,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,OAAO,CAClC;YACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;YAC/B,OAAO,EAAE,cAAc;YACvB,MAAM,EAAE,MAAM,CAAC,UAAY,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC7D,iBAAiB,EAAE,YAAY,CAAC,QAAQ,GAAG,gBAAgB;SAC5D,EACD;YACE,gBAAgB,EAAE,EAAE;SACrB,CACF,CAAA;QACD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,WAAW,EAAE,CAAA;QACrC,OAAO,MAAM,CAAA;KACd;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AArCD,kFAqCC"}

package/dist/cjs/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './CreditContractHelper';
+export * from './Sep41ContractHelper';

package/dist/cjs/helpers/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./CreditContractHelper"), exports);
+tslib_1.__exportStar(require("./Sep41ContractHelper"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,iEAAsC;AACtC,gEAAqC"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './helpers';
+export * from './services';
+export * from './utils';

package/dist/cjs/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./helpers"), exports);
+tslib_1.__exportStar(require("./services"), exports);
+tslib_1.__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,qDAA0B;AAC1B,kDAAuB"}

package/dist/cjs/services/HumaContextStellar.d.ts

@@ -0,0 +1,19 @@
+import { StellarNetwork, POOL_NAME, POOL_TYPE } from '../utils/network';
+import { StellarWallet } from './StellarWallet';
+export declare class HumaContextStellar {
+    #private;
+    constructor({ wallet, network, poolName, poolType, }: {
+        wallet: StellarWallet;
+        network: StellarNetwork;
+        poolName: POOL_NAME;
+        poolType: POOL_TYPE;
+    });
+    get wallet(): StellarWallet;
+    set wallet(value: StellarWallet);
+    get network(): StellarNetwork;
+    set network(value: StellarNetwork);
+    get poolName(): POOL_NAME;
+    set poolName(value: POOL_NAME);
+    get poolType(): POOL_TYPE;
+    set poolType(value: POOL_TYPE);
+}

package/dist/cjs/services/HumaContextStellar.js

@@ -0,0 +1,47 @@
+"use strict";
+var _HumaContextStellar_wallet, _HumaContextStellar_network, _HumaContextStellar_poolName, _HumaContextStellar_poolType;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HumaContextStellar = void 0;
+const tslib_1 = require("tslib");
+class HumaContextStellar {
+    constructor({ wallet, network, poolName, poolType, }) {
+        _HumaContextStellar_wallet.set(this, void 0);
+        _HumaContextStellar_network.set(this, void 0);
+        _HumaContextStellar_poolName.set(this, void 0);
+        _HumaContextStellar_poolType.set(this, void 0);
+        if (!wallet || !network || !poolName || !poolType) {
+            throw new Error('All parameters are required');
+        }
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_wallet, wallet, "f");
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_network, network, "f");
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_poolName, poolName, "f");
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_poolType, poolType, "f");
+    }
+    get wallet() {
+        return tslib_1.__classPrivateFieldGet(this, _HumaContextStellar_wallet, "f");
+    }
+    set wallet(value) {
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_wallet, value, "f");
+    }
+    get network() {
+        return tslib_1.__classPrivateFieldGet(this, _HumaContextStellar_network, "f");
+    }
+    set network(value) {
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_network, value, "f");
+    }
+    get poolName() {
+        return tslib_1.__classPrivateFieldGet(this, _HumaContextStellar_poolName, "f");
+    }
+    set poolName(value) {
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_poolName, value, "f");
+    }
+    get poolType() {
+        return tslib_1.__classPrivateFieldGet(this, _HumaContextStellar_poolType, "f");
+    }
+    set poolType(value) {
+        tslib_1.__classPrivateFieldSet(this, _HumaContextStellar_poolType, value, "f");
+    }
+}
+exports.HumaContextStellar = HumaContextStellar;
+_HumaContextStellar_wallet = new WeakMap(), _HumaContextStellar_network = new WeakMap(), _HumaContextStellar_poolName = new WeakMap(), _HumaContextStellar_poolType = new WeakMap();
+//# sourceMappingURL=HumaContextStellar.js.map

package/dist/cjs/services/HumaContextStellar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HumaContextStellar.js","sourceRoot":"","sources":["../../../src/services/HumaContextStellar.ts"],"names":[],"mappings":";;;;;AAGA,MAAa,kBAAkB;IAS7B,YAAY,EACV,MAAM,EACN,OAAO,EACP,QAAQ,EACR,QAAQ,GAMT;QAlBD,6CAAsB;QAEtB,8CAAwB;QAExB,+CAAoB;QAEpB,+CAAoB;QAalB,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,+BAAA,IAAI,8BAAW,MAAM,MAAA,CAAA;QACrB,+BAAA,IAAI,+BAAY,OAAO,MAAA,CAAA;QACvB,+BAAA,IAAI,gCAAa,QAAQ,MAAA,CAAA;QACzB,+BAAA,IAAI,gCAAa,QAAQ,MAAA,CAAA;IAC3B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,+BAAA,IAAI,kCAAQ,CAAA;IACrB,CAAC;IAED,IAAI,MAAM,CAAC,KAAoB;QAC7B,+BAAA,IAAI,8BAAW,KAAK,MAAA,CAAA;IACtB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,+BAAA,IAAI,mCAAS,CAAA;IACtB,CAAC;IAED,IAAI,OAAO,CAAC,KAAqB;QAC/B,+BAAA,IAAI,+BAAY,KAAK,MAAA,CAAA;IACvB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,+BAAA,IAAI,oCAAU,CAAA;IACvB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAgB;QAC3B,+BAAA,IAAI,gCAAa,KAAK,MAAA,CAAA;IACxB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,+BAAA,IAAI,oCAAU,CAAA;IACvB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAgB;QAC3B,+BAAA,IAAI,gCAAa,KAAK,MAAA,CAAA;IACxB,CAAC;CACF;AA7DD,gDA6DC"}

package/dist/cjs/services/StellarWallet.d.ts

@@ -0,0 +1,8 @@
+export declare class StellarWallet {
+    private sourceKeypair;
+    constructor(secretKey: string);
+    get userInfo(): {
+        publicKey: string;
+    };
+    signTransaction(tx: string, opts: any): Promise<string>;
+}

package/dist/cjs/services/StellarWallet.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StellarWallet = void 0;
+const stellar_sdk_1 = require("@stellar/stellar-sdk");
+class StellarWallet {
+    constructor(secretKey) {
+        this.sourceKeypair = stellar_sdk_1.Keypair.fromSecret(secretKey);
+    }
+    get userInfo() {
+        return {
+            publicKey: this.sourceKeypair.publicKey(),
+        };
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async signTransaction(tx, opts) {
+        const txFromXDR = new stellar_sdk_1.Transaction(tx, opts.networkPassphrase);
+        txFromXDR.sign(this.sourceKeypair);
+        return txFromXDR.toXDR();
+    }
+}
+exports.StellarWallet = StellarWallet;
+//# sourceMappingURL=StellarWallet.js.map

package/dist/cjs/services/StellarWallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StellarWallet.js","sourceRoot":"","sources":["../../../src/services/StellarWallet.ts"],"names":[],"mappings":";;;AAAA,sDAA2D;AAE3D,MAAa,aAAa;IAGxB,YAAY,SAAiB;QAC3B,IAAI,CAAC,aAAa,GAAG,qBAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;IACpD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE;SAC1C,CAAA;IACH,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,IAAS;QAChD,MAAM,SAAS,GAAG,IAAI,yBAAW,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAC7D,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAClC,OAAO,SAAS,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC;CACF;AAnBD,sCAmBC"}

package/dist/cjs/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './HumaContextStellar';
+export * from './StellarWallet';

package/dist/cjs/services/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./HumaContextStellar"), exports);
+tslib_1.__exportStar(require("./StellarWallet"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/index.ts"],"names":[],"mappings":";;;AAAA,+DAAoC;AACpC,0DAA+B"}

package/dist/cjs/utils/client.d.ts

@@ -0,0 +1,16 @@
+import { Client as CreditStorageClient } from '@huma-finance/soroban-credit-storage';
+import { Client as CreditManagerClient } from '@huma-finance/soroban-credit-manager';
+import { Client as PoolClient } from '@huma-finance/soroban-pool';
+import { Client as PoolCreditClient } from '@huma-finance/soroban-pool-credit';
+import { Client as PoolStorageClient } from '@huma-finance/soroban-pool-storage';
+import { Client as TrancheVaultClient } from '@huma-finance/soroban-tranche-vault';
+import { Client as Sep41Client } from '@huma-finance/soroban-sep41';
+import { StellarWallet } from '../services/StellarWallet';
+import { POOL_NAME, StellarNetwork } from './network';
+export declare const getPoolClient: (poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet) => PoolClient | undefined;
+export declare const getPoolStorageClient: (poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet) => PoolStorageClient | undefined;
+export declare const getPoolCreditClient: (poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet) => PoolCreditClient | undefined;
+export declare const getCreditStorageClient: (poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet) => CreditStorageClient | undefined;
+export declare const getCreditManagerClient: (poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet) => CreditManagerClient | undefined;
+export declare const getTrancheVaultClient: (poolName: POOL_NAME, network: StellarNetwork, wallet: StellarWallet, tranche: 'senior' | 'junior') => TrancheVaultClient | undefined;
+export declare const getUnderlyingTokenClient: (tokenAddress: string, network: StellarNetwork, wallet: StellarWallet) => Sep41Client;