@huma-finance/sdk 0.0.11 → 0.0.13

package/dist/helpers/PoolContractHelper.js

@@ -1,17 +1,59 @@
-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);
-}
+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);
+}
+/**
+ * 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":"AAGA,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"}
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEnD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAED;;;;;;;;;;;;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;

package/dist/hooks/useContract.js

@@ -1,27 +1,27 @@
-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]);
-}
+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/useERC20TransferableReceivableContract.d.ts

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

package/dist/hooks/useERC20TransferableReceivableContract.js

@@ -1,17 +1,17 @@
-import { ERC20_TRANSFERABLE_RECEIVABLE_ABI, POOL_TYPE, PoolContractMap, } from '@huma-finance/shared';
-import { useContract } from './useContract';
-/**
- * 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 function useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) {
-    var _a, _b, _c;
-    const TransferableReceivableAddress = (_c = (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress;
-    return useContract(TransferableReceivableAddress, ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
-}
+import { ERC20_TRANSFERABLE_RECEIVABLE_ABI, POOL_TYPE, PoolContractMap, } from '@huma-finance/shared';
+import { useContract } from './useContract';
+/**
+ * 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 function useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) {
+    var _a, _b, _c;
+    const TransferableReceivableAddress = (_c = (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress;
+    return useContract(TransferableReceivableAddress, ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
+}
 //# sourceMappingURL=useERC20TransferableReceivableContract.js.map

package/dist/hooks/usePoolContract.d.ts

@@ -1,60 +1,60 @@
-import { BigNumber } from '@ethersproject/bignumber';
-import { Contract, ethers } from 'ethers';
-import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
-/**
- * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
- *
- * @namespace usePoolContract
- * @template T - The type of the contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName - The name of the pool.
- * @param {POOL_TYPE} poolType - The type of the pool.
- * @returns {T} A contract instance of the specific pool.
- */
-export declare function usePoolContract<T extends Contract>(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): T | null;
-/**
- * CreditRecordDetails type object representing the details of a credit line.
- *
- * @memberof usePoolContract
- * @typedef {Object} CreditRecordDetails
- * @property {number} aprInBps - The APR (annual percentage rate) in basis points.
- * @property {BigNumber} correction - adjustment of interest over or under-counted because of drawdown
- *  or principal payment in the middle of a billing period
- * @property {BigNumber} creditLimit - The credit limit in the pools base currency.
- * @property {BigNumber} defaultAmount - The amount of the default, if any.
- * @property {BigNumber} dueDate - The due date of the next payment.
- * @property {BigNumber} feesAndInterestDue - The fees and interest due.
- * @property {number} intervalInDays - The interval in days between payment periods.
- * @property {number} missedPeriods - The number of missed periods.
- * @property {number} remainingPeriods - The number of remaining periods before this credit line is considered paid off.
- * @property {number} state - The state of the factorization. Please see the CreditState in huma-contracts for more details.
- * @property {BigNumber} totalDue - The total due amount of this credit line.
- * @property {BigNumber} unbilledPrincipal - The unbilled principal of the next payment.
- */
-export type CreditRecordDetails = {
-    aprInBps: number;
-    correction: BigNumber;
-    creditLimit: BigNumber;
-    defaultAmount: BigNumber;
-    dueDate: BigNumber;
-    feesAndInterestDue: BigNumber;
-    intervalInDays: number;
-    missedPeriods: number;
-    remainingPeriods: number;
-    state: number;
-    totalDue: BigNumber;
-    unbilledPrincipal: BigNumber;
-};
-/**
- * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
- *
- * @memberof usePoolContract
- * @param {string} userAddress - The address of the user to get the credit record details for.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object 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 credit record details for.
- * @param {POOL_TYPE} poolType - The type of the pool.
- * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
- */
-export declare function useCreditRecordDetails(userAddress: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): [CreditRecordDetails | undefined, () => void];
+import { BigNumber } from '@ethersproject/bignumber';
+import { Contract, ethers } from 'ethers';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+/**
+ * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
+ *
+ * @namespace usePoolContract
+ * @template T - The type of the contract.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {T} A contract instance of the specific pool.
+ */
+export declare function usePoolContract<T extends Contract>(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): T | null;
+/**
+ * CreditRecordDetails type object representing the details of a credit line.
+ *
+ * @memberof usePoolContract
+ * @typedef {Object} CreditRecordDetails
+ * @property {number} aprInBps - The APR (annual percentage rate) in basis points.
+ * @property {BigNumber} correction - adjustment of interest over or under-counted because of drawdown
+ *  or principal payment in the middle of a billing period
+ * @property {BigNumber} creditLimit - The credit limit in the pools base currency.
+ * @property {BigNumber} defaultAmount - The amount of the default, if any.
+ * @property {BigNumber} dueDate - The due date of the next payment.
+ * @property {BigNumber} feesAndInterestDue - The fees and interest due.
+ * @property {number} intervalInDays - The interval in days between payment periods.
+ * @property {number} missedPeriods - The number of missed periods.
+ * @property {number} remainingPeriods - The number of remaining periods before this credit line is considered paid off.
+ * @property {number} state - The state of the factorization. Please see the CreditState in huma-contracts for more details.
+ * @property {BigNumber} totalDue - The total due amount of this credit line.
+ * @property {BigNumber} unbilledPrincipal - The unbilled principal of the next payment.
+ */
+export type CreditRecordDetails = {
+    aprInBps: number;
+    correction: BigNumber;
+    creditLimit: BigNumber;
+    defaultAmount: BigNumber;
+    dueDate: BigNumber;
+    feesAndInterestDue: BigNumber;
+    intervalInDays: number;
+    missedPeriods: number;
+    remainingPeriods: number;
+    state: number;
+    totalDue: BigNumber;
+    unbilledPrincipal: BigNumber;
+};
+/**
+ * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
+ *
+ * @memberof usePoolContract
+ * @param {string} userAddress - The address of the user to get the credit record details for.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object 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 credit record details for.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
+ */
+export declare function useCreditRecordDetails(userAddress: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): [CreditRecordDetails | undefined, () => void];

package/dist/hooks/usePoolContract.js

@@ -1,49 +1,49 @@
-import { useCallback, useEffect, useState } from 'react';
-import { useContract } from './useContract';
-import { getPoolInfo } from '../utils/poolInfo';
-/**
- * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
- *
- * @namespace usePoolContract
- * @template T - The type of the contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName - The name of the pool.
- * @param {POOL_TYPE} poolType - The type of the pool.
- * @returns {T} A contract instance of the specific pool.
- */
-export function usePoolContract(signerOrProvider, chainId, poolName, poolType) {
-    const poolInfo = getPoolInfo(chainId, poolName, poolType);
-    return useContract(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.pool, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolAbi, signerOrProvider);
-}
-/**
- * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
- *
- * @memberof usePoolContract
- * @param {string} userAddress - The address of the user to get the credit record details for.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object 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 credit record details for.
- * @param {POOL_TYPE} poolType - The type of the pool.
- * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
- */
-export function useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) {
-    const poolContract = usePoolContract(signerOrProvider, chainId, poolName, poolType);
-    const [creditRecordDetails, setCreditRecordDetails] = useState();
-    const [refreshCount, setRefreshCount] = useState(0);
-    useEffect(() => {
-        const fetchData = async () => {
-            if (poolContract && userAddress) {
-                const creditRecordMapping = await poolContract.creditRecordMapping(userAddress);
-                const creditRecordStaticMapping = await poolContract.creditRecordStaticMapping(userAddress);
-                setCreditRecordDetails(Object.assign(Object.assign({}, creditRecordMapping), creditRecordStaticMapping));
-            }
-        };
-        fetchData();
-    }, [userAddress, poolContract, refreshCount]);
-    const refresh = useCallback(() => {
-        setRefreshCount((pre) => pre + 1);
-    }, []);
-    return [creditRecordDetails, refresh];
-}
+import { useCallback, useEffect, useState } from 'react';
+import { useContract } from './useContract';
+import { getPoolInfo } from '../utils/poolInfo';
+/**
+ * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
+ *
+ * @namespace usePoolContract
+ * @template T - The type of the contract.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {T} A contract instance of the specific pool.
+ */
+export function usePoolContract(signerOrProvider, chainId, poolName, poolType) {
+    const poolInfo = getPoolInfo(chainId, poolName, poolType);
+    return useContract(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.pool, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolAbi, signerOrProvider);
+}
+/**
+ * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
+ *
+ * @memberof usePoolContract
+ * @param {string} userAddress - The address of the user to get the credit record details for.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object 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 credit record details for.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
+ */
+export function useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) {
+    const poolContract = usePoolContract(signerOrProvider, chainId, poolName, poolType);
+    const [creditRecordDetails, setCreditRecordDetails] = useState();
+    const [refreshCount, setRefreshCount] = useState(0);
+    useEffect(() => {
+        const fetchData = async () => {
+            if (poolContract && userAddress) {
+                const creditRecordMapping = await poolContract.creditRecordMapping(userAddress);
+                const creditRecordStaticMapping = await poolContract.creditRecordStaticMapping(userAddress);
+                setCreditRecordDetails(Object.assign(Object.assign({}, creditRecordMapping), creditRecordStaticMapping));
+            }
+        };
+        fetchData();
+    }, [userAddress, poolContract, refreshCount]);
+    const refresh = useCallback(() => {
+        setRefreshCount((pre) => pre + 1);
+    }, []);
+    return [creditRecordDetails, refresh];
+}
 //# sourceMappingURL=usePoolContract.js.map

package/dist/hooks/useRealWorldReceivableContract.d.ts

@@ -1,10 +1,10 @@
-import { Contract, ethers } from 'ethers';
-/**
- * A react hook that 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 useRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;
+import { Contract, ethers } from 'ethers';
+/**
+ * A react hook that 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 useRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/hooks/useRealWorldReceivableContract.js

@@ -1,16 +1,16 @@
-import { REAL_WORLD_RECEIVABLE_ABI, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
-import { useContract } from './useContract';
-/**
- * A react hook that 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 useRealWorldReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
-    return useContract(realWorldReceivable, REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
-}
+import { REAL_WORLD_RECEIVABLE_ABI, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
+import { useContract } from './useContract';
+/**
+ * A react hook that 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 useRealWorldReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
+    return useContract(realWorldReceivable, REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
 //# sourceMappingURL=useRealWorldReceivableContract.js.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from './helpers';
-export * from './hooks';
-export * from './services';
-export * from './utils';
+export * from './helpers';
+export * from './hooks';
+export * from './services';
+export * from './utils';

package/dist/index.js

@@ -1,5 +1,5 @@
-export * from './helpers';
-export * from './hooks';
-export * from './services';
-export * from './utils';
+export * from './helpers';
+export * from './hooks';
+export * from './services';
+export * from './utils';
 //# sourceMappingURL=index.js.map