@huma-finance/sdk 0.0.7 → 0.0.10

package/README.md

@@ -1,15 +1,31 @@
-# Huma SDK
-
-This is a React SDK package providing helpful hooks, utilities, and API helpers to interact with the Huma protocol.
-
-## Documentation
-
-For documentation on the different functions offered please refer to the [API](API.md)
-
-## Example Usage
-
-To see how the Huma SDK can be used, feel free to use our interactive example in the `huma-widgets` package.
-
-1. Open up the `huma-widgets` package in your terminal
-2. Run `yarn cosmos`
-3. Open up `localhost:8000` in your browser and navigate to the `SDKTesting` fixture
+# Huma SDK
+
+The Huma SDK includes utilities and services for interacting with different layers of our protocol including contracts, our evaluation agent underwriting service, and data storage hosted on ARWeave, Subgraph, on-chain, etc. It's currently offered just as a Javascript NPM package at https://www.npmjs.com/package/@huma-finance/sdk.
+
+## Getting Started
+
+We recommend onboarding onto our SDK using the [Getting Started guide](getting-started.md)
+
+## Documentation
+
+For extensive documentation on the different functions offered please refer to the [API documentation](API.md)
+
+## Features
+
+- Services
+  - `ARWeaveService` contains helper methods for storing data on ARWeave conforming to Huma data standards, querying for metadata, and prefunding ARWeave nodes to pay for data uploading.
+  - `EAService` contains helper methods to request credit approvals from Huma's Evaluation Agent layer.
+  - `ReceivableService` contains helper methods to manage minting and paying Receivable tokens
+  - `SubgraphService` contains helper methods for querying Huma's subgraphs
+- Hooks
+  - React hooks for fetching ethers.js Contract instances of Huma contracts
+- Helpers
+  - Helper functions for fetching ethers.js Contract instances of Huma contracts
+
+## Examples
+
+To see how the Huma SDK can be used, feel free to use our interactive example in the huma-widgets package.
+
+1. Open up the huma-widgets package in your terminal
+2. Run yarn cosmos
+3. Open up localhost:8000 in your browser and navigate to the SDKTesting fixture

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huma-finance/sdk",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "types": "./dist/index.d.ts",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -20,7 +20,7 @@
     "@ethersproject/constants": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.6.0",
-    "@huma-finance/shared": "^0.0.7",
+    "@huma-finance/shared": "^0.0.10",
     "arweave": "^1.13.5",
     "ethers": "^5.7.2",
     "graphql-request": "^6.0.0",
@@ -83,5 +83,5 @@
   "optionalDependencies": {
     "encoding": "^0.1.13"
   },
-  "gitHead": "41eb5cede5591743716e3b4793661b95b55eeecc"
+  "gitHead": "61b1485097a4e7e6d2f1c2825454b9d2283c2a6c"
 }

package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.d.ts

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

package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBaseCreditPoolReceivableContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
-const utils_1 = require("../utils");
-/**
- * Returns an ethers contract instance for the BaseCreditPoolReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider The provider or signer instance to use for the contract.
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
- */
-function getBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const baseCreditPoolReceivable = (_a = huma_shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[huma_shared_1.SupplementaryContracts.BaseCreditPoolReceivable];
-    if (!baseCreditPoolReceivable)
-        return null;
-    return (0, utils_1.getContract)(baseCreditPoolReceivable, huma_shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
-}
-exports.getBaseCreditPoolReceivableContract = getBaseCreditPoolReceivableContract;
-//# sourceMappingURL=BaseCreditPoolReceivableContractHelper.js.map

package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseCreditPoolReceivableContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/BaseCreditPoolReceivableContractHelper.ts"],"names":[],"mappings":";;;AACA,qDAI4B;AAE5B,oCAAsC;AAEtC;;;;;;GAMG;AACH,SAAgB,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,uCAAyB,CAAC,OAAO,CAAC,0CAChC,oCAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,IAAI,CAAC,wBAAwB;QAAE,OAAO,IAAI,CAAA;IAE1C,OAAO,IAAA,mBAAW,EAChB,wBAAwB,EACxB,6CAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC;AAhBD,kFAgBC"}

package/dist/cjs/helpers/index.d.ts

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

package/dist/cjs/helpers/index.js

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

package/dist/cjs/helpers/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,mFAAwD"}

package/dist/cjs/hooks/index.d.ts

@@ -1,5 +0,0 @@
-export * from './useContract';
-export * from './useBaseCreditPoolReceivableContract';
-export * from './useERC20TransferableReceivableContract';
-export * from './usePoolContract';
-export * from './useReceivableFactoringPoolContract';

package/dist/cjs/hooks/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./useContract"), exports);
-tslib_1.__exportStar(require("./useBaseCreditPoolReceivableContract"), exports);
-tslib_1.__exportStar(require("./useERC20TransferableReceivableContract"), exports);
-tslib_1.__exportStar(require("./usePoolContract"), exports);
-tslib_1.__exportStar(require("./useReceivableFactoringPoolContract"), exports);
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":";;;AAAA,wDAA6B;AAC7B,gFAAqD;AACrD,mFAAwD;AACxD,4DAAiC;AACjC,+EAAoD"}

package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.d.ts

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

package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useBaseCreditPoolReceivableContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
-const useContract_1 = require("./useContract");
-/**
- * A react hook that returns an ethers contract instance for the BaseCreditPoolReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider The provider or signer instance to use for the contract.
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
- */
-function useBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const baseCreditPoolReceivable = (_a = huma_shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[huma_shared_1.SupplementaryContracts.BaseCreditPoolReceivable];
-    return (0, useContract_1.useContract)(baseCreditPoolReceivable, huma_shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
-}
-exports.useBaseCreditPoolReceivableContract = useBaseCreditPoolReceivableContract;
-//# sourceMappingURL=useBaseCreditPoolReceivableContract.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useBaseCreditPoolReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useBaseCreditPoolReceivableContract.ts"],"names":[],"mappings":";;;AACA,qDAK4B;AAE5B,+CAA2C;AAE3C;;;;;;GAMG;AACH,SAAgB,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,uCAAyB,CAAC,OAAO,CAAC,0CAChC,oCAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,OAAO,IAAA,yBAAW,EAChB,wBAAwB,EACxB,6CAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC;AAdD,kFAcC"}

package/dist/cjs/hooks/useContract.d.ts

@@ -1,11 +0,0 @@
-import { Contract } from '@ethersproject/contracts';
-import { ethers } from 'ethers';
-/**
- * Custom hook for creating an ethers instance of a smart contract.
- * @param address - The address of the smart contract instance.
- * @param ABI - The ABI of the smart contract.
- * @param 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 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/cjs/hooks/useContract.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useContract = void 0;
-const react_1 = require("react");
-const web3_1 = require("../utils/web3");
-/**
- * Custom hook for creating an ethers instance of a smart contract.
- * @param address - The address of the smart contract instance.
- * @param ABI - The ABI of the smart contract.
- * @param 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 An instance of the smart contract, or null if an error occurs.
- */
-function useContract(address, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-ABI, signerOrProvider) {
-    return (0, react_1.useMemo)(() => {
-        if (!address || !ABI || !signerOrProvider)
-            return null;
-        try {
-            return (0, web3_1.getContract)(address, ABI, signerOrProvider);
-        }
-        catch (error) {
-            return null;
-        }
-    }, [address, ABI, signerOrProvider]);
-}
-exports.useContract = useContract;
-//# sourceMappingURL=useContract.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useContract.js","sourceRoot":"","sources":["../../../src/hooks/useContract.ts"],"names":[],"mappings":";;;AACA,iCAA+B;AAG/B,wCAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,OAAkC;AAClC,8DAA8D;AAC9D,GAAQ,EACR,gBAA2D;IAE3D,OAAO,IAAA,eAAO,EAAC,GAAG,EAAE;QAClB,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAA;QACtD,IAAI;YACF,OAAO,IAAA,kBAAW,EAAC,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;AAdD,kCAcC"}

package/dist/cjs/hooks/useERC20TransferableReceivableContract.d.ts

@@ -1,12 +0,0 @@
-import { JsonRpcProvider, JsonRpcSigner } from '@ethersproject/providers';
-import { Contract } from 'ethers';
-import { POOL_NAME } from '@00labs/huma-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 {JsonRpcProvider | JsonRpcSigner} signerOrProvider The provider or signer instance to use for the contract.
- * @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: JsonRpcProvider | JsonRpcSigner, poolName: POOL_NAME): Contract | null;

package/dist/cjs/hooks/useERC20TransferableReceivableContract.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useERC20TransferableReceivableContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
-const useContract_1 = require("./useContract");
-const chain_1 = require("../utils/chain");
-/**
- * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider The provider or signer instance to use for the contract.
- * @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, poolName) {
-    var _a, _b, _c;
-    const chainId = (0, chain_1.getChainIdFromJsonSignerOrProvider)(signerOrProvider);
-    const TransferableReceivableAddress = chainId
-        ? (_c = (_b = (_a = huma_shared_1.PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[huma_shared_1.POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress
-        : null;
-    return (0, useContract_1.useContract)(TransferableReceivableAddress, huma_shared_1.ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
-}
-exports.useERC20TransferableReceivableContract = useERC20TransferableReceivableContract;
-//# sourceMappingURL=useERC20TransferableReceivableContract.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useERC20TransferableReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useERC20TransferableReceivableContract.ts"],"names":[],"mappings":";;;AAEA,qDAM4B;AAE5B,+CAA2C;AAC3C,0CAAmE;AAEnE;;;;;;;GAOG;AACH,SAAgB,sCAAsC,CACpD,gBAAiD,EACjD,QAAmB;;IAEnB,MAAM,OAAO,GAAG,IAAA,0CAAkC,EAAC,gBAAgB,CAAC,CAAA;IAEpE,MAAM,6BAA6B,GAAG,OAAO;QAC3C,CAAC,CAAC,MAAA,MAAA,MAAA,6BAAe,CAAC,OAAO,CAAC,0CAAG,uBAAS,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAE,YAAY;QACzE,CAAC,CAAC,IAAI,CAAA;IAER,OAAO,IAAA,yBAAW,EAChB,6BAA6B,EAC7B,+CAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC;AAfD,wFAeC"}

package/dist/cjs/hooks/usePoolContract.d.ts

@@ -1,53 +0,0 @@
-import { BigNumber } from '@ethersproject/bignumber';
-import { Contract, ethers } from 'ethers';
-import { POOL_NAME, POOL_TYPE } from '@00labs/huma-shared';
-/**
- * A react hook that returns a contract instance of a specific pool using an ethers JsonRpcProvider or JsonRpcSigner.
- *
- * @template T - The type of the contract.
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - A JsonRpcProvider or JsonRpcSigner instance.
- * @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.
- * @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.
- *
- * @param {string} userAddress - The address of the user to get the credit record details for.
- * @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 credit record details for.
- * @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

@@ -1,49 +0,0 @@
-"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 JsonRpcProvider or JsonRpcSigner.
- *
- * @template T - The type of the contract.
- * @param {JsonRpcProvider | JsonRpcSigner} signerOrProvider - A JsonRpcProvider or JsonRpcSigner instance.
- * @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.
- *
- * @param {string} userAddress - The address of the user to get the credit record details for.
- * @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 credit record details for.
- * @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

@@ -1 +0,0 @@
-{"version":3,"file":"usePoolContract.js","sourceRoot":"","sources":["../../../src/hooks/usePoolContract.ts"],"names":[],"mappings":";;;AAEA,iCAAwD;AAGxD,+CAA2C;AAC3C,gDAA+C;AAE/C;;;;;;;;GAQG;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;AAkCD;;;;;;;GAOG;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/useReceivableFactoringPoolContract.d.ts

@@ -1,10 +0,0 @@
-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/cjs/hooks/useReceivableFactoringPoolContract.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useReceivableFactoringPoolContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
-const usePoolContract_1 = require("./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.
- */
-function useReceivableFactoringPoolContract(signerOrProvider, chainId, poolName) {
-    return (0, usePoolContract_1.usePoolContract)(signerOrProvider, chainId, poolName, huma_shared_1.POOL_TYPE.Invoice);
-}
-exports.useReceivableFactoringPoolContract = useReceivableFactoringPoolContract;
-//# sourceMappingURL=useReceivableFactoringPoolContract.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useReceivableFactoringPoolContract.js","sourceRoot":"","sources":["../../../src/hooks/useReceivableFactoringPoolContract.ts"],"names":[],"mappings":";;;AAAA,qDAI4B;AAG5B,uDAAmD;AAEnD;;;;;;GAMG;AACH,SAAgB,kCAAkC,CAChD,gBAA2D,EAC3D,OAAe,EACf,QAAmB;IAEnB,OAAO,IAAA,iCAAe,EACpB,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,uBAAS,CAAC,OAAO,CAClB,CAAA;AACH,CAAC;AAXD,gFAWC"}

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

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

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

@@ -1,62 +0,0 @@
-import { FundResponse, UploadResponse } from '@bundlr-network/client/build/common/types';
-import { Web3Provider } from '@ethersproject/providers';
-import { POOL_NAME, POOL_TYPE } from '@00labs/huma-shared';
-/**
- * The configuration for Bundlr network instances
- */
-export type BundlrConfig = {
-    nodeUrl: string;
-    currency: string;
-    providerUrl?: string;
-};
-/**
- * Get the configuration for Bundlr network given a chain ID.
- *
- * @function
- * @param {number} chainId - The chain ID.
- * @returns {BundlrConfig} - The configuration for the Bundlr network.
- *      nodeUrl - The node URL of the Bundlr network to use.
- *      currency - The currency to pay for uploads with, if lazy funding.
- *      providerUrl - The provider URL, required for devnets.
- */
-export declare function getBundlrNetworkConfig(chainId: number): BundlrConfig;
-/**
- * Prefund the Bundlr network with the specified amount. Useful if not lazy funding.
- *
- * @async
- * @function
- * @param {BundlrConfig} config - The configuration for the Bundlr network.
- * @param {any} wallet - The wallet to send funds from
- * @param {number} amount - The amount to fund.
- * @returns {Promise<FundResponse>} - The fund response.
- */
-export declare function prefundBundlr(config: BundlrConfig, wallet: any, amount: number): Promise<FundResponse>;
-/**
- * Store data on ARWeave using the Bundlr Network.
- * @async
- * @function
- * @param {BundlrConfig} config - Configuration object for the Bundlr instance.
- * @param {Web3Provider | ethers.Signer} wallet - 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 an `ethers.Signer` instance.
- * @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.
- */
-export declare function storeData(config: BundlrConfig, wallet: 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
- * @param {POOL_NAME} poolName - The pool name tag to query.
- * @param {POOL_TYPE} poolType - The pool type tag to query.
- * @param {string} sender - The sender tag to query.
- * @param {string} internalID - The internal ID tag to query, whatever was used when uploading the metadata.
- * @returns {Promise<any>} Promise resolving with the queried data.
- */
-export declare function queryForMetadata(chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, sender: string, internalId: string): Promise<string | null>;

package/dist/cjs/services/ARWeaveService.js

@@ -1,141 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryForMetadata = exports.storeData = exports.prefundBundlr = exports.getBundlrNetworkConfig = void 0;
-const tslib_1 = require("tslib");
-const client_1 = tslib_1.__importDefault(require("@bundlr-network/client"));
-const graphql_request_1 = tslib_1.__importStar(require("graphql-request"));
-/**
- * Get the configuration for Bundlr network given a chain ID.
- *
- * @function
- * @param {number} chainId - The chain ID.
- * @returns {BundlrConfig} - The configuration for the Bundlr network.
- *      nodeUrl - The node URL of the Bundlr network to use.
- *      currency - The currency to pay for uploads with, if lazy funding.
- *      providerUrl - The provider URL, required for devnets.
- */
-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: '',
-            };
-    }
-}
-exports.getBundlrNetworkConfig = getBundlrNetworkConfig;
-/**
- * Prefund the Bundlr network with the specified amount. Useful if not lazy funding.
- *
- * @async
- * @function
- * @param {BundlrConfig} config - The configuration for the Bundlr network.
- * @param {any} wallet - The wallet to send funds from
- * @param {number} amount - The amount to fund.
- * @returns {Promise<FundResponse>} - The fund response.
- */
-async function prefundBundlr(config, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-wallet, amount) {
-    const bundlr = new client_1.default(config.nodeUrl, config.currency, wallet, config.providerUrl
-        ? {
-            providerUrl: config.providerUrl,
-        }
-        : undefined);
-    await bundlr.ready();
-    return bundlr.fund(amount);
-}
-exports.prefundBundlr = prefundBundlr;
-/**
- * Store data on ARWeave using the Bundlr Network.
- * @async
- * @function
- * @param {BundlrConfig} config - Configuration object for the Bundlr instance.
- * @param {Web3Provider | ethers.Signer} wallet - 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 an `ethers.Signer` instance.
- * @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, wallet, data, tags, lazyFund = true) {
-    const bundlr = new client_1.default(config.nodeUrl, config.currency, wallet, 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 });
-}
-exports.storeData = storeData;
-/**
- * Helper method to query the Arweave network for receivables metadata previously uploaded.
- * @async
- * @function
- * @param {POOL_NAME} poolName - The pool name tag to query.
- * @param {POOL_TYPE} poolType - The pool type tag to query.
- * @param {string} sender - The sender tag to query.
- * @param {string} internalID - The internal ID tag to query, whatever was used when uploading the metadata.
- * @returns {Promise<any>} Promise resolving with the queried data.
- */
-async function queryForMetadata(chainId, poolName, poolType, sender, internalId) {
-    var _a, _b, _c, _d;
-    const config = getBundlrNetworkConfig(chainId);
-    const query = (0, graphql_request_1.gql) `
-    query ArweaveHumaMetadataQuery(
-      $poolName: String!
-      $poolType: String!
-      $sender: String!
-      $internalId: String!
-    ) {
-      transactions(
-        owners: [$sender]
-        tags: [
-          { name: "appName", values: ["HumaFinance"] }
-          { name: "poolName", values: [$poolName] }
-          { name: "poolType", values: [$poolType] }
-          { name: "internalId", values: [$internalId] }
-        ]
-      ) {
-        edges {
-          node {
-            id
-          }
-        }
-      }
-    }
-  `;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const data = await (0, graphql_request_1.default)(`${config.nodeUrl}/graphql`, query, {
-        poolName,
-        poolType,
-        sender,
-        internalId,
-    });
-    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;
-}
-exports.queryForMetadata = queryForMetadata;
-//# sourceMappingURL=ARWeaveService.js.map