@huma-finance/sdk 0.0.39 → 0.0.42-beta.100

package/dist/cjs/services/ReceivableService.d.ts

@@ -0,0 +1,158 @@
+import { TransactionResponse, Web3Provider } from '@ethersproject/providers';
+import { BigNumberish, ethers, Overrides } from 'ethers';
+import { POOL_NAME, POOL_TYPE, RealWorldReceivableInfo } from '@huma-finance/shared';
+import { Pagination } from './SubgraphService';
+/**
+ * Fetches the tokenId of a RealWorldReceivable, or null if it doesn't exist, given a metadata URI
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to lookup metadata uploads for
+ * @param {string} arweaveId -  The internal ARWeave identifier to lookup a token by
+ * @returns {Promise<string | null | undefined>} - Either the token Id or null if no token was found.
+ */
+declare function getTokenIdByURI(signer: ethers.Signer, uri: string | null): Promise<string | null | undefined>;
+/**
+ * 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.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ */
+declare function declareReceivablePaymentByReferenceId(signer: ethers.Signer, referenceId: string, paymentAmount: number, gasOpts?: Overrides): 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.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @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, gasOpts?: Overrides): 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 | null>} - A Promise of the transaction response.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network, or if a token already exists with the same metadata URI.
+ */
+declare function createReceivable(signer: ethers.Signer, poolName: POOL_NAME, poolType: POOL_TYPE, currencyCode: number, receivableAmount: number, maturityDate: number, uri: string, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * Uploads metadata onto ARWeave (or fetches the existing metadata with the same reference Id) and returns the ARWeave URL
+ *
+ * @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 {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 {Record<string, any>} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
+ * @param {string} 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.
+ * @returns {Promise<string>} - The ARWeave metadata URI.
+ */
+declare function uploadOrFetchMetadataURI(signerOrProvider: Web3Provider | ethers.Signer, privateKey: string | null, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, metadata: Record<string, unknown>, referenceId: string, extraTags: {
+    name: string;
+    value: string;
+}[], lazyFund?: boolean): Promise<string>;
+/**
+ * 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 {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 {Record<string, any>} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
+ * @param {string} 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: Record<string, unknown>, referenceId: string, extraTags: {
+    name: string;
+    value: string;
+}[], lazyFund?: boolean, gasOpts?: Overrides): Promise<TransactionResponse>;
+/**
+ * Loads all RWRs belonging to the specified owner, including the RWR metadata
+ *
+ * @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} owner - The receivable token owner to query from.
+ * @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 {Pagination} pagination - The pagination option.
+ * @returns {Promise<RealWorldReceivableInfo[]>} - An array of receivables owned by the owner for the pool.
+ */
+declare function loadReceivablesOfOwnerWithMetadata<T>(signerOrProvider: Web3Provider | ethers.Signer, owner: string, poolName: POOL_NAME, poolType: POOL_TYPE, pagination?: Pagination): Promise<RealWorldReceivableInfo<T>[]>;
+/**
+ * Get the total count of all RWRs belonging to the specified owner
+ *
+ * @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} owner - The receivable token owner to query from.
+ * @returns {Promise<number>} - Total count of receivables owned by the owner for the pool.
+ */
+declare function getTotalCountOfReceivables(signerOrProvider: Web3Provider | ethers.Signer, owner: string): Promise<number>;
+/**
+ * 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;
+    loadReceivablesOfOwnerWithMetadata: typeof loadReceivablesOfOwnerWithMetadata;
+    getTotalCountOfReceivables: typeof getTotalCountOfReceivables;
+    uploadOrFetchMetadataURI: typeof uploadOrFetchMetadataURI;
+    getTokenIdByURI: typeof getTokenIdByURI;
+};
+export {};

package/dist/cjs/services/ReceivableService.js

@@ -0,0 +1,325 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReceivableService = void 0;
+const providers_1 = require("@ethersproject/providers");
+const ethers_1 = require("ethers");
+const shared_1 = require("@huma-finance/shared");
+const graphql_request_1 = require("graphql-request");
+const ARWeaveService_1 = require("./ARWeaveService");
+const helpers_1 = require("../helpers");
+const utils_1 = require("../utils");
+const SubgraphService_1 = require("./SubgraphService");
+/**
+ * Fetches the tokenId of a RealWorldReceivable, or null if it doesn't exist, given a metadata URI
+ *
+ * @async
+ * @function
+ * @memberof ReceivableService
+ * @param {ethers.Signer} signer - The signer used to lookup metadata uploads for
+ * @param {string} arweaveId -  The internal ARWeave identifier to lookup a token by
+ * @returns {Promise<string | null | undefined>} - Either the token Id or null if no token was found.
+ */
+async function getTokenIdByURI(signer, uri) {
+    var _a, _b, _c, _d;
+    if (uri === null) {
+        return null;
+    }
+    const chainId = await (0, utils_1.getChainIdFromSignerOrProvider)(signer);
+    const signerAddress = await signer.getAddress();
+    if (!chainId) {
+        throw new Error('No Chain Id found');
+    }
+    // Fetch receivables with the same ARWeave Id
+    const receivablesQuery = (0, graphql_request_1.gql) `
+    query ReceivablesByURIQuery($owner: String!, $uri: String!) {
+      receivables(where: { owner: $owner, uri: $uri }) {
+        ...ReceivableFields
+      }
+    }
+
+    fragment ReceivableFields on Receivable {
+      tokenId
+    }
+  `;
+    const receivableSubgraph = (_a = shared_1.PoolSubgraphMap[chainId]) === null || _a === void 0 ? void 0 : _a.receivablesSubgraph;
+    if (!receivableSubgraph) {
+        throw new Error('No receivable subgraph exists for this chain');
+    }
+    const receivablesData = await (0, graphql_request_1.request)(receivableSubgraph, receivablesQuery, {
+        owner: signerAddress,
+        uri,
+    });
+    if (!((_b = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _b === void 0 ? void 0 : _b.length)) {
+        console.log('No receivables found with this URI.');
+        return null;
+    }
+    if (((_c = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _c === void 0 ? void 0 : _c.length) > 1) {
+        throw new Error(`This owner has multiple receivables with the same URI, so we don't know which to use. Please burn 
+        unnecessary receivables. If paying, you can pay the correct token manually using declareReceivablePaymentByTokenId`);
+    }
+    return (_d = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables[0]) === null || _d === void 0 ? void 0 : _d.tokenId;
+}
+/**
+ * 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.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
+ */
+async function declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, gasOpts = {}) {
+    const chainId = await (0, utils_1.getChainIdFromSignerOrProvider)(signer);
+    const signerAddress = await signer.getAddress();
+    if (!chainId) {
+        throw new Error('No Chain Id found');
+    }
+    // Get ARWeave Id
+    const dataId = await ARWeaveService_1.ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
+    // Fetch receivables with the same ARWeave Id
+    const tokenId = await getTokenIdByURI(signer, dataId);
+    if (tokenId == null) {
+        throw new Error('Could not find tokenId for this ARWeave Id. Please check your logs for more details.');
+    }
+    const contract = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);
+    if (!contract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+    return contract.declarePayment(tokenId, paymentAmount, gasOpts);
+}
+/**
+ * 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.
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
+ * @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, gasOpts = {}) {
+    var _a;
+    const chainId = await (0, utils_1.getChainIdFromSignerOrProvider)(signer);
+    if (!chainId) {
+        throw new Error('No Chain Id found');
+    }
+    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
+    if (!realWorldReceivable) {
+        throw new Error('RealWorldReceivable is not available on this network');
+    }
+    const contract = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);
+    if (!contract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+    return contract.declarePayment(receivableTokenId, paymentAmount, gasOpts);
+}
+/**
+ * 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 | null>} - A Promise of the transaction response.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network, or if a token already exists with the same metadata URI.
+ */
+async function createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts = {}) {
+    var _a, _b;
+    const tokenId = await getTokenIdByURI(signer, uri);
+    if (tokenId != null) {
+        throw new Error('A token already exists with this metadata, canceling mint');
+    }
+    const chainId = await (0, utils_1.getChainIdFromSignerOrProvider)(signer);
+    if (!chainId) {
+        throw new Error('No Chain Id found');
+    }
+    const poolInfo = chainId
+        ? (_b = (_a = shared_1.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 = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);
+    if (!contract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
+    return contract.createRealWorldReceivable(poolInfo.pool, currencyCode, receivableAmount, maturityDate, uri, gasOpts);
+}
+/**
+ * Uploads metadata onto ARWeave (or fetches the existing metadata with the same reference Id) and returns the ARWeave URL
+ *
+ * @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 {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 {Record<string, any>} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
+ * @param {string} 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.
+ * @returns {Promise<string>} - The ARWeave metadata URI.
+ */
+async function uploadOrFetchMetadataURI(signerOrProvider, privateKey, chainId, poolName, poolType, metadata, referenceId, extraTags, lazyFund = true) {
+    if (typeof metadata !== 'object' || Array.isArray(metadata)) {
+        throw new Error('Input must be a JSON object.');
+    }
+    // Check to see if metadata with referenceId has already been minted
+    const signer = signerOrProvider instanceof providers_1.Web3Provider
+        ? signerOrProvider.getSigner()
+        : signerOrProvider;
+    const signerAddress = await signer.getAddress();
+    const dataId = await ARWeaveService_1.ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
+    const config = ARWeaveService_1.ARWeaveService.getBundlrNetworkConfig(chainId);
+    let arweaveId;
+    if (dataId != null) {
+        console.log(`Metadata already exists with this reference Id, returning existing data ==> ${ARWeaveService_1.ARWeaveService.getURIFromARWeaveId(dataId)}`);
+        arweaveId = dataId;
+    }
+    else {
+        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,
+        ];
+        // Append referenceId to metadata (if it's not already there)
+        if (!Object.prototype.hasOwnProperty.call(metadata, 'referenceId')) {
+            metadata.referenceId = referenceId;
+        }
+        const response = await ARWeaveService_1.ARWeaveService.storeData(config, signerOrProvider instanceof providers_1.Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
+        arweaveId = response.id;
+        console.log(`Data uploaded ==> ${ARWeaveService_1.ARWeaveService.getURIFromARWeaveId(arweaveId)}`);
+    }
+    return ARWeaveService_1.ARWeaveService.getURIFromARWeaveId(arweaveId);
+}
+/**
+ * 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 {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 {Record<string, any>} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
+ * @param {string} 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) {
+    if (typeof metadata !== 'object' || Array.isArray(metadata)) {
+        throw new Error('Input must be a JSON object.');
+    }
+    // Check to see if metadata with referenceId has already been minted
+    const signer = signerOrProvider instanceof providers_1.Web3Provider
+        ? signerOrProvider.getSigner()
+        : signerOrProvider;
+    const metadataURI = await uploadOrFetchMetadataURI(signerOrProvider, privateKey, chainId, poolName, poolType, metadata, referenceId, extraTags, lazyFund);
+    return createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadataURI, gasOpts);
+}
+/**
+ * Loads all RWRs belonging to the specified owner, including the RWR metadata
+ *
+ * @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} owner - The receivable token owner to query from.
+ * @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 {Pagination} pagination - The pagination option.
+ * @returns {Promise<RealWorldReceivableInfo[]>} - An array of receivables owned by the owner for the pool.
+ */
+async function loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType, pagination) {
+    if (!ethers_1.ethers.utils.isAddress(owner)) {
+        throw new Error('Invalid owner address');
+    }
+    const chainId = await (0, utils_1.getChainIdFromSignerOrProvider)(signerOrProvider);
+    if (!chainId) {
+        throw new Error('No Chain Id found');
+    }
+    const rwReceivablesBase = await SubgraphService_1.SubgraphService.getRWReceivableInfo(owner, chainId, poolName, poolType, pagination);
+    const fetchMetadata = async (rwrInfoBase) => ARWeaveService_1.ARWeaveService.fetchMetadataFromUrl(rwrInfoBase.tokenURI);
+    const metadatas = await Promise.all(rwReceivablesBase.map(fetchMetadata));
+    return rwReceivablesBase.map((rwrInfoBase, index) => (Object.assign(Object.assign({}, rwrInfoBase), { metadata: metadatas[index] })));
+}
+/**
+ * Get the total count of all RWRs belonging to the specified owner
+ *
+ * @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} owner - The receivable token owner to query from.
+ * @returns {Promise<number>} - Total count of receivables owned by the owner for the pool.
+ */
+async function getTotalCountOfReceivables(signerOrProvider, owner) {
+    if (!ethers_1.ethers.utils.isAddress(owner)) {
+        throw new Error('Invalid owner address');
+    }
+    const chainId = await (0, utils_1.getChainIdFromSignerOrProvider)(signerOrProvider);
+    if (!chainId) {
+        throw new Error('No Chain Id found');
+    }
+    const rwrContract = (0, helpers_1.getRealWorldReceivableContract)(signerOrProvider, chainId);
+    if (!rwrContract) {
+        throw new Error('Could not find RealWorldReceivable contract');
+    }
+    const balance = await rwrContract.balanceOf(owner);
+    return balance.toNumber();
+}
+/**
+ * An object that contains functions to interact with Huma's receivables.
+ * @namespace ReceivableService
+ */
+exports.ReceivableService = {
+    createReceivableWithMetadata,
+    createReceivable,
+    declareReceivablePaymentByTokenId,
+    declareReceivablePaymentByReferenceId,
+    loadReceivablesOfOwnerWithMetadata,
+    getTotalCountOfReceivables,
+    uploadOrFetchMetadataURI,
+    getTokenIdByURI,
+};
+//# sourceMappingURL=ReceivableService.js.map

package/dist/cjs/services/ReceivableService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../../src/services/ReceivableService.ts"],"names":[],"mappings":";;;AAAA,wDAA4E;AAC5E,mCAAwD;AACxD,iDAS6B;AAC7B,qDAA8C;AAE9C,qDAAiD;AACjD,wCAA2D;AAC3D,oCAA+E;AAE/E,uDAA+D;AAE/D;;;;;;;;;GASG;AACH,KAAK,UAAU,eAAe,CAC5B,MAAqB,EACrB,GAAkB;;IAElB,IAAI,GAAG,KAAK,IAAI,EAAE;QAChB,OAAO,IAAI,CAAA;KACZ;IAED,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,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,6CAA6C;IAC7C,MAAM,gBAAgB,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;GAU3B,CAAA;IAED,MAAM,kBAAkB,GAAG,MAAA,wBAAe,CAAC,OAAO,CAAC,0CAAE,mBAAmB,CAAA;IACxE,IAAI,CAAC,kBAAkB,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IAED,MAAM,eAAe,GAAkC,MAAM,IAAA,yBAAO,EAClE,kBAAkB,EAClB,gBAAgB,EAChB;QACE,KAAK,EAAE,aAAa;QACpB,GAAG;KACJ,CACF,CAAA;IAED,IAAI,CAAC,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAA,EAAE;QACzC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAA;QAClD,OAAO,IAAI,CAAA;KACZ;IACD,IAAI,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,IAAG,CAAC,EAAE;QAC5C,MAAM,IAAI,KAAK,CACb;2HACqH,CACtH,CAAA;KACF;IAED,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAA;AACjD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,qCAAqC,CAClD,MAAqB,EACrB,WAAmB,EACnB,aAAqB,EACrB,UAAqB,EAAE;IAEvB,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,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,+BAAc,CAAC,gBAAgB,CAClD,OAAO,EACP,aAAa,EACb,WAAW,CACZ,CAAA;IAED,6CAA6C;IAC7C,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrD,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAA;KACF;IAED,MAAM,QAAQ,GAAG,IAAA,wCAA8B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;AACjE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,iCAAiC,CAC9C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB,EACrB,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,mBAAmB,GACvB,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,IAAA,wCAA8B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;AAC3E,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,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClD,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;KAC7E;IAED,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,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,wBAAe,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,IAAA,wCAA8B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,yBAAyB,CACvC,QAAQ,CAAC,IAAI,EACb,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,GAAG,EACH,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,UAAU,wBAAwB,CACrC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,QAAiC,EACjC,WAAmB,EACnB,SAA4C,EAC5C,WAAoB,IAAI;IAExB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3D,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,oEAAoE;IACpE,MAAM,MAAM,GACV,gBAAgB,YAAY,wBAAY;QACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;QAC9B,CAAC,CAAC,gBAAgB,CAAA;IACtB,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAA;IAC/C,MAAM,MAAM,GAAG,MAAM,+BAAc,CAAC,gBAAgB,CAClD,OAAO,EACP,aAAa,EACb,WAAW,CACZ,CAAA;IACD,MAAM,MAAM,GAAG,+BAAc,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,IAAI,SAAS,CAAA;IACb,IAAI,MAAM,IAAI,IAAI,EAAE;QAClB,OAAO,CAAC,GAAG,CACT,+EAA+E,+BAAc,CAAC,mBAAmB,CAC/G,MAAM,CACP,EAAE,CACJ,CAAA;QACD,SAAS,GAAG,MAAM,CAAA;KACnB;SAAM;QACL,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,6DAA6D;QAC7D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE;YAClE,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAA;SACnC;QAED,MAAM,QAAQ,GAAG,MAAM,+BAAc,CAAC,SAAS,CAC7C,MAAM,EACN,gBAAgB,YAAY,wBAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAW,EACzE,QAAQ,EACR,IAAI,EACJ,QAAQ,CACT,CAAA;QACD,SAAS,GAAG,QAAQ,CAAC,EAAE,CAAA;QACvB,OAAO,CAAC,GAAG,CACT,qBAAqB,+BAAc,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CACrE,CAAA;KACF;IAED,OAAO,+BAAc,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAA;AACtD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,KAAK,UAAU,4BAA4B,CACzC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,QAAiC,EACjC,WAAmB,EACnB,SAA4C,EAC5C,WAAoB,IAAI,EACxB,OAAmB;IAEnB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3D,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,oEAAoE;IACpE,MAAM,MAAM,GACV,gBAAgB,YAAY,wBAAY;QACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;QAC9B,CAAC,CAAC,gBAAgB,CAAA;IAEtB,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAChD,gBAAgB,EAChB,UAAU,EACV,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,SAAS,EACT,QAAQ,CACT,CAAA;IAED,OAAO,gBAAgB,CACrB,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,WAAW,EACX,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,KAAK,UAAU,kCAAkC,CAC/C,gBAA8C,EAC9C,KAAa,EACb,QAAmB,EACnB,QAAmB,EACnB,UAAuB;IAEvB,IAAI,CAAC,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,gBAAgB,CAAC,CAAA;IACtE,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,iBAAiB,GAAG,MAAM,iCAAe,CAAC,mBAAmB,CACjE,KAAK,EACL,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,UAAU,CACX,CAAA;IAED,MAAM,aAAa,GAAG,KAAK,EAAE,WAAwC,EAAE,EAAE,CACvE,+BAAc,CAAC,oBAAoB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC3D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;IAEzE,OAAO,iBAAiB,CAAC,GAAG,CAC1B,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE,CACrB,CAAC,gCACI,WAAW,KACd,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,GACI,CAAA,CACnC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,0BAA0B,CACvC,gBAA8C,EAC9C,KAAa;IAEb,IAAI,CAAC,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,gBAAgB,CAAC,CAAA;IACtE,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,WAAW,GAAG,IAAA,wCAA8B,EAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;IAC7E,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAClD,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAED;;;GAGG;AACU,QAAA,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;IACrC,kCAAkC;IAClC,0BAA0B;IAC1B,wBAAwB;IACxB,eAAe;CAChB,CAAA"}

package/dist/cjs/services/SubgraphService.d.ts

@@ -0,0 +1,76 @@
+import { POOL_NAME, POOL_TYPE, RealWorldReceivableInfoBase } from '@huma-finance/shared';
+/**
+ * Represents the payload of a credit event.
+ * @typedef {Object} CreditEventPayload
+ */
+export type CreditEventPayload = {
+    amount?: string;
+    timestamp?: string;
+    owner?: string;
+    pool?: string;
+    event?: string;
+};
+/**
+ * Represents the pagination options for a query.
+ * @typedef {Object} Pagination
+ */
+export type Pagination = {
+    first: number | null;
+    skip: number | null;
+    orderBy: string;
+    orderDirection: 'desc' | 'asc';
+};
+/**
+ * Returns the subgraph URL for a given chain ID.
+ *
+ * @memberof SubgraphService
+ * @param {number} chainId - The ID of the chain.
+ * @returns {string} The subgraph URL for the given chain ID.
+ */
+declare function getSubgraphUrlForChainId(chainId: number): string;
+/**
+ * Returns the credit events for a given user.
+ *
+ * @memberof SubgraphService
+ * @param {string} userAddress - The address of the user.
+ * @param {number} chainId - The ID of the chain.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @param {number[]} event - The event types to filter by.
+ * @returns {Promise<CreditEventPayload[]>} The credit events for the given user.
+ */
+declare function getCreditEventsForUser(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, event: number[]): Promise<CreditEventPayload[]>;
+/**
+ * Returns the last factorized amount for a given user and pool.
+ *
+ * @memberof SubgraphService
+ * @param {string} userAddress - The address of the user.
+ * @param {number} chainId - The ID of the chain.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @returns {Promise<number>} The last factorized amount for the given user and pool.
+ */
+declare function getLastFactorizedAmountFromPool(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<number>;
+/**
+ * Returns the paginated real world receivables' info.
+ *
+ * @memberof SubgraphService
+ * @param {string} userAddress - The address of the user.
+ * @param {number} chainId - The ID of the chain.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @param {Pagination} pagination - The pagination option.
+ * @returns {Promise<RealWorldReceivableInfoBase>} The paginated real world receivables' info.
+ */
+declare function getRWReceivableInfo(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, pagination?: Pagination): Promise<RealWorldReceivableInfoBase[]>;
+/**
+ * An object that contains functions to interact with Huma's Subgraph storage.
+ * @namespace SubgraphService
+ */
+export declare const SubgraphService: {
+    getSubgraphUrlForChainId: typeof getSubgraphUrlForChainId;
+    getCreditEventsForUser: typeof getCreditEventsForUser;
+    getLastFactorizedAmountFromPool: typeof getLastFactorizedAmountFromPool;
+    getRWReceivableInfo: typeof getRWReceivableInfo;
+};
+export {};