@huma-finance/sdk 0.0.8 → 0.0.11

package/README.md

@@ -4,7 +4,7 @@ The Huma SDK includes utilities and services for interacting with different laye
 
 ## Getting Started
 
-We recommend onboarding onto our SDK using the [Getting Started guide](docs/getting-started.md)
+We recommend onboarding onto our SDK using the [Getting Started guide](getting-started.md)
 
 ## Documentation
 

package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.d.ts

@@ -1,10 +1,10 @@
 import { Contract, ethers } from 'ethers';
 /**
- * Returns an ethers contract instance for the BaseCreditPoolReceivable contract
+ * Returns an ethers contract instance for the ERC20TransferableReceivable contract
  * associated with the given pool name on the current chain.
  *
  * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
  * @param {number} chainId The chain id where the contract instance exists
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
+ * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
  */
 export declare function getERC20TransferableReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js

@@ -4,12 +4,12 @@ exports.getERC20TransferableReceivableContract = void 0;
 const shared_1 = require("@huma-finance/shared");
 const utils_1 = require("../utils");
 /**
- * Returns an ethers contract instance for the BaseCreditPoolReceivable contract
+ * Returns an ethers contract instance for the ERC20TransferableReceivable contract
  * associated with the given pool name on the current chain.
  *
  * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
  * @param {number} chainId The chain id where the contract instance exists
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
+ * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
  */
 function getERC20TransferableReceivableContract(signerOrProvider, chainId) {
     var _a;

package/dist/cjs/helpers/RealWorldReceivableContractHelper.d.ts

@@ -0,0 +1,10 @@
+import { Contract, ethers } from 'ethers';
+/**
+ * Returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+export declare function getRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/cjs/helpers/RealWorldReceivableContractHelper.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRealWorldReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const utils_1 = require("../utils");
+/**
+ * Returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+function getRealWorldReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
+    if (!realWorldReceivable)
+        return null;
+    return (0, utils_1.getContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.getRealWorldReceivableContract = getRealWorldReceivableContract;
+//# sourceMappingURL=RealWorldReceivableContractHelper.js.map

package/dist/cjs/helpers/RealWorldReceivableContractHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RealWorldReceivableContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/RealWorldReceivableContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAI6B;AAE7B,oCAAsC;AAEtC;;;;;;;GAOG;AACH,SAAgB,8BAA8B,CAC5C,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,mBAAmB,GACvB,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,mBAAmB;QAAE,OAAO,IAAI,CAAA;IAErC,OAAO,IAAA,mBAAW,EAChB,mBAAmB,EACnB,kCAAyB,EACzB,gBAAgB,CACjB,CAAA;AACH,CAAC;AAhBD,wEAgBC"}

package/dist/cjs/helpers/index.d.ts

@@ -1,3 +1,3 @@
-export * from './BaseCreditPoolReceivableContractHelper';
+export * from './RealWorldReceivableContractHelper';
 export * from './ERC20TransferableReceivableContractHelper';
 export * from './PoolContractHelper';

package/dist/cjs/helpers/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./BaseCreditPoolReceivableContractHelper"), exports);
+tslib_1.__exportStar(require("./RealWorldReceivableContractHelper"), exports);
 tslib_1.__exportStar(require("./ERC20TransferableReceivableContractHelper"), exports);
 tslib_1.__exportStar(require("./PoolContractHelper"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,mFAAwD;AACxD,sFAA2D;AAC3D,+DAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,8EAAmD;AACnD,sFAA2D;AAC3D,+DAAoC"}

package/dist/cjs/hooks/index.d.ts

@@ -1,4 +1,4 @@
 export * from './useContract';
-export * from './useBaseCreditPoolReceivableContract';
+export * from './useRealWorldReceivableContract';
 export * from './useERC20TransferableReceivableContract';
 export * from './usePoolContract';

package/dist/cjs/hooks/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./useContract"), exports);
-tslib_1.__exportStar(require("./useBaseCreditPoolReceivableContract"), exports);
+tslib_1.__exportStar(require("./useRealWorldReceivableContract"), exports);
 tslib_1.__exportStar(require("./useERC20TransferableReceivableContract"), exports);
 tslib_1.__exportStar(require("./usePoolContract"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/hooks/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":";;;AAAA,wDAA6B;AAC7B,gFAAqD;AACrD,mFAAwD;AACxD,4DAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":";;;AAAA,wDAA6B;AAC7B,2EAAgD;AAChD,mFAAwD;AACxD,4DAAiC"}

package/dist/cjs/hooks/usePoolContract.d.ts

@@ -49,7 +49,7 @@ export type CreditRecordDetails = {
 /**
  * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
  *
- * @namespace usePoolContract
+ * @memberof usePoolContract
  * @param {string} userAddress - The address of the user to get the credit record details for.
  * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object to use for the contract.
  * @param {number} chainId The chain id where the contract instance exists

package/dist/cjs/hooks/usePoolContract.js

@@ -23,7 +23,7 @@ exports.usePoolContract = usePoolContract;
 /**
  * A react hook that returns the credit record details for a user in a given pool, as well as a function to refresh the data.
  *
- * @namespace usePoolContract
+ * @memberof usePoolContract
  * @param {string} userAddress - The address of the user to get the credit record details for.
  * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object to use for the contract.
  * @param {number} chainId The chain id where the contract instance exists

package/dist/cjs/hooks/useRealWorldReceivableContract.d.ts

@@ -0,0 +1,10 @@
+import { Contract, ethers } from 'ethers';
+/**
+ * A react hook that returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+export declare function useRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;

package/dist/cjs/hooks/useRealWorldReceivableContract.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRealWorldReceivableContract = void 0;
+const shared_1 = require("@huma-finance/shared");
+const useContract_1 = require("./useContract");
+/**
+ * A react hook that returns an ethers contract instance for the RealWorldReceivable contract
+ * associated with the given pool name on the current chain.
+ *
+ * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
+ * @param {number} chainId The chain id where the contract instance exists
+ * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
+ */
+function useRealWorldReceivableContract(signerOrProvider, chainId) {
+    var _a;
+    const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
+    return (0, useContract_1.useContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
+}
+exports.useRealWorldReceivableContract = useRealWorldReceivableContract;
+//# sourceMappingURL=useRealWorldReceivableContract.js.map

package/dist/cjs/hooks/useRealWorldReceivableContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRealWorldReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useRealWorldReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAE7B,+CAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,8BAA8B,CAC5C,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,mBAAmB,GACvB,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,OAAO,IAAA,yBAAW,EAChB,mBAAmB,EACnB,kCAAyB,EACzB,gBAAgB,CACjB,CAAA;AACH,CAAC;AAdD,wEAcC"}

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

@@ -1,6 +1,7 @@
 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
  *
@@ -37,6 +38,18 @@ export declare function getBundlrNetworkConfig(chainId: number): BundlrConfig;
  * @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.
  *
@@ -76,6 +89,7 @@ declare function queryForMetadata(chainId: number, poolName: POOL_NAME, poolType
  * @namespace ARWeaveService
  */
 export declare const ARWeaveService: {
+    getBundlrBalance: typeof getBundlrBalance;
     queryForMetadata: typeof queryForMetadata;
     storeData: typeof storeData;
     prefundBundlr: typeof prefundBundlr;

package/dist/cjs/services/ARWeaveService.js

@@ -4,6 +4,7 @@ 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
  *
@@ -56,6 +57,27 @@ signer, amount) {
     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.
  *
@@ -106,29 +128,29 @@ async function storeData(config, signerOrPrivateKey, data, tags, lazyFund = true
 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
-          }
-        }
-      }
-    }
+    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, {
@@ -144,6 +166,7 @@ async function queryForMetadata(chainId, poolName, poolType, sender, referenceId
  * @namespace ARWeaveService
  */
 exports.ARWeaveService = {
+    getBundlrBalance,
     queryForMetadata,
     storeData,
     prefundBundlr,

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;AAmB9C;;;;;;;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;;;;;;;;;;;;;;;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,SAAS;IACT,aAAa;IACb,sBAAsB;CACvB,CAAA"}
+{"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

@@ -1,36 +1,18 @@
 /**
- * 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 the response to the underwriting approval request.
+ * @typedef {Object} ApprovalResult
  */
 /**
  * Object representing an invoice payload for underwriting approval.
  *
  * @typedef {Object} EAPayload
  */
-export type { ApproveInfo, EAPayload } from '@huma-finance/shared';
+export type { ApprovalResult, 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.
- * @returns {Promise<ApproveInfo>} Promise that returns approval info on success.
- * @throws {EARejectionError} If the underwrite approval is rejected.
  */
 export declare const EAService: {
-    approve: (payload: import("@huma-finance/shared").EAPayload, chainId: number, isDev?: boolean | undefined) => Promise<import("@huma-finance/shared").ApproveInfo>;
+    approve: (payload: import("@huma-finance/shared").EAPayload, chainId: number, isDev?: boolean | undefined) => Promise<import("@huma-finance/shared").Approval>;
 };

package/dist/cjs/services/EAService.js

@@ -6,12 +6,6 @@ const shared_1 = require("@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.
- * @returns {Promise<ApproveInfo>} Promise that returns approval info on success.
- * @throws {EARejectionError} If the underwrite approval is rejected.
  */
 exports.EAService = {
     approve: shared_1.EAService.approve,

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

@@ -1 +1 @@
-{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../../src/services/EAService.ts"],"names":[],"mappings":";;;AAAA,iDAAqE;AAyBrE;;;;;;;;;;GAUG;AACU,QAAA,SAAS,GAAG;IACvB,OAAO,EAAE,kBAAiB,CAAC,OAAO;CACnC,CAAA"}
+{"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

@@ -1,62 +1,43 @@
-import { TransactionReceipt, TransactionResponse, Web3Provider } from '@ethersproject/providers';
+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>;
 /**
- * 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 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.
- * @param {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
- * @returns {Promise<TransactionReceipt>} - A Promise of the transaction receipt.
- * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
- */
-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.
+ * 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 {PaymentMethod} paymentMethod - The payment method to use. See PaymentMethod for more details.
- * @returns {Promise<TransactionReceipt>} - A Promise of the transaction receipt.
- * @throws {Error} - Throws an error if the BaseCreditPoolReceivable contract is not available on the network.
+ * @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 payReceivableByTokenId(signer: ethers.Signer, receivableTokenId: BigNumberish, paymentAmount: number, paymentMethod: PaymentMethod): Promise<TransactionReceipt>;
+declare function declareReceivablePaymentByTokenId(signer: ethers.Signer, receivableTokenId: BigNumberish, paymentAmount: number): Promise<TransactionResponse>;
 /**
- * Mints a new BaseCreditPoolReceivable token on the given chain of the signer
+ * 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 {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.
  * @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 {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.
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
  */
-declare function mintReceivable(signer: ethers.Signer, poolName: POOL_NAME, poolType: POOL_TYPE, receivableAmount: number, maturityDate: number, paymentMethod: PaymentMethod, uri: string, gasOpts?: Overrides): Promise<TransactionResponse>;
+declare function createReceivable(signer: ethers.Signer, poolName: POOL_NAME, poolType: POOL_TYPE, currencyCode: number, receivableAmount: number, maturityDate: number, uri: string, gasOpts?: Overrides): Promise<TransactionResponse>;
 /**
- * Mints a BaseCreditPoolReceivable token with metadata uploaded onto ARWeave
+ * 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
@@ -66,9 +47,9 @@ declare function mintReceivable(signer: ethers.Signer, poolName: POOL_NAME, pool
  * @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 {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} 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
@@ -76,20 +57,20 @@ declare function mintReceivable(signer: ethers.Signer, poolName: POOL_NAME, pool
  * @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.
+ * @returns {Promise<TransactionResponse>} - The transaction receipt.
  */
-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: {
+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<TransactionReceipt>;
+}[], lazyFund?: boolean, gasOpts?: Overrides): Promise<TransactionResponse>;
 /**
  * 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;
+    createReceivableWithMetadata: typeof createReceivableWithMetadata;
+    createReceivable: typeof createReceivable;
+    declareReceivablePaymentByTokenId: typeof declareReceivablePaymentByTokenId;
+    declareReceivablePaymentByReferenceId: typeof declareReceivablePaymentByReferenceId;
 };
 export {};