@huma-finance/shared 0.0.8 → 0.0.11

package/dist/services/EAService.d.ts

@@ -1,66 +1,147 @@
 /**
- * Object representing the information returned from a successful approve operation.
- * @typedef {Object} ApproveInfo
- * @property {number} aprInBps The annual percentage rate in basis points.
+ * Object representing the token information of the approval.
+ * @typedef {Object} Token
+ * @property {string} symbol The symbol of the base token of the pool.
+ * @property {string} name The name of the base token of the pool.
+ * @property {number} decimal The number of decimals for the base token of the pool.
+ */
+type Token = {
+    symbol: string;
+    name: string;
+    decimal: number;
+};
+/**
+ * Object representing the approved loan terms.
+ * @typedef {Object} Terms
  * @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.
+ * @property {number} aprInBps The annual percentage rate in basis points.
  */
-export type ApproveInfo = {
-    aprInBps: number;
-    creditLimit: number | string;
+type Terms = {
+    creditLimit: number;
     intervalInDays: number;
-    receivableAmount: number | string;
-    receivableAsset: string;
-    receivableParam: number | string;
     remainingPeriods: number;
-    tokenDecimal: number;
-    tokenName: string;
-    tokenSymbol: string;
+    aprInBps: number;
+};
+/**
+ * Object representing receivable information of the approval.
+ * @typedef {Object} Receivable
+ * @property {string} asset The address of the receivable asset contract.
+ * @property {number|string} param The identifying parameter for the receivable asset, often the token ID of an ERC721.
+ * @property {number|string} amount The expected payment amount of the receivable asset.
+ */
+type Receivable = {
+    asset: string;
+    param: string;
+    amount: number;
+};
+/**
+ * Object representing EA approval.
+ * @typedef {Object} Approval
+ * @property {Token} token The token information for the approval.
+ * @property {Terms} terms The approved loan terms.
+ * @property {Receivable} receivable The receivable information.
+ */
+export type Approval = {
+    token: Token;
+    terms: Terms;
+    receivable?: Receivable;
+};
+/**
+ * Object representing EA rejection.
+ * @typedef {Object} Rejection
+ * @property {string[]} reasons Rejection reasons.
+ */
+export type Rejection = {
+    reasons: string[];
+};
+/**
+ * Object representing the response to the underwriting approval request.
+ * @typedef {Object} ApprovalResult
+ * @property {Approval | Rejection} result the EA decision, either an approval or rejection.
+ */
+export type ApprovalResult = {
+    result: Approval | Rejection;
+};
+/**
+ * Object representing a credit line payload for underwriting approval.
+ * @typedef {Object} EAPayloadCredit
+ * @property {string} poolAddress The address of the pool for the underwriting.
+ * @property {string} [borrowerWalletAddress] The address of the borrower's wallet.
+ */
+export type EAPayloadCredit = {
+    poolAddress: string;
+    borrowerWalletAddress: string;
+};
+/**
+ * Object representing the receivable in an underwriting request.
+ * @typedef {Object} ReceivableRequest
+ * @property {string} [address] The address of the receivable asset contract.
+ * @property {string} [param] The parameter for the receivable asset.
+ */
+type ReceivableRequest = {
+    address: string;
+    param: string;
+};
+/**
+ * Object representing the additional data required for a receivable-based underwriting request.
+ * @typedef {Object} EARequestContextReceivable
+ * @property {ReceivableRequest} [receivable] The receivable information.
+ */
+type EARequestContextReceivable = {
+    receivable: ReceivableRequest;
 };
 /**
  * Object representing an invoice payload for underwriting approval.
  * @typedef {Object} EAPayloadInvoice
- * @property {string} poolAddress The address of the pool for the underwrite.
+ * @property {string} poolAddress The address of the pool for the underwriting.
  * @property {string} [borrowerWalletAddress] The address of the borrower's wallet.
  * @property {string} [receivableAddress] The address of the receivable asset contract.
- * @property {string|number} [receivableParam] The parameter for the receivable asset.
+ * @property {string} [receivableParam] The parameter for the receivable asset.
+ * @property {EARequestContextReceivable} [context] The additional data required for the request.
  */
 export type EAPayloadInvoice = {
     poolAddress: string;
-    borrowerWalletAddress?: string;
+    borrowerWalletAddress: string;
     receivableAddress?: string;
     receivableParam?: string;
+    context: EARequestContextReceivable;
+};
+/**
+ * Object representing the additional data required for a stream factoring underwriting request.
+ * @typedef {Object} EAContextStream
+ * @property {string} payerAddress The address of the payer.
+ * @property {string} superToken The address of the SuperToken contract.
+ */
+type EAContextStream = {
+    payerAddress: string;
+    superToken: string;
 };
 /**
  * Object representing a stream payload for underwriting approval.
  * @typedef {Object} EAPayloadStream
  * @property {string} creditLimit The credit limit for the borrower in the pool's base currency.
- * @property {string} poolAddress The address of the pool for the underwrite.
+ * @property {string} poolAddress The address of the pool for the underwriting.
  * @property {string} borrowerWalletAddress The address of the borrower's wallet.
  * @property {string} payerAddress The address of the payer.
  * @property {string} superToken The address of the SuperToken contract.
+ * @property {EAContextStream} context The additional data required for a stream factoring underwriting request.
  */
 type EAPayloadStream = {
-    creditLimit: string;
     poolAddress: string;
     borrowerWalletAddress: string;
     payerAddress: string;
     superToken: string;
+    context: EAContextStream;
 };
-export type EAPayload = EAPayloadInvoice | EAPayloadStream;
+export type EAPayload = EAPayloadCredit | EAPayloadInvoice | EAPayloadStream;
 export declare const EAService: {
-    approve: (payload: EAPayload, chainId: number, isDev?: boolean) => Promise<ApproveInfo>;
+    approve: (payload: EAPayload, chainId: number, isDev?: boolean) => Promise<Approval>;
     approveLender: (payload: {
         poolAddress: string;
         lenderWalletAddress: string;
-    }, chainId: number) => Promise<ApproveInfo>;
+    }, chainId: number) => Promise<ApprovalResult>;
     addToAllowList: (walletAddress: string, poolAddress: string, userName?: string) => Promise<void>;
 };
 export {};

package/dist/services/EAService.js

@@ -1,22 +1,22 @@
 import { configUtil } from '../utils/config';
 import { EARejectionError } from '../utils/errors';
 import { requestPost } from '../utils/request';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isRejection = (obj) => obj !== null && typeof obj === 'object' && Array.isArray(obj.reasons);
 /**
  * Submits a credit underwriting request to Huma's EAVerse.
  * @param {EAPayload} payload The payload for the underwrite approval.
  * @param {number} chainId The chain ID.
  * @param {boolean} isDev Is dev environment or not.
- * @returns {Promise<ApproveInfo>} Promise that returns approval info on success.
+ * @returns {Promise<Approval>} Promise that returns the approval on success.
  * @throws {EARejectionError} If the underwrite approval is rejected.
  */
 const approve = async (payload, chainId, isDev = false) => {
-    var _a;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const data = await requestPost(`${configUtil.getEAVerseUrl(chainId, isDev)}/underwriter/underwrite`, payload);
-    if ((_a = data.rejectionReasons) === null || _a === void 0 ? void 0 : _a.length) {
+    const approvalResult = await requestPost(`${configUtil.getEAVerseUrl(chainId, isDev)}/underwriter/underwrite`, payload);
+    if (isRejection(approvalResult.result)) {
         throw new EARejectionError();
     }
-    return data;
+    return approvalResult.result;
 };
 const approveLender = async (payload, chainId) => {
     var _a, _b;

package/dist/services/EAService.js.map

@@ -1 +1 @@
-{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../src/services/EAService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AA+D9C;;;;;;;GAOG;AACH,MAAM,OAAO,GAAG,KAAK,EAAE,OAAkB,EAAE,OAAe,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE;;IAC3E,8DAA8D;IAC9D,MAAM,IAAI,GAAQ,MAAM,WAAW,CACjC,GAAG,UAAU,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,yBAAyB,EACpE,OAAO,CACR,CAAA;IACD,IAAI,MAAA,IAAI,CAAC,gBAAgB,0CAAE,MAAM,EAAE;QACjC,MAAM,IAAI,gBAAgB,EAAE,CAAA;KAC7B;IAED,OAAO,IAAmB,CAAA;AAC5B,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EACzB,OAGC,EACD,OAAe,EACf,EAAE;;IACF,MAAM,mBAAmB,GACvB,8DAA8D,CAAA;IAChE,IAAI;QACF,8DAA8D;QAC9D,MAAM,IAAI,GAAQ,MAAM,WAAW,CACjC,GAAG,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,oBAAoB,EACzD,OAAO,CACR,CAAA;QACD,IAAI,IAAI,CAAC,UAAU,IAAI,GAAG,EAAE;YAC1B,MAAM,IAAI,KAAK,CACb,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAC/D,CAAA;SACF;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SAChC;aAAM,IAAI,MAAA,IAAI,CAAC,eAAe,0CAAE,MAAM,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;SACzC;QACD,OAAO,IAAmB,CAAA;QAC1B,8DAA8D;KAC/D;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,mBAAmB,EAAE;YACpD,KAAK,EAAE,cAAc;SACtB,CAAC,CAAA;KACH;AACH,CAAC,CAAA;AAED,MAAM,cAAc,GAAG,KAAK,EAC1B,aAAqB,EACrB,WAAmB,EACnB,QAAiB,EACjB,EAAE;IACF,IAAI;QACF,MAAM,WAAW,CAAC,GAAG,UAAU,CAAC,iBAAiB,EAAE,cAAc,EAAE;YACjE,cAAc,EAAE,aAAa;YAC7B,YAAY,EAAE,WAAW;YACzB,SAAS,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE;SAC1B,CAAC,CAAA;QACF,8DAA8D;KAC/D;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;KAC/B;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,OAAO;IACP,aAAa;IACb,cAAc;CACf,CAAA"}
+{"version":3,"file":"EAService.js","sourceRoot":"","sources":["../../src/services/EAService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAmK9C,8DAA8D;AAC9D,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAoB,EAAE,CACjD,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAEvE;;;;;;;GAOG;AACH,MAAM,OAAO,GAAG,KAAK,EAAE,OAAkB,EAAE,OAAe,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE;IAC3E,MAAM,cAAc,GAAmB,MAAM,WAAW,CACtD,GAAG,UAAU,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,yBAAyB,EACpE,OAAO,CACR,CAAA;IACD,IAAI,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;QACtC,MAAM,IAAI,gBAAgB,EAAE,CAAA;KAC7B;IAED,OAAO,cAAc,CAAC,MAAM,CAAA;AAC9B,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EACzB,OAGC,EACD,OAAe,EACf,EAAE;;IACF,MAAM,mBAAmB,GACvB,8DAA8D,CAAA;IAChE,IAAI;QACF,8DAA8D;QAC9D,MAAM,IAAI,GAAQ,MAAM,WAAW,CACjC,GAAG,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,oBAAoB,EACzD,OAAO,CACR,CAAA;QACD,IAAI,IAAI,CAAC,UAAU,IAAI,GAAG,EAAE;YAC1B,MAAM,IAAI,KAAK,CACb,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAC/D,CAAA;SACF;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SAChC;aAAM,IAAI,MAAA,IAAI,CAAC,eAAe,0CAAE,MAAM,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;SACzC;QACD,OAAO,IAAsB,CAAA;QAC7B,8DAA8D;KAC/D;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,mBAAmB,EAAE;YACpD,KAAK,EAAE,cAAc;SACtB,CAAC,CAAA;KACH;AACH,CAAC,CAAA;AAED,MAAM,cAAc,GAAG,KAAK,EAC1B,aAAqB,EACrB,WAAmB,EACnB,QAAiB,EACjB,EAAE;IACF,IAAI;QACF,MAAM,WAAW,CAAC,GAAG,UAAU,CAAC,iBAAiB,EAAE,cAAc,EAAE;YACjE,cAAc,EAAE,aAAa;YAC7B,YAAY,EAAE,WAAW;YACzB,SAAS,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE;SAC1B,CAAC,CAAA;QACF,8DAA8D;KAC/D;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;KAC/B;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,OAAO;IACP,aAAa;IACb,cAAc;CACf,CAAA"}