@huma-finance/sdk 0.0.37 → 0.0.38-beta.20

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 (159) hide show
  1. package/API.md +633 -650
  2. package/LICENSE +660 -660
  3. package/README.md +37 -37
  4. package/getting-started.md +190 -190
  5. package/package.json +3 -3
  6. package/dist/cjs/graphql/generatedTypes.d.ts +0 -40
  7. package/dist/cjs/graphql/generatedTypes.js +0 -9
  8. package/dist/cjs/graphql/generatedTypes.js.map +0 -1
  9. package/dist/cjs/graphql/index.d.ts +0 -1
  10. package/dist/cjs/graphql/index.js +0 -5
  11. package/dist/cjs/graphql/index.js.map +0 -1
  12. package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.d.ts +0 -10
  13. package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js +0 -22
  14. package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js.map +0 -1
  15. package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.d.ts +0 -10
  16. package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js +0 -22
  17. package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js.map +0 -1
  18. package/dist/cjs/helpers/PoolContractHelper.d.ts +0 -119
  19. package/dist/cjs/helpers/PoolContractHelper.js +0 -144
  20. package/dist/cjs/helpers/PoolContractHelper.js.map +0 -1
  21. package/dist/cjs/helpers/RealWorldReceivableContractHelper.d.ts +0 -10
  22. package/dist/cjs/helpers/RealWorldReceivableContractHelper.js +0 -22
  23. package/dist/cjs/helpers/RealWorldReceivableContractHelper.js.map +0 -1
  24. package/dist/cjs/helpers/index.d.ts +0 -3
  25. package/dist/cjs/helpers/index.js +0 -7
  26. package/dist/cjs/helpers/index.js.map +0 -1
  27. package/dist/cjs/hooks/index.d.ts +0 -4
  28. package/dist/cjs/hooks/index.js +0 -8
  29. package/dist/cjs/hooks/index.js.map +0 -1
  30. package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.d.ts +0 -10
  31. package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js +0 -20
  32. package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js.map +0 -1
  33. package/dist/cjs/hooks/useContract.d.ts +0 -13
  34. package/dist/cjs/hooks/useContract.js +0 -31
  35. package/dist/cjs/hooks/useContract.js.map +0 -1
  36. package/dist/cjs/hooks/useERC20TransferableReceivableContract.d.ts +0 -12
  37. package/dist/cjs/hooks/useERC20TransferableReceivableContract.js +0 -21
  38. package/dist/cjs/hooks/useERC20TransferableReceivableContract.js.map +0 -1
  39. package/dist/cjs/hooks/usePoolContract.d.ts +0 -60
  40. package/dist/cjs/hooks/usePoolContract.js +0 -54
  41. package/dist/cjs/hooks/usePoolContract.js.map +0 -1
  42. package/dist/cjs/hooks/useRealWorldReceivableContract.d.ts +0 -10
  43. package/dist/cjs/hooks/useRealWorldReceivableContract.js +0 -20
  44. package/dist/cjs/hooks/useRealWorldReceivableContract.js.map +0 -1
  45. package/dist/cjs/hooks/useReceivableFactoringPoolContract.d.ts +0 -10
  46. package/dist/cjs/hooks/useReceivableFactoringPoolContract.js +0 -17
  47. package/dist/cjs/hooks/useReceivableFactoringPoolContract.js.map +0 -1
  48. package/dist/cjs/index.d.ts +0 -4
  49. package/dist/cjs/index.js +0 -8
  50. package/dist/cjs/index.js.map +0 -1
  51. package/dist/cjs/services/ARWeaveService.d.ts +0 -106
  52. package/dist/cjs/services/ARWeaveService.js +0 -191
  53. package/dist/cjs/services/ARWeaveService.js.map +0 -1
  54. package/dist/cjs/services/EAService.d.ts +0 -20
  55. package/dist/cjs/services/EAService.js +0 -34
  56. package/dist/cjs/services/EAService.js.map +0 -1
  57. package/dist/cjs/services/ReceivableService.d.ts +0 -104
  58. package/dist/cjs/services/ReceivableService.js +0 -309
  59. package/dist/cjs/services/ReceivableService.js.map +0 -1
  60. package/dist/cjs/services/SubgraphService.d.ts +0 -53
  61. package/dist/cjs/services/SubgraphService.js +0 -94
  62. package/dist/cjs/services/SubgraphService.js.map +0 -1
  63. package/dist/cjs/services/index.d.ts +0 -4
  64. package/dist/cjs/services/index.js +0 -8
  65. package/dist/cjs/services/index.js.map +0 -1
  66. package/dist/cjs/utils/chain.d.ts +0 -15
  67. package/dist/cjs/utils/chain.js +0 -38
  68. package/dist/cjs/utils/chain.js.map +0 -1
  69. package/dist/cjs/utils/index.d.ts +0 -4
  70. package/dist/cjs/utils/index.js +0 -8
  71. package/dist/cjs/utils/index.js.map +0 -1
  72. package/dist/cjs/utils/maticGasStation.d.ts +0 -3
  73. package/dist/cjs/utils/maticGasStation.js +0 -39
  74. package/dist/cjs/utils/maticGasStation.js.map +0 -1
  75. package/dist/cjs/utils/poolInfo.d.ts +0 -8
  76. package/dist/cjs/utils/poolInfo.js +0 -13
  77. package/dist/cjs/utils/poolInfo.js.map +0 -1
  78. package/dist/cjs/utils/web3.d.ts +0 -5
  79. package/dist/cjs/utils/web3.js +0 -34
  80. package/dist/cjs/utils/web3.js.map +0 -1
  81. package/dist/graphql/generatedTypes.d.ts +0 -40
  82. package/dist/graphql/generatedTypes.js +0 -5
  83. package/dist/graphql/generatedTypes.js.map +0 -1
  84. package/dist/graphql/index.d.ts +0 -1
  85. package/dist/graphql/index.js +0 -2
  86. package/dist/graphql/index.js.map +0 -1
  87. package/dist/helpers/BaseCreditPoolReceivableContractHelper.d.ts +0 -10
  88. package/dist/helpers/BaseCreditPoolReceivableContractHelper.js +0 -18
  89. package/dist/helpers/BaseCreditPoolReceivableContractHelper.js.map +0 -1
  90. package/dist/helpers/ERC20TransferableReceivableContractHelper.d.ts +0 -10
  91. package/dist/helpers/ERC20TransferableReceivableContractHelper.js +0 -18
  92. package/dist/helpers/ERC20TransferableReceivableContractHelper.js.map +0 -1
  93. package/dist/helpers/PoolContractHelper.d.ts +0 -119
  94. package/dist/helpers/PoolContractHelper.js +0 -135
  95. package/dist/helpers/PoolContractHelper.js.map +0 -1
  96. package/dist/helpers/RealWorldReceivableContractHelper.d.ts +0 -10
  97. package/dist/helpers/RealWorldReceivableContractHelper.js +0 -18
  98. package/dist/helpers/RealWorldReceivableContractHelper.js.map +0 -1
  99. package/dist/helpers/index.d.ts +0 -3
  100. package/dist/helpers/index.js +0 -4
  101. package/dist/helpers/index.js.map +0 -1
  102. package/dist/hooks/index.d.ts +0 -4
  103. package/dist/hooks/index.js +0 -5
  104. package/dist/hooks/index.js.map +0 -1
  105. package/dist/hooks/useBaseCreditPoolReceivableContract.d.ts +0 -10
  106. package/dist/hooks/useBaseCreditPoolReceivableContract.js +0 -16
  107. package/dist/hooks/useBaseCreditPoolReceivableContract.js.map +0 -1
  108. package/dist/hooks/useContract.d.ts +0 -13
  109. package/dist/hooks/useContract.js +0 -27
  110. package/dist/hooks/useContract.js.map +0 -1
  111. package/dist/hooks/useERC20TransferableReceivableContract.d.ts +0 -12
  112. package/dist/hooks/useERC20TransferableReceivableContract.js +0 -17
  113. package/dist/hooks/useERC20TransferableReceivableContract.js.map +0 -1
  114. package/dist/hooks/usePool.d.ts +0 -0
  115. package/dist/hooks/usePool.js +0 -2
  116. package/dist/hooks/usePool.js.map +0 -1
  117. package/dist/hooks/usePoolContract.d.ts +0 -60
  118. package/dist/hooks/usePoolContract.js +0 -49
  119. package/dist/hooks/usePoolContract.js.map +0 -1
  120. package/dist/hooks/useRealWorldReceivableContract.d.ts +0 -10
  121. package/dist/hooks/useRealWorldReceivableContract.js +0 -16
  122. package/dist/hooks/useRealWorldReceivableContract.js.map +0 -1
  123. package/dist/hooks/useReceivableFactoringPoolContract.d.ts +0 -10
  124. package/dist/hooks/useReceivableFactoringPoolContract.js +0 -13
  125. package/dist/hooks/useReceivableFactoringPoolContract.js.map +0 -1
  126. package/dist/index.d.ts +0 -4
  127. package/dist/index.js +0 -5
  128. package/dist/index.js.map +0 -1
  129. package/dist/services/ARWeaveService.d.ts +0 -106
  130. package/dist/services/ARWeaveService.js +0 -186
  131. package/dist/services/ARWeaveService.js.map +0 -1
  132. package/dist/services/EAService.d.ts +0 -20
  133. package/dist/services/EAService.js +0 -31
  134. package/dist/services/EAService.js.map +0 -1
  135. package/dist/services/ReceivableService.d.ts +0 -104
  136. package/dist/services/ReceivableService.js +0 -306
  137. package/dist/services/ReceivableService.js.map +0 -1
  138. package/dist/services/SubgraphService.d.ts +0 -53
  139. package/dist/services/SubgraphService.js +0 -91
  140. package/dist/services/SubgraphService.js.map +0 -1
  141. package/dist/services/index.d.ts +0 -4
  142. package/dist/services/index.js +0 -5
  143. package/dist/services/index.js.map +0 -1
  144. package/dist/tsconfig.cjs.tsbuildinfo +0 -1
  145. package/dist/utils/chain.d.ts +0 -15
  146. package/dist/utils/chain.js +0 -32
  147. package/dist/utils/chain.js.map +0 -1
  148. package/dist/utils/index.d.ts +0 -4
  149. package/dist/utils/index.js +0 -5
  150. package/dist/utils/index.js.map +0 -1
  151. package/dist/utils/maticGasStation.d.ts +0 -3
  152. package/dist/utils/maticGasStation.js +0 -34
  153. package/dist/utils/maticGasStation.js.map +0 -1
  154. package/dist/utils/poolInfo.d.ts +0 -8
  155. package/dist/utils/poolInfo.js +0 -9
  156. package/dist/utils/poolInfo.js.map +0 -1
  157. package/dist/utils/web3.d.ts +0 -5
  158. package/dist/utils/web3.js +0 -28
  159. package/dist/utils/web3.js.map +0 -1
@@ -1,119 +0,0 @@
1
- import { BigNumber } from '@ethersproject/bignumber';
2
- import { BigNumberish, Contract, Overrides, ethers } from 'ethers';
3
- import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
4
- import { TransactionResponse } from '@ethersproject/providers';
5
- /**
6
- * Returns an ethers contract instance for a Huma pool contract
7
- *
8
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
9
- * @param {number} chainId The chain id where the contract instance exists
10
- * @param {POOL_NAME} poolName The name of the pool contract to get.
11
- * @param {POOL_TYPE} poolType The type of the pool contract to get.
12
- * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
13
- */
14
- export declare function getPoolContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Contract | null;
15
- /**
16
- * Return type of getCreditRecord
17
- *
18
- * @memberof getCreditRecord
19
- * @typedef {Object} CreditRecord
20
- * @property {BigNumber} unbilledPrincipal - The amount of principal not included in the bill
21
- * @property {BigNumber} dueDate - Unix timestamp due date of the next payment
22
- * @property {BigNumber} correction - the adjustment of interest over or under-counted because of drawdown
23
- * or principal payment in the middle of a billing period
24
- * @property {BigNumber} totalDue - The due amount of the next payment
25
- * @property {BigNumber} feesAndInterestDue - Interest and fees due for the next payment
26
- * @property {number} missedPeriods - # of consecutive missed payments, for default processing
27
- * @property {number} remainingPeriods - # of payment periods until the maturity of the credit line
28
- * @property {number} state - status of the credit line.
29
- * For more info: https://github.com/00labs/huma-contracts/blob/b075a8f957de281e0885e37dbd72a422b6a54a38/contracts/libraries/BaseStructs.sol#L49
30
- */
31
- export type CreditRecord = [
32
- BigNumber,
33
- BigNumber,
34
- BigNumber,
35
- BigNumber,
36
- BigNumber,
37
- number,
38
- number,
39
- number
40
- ] & {
41
- unbilledPrincipal: BigNumber;
42
- dueDate: BigNumber;
43
- correction: BigNumber;
44
- totalDue: BigNumber;
45
- feesAndInterestDue: BigNumber;
46
- missedPeriods: number;
47
- remainingPeriods: number;
48
- state: number;
49
- };
50
- /**
51
- * Gets the credit record of a wallet in a Huma pool. Denominated in the ERC20 tokens of the pool.
52
- *
53
- * @namespace getCreditRecord
54
- * @async
55
- * @function
56
- * @param {string} address - The address to lookup.
57
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
58
- * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
59
- * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
60
- * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
61
- * @returns {Promise<CreditRecord>} - A Promise of the transaction response.
62
- */
63
- export declare function getCreditRecord(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<CreditRecord>;
64
- /**
65
- * Gets the total due for a Huma pool of the given wallet. Denominated in the ERC20 tokens of the pool.
66
- *
67
- * @async
68
- * @function
69
- * @param {string} address - The address to lookup.
70
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
71
- * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
72
- * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
73
- * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
74
- * @returns {Promise<BigNumber>} - A Promise of the transaction response.
75
- */
76
- export declare function getTotalDue(address: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<BigNumber>;
77
- /**
78
- * Calls drawdown on a Huma pool contract
79
- *
80
- * @async
81
- * @function
82
- * @param {ethers.Signer} signer - The signer used to send the transaction.
83
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
84
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
85
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
86
- * @param {BigNumberish} drawdownAmount - The amount of tokens to withdraw, denominated in the ERC20 tokens of the pool.
87
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
88
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
89
- */
90
- export declare function drawdownFromPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, drawdownAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
91
- /**
92
- * Calls makePayment on a Huma pool contract. If the pool does not have sufficient allowance to complete the operation,
93
- * attempt to first increase the allowance of the pool.
94
- *
95
- * @async
96
- * @function
97
- * @param {ethers.Signer} signer - The signer used to send the transaction.
98
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
99
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
100
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
101
- * @param {BigNumberish} paymentAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
102
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
103
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
104
- */
105
- export declare function makePaymentToPool(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, paymentAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
106
- /**
107
- * Approves an allowance for a Huma pool contract, which is required to do certain actions (e.g. makePayment)
108
- *
109
- * @async
110
- * @function
111
- * @param {ethers.Signer} signer - The signer used to send the transaction.
112
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
113
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
114
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
115
- * @param {BigNumberish} allowanceAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
116
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
117
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
118
- */
119
- export declare function approvePoolAllowance(signer: ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, allowanceAmount: BigNumberish, gasOpts?: Overrides): Promise<TransactionResponse>;
@@ -1,144 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.approvePoolAllowance = exports.makePaymentToPool = exports.drawdownFromPool = exports.getTotalDue = exports.getCreditRecord = exports.getPoolContract = void 0;
4
- const utils_1 = require("../utils");
5
- /**
6
- * Returns an ethers contract instance for a Huma pool contract
7
- *
8
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
9
- * @param {number} chainId The chain id where the contract instance exists
10
- * @param {POOL_NAME} poolName The name of the pool contract to get.
11
- * @param {POOL_TYPE} poolType The type of the pool contract to get.
12
- * @returns {Contract | null} A contract instance for the Pool contract or null if it could not be found.
13
- */
14
- function getPoolContract(signerOrProvider, chainId, poolName, poolType) {
15
- const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
16
- if (!poolInfo)
17
- return null;
18
- return (0, utils_1.getContract)(poolInfo.pool, poolInfo.poolAbi, signerOrProvider);
19
- }
20
- exports.getPoolContract = getPoolContract;
21
- /**
22
- * Gets the credit record of a wallet in a Huma pool. Denominated in the ERC20 tokens of the pool.
23
- *
24
- * @namespace getCreditRecord
25
- * @async
26
- * @function
27
- * @param {string} address - The address to lookup.
28
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
29
- * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
30
- * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
31
- * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
32
- * @returns {Promise<CreditRecord>} - A Promise of the transaction response.
33
- */
34
- async function getCreditRecord(address, signerOrProvider, chainId, poolName, poolType) {
35
- const poolContract = getPoolContract(signerOrProvider, chainId, poolName, poolType);
36
- if (!poolContract) {
37
- throw new Error('Could not find pool contract');
38
- }
39
- return poolContract.creditRecordMapping(address);
40
- }
41
- exports.getCreditRecord = getCreditRecord;
42
- /**
43
- * Gets the total due for a Huma pool of the given wallet. Denominated in the ERC20 tokens of the pool.
44
- *
45
- * @async
46
- * @function
47
- * @param {string} address - The address to lookup.
48
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to read data.
49
- * @param {number} chainId - The chain ID of the pool. Used to lookup the pool address.
50
- * @param {POOL_NAME} poolName - The name of the credit pool. Used to lookup the pool address.
51
- * @param {POOL_TYPE} poolType - The type of the credit pool. Used to lookup the pool address.
52
- * @returns {Promise<BigNumber>} - A Promise of the transaction response.
53
- */
54
- async function getTotalDue(address, signerOrProvider, chainId, poolName, poolType) {
55
- const creditRecord = await getCreditRecord(address, signerOrProvider, chainId, poolName, poolType);
56
- return creditRecord.totalDue;
57
- }
58
- exports.getTotalDue = getTotalDue;
59
- /**
60
- * Calls drawdown on a Huma pool contract
61
- *
62
- * @async
63
- * @function
64
- * @param {ethers.Signer} signer - The signer used to send the transaction.
65
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
66
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
67
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
68
- * @param {BigNumberish} drawdownAmount - The amount of tokens to withdraw, denominated in the ERC20 tokens of the pool.
69
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
70
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
71
- */
72
- async function drawdownFromPool(signer, chainId, poolName, poolType, drawdownAmount, gasOpts = {}) {
73
- const poolContract = getPoolContract(signer, chainId, poolName, poolType);
74
- if (!poolContract) {
75
- throw new Error('Could not find pool contract');
76
- }
77
- gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
78
- // TODO: Generate typechain for pool contract
79
- return poolContract.drawdown(drawdownAmount, gasOpts);
80
- }
81
- exports.drawdownFromPool = drawdownFromPool;
82
- /**
83
- * Calls makePayment on a Huma pool contract. If the pool does not have sufficient allowance to complete the operation,
84
- * attempt to first increase the allowance of the pool.
85
- *
86
- * @async
87
- * @function
88
- * @param {ethers.Signer} signer - The signer used to send the transaction.
89
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
90
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
91
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
92
- * @param {BigNumberish} paymentAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
93
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
94
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
95
- */
96
- async function makePaymentToPool(signer, chainId, poolName, poolType, paymentAmount, gasOpts = {}) {
97
- const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
98
- if (!(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address)) {
99
- throw new Error('Could not find pool underlying token address');
100
- }
101
- const poolTokenContract = (0, utils_1.getERC20Contract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address, signer);
102
- const poolContract = getPoolContract(signer, chainId, poolName, poolType);
103
- if (!poolContract) {
104
- throw new Error('Could not find pool contract');
105
- }
106
- gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
107
- const allowance = await poolTokenContract.allowance(await signer.getAddress(), poolContract.address);
108
- if (allowance.lt(paymentAmount)) {
109
- const approvalTx = await poolTokenContract.approve(poolContract.address, paymentAmount, gasOpts);
110
- // Wait for 5 block confirmations since this is required for makePayment
111
- await approvalTx.wait(5);
112
- }
113
- // TODO: Generate typechain for pool contract
114
- return poolContract.makePayment(await signer.getAddress(), paymentAmount, gasOpts);
115
- }
116
- exports.makePaymentToPool = makePaymentToPool;
117
- /**
118
- * Approves an allowance for a Huma pool contract, which is required to do certain actions (e.g. makePayment)
119
- *
120
- * @async
121
- * @function
122
- * @param {ethers.Signer} signer - The signer used to send the transaction.
123
- * @param {number} chainId - The chain ID of the pool to call drawdown on. Used to lookup the pool address.
124
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
125
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
126
- * @param {BigNumberish} allowanceAmount - The amount of tokens to payback, denominated in the ERC20 tokens of the pool.
127
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
128
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
129
- */
130
- async function approvePoolAllowance(signer, chainId, poolName, poolType, allowanceAmount, gasOpts = {}) {
131
- const poolInfo = (0, utils_1.getPoolInfo)(chainId, poolName, poolType);
132
- if (!(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address)) {
133
- throw new Error('Could not find pool underlying token address');
134
- }
135
- const poolTokenContract = (0, utils_1.getERC20Contract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolUnderlyingToken.address, signer);
136
- const poolContract = getPoolContract(signer, chainId, poolName, poolType);
137
- if (!poolContract) {
138
- throw new Error('Could not find pool contract');
139
- }
140
- gasOpts = await (0, utils_1.getDefaultGasOptions)(gasOpts, chainId);
141
- return poolTokenContract.approve(poolContract.address, allowanceAmount, gasOpts);
142
- }
143
- exports.approvePoolAllowance = approvePoolAllowance;
144
- //# sourceMappingURL=PoolContractHelper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PoolContractHelper.js","sourceRoot":"","sources":["../../../src/helpers/PoolContractHelper.ts"],"names":[],"mappings":";;;AAKA,oCAKiB;AAEjB;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzD,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAE1B,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAXD,0CAWC;AAsCD;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,eAAe,CAClC,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;AAClD,CAAC;AAnBD,0CAmBC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAe,EACf,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,MAAM,eAAe,CACxC,OAAO,EACP,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IAED,OAAO,YAAY,CAAC,QAAQ,CAAA;AAC9B,CAAC;AAhBD,kCAgBC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,gBAAgB,CACpC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,cAA4B,EAC5B,UAAqB,EAAE;IAEvB,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,6CAA6C;IAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AACvD,CAAC;AAlBD,4CAkBC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,aAA2B,EAC3B,UAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,CAAA,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IACD,MAAM,iBAAiB,GAAG,IAAA,wBAAgB,EACxC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,EACrC,MAAM,CACP,CAAA;IACD,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACtD,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,SAAS,CACjD,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,YAAY,CAAC,OAAO,CACrB,CAAA;IACD,IAAI,SAAS,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE;QAC/B,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAChD,YAAY,CAAC,OAAO,EACpB,aAAa,EACb,OAAO,CACR,CAAA;QACD,wEAAwE;QACxE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KACzB;IAED,6CAA6C;IAC7C,OAAO,YAAY,CAAC,WAAW,CAC7B,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AA3CD,8CA2CC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAAqB,EACrB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,eAA6B,EAC7B,UAAqB,EAAE;IAEvB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,CAAA,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IACD,MAAM,iBAAiB,GAAG,IAAA,wBAAgB,EACxC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,CAAC,OAAO,EACrC,MAAM,CACP,CAAA;IACD,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAEzE,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,OAAO,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,iBAAiB,CAAC,OAAO,CAC9B,YAAY,CAAC,OAAO,EACpB,eAAe,EACf,OAAO,CACR,CAAA;AACH,CAAC;AA7BD,oDA6BC"}
@@ -1,10 +0,0 @@
1
- import { Contract, ethers } from 'ethers';
2
- /**
3
- * Returns an ethers contract instance for the RealWorldReceivable contract
4
- * associated with the given pool name on the current chain.
5
- *
6
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
7
- * @param {number} chainId The chain id where the contract instance exists
8
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
9
- */
10
- export declare function getRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;
@@ -1,22 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getRealWorldReceivableContract = void 0;
4
- const shared_1 = require("@huma-finance/shared");
5
- const utils_1 = require("../utils");
6
- /**
7
- * Returns an ethers contract instance for the RealWorldReceivable contract
8
- * associated with the given pool name on the current chain.
9
- *
10
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
11
- * @param {number} chainId The chain id where the contract instance exists
12
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
13
- */
14
- function getRealWorldReceivableContract(signerOrProvider, chainId) {
15
- var _a;
16
- const rwReceivableContract = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
17
- if (!rwReceivableContract)
18
- return null;
19
- return (0, utils_1.getContract)(rwReceivableContract, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
20
- }
21
- exports.getRealWorldReceivableContract = getRealWorldReceivableContract;
22
- //# sourceMappingURL=RealWorldReceivableContractHelper.js.map
@@ -1 +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,oBAAoB,GACxB,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,oBAAoB;QAAE,OAAO,IAAI,CAAA;IAEtC,OAAO,IAAA,mBAAW,EAChB,oBAAoB,EACpB,kCAAyB,EACzB,gBAAgB,CACjB,CAAA;AACH,CAAC;AAhBD,wEAgBC"}
@@ -1,3 +0,0 @@
1
- export * from './RealWorldReceivableContractHelper';
2
- export * from './ERC20TransferableReceivableContractHelper';
3
- export * from './PoolContractHelper';
@@ -1,7 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./RealWorldReceivableContractHelper"), exports);
5
- tslib_1.__exportStar(require("./ERC20TransferableReceivableContractHelper"), exports);
6
- tslib_1.__exportStar(require("./PoolContractHelper"), exports);
7
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,8EAAmD;AACnD,sFAA2D;AAC3D,+DAAoC"}
@@ -1,4 +0,0 @@
1
- export * from './useContract';
2
- export * from './useRealWorldReceivableContract';
3
- export * from './useERC20TransferableReceivableContract';
4
- export * from './usePoolContract';
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./useContract"), exports);
5
- tslib_1.__exportStar(require("./useRealWorldReceivableContract"), exports);
6
- tslib_1.__exportStar(require("./useERC20TransferableReceivableContract"), exports);
7
- tslib_1.__exportStar(require("./usePoolContract"), exports);
8
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":";;;AAAA,wDAA6B;AAC7B,2EAAgD;AAChD,mFAAwD;AACxD,4DAAiC"}
@@ -1,10 +0,0 @@
1
- import { Contract, ethers } from 'ethers';
2
- /**
3
- * A react hook that returns an ethers contract instance for the BaseCreditPoolReceivable contract
4
- * associated with the given pool name on the current chain.
5
- *
6
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
7
- * @param {number} chainId The chain id where the contract instance exists
8
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
9
- */
10
- export declare function useBaseCreditPoolReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.useBaseCreditPoolReceivableContract = void 0;
4
- const shared_1 = require("@huma-finance/shared");
5
- const useContract_1 = require("./useContract");
6
- /**
7
- * A react hook that returns an ethers contract instance for the BaseCreditPoolReceivable contract
8
- * associated with the given pool name on the current chain.
9
- *
10
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
11
- * @param {number} chainId The chain id where the contract instance exists
12
- * @returns {Contract | null} A contract instance for the BaseCreditPoolReceivable contract or null if it could not be found.
13
- */
14
- function useBaseCreditPoolReceivableContract(signerOrProvider, chainId) {
15
- var _a;
16
- const baseCreditPoolReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.BaseCreditPoolReceivable];
17
- return (0, useContract_1.useContract)(baseCreditPoolReceivable, shared_1.BASE_CREDIT_POOL_RECEIVABLE_ABI, signerOrProvider);
18
- }
19
- exports.useBaseCreditPoolReceivableContract = useBaseCreditPoolReceivableContract;
20
- //# sourceMappingURL=useBaseCreditPoolReceivableContract.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useBaseCreditPoolReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useBaseCreditPoolReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAK6B;AAE7B,+CAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,mCAAmC,CACjD,gBAA2D,EAC3D,OAAe;;IAEf,MAAM,wBAAwB,GAC5B,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,wBAAwB,CAChD,CAAA;IAEH,OAAO,IAAA,yBAAW,EAChB,wBAAwB,EACxB,wCAA+B,EAC/B,gBAAgB,CACjB,CAAA;AACH,CAAC;AAdD,kFAcC"}
@@ -1,13 +0,0 @@
1
- import { Contract } from '@ethersproject/contracts';
2
- import { ethers } from 'ethers';
3
- /**
4
- * Custom hook for creating an ethers instance of a smart contract.
5
- *
6
- * @template T - The type of the contract.
7
- * @param {string | null | undefined} address - The address of the smart contract instance.
8
- * @param {any} ABI - The ABI of the smart contract.
9
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
10
- * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
11
- * @returns {T | null} An instance of the smart contract, or null if an error occurs.
12
- */
13
- export declare function useContract<T extends Contract = Contract>(address: string | null | undefined, ABI: any, signerOrProvider: ethers.providers.Provider | ethers.Signer): T | null;
@@ -1,31 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.useContract = void 0;
4
- const react_1 = require("react");
5
- const web3_1 = require("../utils/web3");
6
- /**
7
- * Custom hook for creating an ethers instance of a smart contract.
8
- *
9
- * @template T - The type of the contract.
10
- * @param {string | null | undefined} address - The address of the smart contract instance.
11
- * @param {any} ABI - The ABI of the smart contract.
12
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider used to sign transactions or retrieve blockchain data.
13
- * Note that this signerOrProvider must be connected to the same network as the smart contract in question.
14
- * @returns {T | null} An instance of the smart contract, or null if an error occurs.
15
- */
16
- function useContract(address,
17
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
18
- ABI, signerOrProvider) {
19
- return (0, react_1.useMemo)(() => {
20
- if (!address || !ABI || !signerOrProvider)
21
- return null;
22
- try {
23
- return (0, web3_1.getContract)(address, ABI, signerOrProvider);
24
- }
25
- catch (error) {
26
- return null;
27
- }
28
- }, [address, ABI, signerOrProvider]);
29
- }
30
- exports.useContract = useContract;
31
- //# sourceMappingURL=useContract.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useContract.js","sourceRoot":"","sources":["../../../src/hooks/useContract.ts"],"names":[],"mappings":";;;AACA,iCAA+B;AAG/B,wCAA2C;AAE3C;;;;;;;;;GASG;AACH,SAAgB,WAAW,CACzB,OAAkC;AAClC,8DAA8D;AAC9D,GAAQ,EACR,gBAA2D;IAE3D,OAAO,IAAA,eAAO,EAAC,GAAG,EAAE;QAClB,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAA;QACtD,IAAI;YACF,OAAO,IAAA,kBAAW,EAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAA;SACnD;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,IAAI,CAAA;SACZ;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAM,CAAA;AAC3C,CAAC;AAdD,kCAcC"}
@@ -1,12 +0,0 @@
1
- import { Contract, ethers } from 'ethers';
2
- import { POOL_NAME } from '@huma-finance/shared';
3
- /**
4
- * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
5
- * associated with the given pool name on the current chain.
6
- *
7
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
8
- * @param {number} chainId The chain id where the contract instance exists
9
- * @param {POOL_NAME} poolName The name of the pool to get the contract for.
10
- * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
11
- */
12
- export declare function useERC20TransferableReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME): Contract | null;
@@ -1,21 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.useERC20TransferableReceivableContract = void 0;
4
- const shared_1 = require("@huma-finance/shared");
5
- const useContract_1 = require("./useContract");
6
- /**
7
- * A react hook that returns an ethers contract instance for the ERC20TransferableReceivable contract
8
- * associated with the given pool name on the current chain.
9
- *
10
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
11
- * @param {number} chainId The chain id where the contract instance exists
12
- * @param {POOL_NAME} poolName The name of the pool to get the contract for.
13
- * @returns {Contract | null} A contract instance for the ERC20TransferableReceivable contract or null if it could not be found.
14
- */
15
- function useERC20TransferableReceivableContract(signerOrProvider, chainId, poolName) {
16
- var _a, _b, _c;
17
- const TransferableReceivableAddress = (_c = (_b = (_a = shared_1.PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.POOL_TYPE.Invoice]) === null || _b === void 0 ? void 0 : _b[poolName]) === null || _c === void 0 ? void 0 : _c.assetAddress;
18
- return (0, useContract_1.useContract)(TransferableReceivableAddress, shared_1.ERC20_TRANSFERABLE_RECEIVABLE_ABI, signerOrProvider);
19
- }
20
- exports.useERC20TransferableReceivableContract = useERC20TransferableReceivableContract;
21
- //# sourceMappingURL=useERC20TransferableReceivableContract.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useERC20TransferableReceivableContract.js","sourceRoot":"","sources":["../../../src/hooks/useERC20TransferableReceivableContract.ts"],"names":[],"mappings":";;;AACA,iDAM6B;AAE7B,+CAA2C;AAE3C;;;;;;;;GAQG;AACH,SAAgB,sCAAsC,CACpD,gBAA2D,EAC3D,OAAe,EACf,QAAmB;;IAEnB,MAAM,6BAA6B,GACjC,MAAA,MAAA,MAAA,wBAAe,CAAC,OAAO,CAAC,0CAAG,kBAAS,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAE,YAAY,CAAA;IAEzE,OAAO,IAAA,yBAAW,EAChB,6BAA6B,EAC7B,0CAAiC,EACjC,gBAAgB,CACjB,CAAA;AACH,CAAC;AAbD,wFAaC"}
@@ -1,60 +0,0 @@
1
- import { BigNumber } from '@ethersproject/bignumber';
2
- import { Contract, ethers } from 'ethers';
3
- import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
4
- /**
5
- * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
6
- *
7
- * @namespace usePoolContract
8
- * @template T - The type of the contract.
9
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
10
- * @param {number} chainId The chain id where the contract instance exists
11
- * @param {POOL_NAME} poolName - The name of the pool.
12
- * @param {POOL_TYPE} poolType - The type of the pool.
13
- * @returns {T} A contract instance of the specific pool.
14
- */
15
- export declare function usePoolContract<T extends Contract>(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): T | null;
16
- /**
17
- * CreditRecordDetails type object representing the details of a credit line.
18
- *
19
- * @memberof usePoolContract
20
- * @typedef {Object} CreditRecordDetails
21
- * @property {number} aprInBps - The APR (annual percentage rate) in basis points.
22
- * @property {BigNumber} correction - adjustment of interest over or under-counted because of drawdown
23
- * or principal payment in the middle of a billing period
24
- * @property {BigNumber} creditLimit - The credit limit in the pools base currency.
25
- * @property {BigNumber} defaultAmount - The amount of the default, if any.
26
- * @property {BigNumber} dueDate - The due date of the next payment.
27
- * @property {BigNumber} feesAndInterestDue - The fees and interest due.
28
- * @property {number} intervalInDays - The interval in days between payment periods.
29
- * @property {number} missedPeriods - The number of missed periods.
30
- * @property {number} remainingPeriods - The number of remaining periods before this credit line is considered paid off.
31
- * @property {number} state - The state of the factorization. Please see the CreditState in huma-contracts for more details.
32
- * @property {BigNumber} totalDue - The total due amount of this credit line.
33
- * @property {BigNumber} unbilledPrincipal - The unbilled principal of the next payment.
34
- */
35
- export type CreditRecordDetails = {
36
- aprInBps: number;
37
- correction: BigNumber;
38
- creditLimit: BigNumber;
39
- defaultAmount: BigNumber;
40
- dueDate: BigNumber;
41
- feesAndInterestDue: BigNumber;
42
- intervalInDays: number;
43
- missedPeriods: number;
44
- remainingPeriods: number;
45
- state: number;
46
- totalDue: BigNumber;
47
- unbilledPrincipal: BigNumber;
48
- };
49
- /**
50
- * 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.
51
- *
52
- * @memberof usePoolContract
53
- * @param {string} userAddress - The address of the user to get the credit record details for.
54
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object to use for the contract.
55
- * @param {number} chainId The chain id where the contract instance exists
56
- * @param {POOL_NAME} poolName - The name of the pool to get the credit record details for.
57
- * @param {POOL_TYPE} poolType - The type of the pool.
58
- * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
59
- */
60
- export declare function useCreditRecordDetails(userAddress: string, signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): [CreditRecordDetails | undefined, () => void];
@@ -1,54 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.useCreditRecordDetails = exports.usePoolContract = void 0;
4
- const react_1 = require("react");
5
- const useContract_1 = require("./useContract");
6
- const poolInfo_1 = require("../utils/poolInfo");
7
- /**
8
- * A react hook that returns a contract instance of a specific pool using an ethers provider or signer
9
- *
10
- * @namespace usePoolContract
11
- * @template T - The type of the contract.
12
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - An ethers signer or provider instance.
13
- * @param {number} chainId The chain id where the contract instance exists
14
- * @param {POOL_NAME} poolName - The name of the pool.
15
- * @param {POOL_TYPE} poolType - The type of the pool.
16
- * @returns {T} A contract instance of the specific pool.
17
- */
18
- function usePoolContract(signerOrProvider, chainId, poolName, poolType) {
19
- const poolInfo = (0, poolInfo_1.getPoolInfo)(chainId, poolName, poolType);
20
- return (0, useContract_1.useContract)(poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.pool, poolInfo === null || poolInfo === void 0 ? void 0 : poolInfo.poolAbi, signerOrProvider);
21
- }
22
- exports.usePoolContract = usePoolContract;
23
- /**
24
- * 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.
25
- *
26
- * @memberof usePoolContract
27
- * @param {string} userAddress - The address of the user to get the credit record details for.
28
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider - The signer or provider object to use for the contract.
29
- * @param {number} chainId The chain id where the contract instance exists
30
- * @param {POOL_NAME} poolName - The name of the pool to get the credit record details for.
31
- * @param {POOL_TYPE} poolType - The type of the pool.
32
- * @returns {Array<CreditRecordDetails | undefined, function():void>} An array containing the credit record details and a function to refresh the data.
33
- */
34
- function useCreditRecordDetails(userAddress, signerOrProvider, chainId, poolName, poolType) {
35
- const poolContract = usePoolContract(signerOrProvider, chainId, poolName, poolType);
36
- const [creditRecordDetails, setCreditRecordDetails] = (0, react_1.useState)();
37
- const [refreshCount, setRefreshCount] = (0, react_1.useState)(0);
38
- (0, react_1.useEffect)(() => {
39
- const fetchData = async () => {
40
- if (poolContract && userAddress) {
41
- const creditRecordMapping = await poolContract.creditRecordMapping(userAddress);
42
- const creditRecordStaticMapping = await poolContract.creditRecordStaticMapping(userAddress);
43
- setCreditRecordDetails(Object.assign(Object.assign({}, creditRecordMapping), creditRecordStaticMapping));
44
- }
45
- };
46
- fetchData();
47
- }, [userAddress, poolContract, refreshCount]);
48
- const refresh = (0, react_1.useCallback)(() => {
49
- setRefreshCount((pre) => pre + 1);
50
- }, []);
51
- return [creditRecordDetails, refresh];
52
- }
53
- exports.useCreditRecordDetails = useCreditRecordDetails;
54
- //# sourceMappingURL=usePoolContract.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usePoolContract.js","sourceRoot":"","sources":["../../../src/hooks/usePoolContract.ts"],"names":[],"mappings":";;;AAEA,iCAAwD;AAGxD,+CAA2C;AAC3C,gDAA+C;AAE/C;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAC7B,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAA,sBAAW,EAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzD,OAAO,IAAA,yBAAW,EAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;AAC5E,CAAC;AARD,0CAQC;AAoCD;;;;;;;;;;GAUG;AACH,SAAgB,sBAAsB,CACpC,WAAmB,EACnB,gBAA2D,EAC3D,OAAe,EACf,QAAmB,EACnB,QAAmB;IAEnB,MAAM,YAAY,GAAG,eAAe,CAClC,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,CACT,CAAA;IACD,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GACjD,IAAA,gBAAQ,GAAuB,CAAA;IACjC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAA;IAEnD,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;YAC3B,IAAI,YAAY,IAAI,WAAW,EAAE;gBAC/B,MAAM,mBAAmB,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAChE,WAAW,CACZ,CAAA;gBACD,MAAM,yBAAyB,GAC7B,MAAM,YAAY,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;gBAC3D,sBAAsB,iCACjB,mBAAmB,GACnB,yBAAyB,EAC5B,CAAA;aACH;QACH,CAAC,CAAA;QACD,SAAS,EAAE,CAAA;IACb,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAA;IAE7C,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QAC/B,eAAe,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;IACnC,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACvC,CAAC;AAvCD,wDAuCC"}
@@ -1,10 +0,0 @@
1
- import { Contract, ethers } from 'ethers';
2
- /**
3
- * A react hook that returns an ethers contract instance for the RealWorldReceivable contract
4
- * associated with the given pool name on the current chain.
5
- *
6
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
7
- * @param {number} chainId The chain id where the contract instance exists
8
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
9
- */
10
- export declare function useRealWorldReceivableContract(signerOrProvider: ethers.providers.Provider | ethers.Signer, chainId: number): Contract | null;
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.useRealWorldReceivableContract = void 0;
4
- const shared_1 = require("@huma-finance/shared");
5
- const useContract_1 = require("./useContract");
6
- /**
7
- * A react hook that returns an ethers contract instance for the RealWorldReceivable contract
8
- * associated with the given pool name on the current chain.
9
- *
10
- * @param {ethers.providers.Provider | ethers.Signer} signerOrProvider The provider or signer instance to use for the contract.
11
- * @param {number} chainId The chain id where the contract instance exists
12
- * @returns {Contract | null} A contract instance for the RealWorldReceivable contract or null if it could not be found.
13
- */
14
- function useRealWorldReceivableContract(signerOrProvider, chainId) {
15
- var _a;
16
- const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
17
- return (0, useContract_1.useContract)(realWorldReceivable, shared_1.REAL_WORLD_RECEIVABLE_ABI, signerOrProvider);
18
- }
19
- exports.useRealWorldReceivableContract = useRealWorldReceivableContract;
20
- //# sourceMappingURL=useRealWorldReceivableContract.js.map