@huma-finance/sdk 0.0.21 → 0.0.24

package/dist/cjs/hooks/usePoolContract.js

@@ -1,54 +1,54 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCreditRecordDetails = exports.usePoolContract = void 0;
-const react_1 = require("react");
-const useContract_1 = require("./useContract");
-const poolInfo_1 = require("../utils/poolInfo");
-/**
- * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
- *
- * @namespace usePoolContract
- * @template T - The type of the contract.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName - The name of the pool.
- * @param {POOL_TYPE} poolType - The type of the pool.
- * @returns {T} A contract instance of the specific pool.
- */
-function usePoolContract(signerOrProvider, chainId, poolName, poolType) {
-    const poolInfo = (0, poolInfo_1.getPoolInfo)(chainId, poolName, poolType);
-    return (0, useContract_1.useContract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.pool, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolAbi, signerOrProvider);
-}
-exports.usePoolContract = usePoolContract;
-/**
- * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
- *
- * @memberof usePoolContract
- * @param {string} userAddress - The address of the user to get the credit record details for.
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @param {POOL_NAME} poolName - The name of the pool to get the credit record details for.
- * @param {POOL_TYPE} poolType - The type of the pool.
- * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
- */
-function useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) {
-    const poolContract = usePoolContract(signerOrProvider, chainId, poolName, poolType);
-    const [creditRecordDetails, setCreditRecordDetails] = (0, react_1.useState)();
-    const [refreshCount, setRefreshCount] = (0, react_1.useState)(0);
-    (0, react_1.useEffect)(() => {
-        const fetchData = async () => {
-            if (poolContract && userAddress) {
-                const creditRecordMapping = await poolContract.creditRecordMapping(userAddress);
-                const creditRecordStaticMapping = await poolContract.creditRecordStaticMapping(userAddress);
-                setCreditRecordDetails(Object.assign(Object.assign({}, creditRecordMapping), creditRecordStaticMapping));
-            }
-        };
-        fetchData();
-    }, [userAddress, poolContract, refreshCount]);
-    const refresh = (0, react_1.useCallback)(() => {
-        setRefreshCount((pre) => pre + 1);
-    }, []);
-    return [creditRecordDetails, refresh];
-}
-exports.useCreditRecordDetails = useCreditRecordDetails;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCreditRecordDetails = exports.usePoolContract = void 0;
+const react_1 = require("react");
+const useContract_1 = require("./useContract");
+const poolInfo_1 = require("../utils/poolInfo");
+/**
+ * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
+ *
+ * @namespace usePoolContract
+ * @template T - The type of the contract.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {T} A contract instance of the specific pool.
+ */
+function usePoolContract(signerOrProvider, chainId, poolName, poolType) {
+    const poolInfo = (0, poolInfo_1.getPoolInfo)(chainId, poolName, poolType);
+    return (0, useContract_1.useContract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.pool, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolAbi, signerOrProvider);
+}
+exports.usePoolContract = usePoolContract;
+/**
+ * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
+ *
+ * @memberof usePoolContract
+ * @param {string} userAddress - The address of the user to get the credit record details for.
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @param {POOL_NAME} poolName - The name of the pool to get the credit record details for.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
+ */
+function useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) {
+    const poolContract = usePoolContract(signerOrProvider, chainId, poolName, poolType);
+    const [creditRecordDetails, setCreditRecordDetails] = (0, react_1.useState)();
+    const [refreshCount, setRefreshCount] = (0, react_1.useState)(0);
+    (0, react_1.useEffect)(() => {
+        const fetchData = async () => {
+            if (poolContract && userAddress) {
+                const creditRecordMapping = await poolContract.creditRecordMapping(userAddress);
+                const creditRecordStaticMapping = await poolContract.creditRecordStaticMapping(userAddress);
+                setCreditRecordDetails(Object.assign(Object.assign({}, creditRecordMapping), creditRecordStaticMapping));
+            }
+        };
+        fetchData();
+    }, [userAddress, poolContract, refreshCount]);
+    const refresh = (0, react_1.useCallback)(() => {
+        setRefreshCount((pre) => pre + 1);
+    }, []);
+    return [creditRecordDetails, refresh];
+}
+exports.useCreditRecordDetails = useCreditRecordDetails;
 //# sourceMappingURL=usePoolContract.js.map

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

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

package/dist/cjs/hooks/useRealWorldReceivableContract.js

@@ -1,20 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useRealWorldReceivableContract = void 0;
-const shared_1 = require("@huma-finance/shared");
-const useContract_1 = require("./useContract");
-/**
- * A react hook that returns an ethers contract instance for the RealWorldReceivable contract
- * associated with the given pool name on the current chain.
- *
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
- * @param {number} chainId The chain id where the contract instance exists
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
- */
-function useRealWorldReceivableContract(signerOrProvider, chainId) {
-    var _a;
-    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
-    return (0, useContract_1.useContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
-}
-exports.useRealWorldReceivableContract = useRealWorldReceivableContract;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRealWorldReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const useContract_1 = require("./useContract");
+/**
+ * A react hook that returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+function useRealWorldReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
+    return (0, useContract_1.useContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.useRealWorldReceivableContract = useRealWorldReceivableContract;
 //# sourceMappingURL=useRealWorldReceivableContract.js.map

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./helpers"), exports);
-tslib_1.__exportStar(require("./hooks"), exports);
-tslib_1.__exportStar(require("./services"), exports);
-tslib_1.__exportStar(require("./utils"), exports);
+"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/services/ARWeaveService.d.ts

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