@huma-finance/sdk 0.0.7 → 0.0.8

package/dist/services/ARWeaveService.js

@@ -1,14 +1,12 @@
 import Bundlr from '@bundlr-network/client';
 import request, { gql } from 'graphql-request';
 /**
- * Get the configuration for Bundlr network given a chain ID.
+ * 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.
- *      nodeUrl - The node URL of the Bundlr network to use.
- *      currency - The currency to pay for uploads with, if lazy funding.
- *      providerUrl - The provider URL, required for devnets.
  */
 export function getBundlrNetworkConfig(chainId) {
     switch (chainId) {
@@ -32,19 +30,20 @@ export function getBundlrNetworkConfig(chainId) {
     }
 }
 /**
- * Prefund the Bundlr network with the specified amount. Useful if not lazy funding.
+ * 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} wallet - The wallet to send funds from
- * @param {number} amount - The amount to fund.
+ * @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.
  */
-export async function prefundBundlr(config, 
+async function prefundBundlr(config, 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-wallet, amount) {
-    const bundlr = new Bundlr(config.nodeUrl, config.currency, wallet, config.providerUrl
+signer, amount) {
+    const bundlr = new Bundlr(config.nodeUrl, config.currency, signer, config.providerUrl
         ? {
             providerUrl: config.providerUrl,
         }
@@ -54,20 +53,22 @@ wallet, amount) {
 }
 /**
  * Store data on ARWeave using the Bundlr Network.
+ *
  * @async
  * @function
+ * @memberof ArweaveService
  * @param {BundlrConfig} config - Configuration object for the Bundlr instance.
- * @param {Web3Provider | ethers.Signer} wallet - Wallet object used for interacting with 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 an `ethers.Signer` instance.
+ *         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.
  */
-export async function storeData(config, wallet, data, tags, lazyFund = true) {
-    const bundlr = new Bundlr(config.nodeUrl, config.currency, wallet, config.providerUrl
+async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true) {
+    const bundlr = new Bundlr(config.nodeUrl, config.currency, signerOrPrivateKey, config.providerUrl
         ? {
             providerUrl: config.providerUrl,
         }
@@ -86,15 +87,18 @@ export async function storeData(config, wallet, data, tags, lazyFund = true) {
 }
 /**
  * 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} internalID - The internal ID tag to query, whatever was used when uploading the metadata.
+ * @param {string} referenceId - The referenceId tag to query, whatever was used when uploading the metadata.
  * @returns {Promise<any>} Promise resolving with the queried data.
  */
-export async function queryForMetadata(chainId, poolName, poolType, sender, internalId) {
+async function queryForMetadata(chainId, poolName, poolType, sender, referenceId) {
     var _a, _b, _c, _d;
     const config = getBundlrNetworkConfig(chainId);
     const query = gql `
@@ -102,7 +106,7 @@ export async function queryForMetadata(chainId, poolName, poolType, sender, inte
       $poolName: String!
       $poolType: String!
       $sender: String!
-      $internalId: String!
+      $referenceId: String!
     ) {
       transactions(
         owners: [$sender]
@@ -110,7 +114,7 @@ export async function queryForMetadata(chainId, poolName, poolType, sender, inte
           { name: "appName", values: ["HumaFinance"] }
           { name: "poolName", values: [$poolName] }
           { name: "poolType", values: [$poolType] }
-          { name: "internalId", values: [$internalId] }
+          { name: "referenceId", values: [$referenceId] }
         ]
       ) {
         edges {
@@ -126,8 +130,18 @@ export async function queryForMetadata(chainId, poolName, poolType, sender, inte
         poolName,
         poolType,
         sender,
-        internalId,
+        referenceId,
     });
     return (_d = (_c = (_b = (_a = data === null || data === void 0 ? void 0 : data.transactions) === null || _a === void 0 ? void 0 : _a.edges) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.node) === null || _d === void 0 ? void 0 : _d.id;
 }
+/**
+ * An object that contains functions to interact with Huma-related data stored on ARWeave
+ * @namespace ARWeaveService
+ */
+export const ARWeaveService = {
+    queryForMetadata,
+    storeData,
+    prefundBundlr,
+    getBundlrNetworkConfig,
+};
 //# sourceMappingURL=ARWeaveService.js.map

package/dist/services/ARWeaveService.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../src/services/ARWeaveService.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAM3C,OAAO,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAY9C;;;;;;;;;GASG;AACH,MAAM,UAAU,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;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAoB;AACpB,8DAA8D;AAC9D,MAAW,EACX,MAAc;IAEd,MAAM,MAAM,GAAG,IAAI,MAAM,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;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAoB,EACpB,MAA6B,EAC7B,IAAU,EACV,IAAuC,EACvC,WAAoB,IAAI;IAExB,MAAM,MAAM,GAAG,IAAI,MAAM,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,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;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,MAAc,EACd,UAAkB;;IAGlB,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,UAAU,EAAE,KAAK,EAAE;QAClE,QAAQ;QACR,QAAQ;QACR,MAAM;QACN,UAAU;KACX,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"}
+{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../src/services/ARWeaveService.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAM3C,OAAO,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAmB9C;;;;;;;GAOG;AACH,MAAM,UAAU,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;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,aAAa,CAC1B,MAAoB;AACpB,8DAA8D;AAC9D,MAAW,EACX,MAAc;IAEd,MAAM,MAAM,GAAG,IAAI,MAAM,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;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,SAAS,CACtB,MAAoB,EACpB,kBAAyC,EACzC,IAAU,EACV,IAAuC,EACvC,WAAoB,IAAI;IAExB,MAAM,MAAM,GAAG,IAAI,MAAM,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,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,OAAO,CAAC,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;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,gBAAgB;IAChB,SAAS;IACT,aAAa;IACb,sBAAsB;CACvB,CAAA"}

package/dist/services/EAService.d.ts

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

package/dist/services/EAService.js

@@ -1,7 +1,9 @@
-import { EAService as EAServiceInternal } from '@00labs/huma-shared';
+import { EAService as EAServiceInternal } from '@huma-finance/shared';
 /**
  * An object that contains functions to interact with Huma's EAVerse service.
  *
+ * @namespace EAService
+ *
  * approve: Submits a credit underwriting request to Huma's EAVerse.
  * @param {EAPayload} payload The payload for the underwrite approval.
  * @param {number} chainId The chain ID.

package/dist/services/EAService.js.map

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

package/dist/services/ReceivableService.d.ts

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

package/dist/services/ReceivableService.js

@@ -1,13 +1,15 @@
 import { Web3Provider, } from '@ethersproject/providers';
-import { BASE_CREDIT_POOL_RECEIVABLE_ABI, PoolContractMap, SupplementaryContracts, SupplementaryContractsMap, } from '@00labs/huma-shared';
+import { BASE_CREDIT_POOL_RECEIVABLE_ABI, PoolContractMap, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
 import { getContract } from '../utils';
-import { storeData, getBundlrNetworkConfig } from './ARWeaveService';
+import { ARWeaveService } from './ARWeaveService';
 import { getChainIdFromSignerOrProvider } from '../utils/chain';
 /**
  * Enumeration of payment methods. Maps to the PaymentMethod enum in the BaseCreditPoolReceivable contract.
  * Declarative payment methods are those that do not actually send ERC20 funds. Payable payment methods are those that
  * do by calling makePayment on the BaseCreditPool contract.
+ *
  * @enum {number}
+ * @memberof ReceivableService
  */
 export var PaymentMethod;
 (function (PaymentMethod) {
@@ -15,8 +17,9 @@ export var PaymentMethod;
     PaymentMethod[PaymentMethod["Payable"] = 1] = "Payable";
 })(PaymentMethod || (PaymentMethod = {}));
 /**
- * Pays a BaseCreditPoolReceivable using the specified payment method, given an internalId mapping to the receivable's metadata
+ * Pays a BaseCreditPoolReceivable using the specified payment method, given an referenceId mapping to the receivable's metadata
  *
+ * @memberof ReceivableService
  * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
  * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
  * @param {number} paymentAmount - The amount to pay the receivable.
@@ -24,11 +27,11 @@ export var PaymentMethod;
  * @returns {Promise<TransactionReceipt>} - A Promise of the transaction receipt.
  * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
  */
-export async function payReceivableByInternalId(
+async function payReceivableByReferenceId(
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 signer, 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-internalId, 
+referenceId, 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 paymentAmount, 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -38,6 +41,7 @@ paymentMethod) {
 /**
  * Pays a BaseCreditPoolReceivable using the specified payment method, given a tokenID of the receivable.
  *
+ * @memberof ReceivableService
  * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
  * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
  * @param {number} paymentAmount - The amount to pay the receivable.
@@ -45,7 +49,7 @@ paymentMethod) {
  * @returns {Promise<TransactionReceipt>} - A Promise of the transaction receipt.
  * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
  */
-export async function payReceivableByTokenId(signer, receivableTokenId, paymentAmount, paymentMethod) {
+async function payReceivableByTokenId(signer, receivableTokenId, paymentAmount, paymentMethod) {
     var _a;
     const chainId = await getChainIdFromSignerOrProvider(signer);
     const baseCreditPoolReceivable = chainId
@@ -74,6 +78,7 @@ export async function payReceivableByTokenId(signer, receivableTokenId, paymentA
 /**
  * Mints a new BaseCreditPoolReceivable token on the given chain of the signer
  *
+ * @memberof ReceivableService
  * @param {ethers.Signer} signer - The signer used to send the transaction.
  * @param {string} recipient - The address of the recipient of the receivable token.
  * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
@@ -82,10 +87,11 @@ export async function payReceivableByTokenId(signer, receivableTokenId, paymentA
  * @param {number} maturityDate - The maturity date of the receivable token, in UNIX timestamp format.
  * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
  * @param {string} uri - The URI of the receivable token metadata.
+ * @param {Overrides} gasOpts - The gas options to use for the transaction.
  * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
  * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
  */
-export async function mintReceivable(signer, recipient, poolName, poolType, receivableAmount, maturityDate, paymentMethod, uri) {
+async function mintReceivable(signer, poolName, poolType, receivableAmount, maturityDate, paymentMethod, uri, gasOpts = {}) {
     var _a, _b, _c;
     const chainId = await getChainIdFromSignerOrProvider(signer);
     const baseCreditPoolReceivable = chainId
@@ -101,15 +107,16 @@ export async function mintReceivable(signer, recipient, poolName, poolType, rece
     if (!contract) {
         throw new Error('Could not find BaseCreditPoolReceivable contract');
     }
-    return contract.safeMint(recipient, poolInfo.pool, poolInfo.poolUnderlyingToken.address, receivableAmount, maturityDate, paymentMethod, uri);
+    return contract.safeMint(await signer.getAddress(), poolInfo.pool, poolInfo.poolUnderlyingToken.address, receivableAmount, maturityDate, paymentMethod, uri, gasOpts);
 }
 /**
  * Mints a BaseCreditPoolReceivable token with metadata uploaded onto ARWeave
  *
- * @param {Web3Provider | ethers.Signer} wallet - If calling this function from a browser, this function expects a Web3Provider.
+ * @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} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
+ * @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.
@@ -118,27 +125,30 @@ export async function mintReceivable(signer, recipient, poolName, poolType, rece
  * @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
  * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
  * @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
- * @param {number} internalId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
+ * @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
  * @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
  *      ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
  * @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
  *      metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
+ * @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
  * @returns {Promise<TransactionReceipt>} - The transaction receipt.
  */
-export async function mintReceivableWithMetadata(wallet, privateKey, chainId, recipient, poolName, poolType, receivableAmount, maturityDate, paymentMethod, metadata, internalId, extraTags, lazyFund = true) {
-    const config = getBundlrNetworkConfig(chainId);
+async function mintReceivableWithMetadata(signerOrProvider, privateKey, chainId, poolName, poolType, receivableAmount, maturityDate, paymentMethod, 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: 'internalId', value: internalId },
+            { name: 'referenceId', value: referenceId },
             ...extraTags,
         ];
-        const response = await storeData(config, wallet instanceof Web3Provider ? wallet : privateKey, metadata, tags, lazyFund);
+        const response = await ARWeaveService.storeData(config, signerOrProvider instanceof Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
         console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
-        const tx = await mintReceivable(wallet instanceof Web3Provider ? wallet.getSigner() : wallet, recipient, poolName, poolType, receivableAmount, maturityDate, paymentMethod, `https://arweave.net/${response.id}`);
+        const tx = await mintReceivable(signerOrProvider instanceof Web3Provider
+            ? signerOrProvider.getSigner()
+            : signerOrProvider, poolName, poolType, receivableAmount, maturityDate, paymentMethod, `https://arweave.net/${response.id}`, gasOpts);
         return await tx.wait();
     }
     catch (e) {
@@ -146,4 +156,14 @@ export async function mintReceivableWithMetadata(wallet, privateKey, chainId, re
         throw e;
     }
 }
+/**
+ * An object that contains functions to interact with Huma's receivables.
+ * @namespace ReceivableService
+ */
+export const ReceivableService = {
+    mintReceivableWithMetadata,
+    mintReceivable,
+    payReceivableByTokenId,
+    payReceivableByReferenceId,
+};
 //# 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,EAGL,YAAY,GACb,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EACL,+BAA+B,EAG/B,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAA;AACpE,OAAO,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAA;AAE/D;;;;;GAKG;AACH,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,+DAAe,CAAA;IACf,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB;AAC7C,6DAA6D;AAC7D,MAAqB;AACrB,6DAA6D;AAC7D,UAAkB;AAClB,6DAA6D;AAC7D,aAAqB;AACrB,6DAA6D;AAC7D,aAA4B;IAE5B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB,EACrB,aAA4B;;IAE5B,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,wBAAwB,GAAG,OAAO;QACtC,CAAC,CAAC,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,wBAAwB,CAChD;QACH,CAAC,CAAC,IAAI,CAAA;IAER,IAAI,CAAC,wBAAwB,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;KAC7E;IAED,MAAM,QAAQ,GAAG,WAAW,CAC1B,wBAAwB,EACxB,+BAA+B,EAC/B,MAAM,CACP,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;KACpE;IAED,IAAI,EAAE,CAAA;IACN,QAAQ,aAAa,EAAE;QACrB,KAAK,aAAa,CAAC,WAAW;YAC5B,EAAE,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;YACpE,MAAK;QACP,KAAK,aAAa,CAAC,OAAO;YACxB,EAAE,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;YACjE,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;KAC5C;IAED,OAAO,EAAE,CAAC,IAAI,EAAE,CAAA;AAClB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAqB,EACrB,SAAiB,EACjB,QAAmB,EACnB,QAAmB,EACnB,gBAAwB,EACxB,YAAoB,EACpB,aAA4B,EAC5B,GAAW;;IAEX,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,wBAAwB,GAAG,OAAO;QACtC,CAAC,CAAC,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,wBAAwB,CAChD;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,wBAAwB,IAAI,CAAC,QAAQ,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;KAC7E;IAED,MAAM,QAAQ,GAAG,WAAW,CAC1B,wBAAwB,EACxB,+BAA+B,EAC/B,MAAM,CACP,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;KACpE;IAED,OAAO,QAAQ,CAAC,QAAQ,CACtB,SAAS,EACT,QAAQ,CAAC,IAAI,EACb,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EACpC,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,GAAG,CACJ,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,MAAoC,EACpC,UAAkB,EAClB,OAAe,EACf,SAAiB,EACjB,QAAmB,EACnB,QAAmB,EACnB,gBAAwB,EACxB,YAAoB,EACpB,aAA4B,EAC5B,QAAc,EACd,UAAkB,EAClB,SAA4C,EAC5C,WAAoB,IAAI;IAExB,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE9C,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,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE;YACzC,GAAG,SAAS;SACb,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,MAAM,EACN,MAAM,YAAY,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,EACpD,QAAQ,EACR,IAAI,EACJ,QAAQ,CACT,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,yCAAyC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,MAAM,EAAE,GAAG,MAAM,cAAc,CAC7B,MAAM,YAAY,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,EAC5D,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,uBAAuB,QAAQ,CAAC,EAAE,EAAE,CACrC,CAAA;QAED,OAAO,MAAM,EAAE,CAAC,IAAI,EAAE,CAAA;KACvB;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAChB,MAAM,CAAC,CAAA;KACR;AACH,CAAC"}
+{"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../src/services/ReceivableService.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,GACb,MAAM,0BAA0B,CAAA;AAEjC,OAAO,EACL,+BAA+B,EAG/B,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;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,+DAAe,CAAA;IACf,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,0BAA0B;AACvC,6DAA6D;AAC7D,MAAqB;AACrB,6DAA6D;AAC7D,WAAmB;AACnB,6DAA6D;AAC7D,aAAqB;AACrB,6DAA6D;AAC7D,aAA4B;IAE5B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACpC,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,sBAAsB,CACnC,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB,EACrB,aAA4B;;IAE5B,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,wBAAwB,GAAG,OAAO;QACtC,CAAC,CAAC,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,wBAAwB,CAChD;QACH,CAAC,CAAC,IAAI,CAAA;IAER,IAAI,CAAC,wBAAwB,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;KAC7E;IAED,MAAM,QAAQ,GAAG,WAAW,CAC1B,wBAAwB,EACxB,+BAA+B,EAC/B,MAAM,CACP,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;KACpE;IAED,IAAI,EAAE,CAAA;IACN,QAAQ,aAAa,EAAE;QACrB,KAAK,aAAa,CAAC,WAAW;YAC5B,EAAE,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;YACpE,MAAK;QACP,KAAK,aAAa,CAAC,OAAO;YACxB,EAAE,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;YACjE,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;KAC5C;IAED,OAAO,EAAE,CAAC,IAAI,EAAE,CAAA;AAClB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,cAAc,CAC3B,MAAqB,EACrB,QAAmB,EACnB,QAAmB,EACnB,gBAAwB,EACxB,YAAoB,EACpB,aAA4B,EAC5B,GAAW,EACX,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,MAAM,wBAAwB,GAAG,OAAO;QACtC,CAAC,CAAC,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,wBAAwB,CAChD;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,wBAAwB,IAAI,CAAC,QAAQ,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;KAC7E;IAED,MAAM,QAAQ,GAAG,WAAW,CAC1B,wBAAwB,EACxB,+BAA+B,EAC/B,MAAM,CACP,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;KACpE;IAED,OAAO,QAAQ,CAAC,QAAQ,CACtB,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,QAAQ,CAAC,IAAI,EACb,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EACpC,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,GAAG,EACH,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,KAAK,UAAU,0BAA0B,CACvC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,gBAAwB,EACxB,YAAoB,EACpB,aAA4B,EAC5B,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,MAAM,EAAE,GAAG,MAAM,cAAc,CAC7B,gBAAgB,YAAY,YAAY;YACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC9B,CAAC,CAAC,gBAAgB,EACpB,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,uBAAuB,QAAQ,CAAC,EAAE,EAAE,EACpC,OAAO,CACR,CAAA;QAED,OAAO,MAAM,EAAE,CAAC,IAAI,EAAE,CAAA;KACvB;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,0BAA0B;IAC1B,cAAc;IACd,sBAAsB;IACtB,0BAA0B;CAC3B,CAAA"}

package/dist/services/SubgraphService.d.ts

@@ -1,13 +1,15 @@
-import { POOL_NAME, POOL_TYPE } from '@00labs/huma-shared';
+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.
  */
-export declare function getSubgraphUrlForChainId(chainId: number): string;
+declare function getSubgraphUrlForChainId(chainId: number): string;
 /**
  * Represents the payload of a credit event.
+ * @typedef {Object} CreditEventPayload
  */
 export type CreditEventPayload = {
     amount?: string;
@@ -19,6 +21,7 @@ export type CreditEventPayload = {
 /**
  * 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.
@@ -26,14 +29,25 @@ export type CreditEventPayload = {
  * @param {string[]} event - The event types to filter by.
  * @returns {Promise<CreditEventPayload[]>} The credit events for the given user.
  */
-export declare function getCreditEventsForUser(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, event: string[]): Promise<CreditEventPayload[]>;
+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.
  */
-export declare function getLastFactorizedAmountFromPool(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<number>;
+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 {};

package/dist/services/SubgraphService.js

@@ -1,11 +1,12 @@
-import { CreditEvent, PoolContractMap, } from '@00labs/huma-shared';
+import { CreditEvent, PoolContractMap, } 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.
  */
-export function getSubgraphUrlForChainId(chainId) {
+function getSubgraphUrlForChainId(chainId) {
     switch (chainId) {
         case 5:
             return 'https://api.thegraph.com/subgraphs/name/00labs/huma-goerli';
@@ -20,6 +21,7 @@ export function getSubgraphUrlForChainId(chainId) {
 /**
  * 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.
@@ -27,31 +29,31 @@ export function getSubgraphUrlForChainId(chainId) {
  * @param {string[]} event - The event types to filter by.
  * @returns {Promise<CreditEventPayload[]>} The credit events for the given user.
  */
-export function getCreditEventsForUser(userAddress, chainId, poolName, poolType, event) {
+function getCreditEventsForUser(userAddress, chainId, poolName, poolType, event) {
     var _a, _b, _c;
     const url = getSubgraphUrlForChainId(chainId);
     if (!url) {
         return Promise.resolve([]);
     }
     const poolAddress = (_c = (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[poolType]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.pool;
-    const query = `
-    query {
-      creditEvents(
-        where: {
-          owner: "${userAddress}",
-          pool: "${poolAddress}",
-          event_in: "[${event.join('", "')}]"
-        }
-        orderBy: timestamp
-        orderDirection: desc
-      ) {
-        amount
-        timestamp
-        owner
-        pool
-        event
-      }
-    }
+    const query = `
+    query {
+      creditEvents(
+        where: {
+          owner: "${userAddress}",
+          pool: "${poolAddress}",
+          event_in: "[${event.join('", "')}]"
+        }
+        orderBy: timestamp
+        orderDirection: desc
+      ) {
+        amount
+        timestamp
+        owner
+        pool
+        event
+      }
+    }
   `;
     return fetch(url, {
         method: 'POST',
@@ -72,15 +74,25 @@ export function getCreditEventsForUser(userAddress, chainId, poolName, poolType,
 /**
  * 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.
  */
-export function getLastFactorizedAmountFromPool(userAddress, chainId, poolName, poolType) {
+function getLastFactorizedAmountFromPool(userAddress, chainId, poolName, poolType) {
     return getCreditEventsForUser(userAddress, chainId, poolName, poolType, [
         CreditEvent.DrawdownMadeWithReceivable.toString(),
     ]).then((events) => Number(events[0].amount));
 }
+/**
+ * An object that contains functions to interact with Huma's Subgraph storage.
+ * @namespace SubgraphService
+ */
+export const SubgraphService = {
+    getSubgraphUrlForChainId,
+    getCreditEventsForUser,
+    getLastFactorizedAmountFromPool,
+};
 //# sourceMappingURL=SubgraphService.js.map