@huma-finance/sdk 0.0.11 → 0.0.13

package/dist/services/ReceivableService.d.ts

@@ -1,76 +1,87 @@
-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 {};
+import { TransactionResponse, Web3Provider } from '@ethersproject/providers';
+import { BigNumberish, ethers, Overrides } from 'ethers';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+/**
+ * Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
+ *
+ * @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 {string} referenceId -  An internal identifier value added as a tag on ARWeave
+ * @param {number} paymentAmount - The amount to declare paid to the receivable.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ */
+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 {};

package/dist/services/ReceivableService.js

@@ -1,135 +1,185 @@
-import { Web3Provider } from '@ethersproject/providers';
-import { REAL_WORLD_RECEIVABLE_ABI, PoolContractMap, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
-import { getContract } from '../utils';
-import { ARWeaveService } from './ARWeaveService';
-import { getChainIdFromSignerOrProvider } from '../utils/chain';
-async function declareReceivablePaymentByReferenceId(
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-signer, 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-referenceId, 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-paymentAmount) {
-    throw new Error('Not implemented');
-}
-/**
- * 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.
- */
-async function declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount) {
-    var _a;
-    const chainId = await getChainIdFromSignerOrProvider(signer);
-    const realWorldReceivable = chainId
-        ? (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable]
-        : null;
-    if (!realWorldReceivable) {
-        throw new Error('RealWorldReceivable is not available on this network');
+import { Web3Provider } from '@ethersproject/providers';
+import { ChainEnum, PoolContractMap, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
+import request, { gql } from 'graphql-request';
+import { ARWeaveService } from './ARWeaveService';
+import { getRealWorldReceivableContract } from '../helpers';
+import { getChainIdFromSignerOrProvider } from '../utils/chain';
+/**
+ * Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
+ *
+ * @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 {string} referenceId -  An internal identifier value added as a tag on ARWeave
+ * @param {number} paymentAmount - The amount to declare paid to the receivable.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ */
+async function declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount) {
+    var _a, _b, _c;
+    const chainId = await getChainIdFromSignerOrProvider(signer);
+    const signerAddress = await signer.getAddress();
+    if (!chainId) {
+        throw new Error('No Chain ID found');
+    }
+    // Get ARWeave ID
+    const dataID = await ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
+    // Fetch receivables with the same ARWeave ID
+    const receivablesQuery = gql `
+    query ReceivablesByURIQuery($owner: String!, $uri: String!) {
+      receivables(where: { owner: $owner, uri: $uri }) {
+        ...ReceivableFields
+      }
     }
-    const contract = getContract(realWorldReceivable, REAL_WORLD_RECEIVABLE_ABI, signer);
-    if (!contract) {
-        throw new Error('Could not find RealWorldReceivable contract');
+
+    fragment ReceivableFields on Receivable {
+      tokenId
     }
-    return contract.declarePayment(receivableTokenId, paymentAmount);
-}
-/**
- * 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.
- */
-async function createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts = {}) {
-    var _a, _b, _c;
-    const chainId = await getChainIdFromSignerOrProvider(signer);
-    const realWorldReceivable = chainId
-        ? (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable]
-        : null;
-    const poolInfo = chainId
-        ? (_c = (_b = PoolContractMap[chainId]) === null || _b === void 0 ? void 0 : _b[poolType]) === null || _c === void 0 ? void 0 : _c[poolName]
-        : undefined;
-    if (!realWorldReceivable || !poolInfo) {
-        throw new Error('RealWorldReceivable is not available on this network');
-    }
-    const contract = getContract(realWorldReceivable, REAL_WORLD_RECEIVABLE_ABI, signer);
-    if (!contract) {
-        throw new Error('Could not find RealWorldReceivable contract');
-    }
-    return contract.createRealWorldReceivable(poolInfo.pool, currencyCode, receivableAmount, maturityDate, uri, gasOpts);
-}
-/**
- * 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.
- */
-async function createReceivableWithMetadata(signerOrProvider, privateKey, chainId, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, lazyFund = true, gasOpts) {
-    const config = ARWeaveService.getBundlrNetworkConfig(chainId);
-    try {
-        const tags = [
-            { name: 'Content-Type', value: 'application/json' },
-            { name: 'appName', value: 'HumaFinance' },
-            { name: 'poolName', value: poolName },
-            { name: 'poolType', value: poolType },
-            { name: 'referenceId', value: referenceId },
-            ...extraTags,
-        ];
-        const response = await ARWeaveService.storeData(config, signerOrProvider instanceof Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
-        console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
-        return await createReceivable(signerOrProvider instanceof Web3Provider
-            ? signerOrProvider.getSigner()
-            : signerOrProvider, poolName, poolType, currencyCode, receivableAmount, maturityDate, `https://arweave.net/${response.id}`, gasOpts);
-    }
-    catch (e) {
-        console.error(e);
-        throw e;
-    }
-}
-/**
- * An object that contains functions to interact with Huma's receivables.
- * @namespace ReceivableService
- */
-export const ReceivableService = {
-    createReceivableWithMetadata,
-    createReceivable,
-    declareReceivablePaymentByTokenId,
-    declareReceivablePaymentByReferenceId,
-};
+  `;
+    let receivableSubgraph;
+    switch (chainId) {
+        case ChainEnum.Goerli:
+            receivableSubgraph = `https://api.thegraph.com/subgraphs/name/00labs/huma-receivables-goerli`;
+            break;
+        default:
+            throw new Error('No receivable subgraph exists for this chain');
+    }
+    const receivablesData = await request(receivableSubgraph, receivablesQuery, {
+        owner: signerAddress,
+        uri: `https://arweave.net/${dataID}`,
+    });
+    if (!(receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) || !((_a = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _a === void 0 ? void 0 : _a.length)) {
+        throw new Error('No receivables found with this ARWeave ID.');
+    }
+    else if (((_b = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _b === void 0 ? void 0 : _b.length) > 1) {
+        throw new Error(`This owner has multiple receivables with the same URI. Please burn 
+      unnecessary receivables or pay the correct token manually using declareReceivablePaymentByTokenId`);
+    }
+    const contract = getRealWorldReceivableContract(signer, chainId);
+    if (!contract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    return contract.declarePayment((_c = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables[0]) === null || _c === void 0 ? void 0 : _c.tokenId, paymentAmount);
+}
+/**
+ * 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.
+ */
+async function declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount) {
+    var _a;
+    const chainId = await getChainIdFromSignerOrProvider(signer);
+    if (!chainId) {
+        throw new Error('No Chain ID found');
+    }
+    const realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
+    if (!realWorldReceivable) {
+        throw new Error('RealWorldReceivable is not available on this network');
+    }
+    const contract = getRealWorldReceivableContract(signer, chainId);
+    if (!contract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    return contract.declarePayment(receivableTokenId, paymentAmount);
+}
+/**
+ * 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.
+ */
+async function createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts = {}) {
+    var _a, _b;
+    const chainId = await getChainIdFromSignerOrProvider(signer);
+    if (!chainId) {
+        throw new Error('No Chain ID found');
+    }
+    const poolInfo = chainId
+        ? (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[poolType]) === null || _b === void 0 ? void 0 : _b[poolName]
+        : undefined;
+    if (!poolInfo) {
+        throw new Error('RealWorldReceivable is not available on this network');
+    }
+    const contract = getRealWorldReceivableContract(signer, chainId);
+    if (!contract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    return contract.createRealWorldReceivable(poolInfo.pool, currencyCode, receivableAmount, maturityDate, uri, gasOpts);
+}
+/**
+ * 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.
+ */
+async function createReceivableWithMetadata(signerOrProvider, privateKey, chainId, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, lazyFund = true, gasOpts) {
+    const config = ARWeaveService.getBundlrNetworkConfig(chainId);
+    try {
+        const tags = [
+            { name: 'Content-Type', value: 'application/json' },
+            { name: 'appName', value: 'HumaFinance' },
+            { name: 'poolName', value: poolName },
+            { name: 'poolType', value: poolType },
+            { name: 'referenceId', value: referenceId },
+            ...extraTags,
+        ];
+        const response = await ARWeaveService.storeData(config, signerOrProvider instanceof Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
+        console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
+        return await createReceivable(signerOrProvider instanceof Web3Provider
+            ? signerOrProvider.getSigner()
+            : signerOrProvider, poolName, poolType, currencyCode, receivableAmount, maturityDate, `https://arweave.net/${response.id}`, gasOpts);
+    }
+    catch (e) {
+        console.error(e);
+        throw e;
+    }
+}
+/**
+ * An object that contains functions to interact with Huma's receivables.
+ * @namespace ReceivableService
+ */
+export const ReceivableService = {
+    createReceivableWithMetadata,
+    createReceivable,
+    declareReceivablePaymentByTokenId,
+    declareReceivablePaymentByReferenceId,
+};
 //# sourceMappingURL=ReceivableService.js.map

package/dist/services/ReceivableService.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../src/services/ReceivableService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAE5E,OAAO,EACL,yBAAyB,EAGzB,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAA;AAE/D,KAAK,UAAU,qCAAqC;AAClD,6DAA6D;AAC7D,MAAqB;AACrB,6DAA6D;AAC7D,WAAmB;AACnB,6DAA6D;AAC7D,aAAqB;IAErB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,iCAAiC,CAC9C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB;;IAErB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,mBAAmB,GAAG,OAAO;QACjC,CAAC,CAAC,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C;QACH,CAAC,CAAC,IAAI,CAAA;IAER,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,WAAW,CAC1B,mBAAmB,EACnB,yBAAyB,EACzB,MAAM,CACP,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;AAClE,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,gBAAgB,CAC7B,MAAqB,EACrB,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,GAAW,EACX,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,mBAAmB,GAAG,OAAO;QACjC,CAAC,CAAC,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C;QACH,CAAC,CAAC,IAAI,CAAA;IAER,MAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC;QAClD,CAAC,CAAC,SAAS,CAAA;IAEb,IAAI,CAAC,mBAAmB,IAAI,CAAC,QAAQ,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,WAAW,CAC1B,mBAAmB,EACnB,yBAAyB,EACzB,MAAM,CACP,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,yBAAyB,CACvC,QAAQ,CAAC,IAAI,EACb,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,GAAG,EACH,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,KAAK,UAAU,4BAA4B,CACzC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,QAAc,EACd,WAAmB,EACnB,SAA4C,EAC5C,WAAoB,IAAI,EACxB,OAAmB;IAEnB,MAAM,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,IAAI;QACF,MAAM,IAAI,GAAG;YACX,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE;YACnD,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE;YACzC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE;YAC3C,GAAG,SAAS;SACb,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,SAAS,CAC7C,MAAM,EACN,gBAAgB,YAAY,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAW,EACzE,QAAQ,EACR,IAAI,EACJ,QAAQ,CACT,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,yCAAyC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,OAAO,MAAM,gBAAgB,CAC3B,gBAAgB,YAAY,YAAY;YACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC9B,CAAC,CAAC,gBAAgB,EACpB,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,QAAQ,CAAC,EAAE,EAAE,EACpC,OAAO,CACR,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAChB,MAAM,CAAC,CAAA;KACR;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;CACtC,CAAA"}
+{"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../src/services/ReceivableService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAE5E,OAAO,EACL,SAAS,EAGT,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,YAAY,CAAA;AAC3D,OAAO,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAA;AAG/D;;;;;;;;;;GAUG;AACH,KAAK,UAAU,qCAAqC,CAClD,MAAqB,EACrB,WAAmB,EACnB,aAAqB;;IAErB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAC5D,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAA;IAE/C,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,iBAAiB;IACjB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,gBAAgB,CAClD,OAAO,EACP,aAAa,EACb,WAAW,CACZ,CAAA;IAED,6CAA6C;IAC7C,MAAM,gBAAgB,GAAG,GAAG,CAAA;;;;;;;;;;GAU3B,CAAA;IAED,IAAI,kBAAkB,CAAA;IACtB,QAAQ,OAAO,EAAE;QACf,KAAK,SAAS,CAAC,MAAM;YACnB,kBAAkB,GAAG,wEAAwE,CAAA;YAC7F,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAClE;IAED,MAAM,eAAe,GAAkC,MAAM,OAAO,CAClE,kBAAkB,EAClB,gBAAgB,EAChB;QACE,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,uBAAuB,MAAM,EAAE;KACrC,CACF,CAAA;IAED,IAAI,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAA,IAAI,CAAC,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAA,EAAE;QAC1E,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;KAC9D;SAAM,IAAI,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,IAAG,CAAC,EAAE;QACnD,MAAM,IAAI,KAAK,CACb;wGACkG,CACnG,CAAA;KACF;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,cAAc,CAC5B,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAC,CAAC,CAAC,0CAAE,OAAQ,EACzC,aAAa,CACd,CAAA;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,iCAAiC,CAC9C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB;;IAErB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,mBAAmB,GACvB,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;AAClE,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,gBAAgB,CAC7B,MAAqB,EACrB,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,GAAW,EACX,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC;QAClD,CAAC,CAAC,SAAS,CAAA;IAEb,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,yBAAyB,CACvC,QAAQ,CAAC,IAAI,EACb,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,GAAG,EACH,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,KAAK,UAAU,4BAA4B,CACzC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,QAAc,EACd,WAAmB,EACnB,SAA4C,EAC5C,WAAoB,IAAI,EACxB,OAAmB;IAEnB,MAAM,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,IAAI;QACF,MAAM,IAAI,GAAG;YACX,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE;YACnD,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE;YACzC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE;YAC3C,GAAG,SAAS;SACb,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,SAAS,CAC7C,MAAM,EACN,gBAAgB,YAAY,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAW,EACzE,QAAQ,EACR,IAAI,EACJ,QAAQ,CACT,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,yCAAyC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,OAAO,MAAM,gBAAgB,CAC3B,gBAAgB,YAAY,YAAY;YACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC9B,CAAC,CAAC,gBAAgB,EACpB,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,QAAQ,CAAC,EAAE,EAAE,EACpC,OAAO,CACR,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAChB,MAAM,CAAC,CAAA;KACR;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;CACtC,CAAA"}