@huma-finance/sdk 0.0.53 → 0.0.54-beta.423

package/dist/cjs/helpers/v2/CreditContractHelper.d.ts

@@ -1,5 +1,5 @@
 import { JsonRpcProvider, Web3Provider } from '@ethersproject/providers';
-import { POOL_NAME } from '@huma-finance/shared';
+import { CreditRecordStructOutput, POOL_NAME } from '@huma-finance/shared';
 import { ethers } from 'ethers';
 /**
  * Returns the current pool balance available for borrowing
@@ -8,6 +8,14 @@ import { ethers } from 'ethers';
  * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
  */
 export declare function getAvailableBalanceForPool(poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<ethers.BigNumber>;
+/**
+ * Returns the credit record of the borrower
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {string} borrower - The address of the borrower to check the credit record for
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export declare function getCreditRecordForPool(poolName: POOL_NAME, borrower: string, provider: JsonRpcProvider | Web3Provider): Promise<CreditRecordStructOutput>;
 /**
  * Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
  * currently available for borrowing as the credit limit might exceed the available pool balance. Use

package/dist/cjs/helpers/v2/CreditContractHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAvailableCreditForPool = exports.getAvailableBalanceForPool = void 0;
+exports.getAvailableCreditForPool = exports.getCreditRecordForPool = exports.getAvailableBalanceForPool = void 0;
 const shared_1 = require("@huma-finance/shared");
 /**
  * Returns the current pool balance available for borrowing
@@ -16,6 +16,21 @@ async function getAvailableBalanceForPool(poolName, provider) {
     return safeContract.getAvailableBalanceForPool();
 }
 exports.getAvailableBalanceForPool = getAvailableBalanceForPool;
+/**
+ * Returns the credit record of the borrower
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {string} borrower - The address of the borrower to check the credit record for
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+async function getCreditRecordForPool(poolName, borrower, provider) {
+    const creditRecord = await (0, shared_1.getCreditRecordV2)(poolName, borrower, provider);
+    if (!creditRecord) {
+        throw new Error('Could not find credit record for pool');
+    }
+    return creditRecord;
+}
+exports.getCreditRecordForPool = getCreditRecordForPool;
 /**
  * Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
  * currently available for borrowing as the credit limit might exceed the available pool balance. Use

package/dist/cjs/helpers/v2/CreditContractHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../../src/helpers/v2/CreditContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAG7B;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,8BAAqB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEpE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAC,0BAA0B,EAAE,CAAA;AAClD,CAAC;AAXD,gEAWC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;AACrE,CAAC;AAbD,8DAaC"}
+{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../../src/helpers/v2/CreditContractHelper.ts"],"names":[],"mappings":";;;AACA,iDAM6B;AAG7B;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,8BAAqB,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEpE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAC,0BAA0B,EAAE,CAAA;AAClD,CAAC;AAXD,gEAWC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAC1C,QAAmB,EACnB,QAAgB,EAChB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AAZD,wDAYC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAiB,EAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;AACrE,CAAC;AAbD,8DAaC"}

package/dist/helpers/v2/CreditContractHelper.d.ts

@@ -1,5 +1,5 @@
 import { JsonRpcProvider, Web3Provider } from '@ethersproject/providers';
-import { POOL_NAME } from '@huma-finance/shared';
+import { CreditRecordStructOutput, POOL_NAME } from '@huma-finance/shared';
 import { ethers } from 'ethers';
 /**
  * Returns the current pool balance available for borrowing
@@ -8,6 +8,14 @@ import { ethers } from 'ethers';
  * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
  */
 export declare function getAvailableBalanceForPool(poolName: POOL_NAME, provider: JsonRpcProvider | Web3Provider): Promise<ethers.BigNumber>;
+/**
+ * Returns the credit record of the borrower
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {string} borrower - The address of the borrower to check the credit record for
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export declare function getCreditRecordForPool(poolName: POOL_NAME, borrower: string, provider: JsonRpcProvider | Web3Provider): Promise<CreditRecordStructOutput>;
 /**
  * Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
  * currently available for borrowing as the credit limit might exceed the available pool balance. Use

package/dist/helpers/v2/CreditContractHelper.js

@@ -12,6 +12,20 @@ export async function getAvailableBalanceForPool(poolName, provider) {
     }
     return safeContract.getAvailableBalanceForPool();
 }
+/**
+ * Returns the credit record of the borrower
+ *
+ * @param {POOL_NAME} poolName - The name of the credit pool to get the contract instance for.
+ * @param {string} borrower - The address of the borrower to check the credit record for
+ * @param {JsonRpcProvider | Web3Provider} provider The provider instance to use for reading from the contract.
+ */
+export async function getCreditRecordForPool(poolName, borrower, provider) {
+    const creditRecord = await getCreditRecordV2(poolName, borrower, provider);
+    if (!creditRecord) {
+        throw new Error('Could not find credit record for pool');
+    }
+    return creditRecord;
+}
 /**
  * Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
  * currently available for borrowing as the credit limit might exceed the available pool balance. Use

package/dist/helpers/v2/CreditContractHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/v2/CreditContractHelper.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GAEtB,MAAM,sBAAsB,CAAA;AAG7B;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEpE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAC,0BAA0B,EAAE,CAAA;AAClD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;AACrE,CAAC"}
+{"version":3,"file":"CreditContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/v2/CreditContractHelper.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,GAGtB,MAAM,sBAAsB,CAAA;AAG7B;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEpE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAC,0BAA0B,EAAE,CAAA;AAClD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,QAAmB,EACnB,QAAgB,EAChB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;KACzD;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,QAAgB,EAChB,QAAmB,EACnB,QAAwC;IAExC,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAE1E,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;KACjE;IAED,OAAO,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;AACrE,CAAC"}