@huma-finance/sdk 0.0.51-beta.225 → 0.0.51-beta.346

package/API.md

@@ -18,6 +18,9 @@
 <dl>
 <dt><a href="#defaultWrapper">defaultWrapper()</a></dt>
 <dd><p>All built-in and custom scalars, mapped to their actual values</p></dd>
+<dt><a href="#approveERC20AllowanceIfInsufficient">approveERC20AllowanceIfInsufficient(signer, tokenAddress, spenderAddress, allowanceAmount, [gasOpts])</a> ⇒ <code>Promise.&lt;(TransactionResponse|null)&gt;</code></dt>
+<dd><p>Approves an ERC20 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)</p></dd>
 <dt><a href="#getERC20TransferableReceivableContract">getERC20TransferableReceivableContract(signerOrProvider, chainId)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
 <dd><p>Returns an ethers contract instance for the ERC20TransferableReceivable contract
 associated with the given pool name on the current chain.</p></dd>
@@ -37,6 +40,21 @@ attempt to first increase the allowance of the pool.</p></dd>
 <dt><a href="#getRealWorldReceivableContract">getRealWorldReceivableContract(signerOrProvider, chainId)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
 <dd><p>Returns an ethers contract instance for the RealWorldReceivable contract
 associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#getReceivableBackedCreditLineContractV2">getReceivableBackedCreditLineContractV2(signerOrProvider, poolName)</a> ⇒ <code>ReceivableBackedCreditLine</code> | <code>null</code></dt>
+<dd><p>Returns an ethers contract instance for the V2 Receivable contract
+associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#getTotalDueV2">getTotalDueV2(provider, poolName)</a> ⇒ <code>BigNumber</code> | <code>null</code></dt>
+<dd><p>Returns account's total due amount in BigNumber format
+associated with the given pool name on the current chain.</p></dd>
+<dt><a href="#drawdownWithReceivable">drawdownWithReceivable(signer, poolName, receivableId, drawdownAmount, [gasOpts])</a> ⇒ <code>Promise.&lt;TransactionResponse&gt;</code></dt>
+<dd><p>Draws down from a pool using a receivable.</p></dd>
+<dt><a href="#makePaymentWithReceivable">makePaymentWithReceivable(signer, poolName, receivableId, paymentAmount, principalOnly, [gasOpts])</a> ⇒ <code>Promise.&lt;TransactionResponse&gt;</code></dt>
+<dd><p>Makes a payment with a receivable.</p></dd>
+<dt><a href="#makePrincipalPaymentAndDrawdownWithReceivable">makePrincipalPaymentAndDrawdownWithReceivable(signer, poolName, paymentReceivableId, paymentAmount, drawdownReceivableId, drawdownAmount, [gasOpts])</a> ⇒ <code>Promise.&lt;TransactionResponse&gt;</code></dt>
+<dd><p>Makes a principal payment and drawdown with receivables.</p></dd>
+<dt><a href="#getReceivableContractV2">getReceivableContractV2(signerOrProvider, chainId)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
+<dd><p>Returns an ethers contract instance for the V2 Receivable contract
+associated with the given pool name on the current chain.</p></dd>
 <dt><a href="#useContract">useContract(address, ABI, signerOrProvider)</a> ⇒ <code>T</code> | <code>null</code></dt>
 <dd><p>Custom hook for creating an ethers instance of a smart contract.</p></dd>
 <dt><a href="#useERC20TransferableReceivableContract">useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
@@ -475,6 +493,7 @@ in Huma's pools that can be drawn down by the borrower.</p>
     * [.getLastFactorizedAmountFromPool(userAddress, chainId, poolName, poolType)](#SubgraphService.getLastFactorizedAmountFromPool) ⇒ <code>Promise.&lt;number&gt;</code>
     * [.getRWReceivableInfo(userAddress, chainId, poolName, poolType, pagination)](#SubgraphService.getRWReceivableInfo) ⇒ <code>Promise.&lt;RealWorldReceivableInfoBase&gt;</code>
     * [.getPoolStats(chainId, pool)](#SubgraphService.getPoolStats) ⇒ <code>Promise.&lt;{PoolStats}&gt;</code>
+    * [.checkBorrowAndLendHistory(chainId, pool, userAddress)](#SubgraphService.checkBorrowAndLendHistory) ⇒ <code>Promise.&lt;{hasBorrowHistory: boolean, hasLendHistory: boolean}&gt;</code>
 
 <a name="SubgraphService.getSubgraphUrlForChainId"></a>
 
@@ -548,12 +567,45 @@ in Huma's pools that can be drawn down by the borrower.</p>
 | chainId | <code>number</code> | <p>The ID of the chain.</p> |
 | pool | <code>string</code> | <p>The address of the pool.</p> |
 
+<a name="SubgraphService.checkBorrowAndLendHistory"></a>
+
+### SubgraphService.checkBorrowAndLendHistory(chainId, pool, userAddress) ⇒ <code>Promise.&lt;{hasBorrowHistory: boolean, hasLendHistory: boolean}&gt;</code>
+<p>Returns if user has borrow or lend history.</p>
+
+**Kind**: static method of [<code>SubgraphService</code>](#SubgraphService)  
+**Returns**: <code>Promise.&lt;{hasBorrowHistory: boolean, hasLendHistory: boolean}&gt;</code> - <p>If user has borrow or lend history.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chainId | <code>number</code> | <p>The ID of the chain.</p> |
+| pool | <code>string</code> | <p>The address of the pool.</p> |
+| userAddress | <code>string</code> | <p>The address of the user.</p> |
+
 <a name="defaultWrapper"></a>
 
 ## defaultWrapper()
 <p>All built-in and custom scalars, mapped to their actual values</p>
 
 **Kind**: global function  
+<a name="approveERC20AllowanceIfInsufficient"></a>
+
+## approveERC20AllowanceIfInsufficient(signer, tokenAddress, spenderAddress, allowanceAmount, [gasOpts]) ⇒ <code>Promise.&lt;(TransactionResponse\|null)&gt;</code>
+<p>Approves an ERC20 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)</p>
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;(TransactionResponse\|null)&gt;</code> - <ul>
+<li>A Promise of the transaction response, or null if the allowance was already sufficient.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction.</p> |
+| tokenAddress | <code>string</code> | <p>The address of the ERC20 token to approve.</p> |
+| spenderAddress | <code>string</code> | <p>The address of the spender to approve an allowance for.</p> |
+| allowanceAmount | <code>BigNumber</code> | <p>The amount of tokens to approve, if applicable. Denominated in the ERC20 tokens.</p> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
 <a name="getERC20TransferableReceivableContract"></a>
 
 ## getERC20TransferableReceivableContract(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>
@@ -710,6 +762,105 @@ associated with the given pool name on the current chain.</p>
 | signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
 | chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
 
+<a name="getReceivableBackedCreditLineContractV2"></a>
+
+## getReceivableBackedCreditLineContractV2(signerOrProvider, poolName) ⇒ <code>ReceivableBackedCreditLine</code> \| <code>null</code>
+<p>Returns an ethers contract instance for the V2 Receivable contract
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>ReceivableBackedCreditLine</code> \| <code>null</code> - <p>A contract instance for the ReceivableBackedCreditLine contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to get the contract instance for.</p> |
+
+<a name="getTotalDueV2"></a>
+
+## getTotalDueV2(provider, poolName) ⇒ <code>BigNumber</code> \| <code>null</code>
+<p>Returns account's total due amount in BigNumber format
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>BigNumber</code> \| <code>null</code> - <p>The account's total due amount in BigNumber format</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| provider | <code>JsonRpcProvider</code> \| <code>Web3Provider</code> | <p>The provider instance to use for the contract.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to get the contract instance for.</p> |
+
+<a name="drawdownWithReceivable"></a>
+
+## drawdownWithReceivable(signer, poolName, receivableId, drawdownAmount, [gasOpts]) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Draws down from a pool using a receivable.</p>
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>A Promise of the transaction response.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to drawdown from.</p> |
+| receivableId | <code>BigNumberish</code> | <p>The ID of the receivable.</p> |
+| drawdownAmount | <code>BigNumberish</code> | <p>The amount to drawdown.</p> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="makePaymentWithReceivable"></a>
+
+## makePaymentWithReceivable(signer, poolName, receivableId, paymentAmount, principalOnly, [gasOpts]) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Makes a payment with a receivable.</p>
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>A Promise of the transaction response.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool to interact with.</p> |
+| receivableId | <code>BigNumberish</code> | <p>The ID of the receivable.</p> |
+| paymentAmount | <code>BigNumberish</code> | <p>The amount to payback.</p> |
+| principalOnly | <code>boolean</code> | <p>Whether this payment should ONLY apply to the principal</p> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="makePrincipalPaymentAndDrawdownWithReceivable"></a>
+
+## makePrincipalPaymentAndDrawdownWithReceivable(signer, poolName, paymentReceivableId, paymentAmount, drawdownReceivableId, drawdownAmount, [gasOpts]) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Makes a principal payment and drawdown with receivables.</p>
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;TransactionResponse&gt;</code> - <ul>
+<li>A Promise of the transaction response.</li>
+</ul>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signer | <code>ethers.Signer</code> | <p>The signer used to send the transaction.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool to interact with.</p> |
+| paymentReceivableId | <code>BigNumberish</code> | <p>The ID of the receivable for payment.</p> |
+| paymentAmount | <code>BigNumberish</code> | <p>The amount to payback.</p> |
+| drawdownReceivableId | <code>BigNumberish</code> | <p>The ID of the drawdown receivable.</p> |
+| drawdownAmount | <code>BigNumberish</code> | <p>The amount to drawdown.</p> |
+| [gasOpts] | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="getReceivableContractV2"></a>
+
+## getReceivableContractV2(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>
+<p>Returns an ethers contract instance for the V2 Receivable contract
+associated with the given pool name on the current chain.</p>
+
+**Kind**: global function  
+**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the Receivable contract or null if it could not be found.</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The provider or signer instance to use for the contract.</p> |
+| chainId | <code>number</code> | <p>The chain id where the contract instance exists</p> |
+
 <a name="useContract"></a>
 
 ## useContract(address, ABI, signerOrProvider) ⇒ <code>T</code> \| <code>null</code>

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

@@ -0,0 +1,16 @@
+import { BigNumberish, Overrides, ethers } from 'ethers';
+import { TransactionResponse } from '@ethersproject/providers';
+/**
+ * Approves an ERC20 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)
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {string} tokenAddress - The address of the ERC20 token to approve.
+ * @param {string} spenderAddress - The address of the spender to approve an allowance for.
+ * @param {BigNumber} allowanceAmount - The amount of tokens to approve, if applicable. Denominated in the ERC20 tokens.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse | null>} - A Promise of the transaction response, or null if the allowance was already sufficient.
+ */
+export declare function approveERC20AllowanceIfInsufficient(signer: ethers.Signer, tokenAddress: string, spenderAddress: string, allowanceAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse | null>;

package/dist/cjs/helpers/ERC20ContractHelper.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.approveERC20AllowanceIfInsufficient = void 0;
+const shared_1 = require("@huma-finance/shared");
+const utils_1 = require("../utils");
+/**
+ * Approves an ERC20 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)
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {string} tokenAddress - The address of the ERC20 token to approve.
+ * @param {string} spenderAddress - The address of the spender to approve an allowance for.
+ * @param {BigNumber} allowanceAmount - The amount of tokens to approve, if applicable. Denominated in the ERC20 tokens.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse | null>} - A Promise of the transaction response, or null if the allowance was already sufficient.
+ */
+async function approveERC20AllowanceIfInsufficient(signer, tokenAddress, spenderAddress, allowanceAmount, gasOpts = {}) {
+    const chainId = await (0, shared_1.getChainIdFromSignerOrProvider)(signer);
+    if (!chainId) {
+        throw new Error('Could not find chain ID');
+    }
+    const tokenContract = (0, utils_1.getERC20Contract)(tokenAddress, signer);
+    const allowance = await tokenContract.allowance(await signer.getAddress(), spenderAddress);
+    if (allowance.lt(allowanceAmount)) {
+        gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+        return tokenContract.approve(spenderAddress, allowanceAmount, gasOpts);
+    }
+    return null;
+}
+exports.approveERC20AllowanceIfInsufficient = approveERC20AllowanceIfInsufficient;
+//# sourceMappingURL=ERC20ContractHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ERC20ContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/ERC20ContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAAqE;AAErE,oCAAiE;AAEjE;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,mCAAmC,CACvD,MAAqB,EACrB,YAAoB,EACpB,cAAsB,EACtB,eAA6B,EAC7B,UAAqB,EAAE;IAEvB,MAAM,OAAO,GAAG,MAAM,IAAA,uCAA8B,EAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;KAC3C;IAED,MAAM,aAAa,GAAG,IAAA,wBAAgB,EAAC,YAAY,EAAE,MAAM,CAAC,CAAA;IAE5D,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,SAAS,CAC7C,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,cAAc,CACf,CAAA;IACD,IAAI,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,EAAE;QACjC,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACtD,OAAO,aAAa,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,EAAE,OAAO,CAAC,CAAA;KACvE;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAzBD,kFAyBC"}

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

@@ -1,6 +1,6 @@
 import { BigNumber } from '@ethersproject/bignumber';
-import { BigNumberish, Contract, Overrides, ethers } from 'ethers';
-import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+import { BigNumberish, Overrides, ethers } from 'ethers';
+import { BaseCreditPool, POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
 import { TransactionResponse } from '@ethersproject/providers';
 /**
  * Returns an ethers contract instance for a Huma pool contract
@@ -11,7 +11,7 @@ import { TransactionResponse } from '@ethersproject/providers';
  * @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.
  */
-export declare function getPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Contract | null;
+export declare function getPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): BaseCreditPool | null;
 /**
  * Return type of getCreditRecord
  *

package/dist/cjs/helpers/PoolContractHelper.js

@@ -2,6 +2,7 @@
 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");
+const ERC20ContractHelper_1 = require("./ERC20ContractHelper");
 /**
  * Returns an ethers contract instance for a Huma pool contract
  *
@@ -75,7 +76,6 @@ async function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmo
         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;
@@ -98,19 +98,16 @@ async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmo
     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);
+    const approvalTx = await (0, ERC20ContractHelper_1.approveERC20AllowanceIfInsufficient)(signer, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address, poolContract.address, paymentAmount, gasOpts);
+    if (approvalTx) {
         // Wait for 5 block confirmations since this is required for makePayment
         await approvalTx.wait(5);
     }
-    // TODO: Generate typechain for pool contract
     return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
 }
 exports.makePaymentToPool = makePaymentToPool;

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

@@ -1 +1 @@
-{"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,wEAAwE;QACxE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KACzB;IAED,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AA3CD,8CA2CC;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"}
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAKA,oCAKiB;AACjB,+DAA2E;AAE3E;;;;;;;;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,EAChB,QAAQ,CAAC,IAAI,EACb,QAAQ,CAAC,OAAO,EAChB,gBAAgB,CACjB,CAAA;AACH,CAAC;AAfD,0CAeC;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,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAjBD,4CAiBC;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,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,UAAU,GAAG,MAAM,IAAA,yDAAmC,EAC1D,MAAM,EACN,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,EACrC,YAAY,CAAC,OAAO,EACpB,aAAa,EACb,OAAO,CACR,CAAA;IAED,IAAI,UAAU,EAAE;QACd,wEAAwE;QACxE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KACzB;IAED,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AArCD,8CAqCC;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/index.d.ts

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

package/dist/cjs/helpers/index.js

@@ -4,4 +4,6 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./RealWorldReceivableContractHelper"), exports);
 tslib_1.__exportStar(require("./ERC20TransferableReceivableContractHelper"), exports);
 tslib_1.__exportStar(require("./PoolContractHelper"), exports);
+tslib_1.__exportStar(require("./v2/ReceivableContractHelper"), exports);
+tslib_1.__exportStar(require("./v2/ReceivableBackedCreditLineContractHelper"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,8EAAmD;AACnD,sFAA2D;AAC3D,+DAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,8EAAmD;AACnD,sFAA2D;AAC3D,+DAAoC;AACpC,wEAA6C;AAC7C,wFAA6D"}

package/dist/cjs/helpers/v2/ReceivableBackedCreditLineContractHelper.d.ts

@@ -0,0 +1,64 @@
+import { JsonRpcProvider, TransactionResponse, Web3Provider } from '@ethersproject/providers';
+import { POOL_NAME } from '@huma-finance/shared';
+import { ReceivableBackedCreditLine } from '@huma-finance/shared/src/v2/abis/types';
+import { BigNumber, BigNumberish, ethers, Overrides } from 'ethers';
+/**
+ * Returns an ethers contract instance for the V2 Receivable 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 {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @returns {ReceivableBackedCreditLine | null} A contract instance for the ReceivableBackedCreditLine contract or null if it could not be found.
+ */
+export declare function getReceivableBackedCreditLineContractV2(poolName: POOL_NAME, signerOrProvider: JsonRpcProvider | Web3Provider | ethers.Signer): Promise<ReceivableBackedCreditLine | null>;
+/**
+ * Returns account's total due amount in BigNumber format
+ * associated with the given pool name on the current chain.
+ *
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for the contract.
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @returns {BigNumber | null} The account's total due amount in BigNumber format
+ */
+export declare function getTotalDueV2(poolName: POOL_NAME, account: string, provider: JsonRpcProvider | Web3Provider): Promise<BigNumber | null>;
+/**
+ * Draws down from a pool using a receivable.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the credit pool to drawdown from.
+ * @param {BigNumberish} receivableId - The ID of the receivable.
+ * @param {BigNumberish} drawdownAmount - The amount to drawdown.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+export declare function drawdownWithReceivable(signer: ethers.Signer, poolName: POOL_NAME, receivableId: BigNumberish, drawdownAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * Makes a payment with a receivable.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the pool to interact with.
+ * @param {BigNumberish} receivableId - The ID of the receivable.
+ * @param {BigNumberish} paymentAmount - The amount to payback.
+ * @param {boolean} principalOnly - Whether this payment should ONLY apply to the principal
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+export declare function makePaymentWithReceivable(signer: ethers.Signer, poolName: POOL_NAME, receivableId: BigNumberish, paymentAmount: BigNumberish, principalOnly: boolean, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * Makes a principal payment and drawdown with receivables.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the pool to interact with.
+ * @param {BigNumberish} paymentReceivableId - The ID of the receivable for payment.
+ * @param {BigNumberish} paymentAmount - The amount to payback.
+ * @param {BigNumberish} drawdownReceivableId - The ID of the drawdown receivable.
+ * @param {BigNumberish} drawdownAmount - The amount to drawdown.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+export declare function makePrincipalPaymentAndDrawdownWithReceivable(signer: ethers.Signer, poolName: POOL_NAME, paymentReceivableId: BigNumberish, paymentAmount: BigNumberish, drawdownReceivableId: BigNumberish, drawdownAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;

package/dist/cjs/helpers/v2/ReceivableBackedCreditLineContractHelper.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makePrincipalPaymentAndDrawdownWithReceivable = exports.makePaymentWithReceivable = exports.drawdownWithReceivable = exports.getTotalDueV2 = exports.getReceivableBackedCreditLineContractV2 = void 0;
+const shared_1 = require("@huma-finance/shared");
+const utils_1 = require("../../utils");
+const ERC20ContractHelper_1 = require("../ERC20ContractHelper");
+const ReceivableContractHelper_1 = require("./ReceivableContractHelper");
+/**
+ * Returns an ethers contract instance for the V2 Receivable 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 {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @returns {ReceivableBackedCreditLine | null} A contract instance for the ReceivableBackedCreditLine contract or null if it could not be found.
+ */
+async function getReceivableBackedCreditLineContractV2(poolName, signerOrProvider) {
+    const chainId = await (0, shared_1.getChainIdFromSignerOrProvider)(signerOrProvider);
+    const poolInfo = (0, shared_1.getPoolInfoV2)(poolName, chainId);
+    if (!poolInfo || poolInfo.poolType !== shared_1.POOL_TYPE.ReceivableBackedCreditLine) {
+        return null;
+    }
+    return (0, utils_1.getContract)(poolInfo.poolCredit, shared_1.RECEIVABLE_BACKED_CREDIT_LINE_V2_ABI, signerOrProvider);
+}
+exports.getReceivableBackedCreditLineContractV2 = getReceivableBackedCreditLineContractV2;
+/**
+ * Returns account's total due amount in BigNumber format
+ * associated with the given pool name on the current chain.
+ *
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for the contract.
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @returns {BigNumber | null} The account's total due amount in BigNumber format
+ */
+async function getTotalDueV2(poolName, account, provider) {
+    const creditRecord = await (0, shared_1.getCreditRecordV2)(poolName, account, provider);
+    if (!creditRecord) {
+        return null;
+    }
+    return creditRecord.nextDue.add(creditRecord.totalPastDue);
+}
+exports.getTotalDueV2 = getTotalDueV2;
+/**
+ * Draws down from a pool using a receivable.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the credit pool to drawdown from.
+ * @param {BigNumberish} receivableId - The ID of the receivable.
+ * @param {BigNumberish} drawdownAmount - The amount to drawdown.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+async function drawdownWithReceivable(signer, poolName, receivableId, drawdownAmount, gasOpts = {}) {
+    const creditContract = await getReceivableBackedCreditLineContractV2(poolName, signer);
+    if (!creditContract) {
+        throw new Error('Could not find credit contract');
+    }
+    const approveTx = await (0, ReceivableContractHelper_1.approveReceivableTransferIfNeeded)(signer, poolName, receivableId);
+    await (approveTx === null || approveTx === void 0 ? void 0 : approveTx.wait(5));
+    return creditContract.drawdownWithReceivable(receivableId, drawdownAmount, gasOpts);
+}
+exports.drawdownWithReceivable = drawdownWithReceivable;
+/**
+ * Makes a payment with a receivable.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the pool to interact with.
+ * @param {BigNumberish} receivableId - The ID of the receivable.
+ * @param {BigNumberish} paymentAmount - The amount to payback.
+ * @param {boolean} principalOnly - Whether this payment should ONLY apply to the principal
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+async function makePaymentWithReceivable(signer, poolName, receivableId, paymentAmount, principalOnly, gasOpts = {}) {
+    const creditContract = await getReceivableBackedCreditLineContractV2(poolName, signer);
+    if (!creditContract) {
+        throw new Error('Could not find credit contract');
+    }
+    const poolSafeContract = await (0, shared_1.getPoolSafeContractV2)(poolName, signer.provider);
+    if (!poolSafeContract) {
+        throw new Error('Could not find pool safe contract');
+    }
+    const underlyingToken = await (0, shared_1.getPoolUnderlyingTokenContractV2)(poolName, signer.provider);
+    if (!underlyingToken) {
+        throw new Error('Could not find underlying token contract');
+    }
+    const approveERC20Tx = await (0, ERC20ContractHelper_1.approveERC20AllowanceIfInsufficient)(signer, underlyingToken.address, poolSafeContract.address, paymentAmount, gasOpts);
+    await (approveERC20Tx === null || approveERC20Tx === void 0 ? void 0 : approveERC20Tx.wait(5));
+    let paymentTx;
+    if (principalOnly) {
+        paymentTx = await creditContract.makePrincipalPaymentWithReceivable(receivableId, paymentAmount, gasOpts);
+    }
+    else {
+        paymentTx = await creditContract.makePaymentWithReceivable(await signer.getAddress(), receivableId, paymentAmount, gasOpts);
+    }
+    return paymentTx;
+}
+exports.makePaymentWithReceivable = makePaymentWithReceivable;
+/**
+ * Makes a principal payment and drawdown with receivables.
+ *
+ * @async
+ * @function
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the pool to interact with.
+ * @param {BigNumberish} paymentReceivableId - The ID of the receivable for payment.
+ * @param {BigNumberish} paymentAmount - The amount to payback.
+ * @param {BigNumberish} drawdownReceivableId - The ID of the drawdown receivable.
+ * @param {BigNumberish} drawdownAmount - The amount to drawdown.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ */
+async function makePrincipalPaymentAndDrawdownWithReceivable(signer, poolName, paymentReceivableId, paymentAmount, drawdownReceivableId, drawdownAmount, gasOpts = {}) {
+    const creditContract = await getReceivableBackedCreditLineContractV2(poolName, signer);
+    if (!creditContract) {
+        throw new Error('Could not find credit contract');
+    }
+    const underlyingToken = await (0, shared_1.getPoolUnderlyingTokenContractV2)(poolName, signer.provider);
+    const poolSafeContract = await (0, shared_1.getPoolSafeContractV2)(poolName, signer.provider);
+    if (!poolSafeContract) {
+        throw new Error('Could not find pool safe contract');
+    }
+    if (!underlyingToken) {
+        throw new Error('Could not find underlying token contract');
+    }
+    const approveERC20Tx = await (0, ERC20ContractHelper_1.approveERC20AllowanceIfInsufficient)(signer, underlyingToken.address, poolSafeContract.address, paymentAmount, gasOpts);
+    await (approveERC20Tx === null || approveERC20Tx === void 0 ? void 0 : approveERC20Tx.wait(5));
+    const approveTx = await (0, ReceivableContractHelper_1.approveReceivableTransferIfNeeded)(signer, poolName, drawdownReceivableId);
+    await (approveTx === null || approveTx === void 0 ? void 0 : approveTx.wait(5));
+    return creditContract.makePrincipalPaymentAndDrawdownWithReceivable(paymentReceivableId, paymentAmount, drawdownReceivableId, drawdownAmount, gasOpts);
+}
+exports.makePrincipalPaymentAndDrawdownWithReceivable = makePrincipalPaymentAndDrawdownWithReceivable;
+//# sourceMappingURL=ReceivableBackedCreditLineContractHelper.js.map

package/dist/cjs/helpers/v2/ReceivableBackedCreditLineContractHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReceivableBackedCreditLineContractHelper.js","sourceRoot":"","sources":["../../../../src/helpers/v2/ReceivableBackedCreditLineContractHelper.ts"],"names":[],"mappings":";;;AAKA,iDAS6B;AAG7B,uCAAyC;AACzC,gEAA4E;AAC5E,yEAA8E;AAE9E;;;;;;;GAOG;AACI,KAAK,UAAU,uCAAuC,CAC3D,QAAmB,EACnB,gBAAgE;IAEhE,MAAM,OAAO,GAAG,MAAM,IAAA,uCAA8B,EAAC,gBAAgB,CAAC,CAAA;IACtE,MAAM,QAAQ,GAAG,IAAA,sBAAa,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IACjD,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,KAAK,kBAAS,CAAC,0BAA0B,EAAE;QAC3E,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,IAAA,mBAAW,EAChB,QAAQ,CAAC,UAAU,EACnB,6CAAoC,EACpC,gBAAgB,CACjB,CAAA;AACH,CAAC;AAfD,0FAeC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,aAAa,CACjC,QAAmB,EACnB,OAAe,EACf,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IACzE,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,IAAI,CAAA;KACZ;IAED,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;AAC5D,CAAC;AAXD,sCAWC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,sBAAsB,CAC1C,MAAqB,EACrB,QAAmB,EACnB,YAA0B,EAC1B,cAA4B,EAC5B,UAAqB,EAAE;IAEvB,MAAM,cAAc,GAAG,MAAM,uCAAuC,CAClE,QAAQ,EACR,MAAM,CACP,CAAA;IAED,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;KAClD;IAED,MAAM,SAAS,GAAG,MAAM,IAAA,4DAAiC,EACvD,MAAM,EACN,QAAQ,EACR,YAAY,CACb,CAAA;IACD,MAAM,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,CAAC,CAAC,CAAC,CAAA,CAAA;IAExB,OAAO,cAAc,CAAC,sBAAsB,CAC1C,YAAY,EACZ,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AA5BD,wDA4BC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,yBAAyB,CAC7C,MAAqB,EACrB,QAAmB,EACnB,YAA0B,EAC1B,aAA2B,EAC3B,aAAsB,EACtB,UAAqB,EAAE;IAEvB,MAAM,cAAc,GAAG,MAAM,uCAAuC,CAClE,QAAQ,EACR,MAAM,CACP,CAAA;IAED,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;KAClD;IAED,MAAM,gBAAgB,GAAG,MAAM,IAAA,8BAAqB,EAClD,QAAQ,EACR,MAAM,CAAC,QAAsD,CAC9D,CAAA;IAED,IAAI,CAAC,gBAAgB,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;KACrD;IAED,MAAM,eAAe,GAAG,MAAM,IAAA,yCAAgC,EAC5D,QAAQ,EACR,MAAM,CAAC,QAAsD,CAC9D,CAAA;IAED,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;KAC5D;IACD,MAAM,cAAc,GAAG,MAAM,IAAA,yDAAmC,EAC9D,MAAM,EACN,eAAe,CAAC,OAAO,EACvB,gBAAgB,CAAC,OAAO,EACxB,aAAa,EACb,OAAO,CACR,CAAA;IACD,MAAM,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,CAAC,CAAC,CAAC,CAAA,CAAA;IAE7B,IAAI,SAAS,CAAA;IACb,IAAI,aAAa,EAAE;QACjB,SAAS,GAAG,MAAM,cAAc,CAAC,kCAAkC,CACjE,YAAY,EACZ,aAAa,EACb,OAAO,CACR,CAAA;KACF;SAAM;QACL,SAAS,GAAG,MAAM,cAAc,CAAC,yBAAyB,CACxD,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,YAAY,EACZ,aAAa,EACb,OAAO,CACR,CAAA;KACF;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AA5DD,8DA4DC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,6CAA6C,CACjE,MAAqB,EACrB,QAAmB,EACnB,mBAAiC,EACjC,aAA2B,EAC3B,oBAAkC,EAClC,cAA4B,EAC5B,UAAqB,EAAE;IAEvB,MAAM,cAAc,GAAG,MAAM,uCAAuC,CAClE,QAAQ,EACR,MAAM,CACP,CAAA;IAED,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;KAClD;IAED,MAAM,eAAe,GAAG,MAAM,IAAA,yCAAgC,EAC5D,QAAQ,EACR,MAAM,CAAC,QAAsD,CAC9D,CAAA;IAED,MAAM,gBAAgB,GAAG,MAAM,IAAA,8BAAqB,EAClD,QAAQ,EACR,MAAM,CAAC,QAAsD,CAC9D,CAAA;IAED,IAAI,CAAC,gBAAgB,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;KACrD;IAED,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;KAC5D;IAED,MAAM,cAAc,GAAG,MAAM,IAAA,yDAAmC,EAC9D,MAAM,EACN,eAAe,CAAC,OAAO,EACvB,gBAAgB,CAAC,OAAO,EACxB,aAAa,EACb,OAAO,CACR,CAAA;IACD,MAAM,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,CAAC,CAAC,CAAC,CAAA,CAAA;IAE7B,MAAM,SAAS,GAAG,MAAM,IAAA,4DAAiC,EACvD,MAAM,EACN,QAAQ,EACR,oBAAoB,CACrB,CAAA;IACD,MAAM,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,CAAC,CAAC,CAAC,CAAA,CAAA;IAExB,OAAO,cAAc,CAAC,6CAA6C,CACjE,mBAAmB,EACnB,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AA3DD,sGA2DC"}

package/dist/cjs/helpers/v2/ReceivableContractHelper.d.ts

@@ -0,0 +1,15 @@
+import { BigNumber, BigNumberish, Overrides, ethers } from 'ethers';
+import { POOL_NAME, v2Contracts } from '@huma-finance/shared';
+import { JsonRpcProvider, TransactionResponse, Web3Provider } from '@ethersproject/providers';
+/**
+ * Returns an ethers contract instance for the V2 Receivable 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 Receivable contract or null if it could not be found.
+ */
+export declare function getReceivableContractV2(poolName: POOL_NAME, signerOrProvider: JsonRpcProvider | Web3Provider | ethers.Signer): Promise<v2Contracts.Receivable | null>;
+export declare function getReceivableTokenIdFromReferenceId(referenceId: string, creator: string, poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<BigNumber>;
+export declare function getReceivableReferenceAlreadyExists(referenceId: string, signerAddress: string, poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<boolean>;
+export declare function approveReceivableTransferIfNeeded(signer: ethers.Signer, poolName: POOL_NAME, receivableId: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse | null>;