@huma-finance/sdk 0.0.28 → 0.0.30

package/dist/cjs/helpers/PoolContractHelper.js

@@ -1,105 +1,143 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makePaymentToPool = exports.drawdownFromPool = exports.getTotalDue = exports.getCreditRecord = exports.getPoolContract = void 0;
-const utils_1 = require("../utils");
-/**
- * Returns an ethers contract instance for a Huma pool contract
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName The name of the pool contract to get.
- * @param {POOL_TYPE} poolType The type of the pool contract to get.
- * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
- */
-function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
-    const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
-    if (!poolInfo)
-        return null;
-    return (0, utils_1.getContract)(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
-}
-exports.getPoolContract = getPoolContract;
-/**
- * Gets the credit record of a wallet in a Huma pool. Denominated in the ERC20 tokens of the pool.
- *
- * @namespace getCreditRecord
- * @async
- * @function
- * @param {string} address - The address to lookup.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
- * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
- * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
- * @returns {Promise<CreditRecord>} - A Promise of the transaction response.
- */
-async function getCreditRecord(address, signerOrProvider, chainId, poolName, poolType) {
-    const poolContract = getPoolContract(signerOrProvider, chainId, poolName, poolType);
-    if (!poolContract) {
-        throw new Error('Could not find pool contract');
-    }
-    return poolContract.creditRecordMapping(address);
-}
-exports.getCreditRecord = getCreditRecord;
-/**
- * Gets the total due for a Huma pool of the given wallet. Denominated in the ERC20 tokens of the pool.
- *
- * @async
- * @function
- * @param {string} address - The address to lookup.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
- * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
- * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
- * @returns {Promise<BigNumber>} - A Promise of the transaction response.
- */
-async function getTotalDue(address, signerOrProvider, chainId, poolName, poolType) {
-    const creditRecord = await getCreditRecord(address, signerOrProvider, chainId, poolName, poolType);
-    return creditRecord.totalDue;
-}
-exports.getTotalDue = getTotalDue;
-/**
- * Calls drawdown on a Huma pool contract
- *
- * @async
- * @function
- * @param {ethers.Signer} signer - The signer used to send the transaction.
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {BigNumberish} drawdownAmount - The amount of tokens to withdraw, denominated in the ERC20 tokens of the pool.
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
- */
-async function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount, gasOpts = {}) {
-    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
-    if (!poolContract) {
-        throw new Error('Could not find pool contract');
-    }
-    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
-    // TODO: Generate typechain for pool contract
-    return poolContract.drawdown(drawdownAmount, gasOpts);
-}
-exports.drawdownFromPool = drawdownFromPool;
-/**
- * Calls drawdown on a Huma pool contract
- *
- * @async
- * @function
- * @param {ethers.Signer} signer - The signer used to send the transaction.
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {BigNumberish} paymentAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
- */
-async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount, gasOpts = {}) {
-    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
-    if (!poolContract) {
-        throw new Error('Could not find pool contract');
-    }
-    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
-    // TODO: Generate typechain for pool contract
-    return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
-}
-exports.makePaymentToPool = makePaymentToPool;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.approvePoolAllowance = exports.makePaymentToPool = exports.drawdownFromPool = exports.getTotalDue = exports.getCreditRecord = exports.getPoolContract = void 0;
+const utils_1 = require("../utils");
+/**
+ * Returns an ethers contract instance for a Huma pool contract
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName The name of the pool contract to get.
+ * @param {POOL_TYPE} poolType The type of the pool contract to get.
+ * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
+ */
+function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
+    const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
+    if (!poolInfo)
+        return null;
+    return (0, utils_1.getContract)(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
+}
+exports.getPoolContract = getPoolContract;
+/**
+ * Gets the credit record of a wallet in a Huma pool. Denominated in the ERC20 tokens of the pool.
+ *
+ * @namespace getCreditRecord
+ * @async
+ * @function
+ * @param {string} address - The address to lookup.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
+ * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
+ * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
+ * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
+ * @returns {Promise<CreditRecord>} - A Promise of the transaction response.
+ */
+async function getCreditRecord(address, signerOrProvider, chainId, poolName, poolType) {
+    const poolContract = getPoolContract(signerOrProvider, chainId, poolName, poolType);
+    if (!poolContract) {
+        throw new Error('Could not find pool contract');
+    }
+    return poolContract.creditRecordMapping(address);
+}
+exports.getCreditRecord = getCreditRecord;
+/**
+ * Gets the total due for a Huma pool of the given wallet. Denominated in the ERC20 tokens of the pool.
+ *
+ * @async
+ * @function
+ * @param {string} address - The address to lookup.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
+ * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
+ * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
+ * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
+ * @returns {Promise<BigNumber>} - A Promise of the transaction response.
+ */
+async function getTotalDue(address, signerOrProvider, chainId, poolName, poolType) {
+    const creditRecord = await getCreditRecord(address, signerOrProvider, chainId, poolName, poolType);
+    return creditRecord.totalDue;
+}
+exports.getTotalDue = getTotalDue;
+/**
+ * Calls drawdown on a Huma pool contract
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
+ * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {BigNumberish} drawdownAmount - The amount of tokens to withdraw, denominated in the ERC20 tokens of the pool.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+async function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount, gasOpts = {}) {
+    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
+    if (!poolContract) {
+        throw new Error('Could not find pool contract');
+    }
+    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+    // TODO: Generate typechain for pool contract
+    return poolContract.drawdown(drawdownAmount, gasOpts);
+}
+exports.drawdownFromPool = drawdownFromPool;
+/**
+ * Calls makePayment on a Huma pool contract. If the pool does not have sufficient allowance to complete the operation,
+ * attempt to first increase the allowance of the pool.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
+ * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {BigNumberish} paymentAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount, gasOpts = {}) {
+    const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
+    if (!(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address)) {
+        throw new Error('Could not find pool underlying token address');
+    }
+    const poolTokenContract = (0, utils_1.getERC20Contract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address, signer);
+    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
+    if (!poolContract) {
+        throw new Error('Could not find pool contract');
+    }
+    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+    const allowance = await poolTokenContract.allowance(await signer.getAddress(), poolContract.address);
+    if (allowance.lt(paymentAmount)) {
+        const approvalTx = await poolTokenContract.approve(poolContract.address, paymentAmount, gasOpts);
+        await approvalTx.wait();
+    }
+    // TODO: Generate typechain for pool contract
+    return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
+}
+exports.makePaymentToPool = makePaymentToPool;
+/**
+ * Approves an allowance for a Huma pool contract, which is required to do certain actions (e.g. makePayment)
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
+ * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {BigNumberish} allowanceAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+async function approvePoolAllowance(signer, chainId, poolName, poolType, allowanceAmount, gasOpts = {}) {
+    const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
+    if (!(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address)) {
+        throw new Error('Could not find pool underlying token address');
+    }
+    const poolTokenContract = (0, utils_1.getERC20Contract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address, signer);
+    const poolContract = getPoolContract(signer, chainId, poolName, poolType);
+    if (!poolContract) {
+        throw new Error('Could not find pool contract');
+    }
+    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+    return poolTokenContract.approve(poolContract.address, allowanceAmount, gasOpts);
+}
+exports.approvePoolAllowance = approvePoolAllowance;
 //# sourceMappingURL=PoolContractHelper.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAKA,oCAAyE;AAEzE;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAXD,0CAWC;AAsCD;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,eAAe,CAClC,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;AAClD,CAAC;AAnBD,0CAmBC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAe,EACf,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,MAAM,eAAe,CACxC,OAAO,EACP,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,OAAO,YAAY,CAAC,QAAQ,CAAA;AAC9B,CAAC;AAhBD,kCAgBC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,gBAAgB,CACpC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,cAA4B,EAC5B,UAAqB,EAAE;IAEvB,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAlBD,4CAkBC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B,EAC3B,UAAqB,EAAE;IAEvB,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AAtBD,8CAsBC"}
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAKA,oCAKiB;AAEjB;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAXD,0CAWC;AAsCD;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,eAAe,CAClC,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;AAClD,CAAC;AAnBD,0CAmBC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAe,EACf,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,MAAM,eAAe,CACxC,OAAO,EACP,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,OAAO,YAAY,CAAC,QAAQ,CAAA;AAC9B,CAAC;AAhBD,kCAgBC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,gBAAgB,CACpC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,cAA4B,EAC5B,UAAqB,EAAE;IAEvB,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAlBD,4CAkBC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B,EAC3B,UAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,CAAA,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IACD,MAAM,iBAAiB,GAAG,IAAA,wBAAgB,EACxC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,EACrC,MAAM,CACP,CAAA;IACD,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACtD,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,SAAS,CACjD,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,YAAY,CAAC,OAAO,CACrB,CAAA;IACD,IAAI,SAAS,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE;QAC/B,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAChD,YAAY,CAAC,OAAO,EACpB,aAAa,EACb,OAAO,CACR,CAAA;QACD,MAAM,UAAU,CAAC,IAAI,EAAE,CAAA;KACxB;IAED,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AA1CD,8CA0CC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,eAA6B,EAC7B,UAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,CAAA,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IACD,MAAM,iBAAiB,GAAG,IAAA,wBAAgB,EACxC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,EACrC,MAAM,CACP,CAAA;IACD,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,iBAAiB,CAAC,OAAO,CAC9B,YAAY,CAAC,OAAO,EACpB,eAAe,EACf,OAAO,CACR,CAAA;AACH,CAAC;AA7BD,oDA6BC"}

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

@@ -1,10 +1,10 @@
-import { Contract, ethers } from 'ethers';
-/**
- * Returns an ethers contract instance for the RealWorldReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
- */
-export declare function getRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;
+import { Contract, ethers } from 'ethers';
+/**
+ * Returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+export declare function getRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/cjs/helpers/RealWorldReceivableContractHelper.js

@@ -1,22 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRealWorldReceivableContract = void 0;
-const shared_1 = require("@huma-finance/shared");
-const utils_1 = require("../utils");
-/**
- * Returns an ethers contract instance for the RealWorldReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
- */
-function getRealWorldReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
-    if (!realWorldReceivable)
-        return null;
-    return (0, utils_1.getContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
-}
-exports.getRealWorldReceivableContract = getRealWorldReceivableContract;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRealWorldReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const utils_1 = require("../utils");
+/**
+ * Returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+function getRealWorldReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
+    if (!realWorldReceivable)
+        return null;
+    return (0, utils_1.getContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.getRealWorldReceivableContract = getRealWorldReceivableContract;
 //# sourceMappingURL=RealWorldReceivableContractHelper.js.map

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

@@ -1,3 +1,3 @@
-export * from './RealWorldReceivableContractHelper';
-export * from './ERC20TransferableReceivableContractHelper';
-export * from './PoolContractHelper';
+export * from './RealWorldReceivableContractHelper';
+export * from './ERC20TransferableReceivableContractHelper';
+export * from './PoolContractHelper';

package/dist/cjs/helpers/index.js

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

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

@@ -1,4 +1,4 @@
-export * from './useContract';
-export * from './useRealWorldReceivableContract';
-export * from './useERC20TransferableReceivableContract';
-export * from './usePoolContract';
+export * from './useContract';
+export * from './useRealWorldReceivableContract';
+export * from './useERC20TransferableReceivableContract';
+export * from './usePoolContract';

package/dist/cjs/hooks/index.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./useContract"), exports);
-tslib_1.__exportStar(require("./useRealWorldReceivableContract"), exports);
-tslib_1.__exportStar(require("./useERC20TransferableReceivableContract"), exports);
-tslib_1.__exportStar(require("./usePoolContract"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./useContract"), exports);
+tslib_1.__exportStar(require("./useRealWorldReceivableContract"), exports);
+tslib_1.__exportStar(require("./useERC20TransferableReceivableContract"), exports);
+tslib_1.__exportStar(require("./usePoolContract"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.d.ts

@@ -0,0 +1,10 @@
+import { Contract, ethers } from 'ethers';
+/**
+ * A react hook that returns an ethers contract instance for the BaseCreditPoolReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
+ */
+export declare function useBaseCreditPoolReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useBaseCreditPoolReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const useContract_1 = require("./useContract");
+/**
+ * A react hook that returns an ethers contract instance for the BaseCreditPoolReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
+ */
+function useBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const baseCreditPoolReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.BaseCreditPoolReceivable];
+    return (0, useContract_1.useContract)(baseCreditPoolReceivable, shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.useBaseCreditPoolReceivableContract = useBaseCreditPoolReceivableContract;
+//# sourceMappingURL=useBaseCreditPoolReceivableContract.js.map

package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBaseCreditPoolReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useBaseCreditPoolReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAE7B,+CAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,OAAO,IAAA,yBAAW,EAChB,wBAAwB,EACxB,wCAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC;AAdD,kFAcC"}

package/dist/cjs/hooks/useContract.d.ts

@@ -1,13 +1,13 @@
-import { Contract } from '@ethersproject/contracts';
-import { ethers } from 'ethers';
-/**
- * Custom hook for creating an ethers instance of a smart contract.
- *
- * @template T - The type of the contract.
- * @param {string | null | undefined} address - The address of the smart contract instance.
- * @param {any} ABI - The ABI of the smart contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
- * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
- * @returns {T | null} An instance of the smart contract, or null if an error occurs.
- */
-export declare function useContract<T extends Contract = Contract>(address: string | null | undefined, ABI: any, signerOrProvider: ethers.providers.Provider | ethers.Signer): T | null;
+import { Contract } from '@ethersproject/contracts';
+import { ethers } from 'ethers';
+/**
+ * Custom hook for creating an ethers instance of a smart contract.
+ *
+ * @template T - The type of the contract.
+ * @param {string | null | undefined} address - The address of the smart contract instance.
+ * @param {any} ABI - The ABI of the smart contract.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
+ * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
+ * @returns {T | null} An instance of the smart contract, or null if an error occurs.
+ */
+export declare function useContract<T extends Contract = Contract>(address: string | null | undefined, ABI: any, signerOrProvider: ethers.providers.Provider | ethers.Signer): T | null;

package/dist/cjs/hooks/useContract.js

@@ -1,31 +1,31 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useContract = void 0;
-const react_1 = require("react");
-const web3_1 = require("../utils/web3");
-/**
- * Custom hook for creating an ethers instance of a smart contract.
- *
- * @template T - The type of the contract.
- * @param {string | null | undefined} address - The address of the smart contract instance.
- * @param {any} ABI - The ABI of the smart contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
- * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
- * @returns {T | null} An instance of the smart contract, or null if an error occurs.
- */
-function useContract(address, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-ABI, signerOrProvider) {
-    return (0, react_1.useMemo)(() => {
-        if (!address || !ABI || !signerOrProvider)
-            return null;
-        try {
-            return (0, web3_1.getContract)(address, ABI, signerOrProvider);
-        }
-        catch (error) {
-            return null;
-        }
-    }, [address, ABI, signerOrProvider]);
-}
-exports.useContract = useContract;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useContract = void 0;
+const react_1 = require("react");
+const web3_1 = require("../utils/web3");
+/**
+ * Custom hook for creating an ethers instance of a smart contract.
+ *
+ * @template T - The type of the contract.
+ * @param {string | null | undefined} address - The address of the smart contract instance.
+ * @param {any} ABI - The ABI of the smart contract.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
+ * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
+ * @returns {T | null} An instance of the smart contract, or null if an error occurs.
+ */
+function useContract(address, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+ABI, signerOrProvider) {
+    return (0, react_1.useMemo)(() => {
+        if (!address || !ABI || !signerOrProvider)
+            return null;
+        try {
+            return (0, web3_1.getContract)(address, ABI, signerOrProvider);
+        }
+        catch (error) {
+            return null;
+        }
+    }, [address, ABI, signerOrProvider]);
+}
+exports.useContract = useContract;
 //# sourceMappingURL=useContract.js.map

package/dist/cjs/hooks/useERC20TransferableReceivableContract.d.ts

@@ -1,12 +1,12 @@
-import { Contract, ethers } from 'ethers';
-import { POOL_NAME } from '@huma-finance/shared';
-/**
- * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName The name of the pool to get the contract for.
- * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
- */
-export declare function useERC20TransferableReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME): Contract | null;
+import { Contract, ethers } from 'ethers';
+import { POOL_NAME } from '@huma-finance/shared';
+/**
+ * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName The name of the pool to get the contract for.
+ * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
+ */
+export declare function useERC20TransferableReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME): Contract | null;

package/dist/cjs/hooks/useERC20TransferableReceivableContract.js

@@ -1,21 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useERC20TransferableReceivableContract = void 0;
-const shared_1 = require("@huma-finance/shared");
-const useContract_1 = require("./useContract");
-/**
- * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName The name of the pool to get the contract for.
- * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
- */
-function useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) {
-    var _a, _b, _c;
-    const TransferableReceivableAddress = (_c = (_b = (_a = shared_1.PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress;
-    return (0, useContract_1.useContract)(TransferableReceivableAddress, shared_1.ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
-}
-exports.useERC20TransferableReceivableContract = useERC20TransferableReceivableContract;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useERC20TransferableReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const useContract_1 = require("./useContract");
+/**
+ * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName The name of the pool to get the contract for.
+ * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
+ */
+function useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) {
+    var _a, _b, _c;
+    const TransferableReceivableAddress = (_c = (_b = (_a = shared_1.PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress;
+    return (0, useContract_1.useContract)(TransferableReceivableAddress, shared_1.ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.useERC20TransferableReceivableContract = useERC20TransferableReceivableContract;
 //# sourceMappingURL=useERC20TransferableReceivableContract.js.map