@huma-finance/sdk 0.0.8 → 0.0.10

package/README.md

@@ -1,31 +1,31 @@
-# 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](docs/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
+# 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.8",
+  "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.8",
+    "@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": "d9e7878a7b163ccc5b29959eb8a0fbb73c988244"
+  "gitHead": "61b1485097a4e7e6d2f1c2825454b9d2283c2a6c"
 }

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

@@ -1,10 +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 {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,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBaseCreditPoolReceivableContract = 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 getBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    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, 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,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

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

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

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

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

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

@@ -1 +0,0 @@
-{"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,3 +0,0 @@
-export * from './BaseCreditPoolReceivableContractHelper';
-export * from './ERC20TransferableReceivableContractHelper';
-export * from './PoolContractHelper';

package/dist/cjs/helpers/index.js

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

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

package/dist/cjs/hooks/index.js

@@ -1,8 +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);
-//# 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"}

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

@@ -1,10 +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 {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,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useBaseCreditPoolReceivableContract = 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 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 useBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    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 +0,0 @@
-{"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

@@ -1,13 +0,0 @@
-import { Contract } from '@ethersproject/contracts';
-import { ethers } from 'ethers';
-/**
- * Custom hook for creating an ethers instance of a smart contract.
- *
- * @template T - The type of the contract.
- * @param {string | null | undefined} address - The address of the smart contract instance.
- * @param {any} ABI - The ABI of the smart contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
- * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
- * @returns {T | null} An instance of the smart contract, or null if an error occurs.
- */
-export declare function useContract<T extends Contract = Contract>(address: string | null | undefined, ABI: any, signerOrProvider: ethers.providers.Provider | ethers.Signer): T | null;

package/dist/cjs/hooks/useContract.js

@@ -1,31 +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.
- *
- * @template T - The type of the contract.
- * @param {string | null | undefined} address - The address of the smart contract instance.
- * @param {any} ABI - The ABI of the smart contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
- * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
- * @returns {T | null} An instance of the smart contract, or null if an error occurs.
- */
-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;;;;;;;;;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 +0,0 @@
-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

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

@@ -1 +0,0 @@
-{"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,60 +0,0 @@
-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.
- *
- * @namespace 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

@@ -1,54 +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 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.
- *
- * @namespace 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

@@ -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;;;;;;;;;;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/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"}