@huma-finance/sdk 0.0.42-beta.99 → 0.0.42

package/dist/services/SubgraphService.d.ts

@@ -1,12 +1,4 @@
-import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
-/**
- * Returns the subgraph URL for a given chain ID.
- *
- * @memberof SubgraphService
- * @param {number} chainId - The ID of the chain.
- * @returns {string} The subgraph URL for the given chain ID.
- */
-declare function getSubgraphUrlForChainId(chainId: number): string;
+import { POOL_NAME, POOL_TYPE, RealWorldReceivableInfoBase } from '@huma-finance/shared';
 /**
  * Represents the payload of a credit event.
  * @typedef {Object} CreditEventPayload
@@ -18,6 +10,24 @@ export type CreditEventPayload = {
     pool?: string;
     event?: string;
 };
+/**
+ * Represents the pagination options for a query.
+ * @typedef {Object} Pagination
+ */
+export type Pagination = {
+    first: number | null;
+    skip: number | null;
+    orderBy: string;
+    orderDirection: 'desc' | 'asc';
+};
+/**
+ * Returns the subgraph URL for a given chain ID.
+ *
+ * @memberof SubgraphService
+ * @param {number} chainId - The ID of the chain.
+ * @returns {string} The subgraph URL for the given chain ID.
+ */
+declare function getSubgraphUrlForChainId(chainId: number): string;
 /**
  * Returns the credit events for a given user.
  *
@@ -41,6 +51,18 @@ declare function getCreditEventsForUser(userAddress: string, chainId: number, po
  * @returns {Promise<number>} The last factorized amount for the given user and pool.
  */
 declare function getLastFactorizedAmountFromPool(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<number>;
+/**
+ * Returns the paginated real world receivables' info.
+ *
+ * @memberof SubgraphService
+ * @param {string} userAddress - The address of the user.
+ * @param {number} chainId - The ID of the chain.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @param {Pagination} pagination - The pagination option.
+ * @returns {Promise<RealWorldReceivableInfoBase>} The paginated real world receivables' info.
+ */
+declare function getRWReceivableInfo(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, pagination?: Pagination): Promise<RealWorldReceivableInfoBase[]>;
 /**
  * An object that contains functions to interact with Huma's Subgraph storage.
  * @namespace SubgraphService
@@ -49,5 +71,6 @@ export declare const SubgraphService: {
     getSubgraphUrlForChainId: typeof getSubgraphUrlForChainId;
     getCreditEventsForUser: typeof getCreditEventsForUser;
     getLastFactorizedAmountFromPool: typeof getLastFactorizedAmountFromPool;
+    getRWReceivableInfo: typeof getRWReceivableInfo;
 };
 export {};

package/dist/services/SubgraphService.js

@@ -1,4 +1,4 @@
-import { CreditEvent, PoolContractMap, requestPost, } from '@huma-finance/shared';
+import { CreditEvent, PoolContractMap, requestPost, PoolSubgraphMap, } from '@huma-finance/shared';
 /**
  * Returns the subgraph URL for a given chain ID.
  *
@@ -7,16 +7,8 @@ import { CreditEvent, PoolContractMap, requestPost, } from '@huma-finance/shared
  * @returns {string} The subgraph URL for the given chain ID.
  */
 function getSubgraphUrlForChainId(chainId) {
-    switch (chainId) {
-        case 5:
-            return 'https://api.thegraph.com/subgraphs/name/00labs/huma-goerli';
-        case 137:
-            return 'https://api.thegraph.com/subgraphs/name/00labs/huma-polygon';
-        case 80001:
-            return 'https://api.thegraph.com/subgraphs/name/00labs/huma-mumbai';
-        default:
-            return '';
-    }
+    var _a, _b;
+    return (_b = (_a = PoolSubgraphMap[chainId]) === null || _a === void 0 ? void 0 : _a.subgraph) !== null && _b !== void 0 ? _b : '';
 }
 /**
  * Returns the credit events for a given user.
@@ -79,6 +71,68 @@ function getLastFactorizedAmountFromPool(userAddress, chainId, poolName, poolTyp
         CreditEvent.DrawdownMadeWithReceivable,
     ]).then((events) => Number(events[0].amount));
 }
+/**
+ * Returns the paginated real world receivables' info.
+ *
+ * @memberof SubgraphService
+ * @param {string} userAddress - The address of the user.
+ * @param {number} chainId - The ID of the chain.
+ * @param {POOL_NAME} poolName - The name of the pool.
+ * @param {POOL_TYPE} poolType - The type of the pool.
+ * @param {Pagination} pagination - The pagination option.
+ * @returns {Promise<RealWorldReceivableInfoBase>} The paginated real world receivables' info.
+ */
+function getRWReceivableInfo(userAddress, chainId, poolName, poolType, pagination = {
+    first: null,
+    skip: null,
+    orderBy: 'tokenId',
+    orderDirection: 'desc',
+}) {
+    var _a, _b, _c, _d;
+    const url = (_a = PoolSubgraphMap[chainId]) === null || _a === void 0 ? void 0 : _a.receivablesSubgraph;
+    if (!url) {
+        return Promise.resolve([]);
+    }
+    const poolAddress = (_d = (_c = (_b = PoolContractMap[chainId]) === null || _b === void 0 ? void 0 : _b[poolType]) === null || _c === void 0 ? void 0 : _c[poolName]) === null || _d === void 0 ? void 0 : _d.pool;
+    const RWReceivablesQuery = `
+  query {
+    rwreceivables(
+      where: {
+        owner: "${userAddress}",
+        pool: "${poolAddress}",
+      }
+      first: ${pagination.first}
+      skip: ${pagination.skip}
+      orderBy: "${pagination.orderBy}"
+      orderDirection: "${pagination.orderDirection}"
+    ) {
+      id
+      tokenId
+      receivableAmount
+      paidAmount
+      owner
+      pool
+      maturityDate
+      currencyCode
+      tokenUri
+      status
+    }
+  }
+`;
+    return requestPost(url, JSON.stringify({ query: RWReceivablesQuery }), {
+        withCredentials: false,
+    }).then((res) => {
+        if (res.errors) {
+            console.error(res.errors);
+            return [];
+        }
+        return res.data.rwreceivables.map((item) => {
+            item.poolAddress = item.pool;
+            item.tokenURI = item.tokenUri;
+            return item;
+        });
+    });
+}
 /**
  * An object that contains functions to interact with Huma's Subgraph storage.
  * @namespace SubgraphService
@@ -87,5 +141,6 @@ export const SubgraphService = {
     getSubgraphUrlForChainId,
     getCreditEventsForUser,
     getLastFactorizedAmountFromPool,
+    getRWReceivableInfo,
 };
 //# sourceMappingURL=SubgraphService.js.map

package/dist/services/SubgraphService.js.map

@@ -1 +1 @@
-{"version":3,"file":"SubgraphService.js","sourceRoot":"","sources":["../../src/services/SubgraphService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EAGf,WAAW,GACZ,MAAM,sBAAsB,CAAA;AAE7B;;;;;;GAMG;AACH,SAAS,wBAAwB,CAAC,OAAe;IAC/C,QAAQ,OAAO,EAAE;QACf,KAAK,CAAC;YACJ,OAAO,4DAA4D,CAAA;QACrE,KAAK,GAAG;YACN,OAAO,6DAA6D,CAAA;QACtE,KAAK,KAAK;YACR,OAAO,4DAA4D,CAAA;QACrE;YACE,OAAO,EAAE,CAAA;KACZ;AACH,CAAC;AAcD;;;;;;;;;;GAUG;AACH,SAAS,sBAAsB,CAC7B,WAAmB,EACnB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,KAAe;;IAEf,MAAM,GAAG,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAA;IAC7C,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;KAC3B;IAED,MAAM,WAAW,GAAG,MAAA,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC,0CAAE,IAAI,CAAA;IAE1E,MAAM,KAAK,GAAG;;;;oBAII,WAAW;mBACZ,WAAW;uBACP,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;;;;;;;;;;;;GAYnC,CAAA;IAED,8DAA8D;IAC9D,OAAO,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAQ,EAAE,EAAE;QACnE,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACzB,OAAO,EAAE,CAAA;SACV;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,YAAY,CAAA;IAC9B,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,+BAA+B,CACtC,WAAmB,EACnB,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,OAAO,sBAAsB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE;QACtE,WAAW,CAAC,0BAA0B;KACvC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,wBAAwB;IACxB,sBAAsB;IACtB,+BAA+B;CAChC,CAAA"}
+{"version":3,"file":"SubgraphService.js","sourceRoot":"","sources":["../../src/services/SubgraphService.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,eAAe,EAGf,WAAW,EACX,eAAe,GAEhB,MAAM,sBAAsB,CAAA;AAyB7B;;;;;;GAMG;AACH,SAAS,wBAAwB,CAAC,OAAe;;IAC/C,OAAO,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAE,QAAQ,mCAAI,EAAE,CAAA;AACjD,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,sBAAsB,CAC7B,WAAmB,EACnB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,KAAe;;IAEf,MAAM,GAAG,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAA;IAC7C,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;KAC3B;IAED,MAAM,WAAW,GAAG,MAAA,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC,0CAAE,IAAI,CAAA;IAE1E,MAAM,KAAK,GAAG;;;;oBAII,WAAW;mBACZ,WAAW;uBACP,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;;;;;;;;;;;;GAYnC,CAAA;IAED,8DAA8D;IAC9D,OAAO,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAQ,EAAE,EAAE;QACnE,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACzB,OAAO,EAAE,CAAA;SACV;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,YAAY,CAAA;IAC9B,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,+BAA+B,CACtC,WAAmB,EACnB,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,OAAO,sBAAsB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE;QACtE,WAAW,CAAC,0BAA0B;KACvC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,mBAAmB,CAC1B,WAAmB,EACnB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAAyB;IACvB,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,OAAO,EAAE,SAAS;IAClB,cAAc,EAAE,MAAM;CACvB;;IAED,MAAM,GAAG,GAAG,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAE,mBAAmB,CAAA;IACzD,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;KAC3B;IAED,MAAM,WAAW,GAAG,MAAA,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC,0CAAE,IAAI,CAAA;IAE1E,MAAM,kBAAkB,GAAG;;;;kBAIX,WAAW;iBACZ,WAAW;;eAEb,UAAU,CAAC,KAAK;cACjB,UAAU,CAAC,IAAI;kBACX,UAAU,CAAC,OAAO;yBACX,UAAU,CAAC,cAAc;;;;;;;;;;;;;;CAcjD,CAAA;IAEC,OAAO,WAAW,CAOf,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC,EAAE;QACrD,eAAe,EAAE,KAAK;KACvB,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACzB,OAAO,EAAE,CAAA;SACV;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAA;YAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,wBAAwB;IACxB,sBAAsB;IACtB,+BAA+B;IAC/B,mBAAmB;CACpB,CAAA"}