@huma-finance/sdk 0.0.10 → 0.0.12

package/dist/hooks/useContract.d.ts

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

package/dist/hooks/useContract.js

@@ -0,0 +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]);
+}
+//# sourceMappingURL=useContract.js.map

package/dist/hooks/useContract.js.map

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

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

package/dist/hooks/useERC20TransferableReceivableContract.js

@@ -0,0 +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);
+}
+//# sourceMappingURL=useERC20TransferableReceivableContract.js.map

package/dist/hooks/useERC20TransferableReceivableContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useERC20TransferableReceivableContract.js","sourceRoot":"","sources":["../../src/hooks/useERC20TransferableReceivableContract.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iCAAiC,EAGjC,SAAS,EACT,eAAe,GAChB,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;;;;GAQG;AACH,MAAM,UAAU,sCAAsC,CACpD,gBAA2D,EAC3D,OAAe,EACf,QAAmB;;IAEnB,MAAM,6BAA6B,GACjC,MAAA,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,SAAS,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAE,YAAY,CAAA;IAEzE,OAAO,WAAW,CAChB,6BAA6B,EAC7B,iCAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC"}

package/dist/hooks/usePool.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=usePool.js.map

package/dist/hooks/usePool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePool.js","sourceRoot":"","sources":["../../src/hooks/usePool.ts"],"names":[],"mappings":""}

package/dist/hooks/usePoolContract.d.ts

@@ -0,0 +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];

package/dist/hooks/usePoolContract.js

@@ -0,0 +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];
+}
+//# sourceMappingURL=usePoolContract.js.map

package/dist/hooks/usePoolContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePoolContract.js","sourceRoot":"","sources":["../../src/hooks/usePoolContract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAGxD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;;;;;;;;;GAUG;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;IACzD,OAAO,WAAW,CAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;AAC5E,CAAC;AAoCD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,sBAAsB,CACpC,WAAmB,EACnB,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,eAAe,CAClC,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IACD,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GACjD,QAAQ,EAAuB,CAAA;IACjC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;IAEnD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;YAC3B,IAAI,YAAY,IAAI,WAAW,EAAE;gBAC/B,MAAM,mBAAmB,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAChE,WAAW,CACZ,CAAA;gBACD,MAAM,yBAAyB,GAC7B,MAAM,YAAY,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;gBAC3D,sBAAsB,iCACjB,mBAAmB,GACnB,yBAAyB,EAC5B,CAAA;aACH;QACH,CAAC,CAAA;QACD,SAAS,EAAE,CAAA;IACb,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAA;IAE7C,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE;QAC/B,eAAe,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;IACnC,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACvC,CAAC"}

package/dist/hooks/useRealWorldReceivableContract.d.ts

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

package/dist/hooks/useRealWorldReceivableContract.js

@@ -0,0 +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);
+}
+//# sourceMappingURL=useRealWorldReceivableContract.js.map

package/dist/hooks/useRealWorldReceivableContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRealWorldReceivableContract.js","sourceRoot":"","sources":["../../src/hooks/useRealWorldReceivableContract.ts"],"names":[],"mappings":"AACA,OAAO,EACL,yBAAyB,EAEzB,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B,CAC5C,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,mBAAmB,GACvB,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,OAAO,WAAW,CAChB,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,CACjB,CAAA;AACH,CAAC"}

package/dist/hooks/useReceivableFactoringPoolContract.d.ts

@@ -0,0 +1,10 @@
+import { POOL_NAME, ReceivableFactoringPool } from '@00labs/huma-shared';
+import { ethers } from 'ethers';
+/**
+ * A react hook that returns the instance of the ReceivableFactoringPool contract for a given signer or provider and pool name.
+ *
+ * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The signer or provider object to use for the contract.
+ * @param {POOL_NAME} poolName - The name of the pool to get the contract for. Check the type for more details.
+ * @returns {ReceivableFactoringPool} An ethers instance of the ReceivableFactoringPool contract.
+ */
+export declare function useReceivableFactoringPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME): ReceivableFactoringPool | null;

package/dist/hooks/useReceivableFactoringPoolContract.js

@@ -0,0 +1,13 @@
+import { POOL_TYPE, } from '@00labs/huma-shared';
+import { usePoolContract } from './usePoolContract';
+/**
+ * A react hook that returns the instance of the ReceivableFactoringPool contract for a given signer or provider and pool name.
+ *
+ * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - The signer or provider object to use for the contract.
+ * @param {POOL_NAME} poolName - The name of the pool to get the contract for. Check the type for more details.
+ * @returns {ReceivableFactoringPool} An ethers instance of the ReceivableFactoringPool contract.
+ */
+export function useReceivableFactoringPoolContract(signerOrProvider, chainId, poolName) {
+    return usePoolContract(signerOrProvider, chainId, poolName, POOL_TYPE.Invoice);
+}
+//# sourceMappingURL=useReceivableFactoringPoolContract.js.map

package/dist/hooks/useReceivableFactoringPoolContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useReceivableFactoringPoolContract.js","sourceRoot":"","sources":["../../src/hooks/useReceivableFactoringPoolContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,GAEV,MAAM,qBAAqB,CAAA;AAG5B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;;;;GAMG;AACH,MAAM,UAAU,kCAAkC,CAChD,gBAA2D,EAC3D,OAAe,EACf,QAAmB;IAEnB,OAAO,eAAe,CACpB,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,SAAS,CAAC,OAAO,CAClB,CAAA;AACH,CAAC"}

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA"}

package/dist/services/ARWeaveService.d.ts

@@ -0,0 +1,81 @@
+import { FundResponse, UploadResponse } from '@bundlr-network/client/build/common/types';
+import { Web3Provider } from '@ethersproject/providers';
+/**
+ * The configuration for Bundlr network instances
+ *
+ * @typedef {Object} BundlrConfig
+ * @memberof ArweaveService
+ * @property {string} nodeUrl - The Bundlr node URL to use.
+ * @property {string} currency - The currency to pay for uploads with.
+ *  Please see https://docs.bundlr.network/sdk/using-other-currencies for all the supported currencies
+ * @property {string} [providerUrl] - The provider URL, required for devnets.
+ */
+export type BundlrConfig = {
+    nodeUrl: string;
+    currency: string;
+    providerUrl?: string;
+};
+/**
+ * Get the configuration for Bundlr network given a chain ID
+ *
+ * @function
+ * @memberof ArweaveService
+ * @param {number} chainId - The chain ID.
+ * @returns {BundlrConfig} - The configuration for the Bundlr network.
+ */
+export declare function getBundlrNetworkConfig(chainId: number): BundlrConfig;
+/**
+ * Prefund the Bundlr network with the specified amount. Required if not lazy funding.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {any} signer - The wallet to send funds from. This can be either a web3 signer or a private key string.
+ * @param {number} amount - The amount to fund, denoted in whatever currency specified by the config.
+ * @returns {Promise<FundResponse>} - The fund response.
+ */
+declare function prefundBundlr(config: BundlrConfig, signer: any, amount: number): Promise<FundResponse>;
+/**
+ * Store data on ARWeave using the Bundlr Network.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {BundlrConfig} config - Configuration object for the Bundlr instance.
+ * @param {Web3Provider | string} signerOrPrivateKey - Wallet object used for interacting with the Bundlr instance.
+ *         If calling from a browser, this should be a `Web3Provider` instance. If calling from a Node.js
+ *         environment, this should be a private key string.
+ * @param {JSON} data - The data to store in the Bundlr instance.
+ * @param {Array<{ name: string, value: string }>} tags - Array of tag objects with `name` and `value` properties.
+ * @param {boolean} [lazyFund=true] - Optional flag to fund the Bundlr instance lazily. If set to `false`, the
+ *        Bundlr node should already be funded or else uploads will fail.
+ * @returns {Promise<UploadResponse>} Promise resolving with the upload response.
+ */
+declare function storeData(config: BundlrConfig, signerOrPrivateKey: Web3Provider | string, data: JSON, tags: {
+    name: string;
+    value: string;
+}[], lazyFund?: boolean): Promise<UploadResponse>;
+/**
+ * Helper method to query the Arweave network for receivables metadata previously uploaded.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {number} chainId - The chain ID.
+ * @param {string} sender - The sender tag to query.
+ * @param {string} referenceId - The referenceId tag to query, whatever was used when uploading the metadata.
+ * @returns {Promise<any>} Promise resolving with the queried data.
+ */
+declare function queryForMetadata(chainId: number, sender: string, referenceId: string): Promise<string | null>;
+/**
+ * An object that contains functions to interact with Huma-related data stored on ARWeave
+ * @namespace ARWeaveService
+ */
+export declare const ARWeaveService: {
+    queryForMetadata: typeof queryForMetadata;
+    storeData: typeof storeData;
+    prefundBundlr: typeof prefundBundlr;
+    getBundlrNetworkConfig: typeof getBundlrNetworkConfig;
+};
+export {};

package/dist/services/ARWeaveService.js

@@ -0,0 +1,136 @@
+import Bundlr from '@bundlr-network/client';
+import request, { gql } from 'graphql-request';
+/**
+ * Get the configuration for Bundlr network given a chain ID
+ *
+ * @function
+ * @memberof ArweaveService
+ * @param {number} chainId - The chain ID.
+ * @returns {BundlrConfig} - The configuration for the Bundlr network.
+ */
+export function getBundlrNetworkConfig(chainId) {
+    switch (chainId) {
+        case 5:
+            return {
+                nodeUrl: 'https://devnet.bundlr.network',
+                currency: 'ethereum',
+                providerUrl: 'https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161',
+            };
+        case 80001:
+            return {
+                nodeUrl: 'https://devnet.bundlr.network',
+                currency: 'matic',
+                providerUrl: 'https://rpc-mumbai.matic.today',
+            };
+        default:
+            return {
+                nodeUrl: '',
+                currency: '',
+            };
+    }
+}
+/**
+ * Prefund the Bundlr network with the specified amount. Required if not lazy funding.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {any} signer - The wallet to send funds from. This can be either a web3 signer or a private key string.
+ * @param {number} amount - The amount to fund, denoted in whatever currency specified by the config.
+ * @returns {Promise<FundResponse>} - The fund response.
+ */
+async function prefundBundlr(config, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+signer, amount) {
+    const bundlr = new Bundlr(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    return bundlr.fund(amount);
+}
+/**
+ * Store data on ARWeave using the Bundlr Network.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {BundlrConfig} config - Configuration object for the Bundlr instance.
+ * @param {Web3Provider | string} signerOrPrivateKey - Wallet object used for interacting with the Bundlr instance.
+ *         If calling from a browser, this should be a `Web3Provider` instance. If calling from a Node.js
+ *         environment, this should be a private key string.
+ * @param {JSON} data - The data to store in the Bundlr instance.
+ * @param {Array<{ name: string, value: string }>} tags - Array of tag objects with `name` and `value` properties.
+ * @param {boolean} [lazyFund=true] - Optional flag to fund the Bundlr instance lazily. If set to `false`, the
+ *        Bundlr node should already be funded or else uploads will fail.
+ * @returns {Promise<UploadResponse>} Promise resolving with the upload response.
+ */
+async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true) {
+    const bundlr = new Bundlr(config.nodeUrl, config.currency, signerOrPrivateKey, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    const dataStr = JSON.stringify(data);
+    if (lazyFund) {
+        const size = Buffer.byteLength(dataStr);
+        const price = await bundlr.getPrice(size);
+        // Add a buffer of 10% to account for fluctuations in the price
+        price.multipliedBy(1.1);
+        console.log(`Funding bundlr with ${price} ${config.currency} to upload data`);
+        await bundlr.fund(price);
+    }
+    return bundlr.upload(dataStr, { tags });
+}
+/**
+ * Helper method to query the Arweave network for receivables metadata previously uploaded.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {number} chainId - The chain ID.
+ * @param {string} sender - The sender tag to query.
+ * @param {string} referenceId - The referenceId tag to query, whatever was used when uploading the metadata.
+ * @returns {Promise<any>} Promise resolving with the queried data.
+ */
+async function queryForMetadata(chainId, sender, referenceId) {
+    var _a, _b, _c, _d;
+    const config = getBundlrNetworkConfig(chainId);
+    const query = gql `
+    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
+      transactions(
+        owners: [$sender]
+        tags: [
+          { name: "appName", values: ["HumaFinance"] }
+          { name: "referenceId", values: [$referenceId] }
+        ]
+      ) {
+        edges {
+          node {
+            id
+          }
+        }
+      }
+    }
+  `;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const data = await request(`${config.nodeUrl}/graphql`, query, {
+        sender,
+        referenceId,
+    });
+    return (_d = (_c = (_b = (_a = data === null || data === void 0 ? void 0 : data.transactions) === null || _a === void 0 ? void 0 : _a.edges) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.node) === null || _d === void 0 ? void 0 : _d.id;
+}
+/**
+ * An object that contains functions to interact with Huma-related data stored on ARWeave
+ * @namespace ARWeaveService
+ */
+export const ARWeaveService = {
+    queryForMetadata,
+    storeData,
+    prefundBundlr,
+    getBundlrNetworkConfig,
+};
+//# sourceMappingURL=ARWeaveService.js.map

package/dist/services/ARWeaveService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../src/services/ARWeaveService.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAM3C,OAAO,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAkB9C;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAAe;IACpD,QAAQ,OAAO,EAAE;QACf,KAAK,CAAC;YACJ,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,UAAU;gBACpB,WAAW,EACT,8DAA8D;aACjE,CAAA;QACH,KAAK,KAAK;YACR,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,gCAAgC;aAC9C,CAAA;QACH;YACE,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAA;KACJ;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,aAAa,CAC1B,MAAoB;AACpB,8DAA8D;AAC9D,MAAW,EACX,MAAc;IAEd,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,EACN,MAAM,CAAC,WAAW;QAChB,CAAC,CAAC;YACE,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC;QACH,CAAC,CAAC,SAAS,CACd,CAAA;IACD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;IAEpB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,SAAS,CACtB,MAAoB,EACpB,kBAAyC,EACzC,IAAU,EACV,IAAuC,EACvC,WAAoB,IAAI;IAExB,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,kBAAkB,EAClB,MAAM,CAAC,WAAW;QAChB,CAAC,CAAC;YACE,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC;QACH,CAAC,CAAC,SAAS,CACd,CAAA;IACD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;IAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAEpC,IAAI,QAAQ,EAAE;QACZ,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAEzC,+DAA+D;QAC/D,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QACvB,OAAO,CAAC,GAAG,CACT,uBAAuB,KAAK,IAAI,MAAM,CAAC,QAAQ,iBAAiB,CACjE,CAAA;QACD,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;KACzB;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,gBAAgB,CAC7B,OAAe,EACf,MAAc,EACd,WAAmB;;IAEnB,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;GAgBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,UAAU,EAAE,KAAK,EAAE;QAClE,MAAM;QACN,WAAW;KACZ,CAAC,CAAA;IAEF,OAAO,MAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,0CAAE,KAAK,0CAAG,CAAC,CAAC,0CAAE,IAAI,0CAAE,EAAE,CAAA;AACjD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,gBAAgB;IAChB,SAAS;IACT,aAAa;IACb,sBAAsB;CACvB,CAAA"}

package/dist/services/EAService.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Object representing the response to the underwriting approval request.
+ * @typedef {Object} ApprovalResult
+ */
+/**
+ * Object representing an invoice payload for underwriting approval.
+ *
+ * @typedef {Object} EAPayload
+ */
+export type { ApprovalResult, EAPayload } from '@huma-finance/shared';
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+export declare const EAService: {
+    approve: (payload: import("@huma-finance/shared").EAPayload, chainId: number, isDev?: boolean | undefined) => Promise<import("@huma-finance/shared").Approval>;
+};

package/dist/services/EAService.js

@@ -0,0 +1,10 @@
+import { EAService as EAServiceInternal } from '@huma-finance/shared';
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+export const EAService = {
+    approve: EAServiceInternal.approve,
+};
+//# sourceMappingURL=EAService.js.map

package/dist/services/EAService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../src/services/EAService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAarE;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,OAAO,EAAE,iBAAiB,CAAC,OAAO;CACnC,CAAA"}

package/dist/services/ReceivableService.d.ts

@@ -0,0 +1,87 @@
+import { TransactionResponse, Web3Provider } from '@ethersproject/providers';
+import { BigNumberish, ethers, Overrides } from 'ethers';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+/**
+ * Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
+ * @param {string} referenceId -  An internal identifier value added as a tag on ARWeave
+ * @param {number} paymentAmount - The amount to declare paid to the receivable.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ */
+declare function declareReceivablePaymentByReferenceId(signer: ethers.Signer, referenceId: string, paymentAmount: number): Promise<TransactionResponse>;
+/**
+ * Declares a payment on a RealWorldReceivable given a tokenID of the receivable.
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
+ * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
+ * @param {number} paymentAmount - The amount to pay the receivable.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
+ */
+declare function declareReceivablePaymentByTokenId(signer: ethers.Signer, receivableTokenId: BigNumberish, paymentAmount: number): Promise<TransactionResponse>;
+/**
+ * Creates a new RealWorldReceivable token on the given chain of the signer
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @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 {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
+ * @param {number} receivableAmount - The amount of the receivable token to mint.
+ * @param {number} maturityDate - The maturity date of the receivable token, in UNIX timestamp format.
+ * @param {string} uri - The URI of the receivable token metadata.
+ * @param {Overrides} gasOpts - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
+ */
+declare function createReceivable(signer: ethers.Signer, poolName: POOL_NAME, poolType: POOL_TYPE, currencyCode: number, receivableAmount: number, maturityDate: number, uri: string, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * Creates a RealWorldReceivable token with metadata uploaded onto ARWeave
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
+ *      If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
+ *      from server calls.
+ * @param {string | null} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
+ * @param {number} chainId - The chain ID to mint the receivable token on and pay ARWeave funds from.
+ * @param {string} recipient - The receivable token recipient.
+ * @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
+ * @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
+ * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
+ * @param {number} receivableAmount - The receivable amount.
+ * @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
+ * @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
+ * @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
+ * @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
+ *      ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
+ * @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
+ *      metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
+ * @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
+ * @returns {Promise<TransactionResponse>} - The transaction receipt.
+ */
+declare function createReceivableWithMetadata(signerOrProvider: Web3Provider | ethers.Signer, privateKey: string | null, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, currencyCode: number, receivableAmount: number, maturityDate: number, metadata: JSON, referenceId: string, extraTags: {
+    name: string;
+    value: string;
+}[], lazyFund?: boolean, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * An object that contains functions to interact with Huma's receivables.
+ * @namespace ReceivableService
+ */
+export declare const ReceivableService: {
+    createReceivableWithMetadata: typeof createReceivableWithMetadata;
+    createReceivable: typeof createReceivable;
+    declareReceivablePaymentByTokenId: typeof declareReceivablePaymentByTokenId;
+    declareReceivablePaymentByReferenceId: typeof declareReceivablePaymentByReferenceId;
+};
+export {};