@huma-finance/sdk 0.0.8 → 0.0.11

package/dist/services/ARWeaveService.js

@@ -1,147 +1,147 @@
-import Bundlr from '@bundlr-network/client';
-import request, { gql } from 'graphql-request';
-/**
- * Get the configuration for Bundlr network given a chain ID
- *
- * @function
- * @memberof ArweaveService
- * @param {number} chainId - The chain ID.
- * @returns {BundlrConfig} - The configuration for the Bundlr network.
- */
-export 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: '',
-            };
-    }
-}
-/**
- * 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.
- */
-async function prefundBundlr(config, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-signer, amount) {
-    const bundlr = new Bundlr(config.nodeUrl, config.currency, signer, config.providerUrl
-        ? {
-            providerUrl: config.providerUrl,
-        }
-        : undefined);
-    await bundlr.ready();
-    return bundlr.fund(amount);
-}
-/**
- * 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.
- */
-async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true) {
-    const bundlr = new Bundlr(config.nodeUrl, config.currency, signerOrPrivateKey, config.providerUrl
-        ? {
-            providerUrl: config.providerUrl,
-        }
-        : undefined);
-    await bundlr.ready();
-    const dataStr = JSON.stringify(data);
-    if (lazyFund) {
-        const size = Buffer.byteLength(dataStr);
-        const price = await bundlr.getPrice(size);
-        // Add a buffer of 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 });
-}
-/**
- * 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} referenceId - The referenceId tag to query, whatever was used when uploading the metadata.
- * @returns {Promise<any>} Promise resolving with the queried data.
- */
-async function queryForMetadata(chainId, poolName, poolType, sender, referenceId) {
-    var _a, _b, _c, _d;
-    const config = getBundlrNetworkConfig(chainId);
-    const query = gql `
-    query ArweaveHumaMetadataQuery(
-      $poolName: String!
-      $poolType: String!
-      $sender: String!
-      $referenceId: String!
-    ) {
-      transactions(
-        owners: [$sender]
-        tags: [
-          { name: "appName", values: ["HumaFinance"] }
-          { name: "poolName", values: [$poolName] }
-          { name: "poolType", values: [$poolType] }
-          { name: "referenceId", values: [$referenceId] }
-        ]
-      ) {
-        edges {
-          node {
-            id
-          }
+import Bundlr from '@bundlr-network/client';
+import request, { gql } from 'graphql-request';
+/**
+ * Get the configuration for Bundlr network given a chain ID
+ *
+ * @function
+ * @memberof ArweaveService
+ * @param {number} chainId - The chain ID.
+ * @returns {BundlrConfig} - The configuration for the Bundlr network.
+ */
+export 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: '',
+            };
+    }
+}
+/**
+ * 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.
+ */
+async function prefundBundlr(config, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+signer, amount) {
+    const bundlr = new Bundlr(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    return bundlr.fund(amount);
+}
+/**
+ * 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.
+ */
+async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true) {
+    const bundlr = new Bundlr(config.nodeUrl, config.currency, signerOrPrivateKey, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
         }
-      }
+        : undefined);
+    await bundlr.ready();
+    const dataStr = JSON.stringify(data);
+    if (lazyFund) {
+        const size = Buffer.byteLength(dataStr);
+        const price = await bundlr.getPrice(size);
+        // Add a buffer of 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);
     }
-  `;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const data = await request(`${config.nodeUrl}/graphql`, query, {
-        poolName,
-        poolType,
-        sender,
-        referenceId,
-    });
-    return (_d = (_c = (_b = (_a = data === null || data === void 0 ? void 0 : data.transactions) === null || _a === void 0 ? void 0 : _a.edges) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.node) === null || _d === void 0 ? void 0 : _d.id;
-}
-/**
- * An object that contains functions to interact with Huma-related data stored on ARWeave
- * @namespace ARWeaveService
- */
-export const ARWeaveService = {
-    queryForMetadata,
-    storeData,
-    prefundBundlr,
-    getBundlrNetworkConfig,
-};
+    return bundlr.upload(dataStr, { tags });
+}
+/**
+ * Helper method to query the Arweave network for receivables metadata previously uploaded.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {number} chainId - The chain ID.
+ * @param {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} referenceId - The referenceId tag to query, whatever was used when uploading the metadata.
+ * @returns {Promise<any>} Promise resolving with the queried data.
+ */
+async function queryForMetadata(chainId, poolName, poolType, sender, referenceId) {
+    var _a, _b, _c, _d;
+    const config = getBundlrNetworkConfig(chainId);
+    const query = gql `
+    query ArweaveHumaMetadataQuery(
+      $poolName: String!
+      $poolType: String!
+      $sender: String!
+      $referenceId: String!
+    ) {
+      transactions(
+        owners: [$sender]
+        tags: [
+          { name: "appName", values: ["HumaFinance"] }
+          { name: "poolName", values: [$poolName] }
+          { name: "poolType", values: [$poolType] }
+          { name: "referenceId", values: [$referenceId] }
+        ]
+      ) {
+        edges {
+          node {
+            id
+          }
+        }
+      }
+    }
+  `;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const data = await request(`${config.nodeUrl}/graphql`, query, {
+        poolName,
+        poolType,
+        sender,
+        referenceId,
+    });
+    return (_d = (_c = (_b = (_a = data === null || data === void 0 ? void 0 : data.transactions) === null || _a === void 0 ? void 0 : _a.edges) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.node) === null || _d === void 0 ? void 0 : _d.id;
+}
+/**
+ * An object that contains functions to interact with Huma-related data stored on ARWeave
+ * @namespace ARWeaveService
+ */
+export const ARWeaveService = {
+    queryForMetadata,
+    storeData,
+    prefundBundlr,
+    getBundlrNetworkConfig,
+};
 //# sourceMappingURL=ARWeaveService.js.map

package/dist/services/EAService.d.ts

@@ -1,36 +1,18 @@
-/**
- * Object representing the information returned from a successful evaluation agent approve operation.
- *
- * @typedef {Object} ApproveInfo
- * @memberof EAService
- * @property {number} aprInBps The annual percentage rate in basis points.
- * @property {number|string} creditLimit The credit limit for the borrower in the pool's base currency.
- * @property {number} intervalInDays The interval in days for credit line rebalancing.
- * @property {number|string} receivableAmount The expected payment amount of the receivable asset.
- * @property {string} receivableAsset The address of the receivable asset contract.
- * @property {number|string} receivableParam The identifying parameter for the receivable asset, often the token ID of an ERC721.
- * @property {number} remainingPeriods The number of remaining payback periods in the credit line.
- * @property {number} tokenDecimal The number of decimals for the base token of the pool.
- * @property {string} tokenName The name of the base token of the pool.
- * @property {string} tokenSymbol The symbol of the base token of the pool.
- */
-/**
- * Object representing an invoice payload for underwriting approval.
- *
- * @typedef {Object} EAPayload
- */
-export type { ApproveInfo, EAPayload } from '@huma-finance/shared';
-/**
- * An object that contains functions to interact with Huma's EAVerse service.
- *
- * @namespace EAService
- *
- * approve: Submits a credit underwriting request to Huma's EAVerse.
- * @param {EAPayload} payload The payload for the underwrite approval.
- * @param {number} chainId The chain ID.
- * @returns {Promise<ApproveInfo>} Promise that returns approval info on success.
- * @throws {EARejectionError} If the underwrite approval is rejected.
- */
-export declare const EAService: {
-    approve: (payload: import("@huma-finance/shared").EAPayload, chainId: number, isDev?: boolean | undefined) => Promise<import("@huma-finance/shared").ApproveInfo>;
-};
+/**
+ * Object representing the response to the underwriting approval request.
+ * @typedef {Object} ApprovalResult
+ */
+/**
+ * Object representing an invoice payload for underwriting approval.
+ *
+ * @typedef {Object} EAPayload
+ */
+export type { ApprovalResult, EAPayload } from '@huma-finance/shared';
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+export declare const EAService: {
+    approve: (payload: import("@huma-finance/shared").EAPayload, chainId: number, isDev?: boolean | undefined) => Promise<import("@huma-finance/shared").Approval>;
+};

package/dist/services/EAService.js

@@ -1,16 +1,10 @@
-import { EAService as EAServiceInternal } from '@huma-finance/shared';
-/**
- * An object that contains functions to interact with Huma's EAVerse service.
- *
- * @namespace EAService
- *
- * approve: Submits a credit underwriting request to Huma's EAVerse.
- * @param {EAPayload} payload The payload for the underwrite approval.
- * @param {number} chainId The chain ID.
- * @returns {Promise<ApproveInfo>} Promise that returns approval info on success.
- * @throws {EARejectionError} If the underwrite approval is rejected.
- */
-export const EAService = {
-    approve: EAServiceInternal.approve,
-};
+import { EAService as EAServiceInternal } from '@huma-finance/shared';
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+export const EAService = {
+    approve: EAServiceInternal.approve,
+};
 //# sourceMappingURL=EAService.js.map

package/dist/services/EAService.js.map

@@ -1 +1 @@
-{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../src/services/EAService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAyBrE;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,OAAO,EAAE,iBAAiB,CAAC,OAAO;CACnC,CAAA"}
+{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../src/services/EAService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAarE;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,OAAO,EAAE,iBAAiB,CAAC,OAAO;CACnC,CAAA"}

package/dist/services/ReceivableService.d.ts

@@ -1,95 +1,76 @@
-import { TransactionReceipt, TransactionResponse, Web3Provider } from '@ethersproject/providers';
-import { BigNumberish, ethers, Overrides } from 'ethers';
-import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
-/**
- * Enumeration of payment methods. Maps to the PaymentMethod enum in the BaseCreditPoolReceivable contract.
- * Declarative payment methods are those that do not actually send ERC20 funds. Payable payment methods are those that
- * do by calling makePayment on the BaseCreditPool contract.
- *
- * @enum {number}
- * @memberof ReceivableService
- */
-export declare enum PaymentMethod {
-    Declarative = 0,
-    Payable = 1
-}
-/**
- * Pays a BaseCreditPoolReceivable using the specified payment method, given an referenceId mapping to the receivable's metadata
- *
- * @memberof ReceivableService
- * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
- * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
- * @param {number} paymentAmount - The amount to pay the receivable.
- * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
- * @returns {Promise<TransactionReceipt>} - A Promise of the transaction receipt.
- * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
- */
-declare function payReceivableByReferenceId(signer: ethers.Signer, referenceId: string, paymentAmount: number, paymentMethod: PaymentMethod): Promise<TransactionReceipt>;
-/**
- * Pays a BaseCreditPoolReceivable using the specified payment method, given a tokenID of the receivable.
- *
- * @memberof ReceivableService
- * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
- * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
- * @param {number} paymentAmount - The amount to pay the receivable.
- * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
- * @returns {Promise<TransactionReceipt>} - A Promise of the transaction receipt.
- * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
- */
-declare function payReceivableByTokenId(signer: ethers.Signer, receivableTokenId: BigNumberish, paymentAmount: number, paymentMethod: PaymentMethod): Promise<TransactionReceipt>;
-/**
- * Mints a new BaseCreditPoolReceivable token on the given chain of the signer
- *
- * @memberof ReceivableService
- * @param {ethers.Signer} signer - The signer used to send the transaction.
- * @param {string} recipient - The address of the recipient of the receivable token.
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
- * @param {number} receivableAmount - The amount of the receivable token to mint.
- * @param {number} maturityDate - The maturity date of the receivable token, in UNIX timestamp format.
- * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
- * @param {string} uri - The URI of the receivable token metadata.
- * @param {Overrides} gasOpts - The gas options to use for the transaction.
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
- * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
- */
-declare function mintReceivable(signer: ethers.Signer, poolName: POOL_NAME, poolType: POOL_TYPE, receivableAmount: number, maturityDate: number, paymentMethod: PaymentMethod, uri: string, gasOpts?: Overrides): Promise<TransactionResponse>;
-/**
- * Mints a BaseCreditPoolReceivable token with metadata uploaded onto ARWeave
- *
- * @memberof ReceivableService
- * @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
- *      If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
- *      from server calls.
- * @param {string | null} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
- * @param {number} chainId - The chain ID to mint the receivable token on and pay ARWeave funds from.
- * @param {string} recipient - The receivable token recipient.
- * @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
- * @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
- * @param {number} receivableAmount - The receivable amount.
- * @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
- * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
- * @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
- * @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
- * @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
- *      ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
- * @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
- *      metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
- * @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
- * @returns {Promise<TransactionReceipt>} - The transaction receipt.
- */
-declare function mintReceivableWithMetadata(signerOrProvider: Web3Provider | ethers.Signer, privateKey: string | null, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, receivableAmount: number, maturityDate: number, paymentMethod: PaymentMethod, metadata: JSON, referenceId: string, extraTags: {
-    name: string;
-    value: string;
-}[], lazyFund?: boolean, gasOpts?: Overrides): Promise<TransactionReceipt>;
-/**
- * An object that contains functions to interact with Huma's receivables.
- * @namespace ReceivableService
- */
-export declare const ReceivableService: {
-    mintReceivableWithMetadata: typeof mintReceivableWithMetadata;
-    mintReceivable: typeof mintReceivable;
-    payReceivableByTokenId: typeof payReceivableByTokenId;
-    payReceivableByReferenceId: typeof payReceivableByReferenceId;
-};
-export {};
+import { TransactionResponse, Web3Provider } from '@ethersproject/providers';
+import { BigNumberish, ethers, Overrides } from 'ethers';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+declare function declareReceivablePaymentByReferenceId(signer: ethers.Signer, referenceId: string, paymentAmount: number): Promise<TransactionResponse>;
+/**
+ * Declares a payment on a RealWorldReceivable given a tokenID of the receivable.
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
+ * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
+ * @param {number} paymentAmount - The amount to pay the receivable.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
+ */
+declare function declareReceivablePaymentByTokenId(signer: ethers.Signer, receivableTokenId: BigNumberish, paymentAmount: number): Promise<TransactionResponse>;
+/**
+ * Creates a new RealWorldReceivable token on the given chain of the signer
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
+ * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
+ * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
+ * @param {number} receivableAmount - The amount of the receivable token to mint.
+ * @param {number} maturityDate - The maturity date of the receivable token, in UNIX timestamp format.
+ * @param {string} uri - The URI of the receivable token metadata.
+ * @param {Overrides} gasOpts - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
+ */
+declare function createReceivable(signer: ethers.Signer, poolName: POOL_NAME, poolType: POOL_TYPE, currencyCode: number, receivableAmount: number, maturityDate: number, uri: string, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * Creates a RealWorldReceivable token with metadata uploaded onto ARWeave
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
+ *      If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
+ *      from server calls.
+ * @param {string | null} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
+ * @param {number} chainId - The chain ID to mint the receivable token on and pay ARWeave funds from.
+ * @param {string} recipient - The receivable token recipient.
+ * @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
+ * @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
+ * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
+ * @param {number} receivableAmount - The receivable amount.
+ * @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
+ * @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
+ * @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
+ * @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
+ *      ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
+ * @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
+ *      metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
+ * @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
+ * @returns {Promise<TransactionResponse>} - The transaction receipt.
+ */
+declare function createReceivableWithMetadata(signerOrProvider: Web3Provider | ethers.Signer, privateKey: string | null, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, currencyCode: number, receivableAmount: number, maturityDate: number, metadata: JSON, referenceId: string, extraTags: {
+    name: string;
+    value: string;
+}[], lazyFund?: boolean, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * An object that contains functions to interact with Huma's receivables.
+ * @namespace ReceivableService
+ */
+export declare const ReceivableService: {
+    createReceivableWithMetadata: typeof createReceivableWithMetadata;
+    createReceivable: typeof createReceivable;
+    declareReceivablePaymentByTokenId: typeof declareReceivablePaymentByTokenId;
+    declareReceivablePaymentByReferenceId: typeof declareReceivablePaymentByReferenceId;
+};
+export {};