@huma-finance/sdk 0.0.28 → 0.0.30

package/dist/cjs/services/ARWeaveService.js

@@ -1,146 +1,170 @@
-"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"));
-/**
- * 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: // Goerli
-            return {
-                nodeUrl: 'https://devnet.bundlr.network',
-                currency: 'ethereum',
-                providerUrl: 'https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161',
-            };
-        case 80001: // Mumbai
-            return {
-                nodeUrl: 'https://devnet.bundlr.network',
-                currency: 'matic',
-                providerUrl: 'https://rpc-mumbai.matic.today',
-            };
-        case 137: // Matic
-            return {
-                nodeUrl: 'https://node1.bundlr.network',
-                currency: 'matic',
-            };
-        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);
-}
-/**
- * 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 {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, sender, referenceId) {
-    var _a, _b, _c, _d;
-    const config = getBundlrNetworkConfig(chainId);
-    const query = (0, graphql_request_1.gql) `
-    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
-      transactions(
-        owners: [$sender]
-        tags: [
-          { name: "appName", values: ["HumaFinance"] }
-          { 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, {
-        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 = {
-    queryForMetadata,
-    storeData,
-    prefundBundlr,
-    getBundlrNetworkConfig,
-};
+"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"));
+/**
+ * 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: // Goerli
+            return {
+                nodeUrl: 'https://devnet.bundlr.network',
+                currency: 'ethereum',
+                providerUrl: 'https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161',
+            };
+        case 80001: // Mumbai
+            return {
+                nodeUrl: 'https://devnet.bundlr.network',
+                currency: 'matic',
+                providerUrl: 'https://rpc.ankr.com/polygon_mumbai',
+            };
+        case 137: // Matic
+            return {
+                nodeUrl: 'https://node1.bundlr.network',
+                currency: 'matic',
+            };
+        default:
+            return {
+                nodeUrl: '',
+                currency: '',
+            };
+    }
+}
+exports.getBundlrNetworkConfig = getBundlrNetworkConfig;
+/**
+ * Get a Bundlr instance for a specific network
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {string} signer - The private key of the wallet to use Bundlr with.
+ * @returns The Bundlr instance
+ */
+async function getBundlrInstance(config, signer) {
+    const bundlr = new client_1.default(config.nodeUrl, config.currency, signer, config.providerUrl
+        ? {
+            providerUrl: config.providerUrl,
+        }
+        : undefined);
+    await bundlr.ready();
+    return bundlr;
+}
+/**
+ * Prefund the Bundlr network with the specified amount. Required if not lazy funding.
+ * Important note: The amount is denominated in the base unit of currency for that network.
+ * If you want to upload 5 Matic to the Bundlr node, pass in an amount of 5.
+ *
+ * @async
+ * @function
+ * @memberof ArweaveService
+ * @param {BundlrConfig} config - The configuration for the Bundlr network.
+ * @param {string} signer - The private key of the wallet to send funds from.
+ * @param {number} amount - The amount to fund, denoted in whatever currency specified by the config (e.g. MATIC, ETH)
+ * @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();
+    // Convert currency to its atomic units (e.g. MATIC -> wei)
+    const atomicAmount = bundlr.utils.toAtomic(amount);
+    return bundlr.fund(atomicAmount);
+}
+/**
+ * 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 20% to account for fluctuations in the price
+        const priceWithBuffer = price.multipliedBy(1.2).integerValue();
+        console.log(`Funding bundlr with ${priceWithBuffer} ${config.currency} to upload data`);
+        await bundlr.fund(priceWithBuffer);
+    }
+    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 {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, sender, referenceId) {
+    var _a, _b, _c, _d;
+    const config = getBundlrNetworkConfig(chainId);
+    const query = (0, graphql_request_1.gql) `
+    query ArweaveHumaMetadataQuery($sender: String!, $referenceId: String!) {
+      transactions(
+        owners: [$sender]
+        tags: [
+          { name: "appName", values: ["HumaFinance"] }
+          { 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, {
+        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 = {
+    queryForMetadata,
+    storeData,
+    prefundBundlr,
+    getBundlrNetworkConfig,
+    getBundlrInstance,
+};
 //# sourceMappingURL=ARWeaveService.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../../src/services/ARWeaveService.ts"],"names":[],"mappings":";;;;AAAA,4EAA2C;AAM3C,2EAA8C;AAkB9C;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,QAAQ,OAAO,EAAE;QACf,KAAK,CAAC,EAAE,SAAS;YACf,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,UAAU;gBACpB,WAAW,EACT,8DAA8D;aACjE,CAAA;QACH,KAAK,KAAK,EAAE,SAAS;YACnB,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,gCAAgC;aAC9C,CAAA;QACH,KAAK,GAAG,EAAE,QAAQ;YAChB,OAAO;gBACL,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,OAAO;aAClB,CAAA;QACH;YACE,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAA;KACJ;AACH,CAAC;AA1BD,wDA0BC;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;;;;;;;;;;;;;;;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;;;;;;;;;;GAUG;AACH,KAAK,UAAU,gBAAgB,CAC7B,OAAe,EACf,MAAc,EACd,WAAmB;;IAEnB,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;GAgBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,IAAA,yBAAO,EAAC,GAAG,MAAM,CAAC,OAAO,UAAU,EAAE,KAAK,EAAE;QAClE,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,SAAS;IACT,aAAa;IACb,sBAAsB;CACvB,CAAA"}
+{"version":3,"file":"ARWeaveService.js","sourceRoot":"","sources":["../../../src/services/ARWeaveService.ts"],"names":[],"mappings":";;;;AAAA,4EAA2C;AAM3C,2EAA8C;AAkB9C;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,QAAQ,OAAO,EAAE;QACf,KAAK,CAAC,EAAE,SAAS;YACf,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,UAAU;gBACpB,WAAW,EACT,8DAA8D;aACjE,CAAA;QACH,KAAK,KAAK,EAAE,SAAS;YACnB,OAAO;gBACL,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,qCAAqC;aACnD,CAAA;QACH,KAAK,GAAG,EAAE,QAAQ;YAChB,OAAO;gBACL,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,OAAO;aAClB,CAAA;QACH;YACE,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAA;KACJ;AACH,CAAC;AA1BD,wDA0BC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,iBAAiB,CAAC,MAAoB,EAAE,MAAc;IACnE,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,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,aAAa,CAC1B,MAAoB;AACpB,8DAA8D;AAC9D,MAAc,EACd,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,2DAA2D;IAC3D,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAElD,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;AAClC,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,MAAM,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,CAAA;QAC9D,OAAO,CAAC,GAAG,CACT,uBAAuB,eAAe,IAAI,MAAM,CAAC,QAAQ,iBAAiB,CAC3E,CAAA;QACD,MAAM,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;KACnC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,gBAAgB,CAC7B,OAAe,EACf,MAAc,EACd,WAAmB;;IAEnB,MAAM,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;GAgBhB,CAAA;IAED,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,IAAA,yBAAO,EAAC,GAAG,MAAM,CAAC,OAAO,UAAU,EAAE,KAAK,EAAE;QAClE,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,SAAS;IACT,aAAa;IACb,sBAAsB;IACtB,iBAAiB;CAClB,CAAA"}

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

@@ -1,20 +1,20 @@
-import { EAPayload, EAPreapprovalPayload } from '@huma-finance/shared';
-/**
- * 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: EAPayload, chainId: number) => Promise<import("@huma-finance/shared").Approval>;
-    preapprove: (payload: EAPreapprovalPayload, chainId: number) => Promise<import("@huma-finance/shared").PreapprovalResult>;
-};
+import { EAPayload, EAPreapprovalPayload } from '@huma-finance/shared';
+/**
+ * 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: EAPayload, chainId: number) => Promise<import("@huma-finance/shared").Approval>;
+    preapprove: (payload: EAPreapprovalPayload, chainId: number) => Promise<import("@huma-finance/shared").PreapprovalResult>;
+};

package/dist/cjs/services/EAService.js

@@ -1,34 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EAService = void 0;
-const shared_1 = require("@huma-finance/shared");
-/**
- * Submits a credit underwriting request to Huma's EAVerse. This approves a creditline
- * in Huma's pools that can be drawn down by the borrower.
- *
- * @memberof EAService
- * @param {EAPayload} payload The payload for the underwrite approval.
- * @param {number} chainId The chain ID.
- * @returns {Promise<Approval>} Promise that returns the approval on success.
- * @throws {EARejectionError} If the underwrite approval is rejected.
- */
-const approve = async (payload, chainId) => shared_1.EAService.approve(payload, chainId);
-/**
- * Checks whether or not a credit underwriting request to Huma's EAVerse would be approved.
- * Note that this does not approve a creditline in Huma's pools and an approve call is still required.
- *
- * @param {EAPreapprovalPayload} payload The payload for the underwrite approval.
- * @param {number} chainId The chain ID.
- * @returns {Promise<Approval>} Promise that returns the approval on success.
- */
-const preapprove = async (payload, chainId) => shared_1.EAService.preapprove(payload, chainId);
-/**
- * An object that contains functions to interact with Huma's EAVerse service.
- *
- * @namespace EAService
- */
-exports.EAService = {
-    approve,
-    preapprove,
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EAService = void 0;
+const shared_1 = require("@huma-finance/shared");
+/**
+ * Submits a credit underwriting request to Huma's EAVerse. This approves a creditline
+ * in Huma's pools that can be drawn down by the borrower.
+ *
+ * @memberof EAService
+ * @param {EAPayload} payload The payload for the underwrite approval.
+ * @param {number} chainId The chain ID.
+ * @returns {Promise<Approval>} Promise that returns the approval on success.
+ * @throws {EARejectionError} If the underwrite approval is rejected.
+ */
+const approve = async (payload, chainId) => shared_1.EAService.approve(payload, chainId);
+/**
+ * Checks whether or not a credit underwriting request to Huma's EAVerse would be approved.
+ * Note that this does not approve a creditline in Huma's pools and an approve call is still required.
+ *
+ * @param {EAPreapprovalPayload} payload The payload for the underwrite approval.
+ * @param {number} chainId The chain ID.
+ * @returns {Promise<Approval>} Promise that returns the approval on success.
+ */
+const preapprove = async (payload, chainId) => shared_1.EAService.preapprove(payload, chainId);
+/**
+ * An object that contains functions to interact with Huma's EAVerse service.
+ *
+ * @namespace EAService
+ */
+exports.EAService = {
+    approve,
+    preapprove,
+};
 //# sourceMappingURL=EAService.js.map

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

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