@huma-finance/sdk 0.0.39 → 0.0.41

package/dist/cjs/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/cjs/hooks/useERC20TransferableReceivableContract.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useERC20TransferableReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const useContract_1 = require("./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.
+ */
+function useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) {
+    var _a, _b, _c;
+    const TransferableReceivableAddress = (_c = (_b = (_a = shared_1.PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress;
+    return (0, useContract_1.useContract)(TransferableReceivableAddress, shared_1.ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.useERC20TransferableReceivableContract = useERC20TransferableReceivableContract;
+//# sourceMappingURL=useERC20TransferableReceivableContract.js.map

package/dist/cjs/hooks/useERC20TransferableReceivableContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useERC20TransferableReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useERC20TransferableReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAM6B;AAE7B,+CAA2C;AAE3C;;;;;;;;GAQG;AACH,SAAgB,sCAAsC,CACpD,gBAA2D,EAC3D,OAAe,EACf,QAAmB;;IAEnB,MAAM,6BAA6B,GACjC,MAAA,MAAA,MAAA,wBAAe,CAAC,OAAO,CAAC,0CAAG,kBAAS,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAE,YAAY,CAAA;IAEzE,OAAO,IAAA,yBAAW,EAChB,6BAA6B,EAC7B,0CAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC;AAbD,wFAaC"}

package/dist/cjs/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/cjs/hooks/usePoolContract.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCreditRecordDetails = exports.usePoolContract = void 0;
+const react_1 = require("react");
+const useContract_1 = require("./useContract");
+const poolInfo_1 = require("../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.
+ */
+function usePoolContract(signerOrProvider, chainId, poolName, poolType) {
+    const poolInfo = (0, poolInfo_1.getPoolInfo)(chainId, poolName, poolType);
+    return (0, useContract_1.useContract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.pool, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolAbi, signerOrProvider);
+}
+exports.usePoolContract = usePoolContract;
+/**
+ * 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.
+ */
+function useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) {
+    const poolContract = usePoolContract(signerOrProvider, chainId, poolName, poolType);
+    const [creditRecordDetails, setCreditRecordDetails] = (0, react_1.useState)();
+    const [refreshCount, setRefreshCount] = (0, react_1.useState)(0);
+    (0, react_1.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 = (0, react_1.useCallback)(() => {
+        setRefreshCount((pre) => pre + 1);
+    }, []);
+    return [creditRecordDetails, refresh];
+}
+exports.useCreditRecordDetails = useCreditRecordDetails;
+//# sourceMappingURL=usePoolContract.js.map

package/dist/cjs/hooks/usePoolContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePoolContract.js","sourceRoot":"","sources":["../../../src/hooks/usePoolContract.ts"],"names":[],"mappings":";;;AAEA,iCAAwD;AAGxD,+CAA2C;AAC3C,gDAA+C;AAE/C;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,sBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,OAAO,IAAA,yBAAW,EAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;AAC5E,CAAC;AARD,0CAQC;AAoCD;;;;;;;;;;GAUG;AACH,SAAgB,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,IAAA,gBAAQ,GAAuB,CAAA;IACjC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAA;IAEnD,IAAA,iBAAS,EAAC,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,IAAA,mBAAW,EAAC,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;AAvCD,wDAuCC"}

package/dist/cjs/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/cjs/hooks/useRealWorldReceivableContract.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRealWorldReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const useContract_1 = require("./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.
+ */
+function useRealWorldReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
+    return (0, useContract_1.useContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.useRealWorldReceivableContract = useRealWorldReceivableContract;
+//# sourceMappingURL=useRealWorldReceivableContract.js.map

package/dist/cjs/hooks/useRealWorldReceivableContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRealWorldReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useRealWorldReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAE7B,+CAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,8BAA8B,CAC5C,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,mBAAmB,GACvB,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,OAAO,IAAA,yBAAW,EAChB,mBAAmB,EACnB,kCAAyB,EACzB,gBAAgB,CACjB,CAAA;AACH,CAAC;AAdD,wEAcC"}

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

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

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,kDAAuB;AACvB,qDAA0B;AAC1B,kDAAuB"}

package/dist/cjs/services/ARWeaveService.d.ts

@@ -0,0 +1,117 @@
+import type { FundResponse, UploadResponse } from '@bundlr-network/client/build/cjs/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;
+/**
+ * Get a Bundlr instance for a specific network
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {string} signer - The private key of the wallet to use Bundlr with.
+ * @returns The Bundlr instance
+ */
+declare function getBundlrInstance(config: BundlrConfig, signer: string): Promise<import("@bundlr-network/client/build/cjs/node/bundlr").default>;
+/**
+ * Prefund the Bundlr network with the specified amount. Required if not lazy funding.
+ * Important note: The amount is denominated in the base unit of currency for that network.
+ * If you want to upload 5 Matic to the Bundlr node, pass in an amount of 5.
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {string} signer - The private key of the wallet to send funds from.
+ * @param {number} amount - The amount to fund, denoted in whatever currency specified by the config (e.g. MATIC, ETH)
+ * @returns {Promise<FundResponse>} - The fund response.
+ */
+declare function prefundBundlr(config: BundlrConfig, signer: string, 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 {Record<string, unknown>} 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: Record<string, unknown>, 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>;
+/**
+ * Helper method to fetch data from an ARWeave URL.
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {string} url - The ARWeave metadata URL to query.
+ * @returns {Promise<JSON>} Promise resolving with the queried data.
+ */
+declare function fetchMetadataFromUrl(url: string): Promise<JSON | null>;
+/**
+ * Helper method to get an ARWeave URI from an ARWeave ID.
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {string} arweaveId - The ARWeave metadata ID.
+ * @returns {string} The ARWeave URI.
+ */
+declare function getURIFromARWeaveId(arweaveId: string): string;
+/**
+ * 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;
+    getBundlrInstance: typeof getBundlrInstance;
+    fetchMetadataFromUrl: typeof fetchMetadataFromUrl;
+    getURIFromARWeaveId: typeof getURIFromARWeaveId;
+};
+export {};

package/dist/cjs/services/ARWeaveService.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARWeaveService = exports.getBundlrNetworkConfig = void 0;
+const tslib_1 = require("tslib");
+const client_1 = tslib_1.__importDefault(require("@bundlr-network/client"));
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const graphql_request_1 = tslib_1.__importStar(require("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.
+ */
+function getBundlrNetworkConfig(chainId) {
+    switch (chainId) {
+        case 5: // Goerli
+            return {
+                nodeUrl: 'https://devnet.bundlr.network',
+                currency: 'ethereum',
+                providerUrl: 'https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161',
+            };
+        case 80001: // Mumbai
+            return {
+                nodeUrl: 'https://devnet.bundlr.network',
+                currency: 'matic',
+                providerUrl: 'https://rpc.ankr.com/polygon_mumbai',
+            };
+        case 137: // Matic
+            return {
+                nodeUrl: 'https://node1.bundlr.network',
+                currency: 'matic',
+            };
+        default:
+            return {
+                nodeUrl: '',
+                currency: '',
+            };
+    }
+}
+exports.getBundlrNetworkConfig = getBundlrNetworkConfig;
+/**
+ * Get a Bundlr instance for a specific network
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {string} signer - The private key of the wallet to use Bundlr with.
+ * @returns The Bundlr instance
+ */
+async function getBundlrInstance(config, signer) {
+    const bundlr = new client_1.default(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    return bundlr;
+}
+/**
+ * Prefund the Bundlr network with the specified amount. Required if not lazy funding.
+ * Important note: The amount is denominated in the base unit of currency for that network.
+ * If you want to upload 5 Matic to the Bundlr node, pass in an amount of 5.
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {string} signer - The private key of the wallet to send funds from.
+ * @param {number} amount - The amount to fund, denoted in whatever currency specified by the config (e.g. MATIC, ETH)
+ * @returns {Promise<FundResponse>} - The fund response.
+ */
+async function prefundBundlr(config, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+signer, amount) {
+    const bundlr = new client_1.default(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    // Convert currency to its atomic units (e.g. MATIC -> wei)
+    const atomicAmount = bundlr.utils.toAtomic(amount);
+    return bundlr.fund(atomicAmount);
+}
+/**
+ * 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 {Record<string, unknown>} 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 client_1.default(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 20% to account for fluctuations in the price
+        const priceWithBuffer = price.multipliedBy(1.2).integerValue();
+        console.log(`Funding bundlr with ${priceWithBuffer} ${config.currency} to upload data`);
+        await bundlr.fund(priceWithBuffer);
+    }
+    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 = (0, graphql_request_1.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 (0, graphql_request_1.default)(`${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;
+}
+/**
+ * Helper method to fetch data from an ARWeave URL.
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {string} url - The ARWeave metadata URL to query.
+ * @returns {Promise<JSON>} Promise resolving with the queried data.
+ */
+async function fetchMetadataFromUrl(url) {
+    try {
+        const response = await axios_1.default.get(url);
+        return response.data;
+    }
+    catch (error) {
+        console.error('Error fetching data:', error);
+        return null;
+    }
+}
+/**
+ * Helper method to get an ARWeave URI from an ARWeave ID.
+ *
+ * @async
+ * @function
+ * @memberof ARWeaveService
+ * @param {string} arweaveId - The ARWeave metadata ID.
+ * @returns {string} The ARWeave URI.
+ */
+function getURIFromARWeaveId(arweaveId) {
+    return `https://arweave.net/${arweaveId}`;
+}
+/**
+ * An object that contains functions to interact with Huma-related data stored on ARWeave
+ * @namespace ARWeaveService
+ */
+exports.ARWeaveService = {
+    queryForMetadata,
+    storeData,
+    prefundBundlr,
+    getBundlrNetworkConfig,
+    getBundlrInstance,
+    fetchMetadataFromUrl,
+    getURIFromARWeaveId,
+};
+//# sourceMappingURL=ARWeaveService.js.map

package/dist/cjs/services/ARWeaveService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../../src/services/ARWeaveService.ts"],"names":[],"mappings":";;;;AAAA,4EAA2C;AAM3C,0DAAyB;AACzB,2EAA8C;AAkB9C;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,QAAQ,OAAO,EAAE;QACf,KAAK,CAAC,EAAE,SAAS;YACf,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,UAAU;gBACpB,WAAW,EACT,8DAA8D;aACjE,CAAA;QACH,KAAK,KAAK,EAAE,SAAS;YACnB,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,qCAAqC;aACnD,CAAA;QACH,KAAK,GAAG,EAAE,QAAQ;YAChB,OAAO;gBACL,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,OAAO;aAClB,CAAA;QACH;YACE,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAA;KACJ;AACH,CAAC;AA1BD,wDA0BC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,iBAAiB,CAAC,MAAoB,EAAE,MAAc;IACnE,MAAM,MAAM,GAAG,IAAI,gBAAM,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,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,aAAa,CAC1B,MAAoB;AACpB,8DAA8D;AAC9D,MAAc,EACd,MAAc;IAEd,MAAM,MAAM,GAAG,IAAI,gBAAM,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,2DAA2D;IAC3D,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAElD,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;AAClC,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,SAAS,CACtB,MAAoB,EACpB,kBAAyC,EACzC,IAA6B,EAC7B,IAAuC,EACvC,WAAoB,IAAI;IAExB,MAAM,MAAM,GAAG,IAAI,gBAAM,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,MAAM,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,CAAA;QAC9D,OAAO,CAAC,GAAG,CACT,uBAAuB,eAAe,IAAI,MAAM,CAAC,QAAQ,iBAAiB,CAC3E,CAAA;QACD,MAAM,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;KACnC;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,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;GAgBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,IAAA,yBAAO,EAAC,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;;;;;;;;GAQG;AACH,KAAK,UAAU,oBAAoB,CAAC,GAAW;IAC7C,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACrC,OAAO,QAAQ,CAAC,IAAI,CAAA;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,mBAAmB,CAAC,SAAiB;IAC5C,OAAO,uBAAuB,SAAS,EAAE,CAAA;AAC3C,CAAC;AAED;;;GAGG;AACU,QAAA,cAAc,GAAG;IAC5B,gBAAgB;IAChB,SAAS;IACT,aAAa;IACb,sBAAsB;IACtB,iBAAiB;IACjB,oBAAoB;IACpB,mBAAmB;CACpB,CAAA"}

package/dist/cjs/services/EAService.d.ts

@@ -0,0 +1,20 @@
+import { EAPayload, EAPreapprovalPayload } from '@huma-finance/shared';
+/**
+ * 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: EAPayload, chainId: number) => Promise<import("@huma-finance/shared").Approval>;
+    preapprove: (payload: EAPreapprovalPayload, chainId: number) => Promise<import("@huma-finance/shared").PreapprovalResult>;
+};

package/dist/cjs/services/EAService.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EAService = void 0;
+const shared_1 = require("@huma-finance/shared");
+/**
+ * Submits a credit underwriting request to Huma's EAVerse. This approves a creditline
+ * in Huma's pools that can be drawn down by the borrower.
+ *
+ * @memberof EAService
+ * @param {EAPayload} payload The payload for the underwrite approval.
+ * @param {number} chainId The chain ID.
+ * @returns {Promise<Approval>} Promise that returns the approval on success.
+ * @throws {EARejectionError} If the underwrite approval is rejected.
+ */
+const approve = async (payload, chainId) => shared_1.EAService.approve(payload, chainId);
+/**
+ * Checks whether or not a credit underwriting request to Huma's EAVerse would be approved.
+ * Note that this does not approve a creditline in Huma's pools and an approve call is still required.
+ *
+ * @param {EAPreapprovalPayload} payload The payload for the underwrite approval.
+ * @param {number} chainId The chain ID.
+ * @returns {Promise<Approval>} Promise that returns the approval on success.
+ */
+const preapprove = async (payload, chainId) => shared_1.EAService.preapprove(payload, chainId);
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+exports.EAService = {
+    approve,
+    preapprove,
+};
+//# sourceMappingURL=EAService.js.map

package/dist/cjs/services/EAService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../../src/services/EAService.ts"],"names":[],"mappings":";;;AAAA,iDAI6B;AAa7B;;;;;;;;;GASG;AACH,MAAM,OAAO,GAAG,KAAK,EAAE,OAAkB,EAAE,OAAe,EAAE,EAAE,CAC5D,kBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAE7C;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,KAAK,EAAE,OAA6B,EAAE,OAAe,EAAE,EAAE,CAC1E,kBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAEhD;;;;GAIG;AACU,QAAA,SAAS,GAAG;IACvB,OAAO;IACP,UAAU;CACX,CAAA"}