@huma-finance/sdk 0.0.21 → 0.0.24

package/dist/helpers/ERC20TransferableReceivableContractHelper.js

@@ -1,18 +1,18 @@
-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);
-}
+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/PoolContractHelper.d.ts

@@ -1,104 +1,104 @@
-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 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>;
+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 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

@@ -1,97 +1,95 @@
-import { getContract, getPoolInfo, getDefaultGasOptions } 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 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');
-    }
-    gasOpts = await getDefaultGasOptions(gasOpts, chainId);
-    // TODO: Generate typechain for pool contract
-    return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
-}
+import { getContract, getPoolInfo } 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 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, gasOpts);
+}
+/**
+ * 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, 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":"AAKA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAEzE;;;;;;;;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;;;;;;;;;;;;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,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,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/helpers/RealWorldReceivableContractHelper.d.ts

@@ -1,10 +1,10 @@
-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;
+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 +1,18 @@
-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 realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
-    if (!realWorldReceivable)
-        return null;
-    return getContract(realWorldReceivable, REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
-}
+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 realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
+    if (!realWorldReceivable)
+        return null;
+    return getContract(realWorldReceivable, REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
 //# sourceMappingURL=RealWorldReceivableContractHelper.js.map

package/dist/helpers/index.d.ts

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

package/dist/helpers/index.js

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

package/dist/hooks/index.d.ts

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

package/dist/hooks/index.js

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

package/dist/hooks/useContract.d.ts

@@ -1,13 +1,13 @@
-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;
+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;