@huma-finance/sdk 0.0.7 → 0.0.8

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.
+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](docs/getting-started.md)
 
 ## Documentation
 
-For documentation on the different functions offered please refer to the [API](API.md)
+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
 
-## Example Usage
+## Examples
 
-To see how the Huma SDK can be used, feel free to use our interactive example in the `huma-widgets` package.
+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
+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/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.d.ts

@@ -3,7 +3,8 @@ 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.
+ * @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 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 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBaseCreditPoolReceivableContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
+const shared_1 = require("@huma-finance/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.
+ * @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 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];
+    const baseCreditPoolReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.BaseCreditPoolReceivable];
     if (!baseCreditPoolReceivable)
         return null;
-    return (0, utils_1.getContract)(baseCreditPoolReceivable, huma_shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
+    return (0, utils_1.getContract)(baseCreditPoolReceivable, shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
 }
 exports.getBaseCreditPoolReceivableContract = getBaseCreditPoolReceivableContract;
 //# sourceMappingURL=BaseCreditPoolReceivableContractHelper.js.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"BaseCreditPoolReceivableContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/BaseCreditPoolReceivableContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAI6B;AAE7B,oCAAsC;AAEtC;;;;;;;GAOG;AACH,SAAgB,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,IAAI,CAAC,wBAAwB;QAAE,OAAO,IAAI,CAAA;IAE1C,OAAO,IAAA,mBAAW,EAChB,wBAAwB,EACxB,wCAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC;AAhBD,kFAgBC"}

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

@@ -0,0 +1,10 @@
+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 {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 BaseCreditPoolReceivable contract or null if it could not be found.
+ */
+export declare function getERC20TransferableReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getERC20TransferableReceivableContract = void 0;
+const shared_1 = require("@huma-finance/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 {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 BaseCreditPoolReceivable contract or null if it could not be found.
+ */
+function getERC20TransferableReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const erc20TransferableReceiable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.ERC20TransferableReceivable];
+    if (!erc20TransferableReceiable)
+        return null;
+    return (0, utils_1.getContract)(erc20TransferableReceiable, shared_1.ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.getERC20TransferableReceivableContract = getERC20TransferableReceivableContract;
+//# sourceMappingURL=ERC20TransferableReceivableContractHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ERC20TransferableReceivableContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/ERC20TransferableReceivableContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAI6B;AAE7B,oCAAsC;AAEtC;;;;;;;GAOG;AACH,SAAgB,sCAAsC,CACpD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,0BAA0B,GAC9B,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,2BAA2B,CACnD,CAAA;IAEH,IAAI,CAAC,0BAA0B;QAAE,OAAO,IAAI,CAAA;IAE5C,OAAO,IAAA,mBAAW,EAChB,0BAA0B,EAC1B,0CAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC;AAhBD,wFAgBC"}

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

@@ -0,0 +1,12 @@
+import { Contract, ethers } from 'ethers';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+/**
+ * Returns an ethers contract instance for a Huma pool contract
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName The name of the pool contract to get.
+ * @param {POOL_TYPE} poolType The type of the pool contract to get.
+ * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
+ */
+export declare function getPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Contract | null;

package/dist/cjs/helpers/PoolContractHelper.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPoolContract = void 0;
+const utils_1 = require("../utils");
+/**
+ * Returns an ethers contract instance for a Huma pool contract
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName The name of the pool contract to get.
+ * @param {POOL_TYPE} poolType The type of the pool contract to get.
+ * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
+ */
+function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
+    const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
+    if (!poolInfo)
+        return null;
+    return (0, utils_1.getContract)(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
+}
+exports.getPoolContract = getPoolContract;
+//# sourceMappingURL=PoolContractHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAGA,oCAAmD;AAEnD;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAXD,0CAWC"}

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

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

package/dist/cjs/helpers/index.js

@@ -2,4 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./BaseCreditPoolReceivableContractHelper"), exports);
+tslib_1.__exportStar(require("./ERC20TransferableReceivableContractHelper"), exports);
+tslib_1.__exportStar(require("./PoolContractHelper"), exports);
 //# sourceMappingURL=index.js.map

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

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

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

@@ -2,4 +2,3 @@ export * from './useContract';
 export * from './useBaseCreditPoolReceivableContract';
 export * from './useERC20TransferableReceivableContract';
 export * from './usePoolContract';
-export * from './useReceivableFactoringPoolContract';

package/dist/cjs/hooks/index.js

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

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

@@ -3,7 +3,8 @@ 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.
+ * @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 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 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useBaseCreditPoolReceivableContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
+const shared_1 = require("@huma-finance/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.
+ * @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 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);
+    const baseCreditPoolReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.BaseCreditPoolReceivable];
+    return (0, useContract_1.useContract)(baseCreditPoolReceivable, shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
 }
 exports.useBaseCreditPoolReceivableContract = useBaseCreditPoolReceivableContract;
 //# sourceMappingURL=useBaseCreditPoolReceivableContract.js.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"useBaseCreditPoolReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useBaseCreditPoolReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAE7B,+CAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,OAAO,IAAA,yBAAW,EAChB,wBAAwB,EACxB,wCAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC;AAdD,kFAcC"}

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

@@ -2,10 +2,12 @@ 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.
+ *
+ * @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 An instance of the smart contract, or null if an error occurs.
+ * @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/cjs/hooks/useContract.js

@@ -5,11 +5,13 @@ 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.
+ *
+ * @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 An instance of the smart contract, or null if an error occurs.
+ * @returns {T | null} An instance of the smart contract, or null if an error occurs.
  */
 function useContract(address, 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"useContract.js","sourceRoot":"","sources":["../../../src/hooks/useContract.ts"],"names":[],"mappings":";;;AACA,iCAA+B;AAG/B,wCAA2C;AAE3C;;;;;;;;;GASG;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 +1,12 @@
-import { JsonRpcProvider, JsonRpcSigner } from '@ethersproject/providers';
-import { Contract } from 'ethers';
-import { POOL_NAME } from '@00labs/huma-shared';
+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 {JsonRpcProvider | JsonRpcSigner} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
  * @param {POOL_NAME} poolName The name of the pool 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;
+export declare function useERC20TransferableReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME): Contract | null;

package/dist/cjs/hooks/useERC20TransferableReceivableContract.js

@@ -1,24 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useERC20TransferableReceivableContract = void 0;
-const huma_shared_1 = require("@00labs/huma-shared");
+const shared_1 = require("@huma-finance/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 {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, poolName) {
+function useERC20TransferableReceivableContract(signerOrProvider, chainId, 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);
+    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

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

@@ -1,11 +1,13 @@
 import { BigNumber } from '@ethersproject/bignumber';
 import { Contract, ethers } from 'ethers';
-import { POOL_NAME, POOL_TYPE } from '@00labs/huma-shared';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
 /**
- * A react hook that returns a contract instance of a specific pool using an ethers JsonRpcProvider or JsonRpcSigner.
+ * 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 {JsonRpcProvider | JsonRpcSigner} signerOrProvider - A JsonRpcProvider or JsonRpcSigner instance.
+ * @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.
@@ -13,6 +15,8 @@ import { POOL_NAME, POOL_TYPE } from '@00labs/huma-shared';
 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
@@ -45,9 +49,12 @@ export type CreditRecordDetails = {
 /**
  * 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.
  *
+ * @namespace usePoolContract
  * @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 {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

@@ -5,10 +5,12 @@ 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.
+ * 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 {JsonRpcProvider | JsonRpcSigner} signerOrProvider - A JsonRpcProvider or JsonRpcSigner instance.
+ * @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.
@@ -21,9 +23,12 @@ 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.
  *
+ * @namespace usePoolContract
  * @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 {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) {

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

@@ -1 +1 @@
-{"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"}
+{"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/services/ARWeaveService.d.ts

@@ -1,8 +1,15 @@
 import { FundResponse, UploadResponse } from '@bundlr-network/client/build/common/types';
 import { Web3Provider } from '@ethersproject/providers';
-import { POOL_NAME, POOL_TYPE } from '@00labs/huma-shared';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
 /**
  * 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;
@@ -10,53 +17,68 @@ export type BundlrConfig = {
     providerUrl?: string;
 };
 /**
- * Get the configuration for Bundlr network given a chain ID.
+ * 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.
- *      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.
+ * 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} wallet - The wallet to send funds from
- * @param {number} amount - The amount to fund.
+ * @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.
  */
-export declare function prefundBundlr(config: BundlrConfig, wallet: any, amount: number): Promise<FundResponse>;
+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 | ethers.Signer} wallet - Wallet object used for interacting with 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 an `ethers.Signer` instance.
+ *         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.
  */
-export declare function storeData(config: BundlrConfig, wallet: Web3Provider | string, data: JSON, tags: {
+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 {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.
+ * @param {string} referenceId - The referenceId 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>;
+declare function queryForMetadata(chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, 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 {};