@huma-finance/sdk 0.0.37 → 0.0.38-beta.20

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

@@ -1 +0,0 @@
-{"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/cjs/utils/web3.d.ts

@@ -1,5 +0,0 @@
-import { Contract } from '@ethersproject/contracts';
-import { ethers } from 'ethers';
-export declare function isAddress(value: any): string | false;
-export declare function getContract(address: string, ABI: any, signerOrProvider: ethers.providers.Provider | ethers.Signer): Contract;
-export declare function getERC20Contract(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer): Contract;

package/dist/cjs/utils/web3.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getERC20Contract = exports.getContract = exports.isAddress = void 0;
-const contracts_1 = require("@ethersproject/contracts");
-const constants_1 = require("@ethersproject/constants");
-const address_1 = require("@ethersproject/address");
-const shared_1 = require("@huma-finance/shared");
-// returns the checksummed address if the address is valid, otherwise returns false
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function isAddress(value) {
-    try {
-        // Alphabetical letters must be made lowercase for getAddress to work.
-        // See documentation here: https://docs.ethers.io/v5/api/utils/address/
-        return (0, address_1.getAddress)(value.toLowerCase());
-    }
-    catch (_a) {
-        return false;
-    }
-}
-exports.isAddress = isAddress;
-function getContract(address, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-ABI, signerOrProvider) {
-    if (!isAddress(address) || address === constants_1.AddressZero) {
-        throw Error(`Invalid 'address' parameter '${address}'.`);
-    }
-    return new contracts_1.Contract(address, ABI, signerOrProvider);
-}
-exports.getContract = getContract;
-function getERC20Contract(address, signerOrProvider) {
-    return getContract(address, shared_1.ERC20_ABI, signerOrProvider);
-}
-exports.getERC20Contract = getERC20Contract;
-//# sourceMappingURL=web3.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"web3.js","sourceRoot":"","sources":["../../../src/utils/web3.ts"],"names":[],"mappings":";;;AAAA,wDAAmD;AACnD,wDAAsD;AACtD,oDAAmD;AAEnD,iDAAgD;AAEhD,mFAAmF;AACnF,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,KAAU;IAClC,IAAI;QACF,sEAAsE;QACtE,uEAAuE;QACvE,OAAO,IAAA,oBAAU,EAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;KACvC;IAAC,WAAM;QACN,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AARD,8BAQC;AAED,SAAgB,WAAW,CACzB,OAAe;AACf,8DAA8D;AAC9D,GAAQ,EACR,gBAA2D;IAE3D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,KAAK,uBAAW,EAAE;QAClD,MAAM,KAAK,CAAC,gCAAgC,OAAO,IAAI,CAAC,CAAA;KACzD;IAED,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAA;AACrD,CAAC;AAXD,kCAWC;AAED,SAAgB,gBAAgB,CAC9B,OAAe,EACf,gBAA2D;IAE3D,OAAO,WAAW,CAAC,OAAO,EAAE,kBAAS,EAAE,gBAAgB,CAAC,CAAA;AAC1D,CAAC;AALD,4CAKC"}

package/dist/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/graphql/generatedTypes.js

@@ -1,5 +0,0 @@
-const defaultWrapper = (action, _operationName, _operationType) => action();
-export function getSdk(client, withWrapper = defaultWrapper) {
-    return {};
-}
-//# sourceMappingURL=generatedTypes.js.map

package/dist/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,MAAM,UAAU,MAAM,CACpB,MAAqB,EACrB,cAAkC,cAAc;IAEhD,OAAO,EAAE,CAAA;AACX,CAAC"}

package/dist/graphql/index.d.ts

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

package/dist/graphql/index.js

@@ -1,2 +0,0 @@
-export * from './generatedTypes';
-//# sourceMappingURL=index.js.map

package/dist/graphql/index.js.map

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

package/dist/helpers/BaseCreditPoolReceivableContractHelper.d.ts

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

package/dist/helpers/BaseCreditPoolReceivableContractHelper.js

@@ -1,18 +0,0 @@
-import { BASE_CREDIT_POOL_RECEIVABLE_ABI, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
-import { getContract } from '../utils';
-/**
- * Returns an ethers contract instance for the BaseCreditPoolReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
- */
-export function getBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const baseCreditPoolReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.BaseCreditPoolReceivable];
-    if (!baseCreditPoolReceivable)
-        return null;
-    return getContract(baseCreditPoolReceivable, BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
-}
-//# sourceMappingURL=BaseCreditPoolReceivableContractHelper.js.map

package/dist/helpers/BaseCreditPoolReceivableContractHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseCreditPoolReceivableContractHelper.js","sourceRoot":"","sources":["../../src/helpers/BaseCreditPoolReceivableContractHelper.ts"],"names":[],"mappings":"AACA,OAAO,EACL,+BAA+B,EAC/B,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,IAAI,CAAC,wBAAwB;QAAE,OAAO,IAAI,CAAA;IAE1C,OAAO,WAAW,CAChB,wBAAwB,EACxB,+BAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC"}

package/dist/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/helpers/ERC20TransferableReceivableContractHelper.js

@@ -1,18 +0,0 @@
-import { ERC20_TRANSFERABLE_RECEIVABLE_ABI, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
-import { getContract } from '../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.
- */
-export function getERC20TransferableReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const erc20TransferableReceiable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.ERC20TransferableReceivable];
-    if (!erc20TransferableReceiable)
-        return null;
-    return getContract(erc20TransferableReceiable, ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
-}
-//# sourceMappingURL=ERC20TransferableReceivableContractHelper.js.map

package/dist/helpers/ERC20TransferableReceivableContractHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ERC20TransferableReceivableContractHelper.js","sourceRoot":"","sources":["../../src/helpers/ERC20TransferableReceivableContractHelper.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iCAAiC,EACjC,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;;;;GAOG;AACH,MAAM,UAAU,sCAAsC,CACpD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,0BAA0B,GAC9B,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,2BAA2B,CACnD,CAAA;IAEH,IAAI,CAAC,0BAA0B;QAAE,OAAO,IAAI,CAAA;IAE5C,OAAO,WAAW,CAChB,0BAA0B,EAC1B,iCAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC"}

package/dist/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/helpers/PoolContractHelper.js

@@ -1,135 +0,0 @@
-import { getContract, getPoolInfo, getDefaultGasOptions, getERC20Contract, } from '../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.
- */
-export function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
-    const poolInfo = getPoolInfo(chainId, poolName, poolType);
-    if (!poolInfo)
-        return null;
-    return getContract(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
-}
-/**
- * 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 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 getDefaultGasOptions(gasOpts, chainId);
-    // TODO: Generate typechain for pool contract
-    return poolContract.drawdown(drawdownAmount, gasOpts);
-}
-/**
- * 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 async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount, gasOpts = {}) {
-    const poolInfo = 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 = 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 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);
-}
-/**
- * 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 async function approvePoolAllowance(signer, chainId, poolName, poolType, allowanceAmount, gasOpts = {}) {
-    const poolInfo = 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 = 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 getDefaultGasOptions(gasOpts, chainId);
-    return poolTokenContract.approve(poolContract.address, allowanceAmount, gasOpts);
-}
-//# sourceMappingURL=PoolContractHelper.js.map

package/dist/helpers/PoolContractHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,WAAW,EACX,WAAW,EACX,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,UAAU,CAAA;AAEjB;;;;;;;;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,CAAC,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,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B,EAC3B,UAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,WAAW,CAAC,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,gBAAgB,CACxC,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,oBAAoB,CAAC,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;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,eAA6B,EAC7B,UAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,WAAW,CAAC,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,gBAAgB,CACxC,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,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,iBAAiB,CAAC,OAAO,CAC9B,YAAY,CAAC,OAAO,EACpB,eAAe,EACf,OAAO,CACR,CAAA;AACH,CAAC"}

package/dist/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;

package/dist/helpers/RealWorldReceivableContractHelper.js

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

package/dist/helpers/RealWorldReceivableContractHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RealWorldReceivableContractHelper.js","sourceRoot":"","sources":["../../src/helpers/RealWorldReceivableContractHelper.ts"],"names":[],"mappings":"AACA,OAAO,EACL,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B,CAC5C,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,oBAAoB,GACxB,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,oBAAoB;QAAE,OAAO,IAAI,CAAA;IAEtC,OAAO,WAAW,CAChB,oBAAoB,EACpB,yBAAyB,EACzB,gBAAgB,CACjB,CAAA;AACH,CAAC"}

package/dist/helpers/index.d.ts

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

package/dist/helpers/index.js

@@ -1,4 +0,0 @@
-export * from './RealWorldReceivableContractHelper';
-export * from './ERC20TransferableReceivableContractHelper';
-export * from './PoolContractHelper';
-//# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

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

package/dist/hooks/index.d.ts

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

package/dist/hooks/index.js

@@ -1,5 +0,0 @@
-export * from './useContract';
-export * from './useRealWorldReceivableContract';
-export * from './useERC20TransferableReceivableContract';
-export * from './usePoolContract';
-//# sourceMappingURL=index.js.map

package/dist/hooks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,kCAAkC,CAAA;AAChD,cAAc,0CAA0C,CAAA;AACxD,cAAc,mBAAmB,CAAA"}

package/dist/hooks/useBaseCreditPoolReceivableContract.d.ts

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

package/dist/hooks/useBaseCreditPoolReceivableContract.js

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

package/dist/hooks/useBaseCreditPoolReceivableContract.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useBaseCreditPoolReceivableContract.js","sourceRoot":"","sources":["../../src/hooks/useBaseCreditPoolReceivableContract.ts"],"names":[],"mappings":"AACA,OAAO,EACL,+BAA+B,EAE/B,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,OAAO,WAAW,CAChB,wBAAwB,EACxB,+BAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC"}

package/dist/hooks/useContract.d.ts

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

package/dist/hooks/useContract.js

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

package/dist/hooks/useContract.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useContract.js","sourceRoot":"","sources":["../../src/hooks/useContract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAG/B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CACzB,OAAkC;AAClC,8DAA8D;AAC9D,GAAQ,EACR,gBAA2D;IAE3D,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAA;QACtD,IAAI;YACF,OAAO,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAA;SACnD;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,IAAI,CAAA;SACZ;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAM,CAAA;AAC3C,CAAC"}

package/dist/hooks/useERC20TransferableReceivableContract.d.ts

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