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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/API.md +15 -0
  2. package/package.json +3 -3
package/API.md CHANGED
@@ -42,6 +42,8 @@ attempt to first increase the allowance of the pool.</p></dd>
42
42
  associated with the given pool name on the current chain.</p></dd>
43
43
  <dt><a href="#getAvailableBalanceForPool">getAvailableBalanceForPool(poolName, provider)</a></dt>
44
44
  <dd><p>Returns the current pool balance available for borrowing</p></dd>
45
+ <dt><a href="#getCreditRecordForPool">getCreditRecordForPool(poolName, borrower, provider)</a></dt>
46
+ <dd><p>Returns the credit record of the borrower</p></dd>
45
47
  <dt><a href="#getAvailableCreditForPool">getAvailableCreditForPool(borrower, poolName, provider)</a></dt>
46
48
  <dd><p>Returns the borrower's remaining credit they can use for borrowing. Note that this might not be
47
49
  currently available for borrowing as the credit limit might exceed the available pool balance. Use
@@ -780,6 +782,19 @@ associated with the given pool name on the current chain.</p>
780
782
  | poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to get the contract instance for.</p> |
781
783
  | provider | <code>JsonRpcProvider</code> \| <code>Web3Provider</code> | <p>The provider instance to use for reading from the contract.</p> |
782
784
 
785
+ <a name="getCreditRecordForPool"></a>
786
+
787
+ ## getCreditRecordForPool(poolName, borrower, provider)
788
+ <p>Returns the credit record of the borrower</p>
789
+
790
+ **Kind**: global function
791
+
792
+ | Param | Type | Description |
793
+ | --- | --- | --- |
794
+ | poolName | <code>POOL\_NAME</code> | <p>The name of the credit pool to get the contract instance for.</p> |
795
+ | borrower | <code>string</code> | <p>The address of the borrower to check the credit record for</p> |
796
+ | provider | <code>JsonRpcProvider</code> \| <code>Web3Provider</code> | <p>The provider instance to use for reading from the contract.</p> |
797
+
783
798
  <a name="getAvailableCreditForPool"></a>
784
799
 
785
800
  ## getAvailableCreditForPool(borrower, poolName, provider)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@huma-finance/sdk",
3
- "version": "0.0.54-beta.423+f865dd7",
3
+ "version": "0.0.54",
4
4
  "types": "./dist/index.d.ts",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/index.js",
@@ -28,7 +28,7 @@
28
28
  "@ethersproject/constants": "^5.7.0",
29
29
  "@ethersproject/contracts": "^5.7.0",
30
30
  "@ethersproject/providers": "^5.6.0",
31
- "@huma-finance/shared": "^0.0.54-beta.423+f865dd7",
31
+ "@huma-finance/shared": "^0.0.54",
32
32
  "axios": "^1.4.0",
33
33
  "bignumber.js": "^9.1.1",
34
34
  "ethers": "^5.7.2",
@@ -109,5 +109,5 @@
109
109
  "optionalDependencies": {
110
110
  "encoding": "^0.1.13"
111
111
  },
112
- "gitHead": "f865dd730cde52be78d7f37c45357ff4aa2e6a3a"
112
+ "gitHead": "5954f428dbcc7c89e34a21aa3b3af2b5eea8e159"
113
113
  }