@huma-finance/sdk 0.0.10 → 0.0.11

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

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

package/dist/cjs/services/ARWeaveService.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARWeaveService = exports.getBundlrNetworkConfig = void 0;
+const tslib_1 = require("tslib");
+const client_1 = tslib_1.__importDefault(require("@bundlr-network/client"));
+const graphql_request_1 = tslib_1.__importStar(require("graphql-request"));
+const ethers_1 = require("ethers");
+/**
+ * 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.
+ */
+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: '',
+            };
+    }
+}
+exports.getBundlrNetworkConfig = getBundlrNetworkConfig;
+/**
+ * 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 client_1.default(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    return bundlr.fund(amount);
+}
+/**
+ * Get the running balance on Bundlr network, in atomic units (the smallest unit of a given currency)
+ *
+ * @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 getBundlrBalance(config, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+signer) {
+    const bundlr = new client_1.default(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    return ethers_1.BigNumber.from(await bundlr.getLoadedBalance());
+}
+/**
+ * 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 client_1.default(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 = (0, graphql_request_1.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 (0, graphql_request_1.default)(`${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
+ */
+exports.ARWeaveService = {
+    getBundlrBalance,
+    queryForMetadata,
+    storeData,
+    prefundBundlr,
+    getBundlrNetworkConfig,
+};
+//# sourceMappingURL=ARWeaveService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../../src/services/ARWeaveService.ts"],"names":[],"mappings":";;;;AAAA,4EAA2C;AAM3C,2EAA8C;AAE9C,mCAAkC;AAkBlC;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,QAAQ,OAAO,EAAE;QACf,KAAK,CAAC;YACJ,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,UAAU;gBACpB,WAAW,EACT,8DAA8D;aACjE,CAAA;QACH,KAAK,KAAK;YACR,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,gCAAgC;aAC9C,CAAA;QACH;YACE,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAA;KACJ;AACH,CAAC;AArBD,wDAqBC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,aAAa,CAC1B,MAAoB;AACpB,8DAA8D;AAC9D,MAAW,EACX,MAAc;IAEd,MAAM,MAAM,GAAG,IAAI,gBAAM,CACvB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,EACN,MAAM,CAAC,WAAW;QAChB,CAAC,CAAC;YACE,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC;QACH,CAAC,CAAC,SAAS,CACd,CAAA;IACD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;IAEpB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC5B,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,gBAAgB,CAC7B,MAAoB;AACpB,8DAA8D;AAC9D,MAAW;IAEX,MAAM,MAAM,GAAG,IAAI,gBAAM,CACvB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,EACN,MAAM,CAAC,WAAW;QAChB,CAAC,CAAC;YACE,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC;QACH,CAAC,CAAC,SAAS,CACd,CAAA;IAED,OAAO,kBAAS,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAA;AACxD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,SAAS,CACtB,MAAoB,EACpB,kBAAyC,EACzC,IAAU,EACV,IAAuC,EACvC,WAAoB,IAAI;IAExB,MAAM,MAAM,GAAG,IAAI,gBAAM,CACvB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,kBAAkB,EAClB,MAAM,CAAC,WAAW;QAChB,CAAC,CAAC;YACE,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC;QACH,CAAC,CAAC,SAAS,CACd,CAAA;IACD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;IAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAEpC,IAAI,QAAQ,EAAE;QACZ,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAEzC,+DAA+D;QAC/D,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QACvB,OAAO,CAAC,GAAG,CACT,uBAAuB,KAAK,IAAI,MAAM,CAAC,QAAQ,iBAAiB,CACjE,CAAA;QACD,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;KACzB;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,gBAAgB,CAC7B,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,MAAc,EACd,WAAmB;;IAGnB,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,IAAA,yBAAO,EAAC,GAAG,MAAM,CAAC,OAAO,UAAU,EAAE,KAAK,EAAE;QAClE,QAAQ;QACR,QAAQ;QACR,MAAM;QACN,WAAW;KACZ,CAAC,CAAA;IAEF,OAAO,MAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,0CAAE,KAAK,0CAAG,CAAC,CAAC,0CAAE,IAAI,0CAAE,EAAE,CAAA;AACjD,CAAC;AAED;;;GAGG;AACU,QAAA,cAAc,GAAG;IAC5B,gBAAgB;IAChB,gBAAgB;IAChB,SAAS;IACT,aAAa;IACb,sBAAsB;CACvB,CAAA"}

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

@@ -0,0 +1,18 @@
+/**
+ * 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/cjs/services/EAService.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EAService = void 0;
+const shared_1 = require("@huma-finance/shared");
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+exports.EAService = {
+    approve: shared_1.EAService.approve,
+};
+//# sourceMappingURL=EAService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../../src/services/EAService.ts"],"names":[],"mappings":";;;AAAA,iDAAqE;AAarE;;;;GAIG;AACU,QAAA,SAAS,GAAG;IACvB,OAAO,EAAE,kBAAiB,CAAC,OAAO;CACnC,CAAA"}

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

@@ -0,0 +1,76 @@
+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 {};

package/dist/cjs/services/ReceivableService.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReceivableService = void 0;
+const providers_1 = require("@ethersproject/providers");
+const shared_1 = require("@huma-finance/shared");
+const utils_1 = require("../utils");
+const ARWeaveService_1 = require("./ARWeaveService");
+const chain_1 = require("../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 (0, chain_1.getChainIdFromSignerOrProvider)(signer);
+    const realWorldReceivable = chainId
+        ? (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable]
+        : null;
+    if (!realWorldReceivable) {
+        throw new Error('RealWorldReceivable is not available on this network');
+    }
+    const contract = (0, utils_1.getContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signer);
+    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, _c;
+    const chainId = await (0, chain_1.getChainIdFromSignerOrProvider)(signer);
+    const realWorldReceivable = chainId
+        ? (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable]
+        : null;
+    const poolInfo = chainId
+        ? (_c = (_b = shared_1.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 = (0, utils_1.getContract)(realWorldReceivable, shared_1.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_1.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_1.ARWeaveService.storeData(config, signerOrProvider instanceof providers_1.Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
+        console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
+        return await createReceivable(signerOrProvider instanceof providers_1.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
+ */
+exports.ReceivableService = {
+    createReceivableWithMetadata,
+    createReceivable,
+    declareReceivablePaymentByTokenId,
+    declareReceivablePaymentByReferenceId,
+};
+//# 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;AAE5E,iDAO6B;AAE7B,oCAAsC;AACtC,qDAAiD;AACjD,0CAA+D;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,IAAA,sCAA8B,EAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,mBAAmB,GAAG,OAAO;QACjC,CAAC,CAAC,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,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,IAAA,mBAAW,EAC1B,mBAAmB,EACnB,kCAAyB,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,IAAA,sCAA8B,EAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,mBAAmB,GAAG,OAAO;QACjC,CAAC,CAAC,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C;QACH,CAAC,CAAC,IAAI,CAAA;IAER,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,mBAAmB,IAAI,CAAC,QAAQ,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAC1B,mBAAmB,EACnB,kCAAyB,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,+BAAc,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,+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,OAAO,CAAC,GAAG,CAAC,yCAAyC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,OAAO,MAAM,gBAAgB,CAC3B,gBAAgB,YAAY,wBAAY;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;AACU,QAAA,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;CACtC,CAAA"}

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

@@ -0,0 +1,53 @@
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+/**
+ * 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;
+/**
+ * Represents the payload of a credit event.
+ * @typedef {Object} CreditEventPayload
+ */
+export type CreditEventPayload = {
+    amount?: string;
+    timestamp?: string;
+    owner?: string;
+    pool?: string;
+    event?: 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 {string[]} 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: string[]): 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>;
+/**
+ * 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;
+};
+export {};