@huma-finance/sdk 0.0.12 → 0.0.15

package/API.md

@@ -16,11 +16,17 @@
 ## Functions
 
 <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="#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>
 <dt><a href="#getPoolContract">getPoolContract(signerOrProvider, chainId, poolName, poolType)</a> ⇒ <code>Contract</code> | <code>null</code></dt>
 <dd><p>Returns an ethers contract instance for a Huma pool contract</p></dd>
+<dt><a href="#drawdownFromPool">drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount, gasOpts)</a> ⇒ <code>Promise.&lt;TransactionResponse&gt;</code></dt>
+<dd><p>Calls drawdown on a Huma pool contract</p></dd>
+<dt><a href="#makePaymentToPool">makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount, gasOpts)</a> ⇒ <code>Promise.&lt;TransactionResponse&gt;</code></dt>
+<dd><p>Calls drawdown on a Huma pool contract</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>
@@ -282,6 +288,12 @@ associated with the given pool name on the current chain.</p></dd>
 | poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
 | poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
 
+<a name="defaultWrapper"></a>
+
+## defaultWrapper()
+<p>All built-in and custom scalars, mapped to their actual values</p>
+
+**Kind**: global function  
 <a name="getERC20TransferableReceivableContract"></a>
 
 ## getERC20TransferableReceivableContract(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>
@@ -311,6 +323,44 @@ associated with the given pool name on the current chain.</p>
 | poolName | <code>POOL\_NAME</code> | <p>The name of the pool contract to get.</p> |
 | poolType | <code>POOL\_TYPE</code> | <p>The type of the pool contract to get.</p> |
 
+<a name="drawdownFromPool"></a>
+
+## drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount, gasOpts) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Calls drawdown on a Huma pool contract</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> |
+| chainId | <code>number</code> | <p>The chain ID of the pool to call drawdown on. Used to lookup the pool address.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to mint the receivable token from. Used to lookup the pool address.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the credit pool to mint the receivable token from. Used to lookup the pool address.</p> |
+| drawdownAmount | <code>BigNumberish</code> | <p>The amount of tokens to withdraw, denominated in the ERC20 tokens of the pool.</p> |
+| gasOpts | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
+<a name="makePaymentToPool"></a>
+
+## makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount, gasOpts) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
+<p>Calls drawdown on a Huma pool contract</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> |
+| chainId | <code>number</code> | <p>The chain ID of the pool to call drawdown on. Used to lookup the pool address.</p> |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to mint the receivable token from. Used to lookup the pool address.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the credit pool to mint the receivable token from. Used to lookup the pool address.</p> |
+| paymentAmount | <code>BigNumberish</code> | <p>The amount of tokens to payback, denominated in the ERC20 tokens of the pool.</p> |
+| gasOpts | <code>Overrides</code> | <p>The gas options to use for the transaction.</p> |
+
 <a name="getRealWorldReceivableContract"></a>
 
 ## getRealWorldReceivableContract(signerOrProvider, chainId) ⇒ <code>Contract</code> \| <code>null</code>

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

@@ -1,4 +1,5 @@
-import { BigNumberish, Contract, ethers } from 'ethers';
+import { BigNumber } from '@ethersproject/bignumber';
+import { BigNumberish, Contract, Overrides, ethers } from 'ethers';
 import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
 import { TransactionResponse } from '@ethersproject/providers';
 /**
@@ -11,5 +12,93 @@ import { TransactionResponse } from '@ethersproject/providers';
  * @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 drawdownFromPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, drawdownAmount: BigNumberish): Promise<TransactionResponse>;
-export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish): Promise<TransactionResponse>;
+/**
+ * Return type of getCreditRecord
+ *
+ * @memberof getCreditRecord
+ * @typedef {Object} CreditRecord
+ * @property {BigNumber} unbilledPrincipal - The amount of principal not included in the bill
+ * @property {BigNumber} dueDate - Unix timestamp due date of the next payment
+ * @property {BigNumber} correction - the adjustment of interest over or under-counted because of drawdown
+ *  or principal payment in the middle of a billing period
+ * @property {BigNumber} totalDue - The due amount of the next payment
+ * @property {BigNumber} feesAndInterestDue - Interest and fees due for the next payment
+ * @property {number} missedPeriods - # of consecutive missed payments, for default processing
+ * @property {number} remainingPeriods - # of payment periods until the maturity of the credit line
+ * @property {number} state - status of the credit line.
+ *  For more info: https://github.com/00labs/huma-contracts/blob/b075a8f957de281e0885e37dbd72a422b6a54a38/contracts/libraries/BaseStructs.sol#L49
+ */
+export type CreditRecord = [
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    number,
+    number,
+    number
+] & {
+    unbilledPrincipal: BigNumber;
+    dueDate: BigNumber;
+    correction: BigNumber;
+    totalDue: BigNumber;
+    feesAndInterestDue: BigNumber;
+    missedPeriods: number;
+    remainingPeriods: number;
+    state: number;
+};
+/**
+ * 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.
+ */
+export declare function getCreditRecord(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<CreditRecord>;
+/**
+ * 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.
+ */
+export declare function getTotalDue(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<BigNumber>;
+/**
+ * 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.
+ */
+export declare function drawdownFromPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, drawdownAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * 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.
+ */
+export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;

package/dist/cjs/helpers/PoolContractHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makePaymentToPool = exports.drawdownFromPool = exports.getPoolContract = void 0;
+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
@@ -18,22 +18,86 @@ function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
     return (0, utils_1.getContract)(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
 }
 exports.getPoolContract = getPoolContract;
-function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount) {
+/**
+ * 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.
+ */
+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');
     }
     // TODO: Generate typechain for pool contract
-    return poolContract.drawdown(drawdownAmount);
+    return poolContract.drawdown(drawdownAmount, gasOpts);
 }
 exports.drawdownFromPool = drawdownFromPool;
-async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount) {
+/**
+ * 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');
     }
     // TODO: Generate typechain for pool contract
-    return poolContract.makePayment(await signer.getAddress(), paymentAmount);
+    return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
 }
 exports.makePaymentToPool = makePaymentToPool;
 //# 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":";;;AAIA,oCAAmD;AAEnD;;;;;;;;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;AAED,SAAgB,gBAAgB,CAC9B,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,cAA4B;IAE5B,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;AAC9C,CAAC;AAfD,4CAeC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B;IAE3B,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAAC,MAAM,MAAM,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,CAAA;AAC3E,CAAC;AAfD,8CAeC"}
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAKA,oCAAmD;AAEnD;;;;;;;;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;AACH,SAAgB,gBAAgB,CAC9B,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAhBD,4CAgBC;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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AApBD,8CAoBC"}

package/dist/cjs/services/ARWeaveService.js

@@ -104,22 +104,22 @@ async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true
 async function queryForMetadata(chainId, sender, referenceId) {
     var _a, _b, _c, _d;
     const config = getBundlrNetworkConfig(chainId);
-    const query = (0, graphql_request_1.gql) `
-    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
-      transactions(
-        owners: [$sender]
-        tags: [
-          { name: "appName", values: ["HumaFinance"] }
-          { name: "referenceId", values: [$referenceId] }
-        ]
-      ) {
-        edges {
-          node {
-            id
-          }
-        }
-      }
-    }
+    const query = (0, graphql_request_1.gql) `
+    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
+      transactions(
+        owners: [$sender]
+        tags: [
+          { name: "appName", values: ["HumaFinance"] }
+          { name: "referenceId", values: [$referenceId] }
+        ]
+      ) {
+        edges {
+          node {
+            id
+          }
+        }
+      }
+    }
   `;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const data = await (0, graphql_request_1.default)(`${config.nodeUrl}/graphql`, query, {

package/dist/cjs/services/ReceivableService.js

@@ -29,16 +29,16 @@ async function declareReceivablePaymentByReferenceId(signer, referenceId, paymen
     // Get ARWeave ID
     const dataID = await ARWeaveService_1.ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
     // Fetch receivables with the same ARWeave ID
-    const receivablesQuery = (0, graphql_request_1.gql) `
-    query ReceivablesByURIQuery($owner: String!, $uri: String!) {
-      receivables(where: { owner: $owner, uri: $uri }) {
-        ...ReceivableFields
-      }
-    }
-
-    fragment ReceivableFields on Receivable {
-      tokenId
-    }
+    const receivablesQuery = (0, graphql_request_1.gql) `
+    query ReceivablesByURIQuery($owner: String!, $uri: String!) {
+      receivables(where: { owner: $owner, uri: $uri }) {
+        ...ReceivableFields
+      }
+    }
+
+    fragment ReceivableFields on Receivable {
+      tokenId
+    }
   `;
     let receivableSubgraph;
     switch (chainId) {
@@ -56,7 +56,7 @@ async function declareReceivablePaymentByReferenceId(signer, referenceId, paymen
         throw new Error('No receivables found with this ARWeave ID.');
     }
     else if (((_b = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _b === void 0 ? void 0 : _b.length) > 1) {
-        throw new Error(`This owner has multiple receivables with the same URI. Please burn 
+        throw new Error(`This owner has multiple receivables with the same URI. Please burn 
       unnecessary receivables or pay the correct token manually using declareReceivablePaymentByTokenId`);
     }
     const contract = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);

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

@@ -1,7 +1,6 @@
 import { POOL_NAME, POOL_TYPE, PoolInfoType } from '@huma-finance/shared';
 /**
  * Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The Web3 provider or signer.
  * @param {POOL_NAME} poolName - The name of the pool.
  * @param {POOL_TYPE} poolType - The type of the pool.
  * @returns {PoolInfoType|undefined} - The pool info or undefined if the chain ID is not supported.

package/dist/cjs/utils/poolInfo.js

@@ -4,7 +4,6 @@ exports.getPoolInfo = void 0;
 const shared_1 = require("@huma-finance/shared");
 /**
  * Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The Web3 provider or signer.
  * @param {POOL_NAME} poolName - The name of the pool.
  * @param {POOL_TYPE} poolType - The type of the pool.
  * @returns {PoolInfoType|undefined} - The pool info or undefined if the chain ID is not supported.

package/dist/cjs/utils/poolInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"poolInfo.js","sourceRoot":"","sources":["../../../src/utils/poolInfo.ts"],"names":[],"mappings":";;;AAAA,iDAK6B;AAE7B;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACO,EAAE,eAAC,OAAA,MAAA,MAAA,wBAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC,CAAA,EAAA,CAAA;AAJlE,QAAA,WAAW,eAIuD"}
+{"version":3,"file":"poolInfo.js","sourceRoot":"","sources":["../../../src/utils/poolInfo.ts"],"names":[],"mappings":";;;AAAA,iDAK6B;AAE7B;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACO,EAAE,eAAC,OAAA,MAAA,MAAA,wBAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC,CAAA,EAAA,CAAA;AAJlE,QAAA,WAAW,eAIuD"}

package/dist/helpers/PoolContractHelper.d.ts

@@ -1,4 +1,5 @@
-import { BigNumberish, Contract, ethers } from 'ethers';
+import { BigNumber } from '@ethersproject/bignumber';
+import { BigNumberish, Contract, Overrides, ethers } from 'ethers';
 import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
 import { TransactionResponse } from '@ethersproject/providers';
 /**
@@ -11,5 +12,93 @@ import { TransactionResponse } from '@ethersproject/providers';
  * @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 drawdownFromPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, drawdownAmount: BigNumberish): Promise<TransactionResponse>;
-export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish): Promise<TransactionResponse>;
+/**
+ * Return type of getCreditRecord
+ *
+ * @memberof getCreditRecord
+ * @typedef {Object} CreditRecord
+ * @property {BigNumber} unbilledPrincipal - The amount of principal not included in the bill
+ * @property {BigNumber} dueDate - Unix timestamp due date of the next payment
+ * @property {BigNumber} correction - the adjustment of interest over or under-counted because of drawdown
+ *  or principal payment in the middle of a billing period
+ * @property {BigNumber} totalDue - The due amount of the next payment
+ * @property {BigNumber} feesAndInterestDue - Interest and fees due for the next payment
+ * @property {number} missedPeriods - # of consecutive missed payments, for default processing
+ * @property {number} remainingPeriods - # of payment periods until the maturity of the credit line
+ * @property {number} state - status of the credit line.
+ *  For more info: https://github.com/00labs/huma-contracts/blob/b075a8f957de281e0885e37dbd72a422b6a54a38/contracts/libraries/BaseStructs.sol#L49
+ */
+export type CreditRecord = [
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    number,
+    number,
+    number
+] & {
+    unbilledPrincipal: BigNumber;
+    dueDate: BigNumber;
+    correction: BigNumber;
+    totalDue: BigNumber;
+    feesAndInterestDue: BigNumber;
+    missedPeriods: number;
+    remainingPeriods: number;
+    state: number;
+};
+/**
+ * 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.
+ */
+export declare function getCreditRecord(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<CreditRecord>;
+/**
+ * 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.
+ */
+export declare function getTotalDue(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<BigNumber>;
+/**
+ * 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.
+ */
+export declare function drawdownFromPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, drawdownAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * 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.
+ */
+export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;

package/dist/helpers/PoolContractHelper.js

@@ -14,20 +14,82 @@ export function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
         return null;
     return getContract(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
 }
-export function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount) {
+/**
+ * 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.
+ */
+export 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);
+}
+/**
+ * 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.
+ */
+export async function getTotalDue(address, signerOrProvider, chainId, poolName, poolType) {
+    const creditRecord = await getCreditRecord(address, signerOrProvider, chainId, poolName, poolType);
+    return creditRecord.totalDue;
+}
+/**
+ * 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.
+ */
+export 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');
     }
     // TODO: Generate typechain for pool contract
-    return poolContract.drawdown(drawdownAmount);
+    return poolContract.drawdown(drawdownAmount, gasOpts);
 }
-export async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount) {
+/**
+ * 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.
+ */
+export 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');
     }
     // TODO: Generate typechain for pool contract
-    return poolContract.makePayment(await signer.getAddress(), paymentAmount);
+    return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
 }
 //# sourceMappingURL=PoolContractHelper.js.map

package/dist/helpers/PoolContractHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEnD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,cAA4B;IAE5B,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;AAC9C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B;IAE3B,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAAC,MAAM,MAAM,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC,CAAA;AAC3E,CAAC"}
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEnD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAsCD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,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;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,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;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAC9B,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,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,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC"}

package/dist/services/ARWeaveService.js

@@ -99,22 +99,22 @@ async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true
 async function queryForMetadata(chainId, sender, referenceId) {
     var _a, _b, _c, _d;
     const config = getBundlrNetworkConfig(chainId);
-    const query = gql `
-    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
-      transactions(
-        owners: [$sender]
-        tags: [
-          { name: "appName", values: ["HumaFinance"] }
-          { name: "referenceId", values: [$referenceId] }
-        ]
-      ) {
-        edges {
-          node {
-            id
-          }
-        }
-      }
-    }
+    const query = gql `
+    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
+      transactions(
+        owners: [$sender]
+        tags: [
+          { name: "appName", values: ["HumaFinance"] }
+          { name: "referenceId", values: [$referenceId] }
+        ]
+      ) {
+        edges {
+          node {
+            id
+          }
+        }
+      }
+    }
   `;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const data = await request(`${config.nodeUrl}/graphql`, query, {