@huma-finance/sdk 0.0.52-beta.405 → 0.0.52

package/API.md

@@ -40,6 +40,12 @@ 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="#getAvailableBalanceForPool">getAvailableBalanceForPool(poolName, provider)</a></dt>
+<dd><p>Returns the current pool balance available for borrowing</p></dd>
+<dt><a href="#getAvailableCreditForPool">getAvailableCreditForPool(borrower, poolName, provider)</a></dt>
+<dd><p>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.</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>
@@ -762,6 +768,33 @@ 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="getAvailableBalanceForPool"></a>
+
+## getAvailableBalanceForPool(poolName, provider)
+<p>Returns the current pool balance available for borrowing</p>
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to get the contract instance for.</p> |
+| provider | <code>JsonRpcProvider</code> \| <code>Web3Provider</code> | <p>The provider instance to use for reading from the contract.</p> |
+
+<a name="getAvailableCreditForPool"></a>
+
+## getAvailableCreditForPool(borrower, poolName, provider)
+<p>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.</p>
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| borrower | <code>string</code> | <p>The address of the borrower to check the available credit for.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to get the contract instance for.</p> |
+| provider | <code>JsonRpcProvider</code> \| <code>Web3Provider</code> | <p>The provider instance to use for reading from the contract.</p> |
+
 <a name="getReceivableBackedCreditLineContractV2"></a>
 
 ## getReceivableBackedCreditLineContractV2(signerOrProvider, poolName) ⇒ <code>ReceivableBackedCreditLine</code> \| <code>null</code>

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

@@ -3,3 +3,4 @@ export * from './ERC20TransferableReceivableContractHelper';
 export * from './PoolContractHelper';
 export * from './v2/ReceivableContractHelper';
 export * from './v2/ReceivableBackedCreditLineContractHelper';
+export * from './v2/CreditContractHelper';

package/dist/cjs/helpers/index.js

@@ -6,4 +6,5 @@ tslib_1.__exportStar(require("./ERC20TransferableReceivableContractHelper"), exp
 tslib_1.__exportStar(require("./PoolContractHelper"), exports);
 tslib_1.__exportStar(require("./v2/ReceivableContractHelper"), exports);
 tslib_1.__exportStar(require("./v2/ReceivableBackedCreditLineContractHelper"), exports);
+tslib_1.__exportStar(require("./v2/CreditContractHelper"), 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;AACpC,wEAA6C;AAC7C,wFAA6D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,8EAAmD;AACnD,sFAA2D;AAC3D,+DAAoC;AACpC,wEAA6C;AAC7C,wFAA6D;AAC7D,oEAAyC"}

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

@@ -0,0 +1,20 @@
+import { JsonRpcProvider, Web3Provider } from '@ethersproject/providers';
+import { POOL_NAME } from '@huma-finance/shared';
+import { ethers } from 'ethers';
+/**
+ * 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 {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export declare function getAvailableBalanceForPool(poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<ethers.BigNumber>;
+/**
+ * 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 {string} borrower - The address of the borrower to check the available credit for.
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export declare function getAvailableCreditForPool(borrower: string, poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<ethers.BigNumber>;

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAvailableCreditForPool = exports.getAvailableBalanceForPool = void 0;
+const shared_1 = require("@huma-finance/shared");
+/**
+ * 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 {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+async function getAvailableBalanceForPool(poolName, provider) {
+    const safeContract = await (0, shared_1.getPoolSafeContractV2)(poolName, provider);
+    if (!safeContract) {
+        throw new Error('Could not find safe contract for pool');
+    }
+    return safeContract.getAvailableBalanceForPool();
+}
+exports.getAvailableBalanceForPool = getAvailableBalanceForPool;
+/**
+ * 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 {string} borrower - The address of the borrower to check the available credit for.
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+async function getAvailableCreditForPool(borrower, poolName, provider) {
+    const creditConfig = await (0, shared_1.getCreditConfigV2)(poolName, borrower, provider);
+    const creditRecord = await (0, shared_1.getCreditRecordV2)(poolName, borrower, provider);
+    if (!creditConfig || !creditRecord) {
+        throw new Error('Could not find credit config or credit record');
+    }
+    return creditConfig.creditLimit.sub(creditRecord.unbilledPrincipal);
+}
+exports.getAvailableCreditForPool = getAvailableCreditForPool;
+//# sourceMappingURL=CreditContractHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../../src/helpers/v2/CreditContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAG7B;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,8BAAqB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEpE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAC,0BAA0B,EAAE,CAAA;AAClD,CAAC;AAXD,gEAWC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;AACrE,CAAC;AAbD,8DAaC"}

package/dist/cjs/services/v2/HumaReceivableHandler.d.ts

@@ -1,5 +1,5 @@
 import { TransactionResponse } from '@ethersproject/providers';
-import { BigNumber, Overrides } from 'ethers';
+import { BigNumber, BigNumberish, Overrides } from 'ethers';
 import { HumaContext } from './HumaContext';
 export declare class HumaReceivableHandler {
     #private;
@@ -7,4 +7,5 @@ export declare class HumaReceivableHandler {
         humaContext: HumaContext;
     });
     declarePayment(paymentAmount: BigNumber, referenceId?: string, gasOpts?: Overrides): Promise<TransactionResponse>;
+    burnReceivable(tokenId: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
 }

package/dist/cjs/services/v2/HumaReceivableHandler.js

@@ -26,6 +26,14 @@ class HumaReceivableHandler {
         }
         return contract.declarePayment(tokenId, paymentAmount, gasOpts);
     }
+    async burnReceivable(tokenId, gasOpts = {}) {
+        const contract = await (0, helpers_1.getReceivableContractV2)(tslib_1.__classPrivateFieldGet(this, _HumaReceivableHandler_humaContext, "f").poolName, tslib_1.__classPrivateFieldGet(this, _HumaReceivableHandler_humaContext, "f").signer);
+        if (!contract) {
+            throw new Error('Could not find Receivable contract');
+        }
+        gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, tslib_1.__classPrivateFieldGet(this, _HumaReceivableHandler_humaContext, "f").chainId);
+        return contract.burn(tokenId, gasOpts);
+    }
 }
 exports.HumaReceivableHandler = HumaReceivableHandler;
 _HumaReceivableHandler_humaContext = new WeakMap();

package/dist/cjs/services/v2/HumaReceivableHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"HumaReceivableHandler.js","sourceRoot":"","sources":["../../../../src/services/v2/HumaReceivableHandler.ts"],"names":[],"mappings":";;;;;AAGA,uCAAkD;AAClD,2CAGsB;AAEtB,MAAa,qBAAqB;IAGhC,YAAY,EAAE,WAAW,EAAgC;QAFzD,qDAAyB;QAGvB,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,+BAAA,IAAI,sCAAgB,WAAW,MAAA,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,aAAwB,EACxB,cAAsB,EAAE,EACxB,UAAqB,EAAE;QAEvB,MAAM,QAAQ,GAAG,MAAM,IAAA,iCAAuB,EAC5C,+BAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,+BAAA,IAAI,0CAAa,CAAC,MAAM,CACzB,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,+BAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,CAAA;QAExE,MAAM,aAAa,GAAG,MAAM,+BAAA,IAAI,0CAAa,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QACjE,MAAM,OAAO,GAAG,MAAM,IAAA,6CAAmC,EACvD,WAAW,EACX,aAAa,EACb,+BAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,+BAAA,IAAI,0CAAa,CAAC,QAAQ,CAC3B,CAAA;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;SAC1C;QAED,OAAO,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;IACjE,CAAC;CACF;AAxCD,sDAwCC"}
+{"version":3,"file":"HumaReceivableHandler.js","sourceRoot":"","sources":["../../../../src/services/v2/HumaReceivableHandler.ts"],"names":[],"mappings":";;;;;AAGA,uCAAkD;AAClD,2CAGsB;AAEtB,MAAa,qBAAqB;IAGhC,YAAY,EAAE,WAAW,EAAgC;QAFzD,qDAAyB;QAGvB,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,+BAAA,IAAI,sCAAgB,WAAW,MAAA,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,aAAwB,EACxB,cAAsB,EAAE,EACxB,UAAqB,EAAE;QAEvB,MAAM,QAAQ,GAAG,MAAM,IAAA,iCAAuB,EAC5C,+BAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,+BAAA,IAAI,0CAAa,CAAC,MAAM,CACzB,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,+BAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,CAAA;QAExE,MAAM,aAAa,GAAG,MAAM,+BAAA,IAAI,0CAAa,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QACjE,MAAM,OAAO,GAAG,MAAM,IAAA,6CAAmC,EACvD,WAAW,EACX,aAAa,EACb,+BAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,+BAAA,IAAI,0CAAa,CAAC,QAAQ,CAC3B,CAAA;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;SAC1C;QAED,OAAO,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;IACjE,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAAqB,EACrB,UAAqB,EAAE;QAEvB,MAAM,QAAQ,GAAG,MAAM,IAAA,iCAAuB,EAC5C,+BAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,+BAAA,IAAI,0CAAa,CAAC,MAAM,CACzB,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,+BAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,CAAA;QAExE,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACxC,CAAC;CACF;AAzDD,sDAyDC"}

package/dist/helpers/index.d.ts

@@ -3,3 +3,4 @@ export * from './ERC20TransferableReceivableContractHelper';
 export * from './PoolContractHelper';
 export * from './v2/ReceivableContractHelper';
 export * from './v2/ReceivableBackedCreditLineContractHelper';
+export * from './v2/CreditContractHelper';

package/dist/helpers/index.js

@@ -3,4 +3,5 @@ export * from './ERC20TransferableReceivableContractHelper';
 export * from './PoolContractHelper';
 export * from './v2/ReceivableContractHelper';
 export * from './v2/ReceivableBackedCreditLineContractHelper';
+export * from './v2/CreditContractHelper';
 //# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,sBAAsB,CAAA;AACpC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+CAA+C,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,6CAA6C,CAAA;AAC3D,cAAc,sBAAsB,CAAA;AACpC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,+CAA+C,CAAA;AAC7D,cAAc,2BAA2B,CAAA"}

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

@@ -0,0 +1,20 @@
+import { JsonRpcProvider, Web3Provider } from '@ethersproject/providers';
+import { POOL_NAME } from '@huma-finance/shared';
+import { ethers } from 'ethers';
+/**
+ * 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 {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export declare function getAvailableBalanceForPool(poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<ethers.BigNumber>;
+/**
+ * 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 {string} borrower - The address of the borrower to check the available credit for.
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export declare function getAvailableCreditForPool(borrower: string, poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<ethers.BigNumber>;

package/dist/helpers/v2/CreditContractHelper.js

@@ -0,0 +1,32 @@
+import { getCreditConfigV2, getCreditRecordV2, getPoolSafeContractV2, } from '@huma-finance/shared';
+/**
+ * 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 {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export async function getAvailableBalanceForPool(poolName, provider) {
+    const safeContract = await getPoolSafeContractV2(poolName, provider);
+    if (!safeContract) {
+        throw new Error('Could not find safe contract for pool');
+    }
+    return safeContract.getAvailableBalanceForPool();
+}
+/**
+ * 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 {string} borrower - The address of the borrower to check the available credit for.
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export async function getAvailableCreditForPool(borrower, poolName, provider) {
+    const creditConfig = await getCreditConfigV2(poolName, borrower, provider);
+    const creditRecord = await getCreditRecordV2(poolName, borrower, provider);
+    if (!creditConfig || !creditRecord) {
+        throw new Error('Could not find credit config or credit record');
+    }
+    return creditConfig.creditLimit.sub(creditRecord.unbilledPrincipal);
+}
+//# sourceMappingURL=CreditContractHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/v2/CreditContractHelper.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GAEtB,MAAM,sBAAsB,CAAA;AAG7B;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEpE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAC,0BAA0B,EAAE,CAAA;AAClD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;AACrE,CAAC"}

package/dist/services/v2/HumaReceivableHandler.d.ts

@@ -1,5 +1,5 @@
 import { TransactionResponse } from '@ethersproject/providers';
-import { BigNumber, Overrides } from 'ethers';
+import { BigNumber, BigNumberish, Overrides } from 'ethers';
 import { HumaContext } from './HumaContext';
 export declare class HumaReceivableHandler {
     #private;
@@ -7,4 +7,5 @@ export declare class HumaReceivableHandler {
         humaContext: HumaContext;
     });
     declarePayment(paymentAmount: BigNumber, referenceId?: string, gasOpts?: Overrides): Promise<TransactionResponse>;
+    burnReceivable(tokenId: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
 }

package/dist/services/v2/HumaReceivableHandler.js

@@ -23,6 +23,14 @@ export class HumaReceivableHandler {
         }
         return contract.declarePayment(tokenId, paymentAmount, gasOpts);
     }
+    async burnReceivable(tokenId, gasOpts = {}) {
+        const contract = await getReceivableContractV2(__classPrivateFieldGet(this, _HumaReceivableHandler_humaContext, "f").poolName, __classPrivateFieldGet(this, _HumaReceivableHandler_humaContext, "f").signer);
+        if (!contract) {
+            throw new Error('Could not find Receivable contract');
+        }
+        gasOpts = await getDefaultGasOptions(gasOpts, __classPrivateFieldGet(this, _HumaReceivableHandler_humaContext, "f").chainId);
+        return contract.burn(tokenId, gasOpts);
+    }
 }
 _HumaReceivableHandler_humaContext = new WeakMap();
 //# sourceMappingURL=HumaReceivableHandler.js.map

package/dist/services/v2/HumaReceivableHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"HumaReceivableHandler.js","sourceRoot":"","sources":["../../../src/services/v2/HumaReceivableHandler.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EACL,uBAAuB,EACvB,mCAAmC,GACpC,MAAM,eAAe,CAAA;AAEtB,MAAM,OAAO,qBAAqB;IAGhC,YAAY,EAAE,WAAW,EAAgC;QAFzD,qDAAyB;QAGvB,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,uBAAA,IAAI,sCAAgB,WAAW,MAAA,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,aAAwB,EACxB,cAAsB,EAAE,EACxB,UAAqB,EAAE;QAEvB,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAC5C,uBAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,uBAAA,IAAI,0CAAa,CAAC,MAAM,CACzB,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,CAAA;QAExE,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,0CAAa,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QACjE,MAAM,OAAO,GAAG,MAAM,mCAAmC,CACvD,WAAW,EACX,aAAa,EACb,uBAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,uBAAA,IAAI,0CAAa,CAAC,QAAQ,CAC3B,CAAA;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;SAC1C;QAED,OAAO,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;IACjE,CAAC;CACF"}
+{"version":3,"file":"HumaReceivableHandler.js","sourceRoot":"","sources":["../../../src/services/v2/HumaReceivableHandler.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EACL,uBAAuB,EACvB,mCAAmC,GACpC,MAAM,eAAe,CAAA;AAEtB,MAAM,OAAO,qBAAqB;IAGhC,YAAY,EAAE,WAAW,EAAgC;QAFzD,qDAAyB;QAGvB,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,uBAAA,IAAI,sCAAgB,WAAW,MAAA,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,aAAwB,EACxB,cAAsB,EAAE,EACxB,UAAqB,EAAE;QAEvB,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAC5C,uBAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,uBAAA,IAAI,0CAAa,CAAC,MAAM,CACzB,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,CAAA;QAExE,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,0CAAa,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QACjE,MAAM,OAAO,GAAG,MAAM,mCAAmC,CACvD,WAAW,EACX,aAAa,EACb,uBAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,uBAAA,IAAI,0CAAa,CAAC,QAAQ,CAC3B,CAAA;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;SAC1C;QAED,OAAO,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;IACjE,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAAqB,EACrB,UAAqB,EAAE;QAEvB,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAC5C,uBAAA,IAAI,0CAAa,CAAC,QAAQ,EAC1B,uBAAA,IAAI,0CAAa,CAAC,MAAM,CACzB,CAAA;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;SACtD;QAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,uBAAA,IAAI,0CAAa,CAAC,OAAO,CAAC,CAAA;QAExE,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACxC,CAAC;CACF"}