@huma-finance/sdk 0.0.36 → 0.0.38-beta.0

package/API.md

@@ -54,19 +54,6 @@ Note that this does not approve a creditline in Huma's pools and an approve call
 <dd><p>Get the chain ID from a signer or provider object.</p></dd>
 <dt><a href="#getPoolInfo">getPoolInfo(poolName, poolType)</a> ⇒ <code>PoolInfoType</code> | <code>undefined</code></dt>
 <dd><p>Returns the pool info based on the provided pool name and type, using the same chain ID as the provider/signer given</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="#getCreditRecord">getCreditRecord(address, signerOrProvider, chainId, poolName, poolType)</a> ⇒ <code>Promise.&lt;CreditRecord&gt;</code></dt>
-<dd><p>Gets the credit record of a wallet in a Huma pool. Denominated in the ERC20 tokens of the pool.</p></dd>
-<dt><a href="#getTotalDue">getTotalDue(address, signerOrProvider, chainId, poolName, poolType)</a> ⇒ <code>Promise.&lt;BigNumber&gt;</code></dt>
-<dd><p>Gets the total due for a Huma pool of the given wallet. Denominated in the ERC20 tokens of the pool.</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 makePayment on a Huma pool contract. If the pool does not have sufficient allowance to complete the operation,
-attempt to first increase the allowance of the pool.</p></dd>
-<dt><a href="#approvePoolAllowance">approvePoolAllowance(signer, chainId, poolName, poolType, allowanceAmount, [gasOpts])</a> ⇒ <code>Promise.&lt;TransactionResponse&gt;</code></dt>
-<dd><p>Approves an allowance for a Huma pool contract, which is required to do certain actions (e.g. makePayment)</p></dd>
 </dl>
 
 ## Typedefs
@@ -417,30 +404,6 @@ associated with the given pool name on the current chain.</p>
 | poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool. Used to lookup the pool address.</p> |
 | poolType | <code>POOL\_TYPE</code> | <p>The type of the credit pool. Used to lookup the pool address.</p> |
 
-
-* [getCreditRecord(address, signerOrProvider, chainId, poolName, poolType)](#getCreditRecord) ⇒ <code>Promise.&lt;CreditRecord&gt;</code>
-    * [.CreditRecord](#getCreditRecord.CreditRecord) : <code>Object</code>
-    * [.CreditRecord](#getCreditRecord.CreditRecord) : <code>Object</code>
-
-<a name="getCreditRecord.CreditRecord"></a>
-
-### getCreditRecord.CreditRecord : <code>Object</code>
-<p>Return type of getCreditRecord</p>
-
-**Kind**: static typedef of [<code>getCreditRecord</code>](#getCreditRecord)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| unbilledPrincipal | <code>BigNumber</code> | <p>The amount of principal not included in the bill</p> |
-| dueDate | <code>BigNumber</code> | <p>Unix timestamp due date of the next payment</p> |
-| correction | <code>BigNumber</code> | <p>the adjustment of interest over or under-counted because of drawdown or principal payment in the middle of a billing period</p> |
-| totalDue | <code>BigNumber</code> | <p>The due amount of the next payment</p> |
-| feesAndInterestDue | <code>BigNumber</code> | <p>Interest and fees due for the next payment</p> |
-| missedPeriods | <code>number</code> | <h1>of consecutive missed payments, for default processing</h1> |
-| remainingPeriods | <code>number</code> | <h1>of payment periods until the maturity of the credit line</h1> |
-| state | <code>number</code> | <p>status of the credit line. For more info: https://github.com/00labs/huma-contracts/blob/b075a8f957de281e0885e37dbd72a422b6a54a38/contracts/libraries/BaseStructs.sol#L49</p> |
-
 <a name="getCreditRecord.CreditRecord"></a>
 
 ### getCreditRecord.CreditRecord : <code>Object</code>
@@ -650,158 +613,6 @@ Note that this does not approve a creditline in Huma's pools and an approve call
 | 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="getPoolContract"></a>
-
-## getPoolContract(signerOrProvider, chainId, poolName, poolType) ⇒ <code>Contract</code> \| <code>null</code>
-<p>Returns an ethers contract instance for a Huma pool contract</p>
-
-**Kind**: global function  
-**Returns**: <code>Contract</code> \| <code>null</code> - <p>A contract instance for the Pool 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> |
-| 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="getCreditRecord"></a>
-
-## getCreditRecord(address, signerOrProvider, chainId, poolName, poolType) ⇒ <code>Promise.&lt;CreditRecord&gt;</code>
-<p>Gets the credit record of a wallet in a Huma pool. Denominated in the ERC20 tokens of the pool.</p>
-
-**Kind**: global function  
-**Returns**: <code>Promise.&lt;CreditRecord&gt;</code> - <ul>
-<li>A Promise of the transaction response.</li>
-</ul>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| address | <code>string</code> | <p>The address to lookup.</p> |
-| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The signer or provider used to read data.</p> |
-| chainId | <code>number</code> | <p>The chain ID of the pool. Used to lookup the pool address.</p> |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool. Used to lookup the pool address.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the credit pool. Used to lookup the pool address.</p> |
-
-
-* [getCreditRecord(address, signerOrProvider, chainId, poolName, poolType)](#getCreditRecord) ⇒ <code>Promise.&lt;CreditRecord&gt;</code>
-    * [.CreditRecord](#getCreditRecord.CreditRecord) : <code>Object</code>
-    * [.CreditRecord](#getCreditRecord.CreditRecord) : <code>Object</code>
-
-<a name="getCreditRecord.CreditRecord"></a>
-
-### getCreditRecord.CreditRecord : <code>Object</code>
-<p>Return type of getCreditRecord</p>
-
-**Kind**: static typedef of [<code>getCreditRecord</code>](#getCreditRecord)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| unbilledPrincipal | <code>BigNumber</code> | <p>The amount of principal not included in the bill</p> |
-| dueDate | <code>BigNumber</code> | <p>Unix timestamp due date of the next payment</p> |
-| correction | <code>BigNumber</code> | <p>the adjustment of interest over or under-counted because of drawdown or principal payment in the middle of a billing period</p> |
-| totalDue | <code>BigNumber</code> | <p>The due amount of the next payment</p> |
-| feesAndInterestDue | <code>BigNumber</code> | <p>Interest and fees due for the next payment</p> |
-| missedPeriods | <code>number</code> | <h1>of consecutive missed payments, for default processing</h1> |
-| remainingPeriods | <code>number</code> | <h1>of payment periods until the maturity of the credit line</h1> |
-| state | <code>number</code> | <p>status of the credit line. For more info: https://github.com/00labs/huma-contracts/blob/b075a8f957de281e0885e37dbd72a422b6a54a38/contracts/libraries/BaseStructs.sol#L49</p> |
-
-<a name="getCreditRecord.CreditRecord"></a>
-
-### getCreditRecord.CreditRecord : <code>Object</code>
-<p>Return type of getCreditRecord</p>
-
-**Kind**: static typedef of [<code>getCreditRecord</code>](#getCreditRecord)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| unbilledPrincipal | <code>BigNumber</code> | <p>The amount of principal not included in the bill</p> |
-| dueDate | <code>BigNumber</code> | <p>Unix timestamp due date of the next payment</p> |
-| correction | <code>BigNumber</code> | <p>the adjustment of interest over or under-counted because of drawdown or principal payment in the middle of a billing period</p> |
-| totalDue | <code>BigNumber</code> | <p>The due amount of the next payment</p> |
-| feesAndInterestDue | <code>BigNumber</code> | <p>Interest and fees due for the next payment</p> |
-| missedPeriods | <code>number</code> | <h1>of consecutive missed payments, for default processing</h1> |
-| remainingPeriods | <code>number</code> | <h1>of payment periods until the maturity of the credit line</h1> |
-| state | <code>number</code> | <p>status of the credit line. For more info: https://github.com/00labs/huma-contracts/blob/b075a8f957de281e0885e37dbd72a422b6a54a38/contracts/libraries/BaseStructs.sol#L49</p> |
-
-<a name="getTotalDue"></a>
-
-## getTotalDue(address, signerOrProvider, chainId, poolName, poolType) ⇒ <code>Promise.&lt;BigNumber&gt;</code>
-<p>Gets the total due for a Huma pool of the given wallet. Denominated in the ERC20 tokens of the pool.</p>
-
-**Kind**: global function  
-**Returns**: <code>Promise.&lt;BigNumber&gt;</code> - <ul>
-<li>A Promise of the transaction response.</li>
-</ul>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| address | <code>string</code> | <p>The address to lookup.</p> |
-| signerOrProvider | <code>ethers.providers.Provider</code> \| <code>ethers.Signer</code> | <p>The signer or provider used to read data.</p> |
-| chainId | <code>number</code> | <p>The chain ID of the pool. Used to lookup the pool address.</p> |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool. Used to lookup the pool address.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the credit pool. Used to lookup the pool address.</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 makePayment on a Huma pool contract. If the pool does not have sufficient allowance to complete the operation,
-attempt to first increase the allowance of the pool.</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="approvePoolAllowance"></a>
-
-## approvePoolAllowance(signer, chainId, poolName, poolType, allowanceAmount, [gasOpts]) ⇒ <code>Promise.&lt;TransactionResponse&gt;</code>
-<p>Approves an allowance for a Huma pool contract, which is required to do certain actions (e.g. makePayment)</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> |
-| allowanceAmount | <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="ApprovalResult"></a>
 
 ## ApprovalResult : <code>Object</code>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huma-finance/sdk",
-  "version": "0.0.36",
+  "version": "0.0.38-beta.0+6ab0460",
   "types": "./dist/index.d.ts",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -28,7 +28,7 @@
     "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.6.0",
-    "@huma-finance/shared": "^0.0.36",
+    "@huma-finance/shared": "^0.0.38-beta.0+6ab0460",
     "arweave": "^1.13.5",
     "axios": "^1.4.0",
     "bignumber.js": "^9.1.1",
@@ -110,5 +110,5 @@
   "optionalDependencies": {
     "encoding": "^0.1.13"
   },
-  "gitHead": "caf50f604219c37f37e17d519aae730144798a11"
+  "gitHead": "6ab046042364e2516f1054e7e82c2811708b771d"
 }

package/dist/cjs/graphql/generatedTypes.d.ts

@@ -1,40 +0,0 @@
-import { GraphQLClient } from 'graphql-request';
-export type Maybe<T> = T | null;
-export type InputMaybe<T> = Maybe<T>;
-export type Exact<T extends {
-    [key: string]: unknown;
-}> = {
-    [K in keyof T]: T[K];
-};
-export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
-    [SubKey in K]?: Maybe<T[SubKey]>;
-};
-export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
-    [SubKey in K]: Maybe<T[SubKey]>;
-};
-/** All built-in and custom scalars, mapped to their actual values */
-export type Scalars = {
-    ID: string;
-    String: string;
-    Boolean: boolean;
-    Int: number;
-    Float: number;
-};
-export type Receivable = {
-    __typename?: 'Receivable';
-    creationDate?: Maybe<Scalars['String']>;
-    currencyCode?: Maybe<Scalars['String']>;
-    id?: Maybe<Scalars['String']>;
-    lastUpdate?: Maybe<Scalars['String']>;
-    maturityDate?: Maybe<Scalars['String']>;
-    owner?: Maybe<Scalars['String']>;
-    paidAmount?: Maybe<Scalars['String']>;
-    pool?: Maybe<Scalars['String']>;
-    receivableAmount?: Maybe<Scalars['String']>;
-    status?: Maybe<Scalars['String']>;
-    tokenId?: Maybe<Scalars['String']>;
-    uri?: Maybe<Scalars['String']>;
-};
-export type SdkFunctionWrapper = <T>(action: (requestHeaders?: Record<string, string>) => Promise<T>, operationName: string, operationType?: string) => Promise<T>;
-export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper): {};
-export type Sdk = ReturnType<typeof getSdk>;

package/dist/cjs/graphql/generatedTypes.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSdk = void 0;
-const defaultWrapper = (action, _operationName, _operationType) => action();
-function getSdk(client, withWrapper = defaultWrapper) {
-    return {};
-}
-exports.getSdk = getSdk;
-//# sourceMappingURL=generatedTypes.js.map

package/dist/cjs/graphql/generatedTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generatedTypes.js","sourceRoot":"","sources":["../../../src/graphql/generatedTypes.ts"],"names":[],"mappings":";;;AA8CA,MAAM,cAAc,GAAuB,CACzC,MAAM,EACN,cAAc,EACd,cAAc,EACd,EAAE,CAAC,MAAM,EAAE,CAAA;AAEb,SAAgB,MAAM,CACpB,MAAqB,EACrB,cAAkC,cAAc;IAEhD,OAAO,EAAE,CAAA;AACX,CAAC;AALD,wBAKC"}

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

@@ -1 +0,0 @@
-export * from './generatedTypes';

package/dist/cjs/graphql/index.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/graphql/index.ts"],"names":[],"mappings":";;;AAAA,2DAAgC"}

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

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

package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"ERC20TransferableReceivableContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/ERC20TransferableReceivableContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAI6B;AAE7B,oCAAsC;AAEtC;;;;;;;GAOG;AACH,SAAgB,sCAAsC,CACpD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,0BAA0B,GAC9B,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,2BAA2B,CACnD,CAAA;IAEH,IAAI,CAAC,0BAA0B;QAAE,OAAO,IAAI,CAAA;IAE5C,OAAO,IAAA,mBAAW,EAChB,0BAA0B,EAC1B,0CAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC;AAhBD,wFAgBC"}

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

@@ -1,119 +0,0 @@
-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';
-/**
- * Returns an ethers contract instance for a Huma pool contract
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName The name of the pool contract to get.
- * @param {POOL_TYPE} poolType The type of the pool contract to get.
- * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
- */
-export declare function getPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Contract | null;
-/**
- * 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 makePayment on a Huma pool contract. If the pool does not have sufficient allowance to complete the operation,
- * attempt to first increase the allowance of the pool.
- *
- * @async
- * @function
- * @param {ethers.Signer} signer - The signer used to send the transaction.
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {BigNumberish} paymentAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
- */
-export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
-/**
- * Approves an allowance for a Huma pool contract, which is required to do certain actions (e.g. makePayment)
- *
- * @async
- * @function
- * @param {ethers.Signer} signer - The signer used to send the transaction.
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {BigNumberish} allowanceAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
- */
-export declare function approvePoolAllowance(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, allowanceAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;

package/dist/cjs/helpers/PoolContractHelper.js

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

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

@@ -1 +0,0 @@
-{"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"}

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

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