@huma-finance/sdk 0.0.30 → 0.0.31

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 (119) hide show
  1. package/API.md +977 -608
  2. package/LICENSE +660 -660
  3. package/README.md +34 -34
  4. package/dist/cjs/graphql/generatedTypes.d.ts +40 -40
  5. package/dist/cjs/graphql/generatedTypes.js +8 -8
  6. package/dist/cjs/graphql/index.d.ts +1 -1
  7. package/dist/cjs/graphql/index.js +4 -4
  8. package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.d.ts +10 -10
  9. package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js +21 -21
  10. package/dist/cjs/helpers/PoolContractHelper.d.ts +119 -119
  11. package/dist/cjs/helpers/PoolContractHelper.js +142 -142
  12. package/dist/cjs/helpers/RealWorldReceivableContractHelper.d.ts +10 -10
  13. package/dist/cjs/helpers/RealWorldReceivableContractHelper.js +21 -21
  14. package/dist/cjs/helpers/index.d.ts +3 -3
  15. package/dist/cjs/helpers/index.js +6 -6
  16. package/dist/cjs/hooks/index.d.ts +4 -4
  17. package/dist/cjs/hooks/index.js +7 -7
  18. package/dist/cjs/hooks/useContract.d.ts +13 -13
  19. package/dist/cjs/hooks/useContract.js +30 -30
  20. package/dist/cjs/hooks/useERC20TransferableReceivableContract.d.ts +12 -12
  21. package/dist/cjs/hooks/useERC20TransferableReceivableContract.js +20 -20
  22. package/dist/cjs/hooks/usePoolContract.d.ts +60 -60
  23. package/dist/cjs/hooks/usePoolContract.js +53 -53
  24. package/dist/cjs/hooks/useRealWorldReceivableContract.d.ts +10 -10
  25. package/dist/cjs/hooks/useRealWorldReceivableContract.js +19 -19
  26. package/dist/cjs/index.d.ts +4 -4
  27. package/dist/cjs/index.js +7 -7
  28. package/dist/cjs/services/ARWeaveService.d.ts +106 -95
  29. package/dist/cjs/services/ARWeaveService.js +190 -169
  30. package/dist/cjs/services/ARWeaveService.js.map +1 -1
  31. package/dist/cjs/services/EAService.d.ts +20 -20
  32. package/dist/cjs/services/EAService.js +33 -33
  33. package/dist/cjs/services/ReceivableService.d.ts +105 -89
  34. package/dist/cjs/services/ReceivableService.js +253 -193
  35. package/dist/cjs/services/ReceivableService.js.map +1 -1
  36. package/dist/cjs/services/SubgraphService.d.ts +53 -53
  37. package/dist/cjs/services/SubgraphService.js +93 -93
  38. package/dist/cjs/services/index.d.ts +4 -4
  39. package/dist/cjs/services/index.js +7 -7
  40. package/dist/cjs/utils/chain.d.ts +15 -15
  41. package/dist/cjs/utils/chain.js +37 -37
  42. package/dist/cjs/utils/index.d.ts +4 -4
  43. package/dist/cjs/utils/index.js +7 -7
  44. package/dist/cjs/utils/maticGasStation.d.ts +3 -3
  45. package/dist/cjs/utils/maticGasStation.js +38 -38
  46. package/dist/cjs/utils/poolInfo.d.ts +8 -8
  47. package/dist/cjs/utils/poolInfo.js +12 -12
  48. package/dist/cjs/utils/web3.d.ts +5 -5
  49. package/dist/cjs/utils/web3.js +33 -33
  50. package/dist/graphql/generatedTypes.d.ts +40 -40
  51. package/dist/graphql/generatedTypes.js +4 -4
  52. package/dist/graphql/index.d.ts +1 -1
  53. package/dist/graphql/index.js +1 -1
  54. package/dist/helpers/ERC20TransferableReceivableContractHelper.d.ts +10 -10
  55. package/dist/helpers/ERC20TransferableReceivableContractHelper.js +17 -17
  56. package/dist/helpers/PoolContractHelper.d.ts +119 -119
  57. package/dist/helpers/PoolContractHelper.js +133 -133
  58. package/dist/helpers/RealWorldReceivableContractHelper.d.ts +10 -10
  59. package/dist/helpers/RealWorldReceivableContractHelper.js +17 -17
  60. package/dist/helpers/index.d.ts +3 -3
  61. package/dist/helpers/index.js +3 -3
  62. package/dist/hooks/index.d.ts +4 -4
  63. package/dist/hooks/index.js +4 -4
  64. package/dist/hooks/useContract.d.ts +13 -13
  65. package/dist/hooks/useContract.js +26 -26
  66. package/dist/hooks/useERC20TransferableReceivableContract.d.ts +12 -12
  67. package/dist/hooks/useERC20TransferableReceivableContract.js +16 -16
  68. package/dist/hooks/usePoolContract.d.ts +60 -60
  69. package/dist/hooks/usePoolContract.js +48 -48
  70. package/dist/hooks/useRealWorldReceivableContract.d.ts +10 -10
  71. package/dist/hooks/useRealWorldReceivableContract.js +15 -15
  72. package/dist/index.d.ts +4 -4
  73. package/dist/index.js +4 -4
  74. package/dist/services/ARWeaveService.d.ts +106 -95
  75. package/dist/services/ARWeaveService.js +185 -164
  76. package/dist/services/ARWeaveService.js.map +1 -1
  77. package/dist/services/EAService.d.ts +20 -20
  78. package/dist/services/EAService.js +30 -30
  79. package/dist/services/ReceivableService.d.ts +105 -89
  80. package/dist/services/ReceivableService.js +249 -189
  81. package/dist/services/ReceivableService.js.map +1 -1
  82. package/dist/services/SubgraphService.d.ts +53 -53
  83. package/dist/services/SubgraphService.js +90 -90
  84. package/dist/services/index.d.ts +4 -4
  85. package/dist/services/index.js +4 -4
  86. package/dist/tsconfig.cjs.tsbuildinfo +1 -1
  87. package/dist/utils/chain.d.ts +15 -15
  88. package/dist/utils/chain.js +31 -31
  89. package/dist/utils/index.d.ts +4 -4
  90. package/dist/utils/index.js +4 -4
  91. package/dist/utils/maticGasStation.d.ts +3 -3
  92. package/dist/utils/maticGasStation.js +33 -33
  93. package/dist/utils/poolInfo.d.ts +8 -8
  94. package/dist/utils/poolInfo.js +8 -8
  95. package/dist/utils/web3.d.ts +5 -5
  96. package/dist/utils/web3.js +27 -27
  97. package/getting-started.md +190 -190
  98. package/package.json +3 -3
  99. package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.d.ts +0 -10
  100. package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js +0 -22
  101. package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js.map +0 -1
  102. package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.d.ts +0 -10
  103. package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js +0 -20
  104. package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js.map +0 -1
  105. package/dist/cjs/hooks/useReceivableFactoringPoolContract.d.ts +0 -10
  106. package/dist/cjs/hooks/useReceivableFactoringPoolContract.js +0 -17
  107. package/dist/cjs/hooks/useReceivableFactoringPoolContract.js.map +0 -1
  108. package/dist/helpers/BaseCreditPoolReceivableContractHelper.d.ts +0 -10
  109. package/dist/helpers/BaseCreditPoolReceivableContractHelper.js +0 -18
  110. package/dist/helpers/BaseCreditPoolReceivableContractHelper.js.map +0 -1
  111. package/dist/hooks/useBaseCreditPoolReceivableContract.d.ts +0 -10
  112. package/dist/hooks/useBaseCreditPoolReceivableContract.js +0 -16
  113. package/dist/hooks/useBaseCreditPoolReceivableContract.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/useReceivableFactoringPoolContract.d.ts +0 -10
  118. package/dist/hooks/useReceivableFactoringPoolContract.js +0 -13
  119. package/dist/hooks/useReceivableFactoringPoolContract.js.map +0 -1
@@ -1,190 +1,250 @@
1
- import { Web3Provider } from '@ethersproject/providers';
2
- import { ChainEnum, PoolContractMap, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
3
- import request, { gql } from 'graphql-request';
4
- import { ARWeaveService } from './ARWeaveService';
5
- import { getRealWorldReceivableContract } from '../helpers';
6
- import { getDefaultGasOptions, getChainIdFromSignerOrProvider } from '../utils';
7
- /**
8
- * Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
9
- *
10
- * @async
11
- * @function
12
- * @memberof ReceivableService
13
- * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
14
- * @param {string} referenceId - An internal identifier value added as a tag on ARWeave
15
- * @param {number} paymentAmount - The amount to declare paid to the receivable.
16
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
17
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
18
- */
19
- async function declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, gasOpts = {}) {
20
- var _a, _b, _c;
21
- const chainId = await getChainIdFromSignerOrProvider(signer);
22
- const signerAddress = await signer.getAddress();
23
- if (!chainId) {
24
- throw new Error('No Chain ID found');
25
- }
26
- // Get ARWeave ID
27
- const dataID = await ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
28
- // Fetch receivables with the same ARWeave ID
29
- const receivablesQuery = gql `
30
- query ReceivablesByURIQuery($owner: String!, $uri: String!) {
31
- receivables(where: { owner: $owner, uri: $uri }) {
32
- ...ReceivableFields
33
- }
34
- }
35
-
36
- fragment ReceivableFields on Receivable {
37
- tokenId
38
- }
39
- `;
40
- let receivableSubgraph;
41
- switch (chainId) {
42
- case ChainEnum.Goerli:
43
- receivableSubgraph = `https://api.thegraph.com/subgraphs/name/00labs/huma-receivables-goerli`;
44
- break;
45
- default:
46
- throw new Error('No receivable subgraph exists for this chain');
47
- }
48
- const receivablesData = await request(receivableSubgraph, receivablesQuery, {
49
- owner: signerAddress,
50
- uri: `https://arweave.net/${dataID}`,
51
- });
52
- if (!(receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) || !((_a = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _a === void 0 ? void 0 : _a.length)) {
53
- throw new Error('No receivables found with this ARWeave ID.');
54
- }
55
- else if (((_b = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _b === void 0 ? void 0 : _b.length) > 1) {
56
- throw new Error(`This owner has multiple receivables with the same URI. Please burn
57
- unnecessary receivables or pay the correct token manually using declareReceivablePaymentByTokenId`);
58
- }
59
- const contract = getRealWorldReceivableContract(signer, chainId);
60
- if (!contract) {
61
- throw new Error('Could not find RealWorldReceivable contract');
62
- }
63
- gasOpts = await getDefaultGasOptions(gasOpts, chainId);
64
- return contract.declarePayment((_c = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables[0]) === null || _c === void 0 ? void 0 : _c.tokenId, paymentAmount, gasOpts);
65
- }
66
- /**
67
- * Declares a payment on a RealWorldReceivable given a tokenID of the receivable.
68
- *
69
- * @async
70
- * @function
71
- * @memberof ReceivableService
72
- * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
73
- * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
74
- * @param {number} paymentAmount - The amount to pay the receivable.
75
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
76
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
77
- * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
78
- */
79
- async function declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, gasOpts = {}) {
80
- var _a;
81
- const chainId = await getChainIdFromSignerOrProvider(signer);
82
- if (!chainId) {
83
- throw new Error('No Chain ID found');
84
- }
85
- const realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
86
- if (!realWorldReceivable) {
87
- throw new Error('RealWorldReceivable is not available on this network');
88
- }
89
- const contract = getRealWorldReceivableContract(signer, chainId);
90
- if (!contract) {
91
- throw new Error('Could not find RealWorldReceivable contract');
92
- }
93
- gasOpts = await getDefaultGasOptions(gasOpts, chainId);
94
- return contract.declarePayment(receivableTokenId, paymentAmount, gasOpts);
95
- }
96
- /**
97
- * Creates a new RealWorldReceivable token on the given chain of the signer
98
- *
99
- * @async
100
- * @function
101
- * @memberof ReceivableService
102
- * @param {ethers.Signer} signer - The signer used to send the transaction.
103
- * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
104
- * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
105
- * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
106
- * @param {number} receivableAmount - The amount of the receivable token to mint.
107
- * @param {number} maturityDate - The maturity date of the receivable token, in UNIX timestamp format.
108
- * @param {string} uri - The URI of the receivable token metadata.
109
- * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
110
- * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
111
- * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
112
- */
113
- async function createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts = {}) {
114
- var _a, _b;
115
- const chainId = await getChainIdFromSignerOrProvider(signer);
116
- if (!chainId) {
117
- throw new Error('No Chain ID found');
118
- }
119
- const poolInfo = chainId
120
- ? (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[poolType]) === null || _b === void 0 ? void 0 : _b[poolName]
121
- : undefined;
122
- if (!poolInfo) {
123
- throw new Error('RealWorldReceivable is not available on this network');
124
- }
125
- const contract = getRealWorldReceivableContract(signer, chainId);
126
- if (!contract) {
127
- throw new Error('Could not find RealWorldReceivable contract');
128
- }
129
- gasOpts = await getDefaultGasOptions(gasOpts, chainId);
130
- return contract.createRealWorldReceivable(poolInfo.pool, currencyCode, receivableAmount, maturityDate, uri, gasOpts);
131
- }
132
- /**
133
- * Creates a RealWorldReceivable token with metadata uploaded onto ARWeave
134
- *
135
- * @async
136
- * @function
137
- * @memberof ReceivableService
138
- * @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
139
- * If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
140
- * from server calls.
141
- * @param {string | null} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
142
- * @param {number} chainId - The chain ID to mint the receivable token on and pay ARWeave funds from.
143
- * @param {string} recipient - The receivable token recipient.
144
- * @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
145
- * @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
146
- * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
147
- * @param {number} receivableAmount - The receivable amount.
148
- * @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
149
- * @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
150
- * @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
151
- * @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
152
- * ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
153
- * @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
154
- * metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
155
- * @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
156
- * @returns {Promise<TransactionResponse>} - The transaction receipt.
157
- */
158
- async function createReceivableWithMetadata(signerOrProvider, privateKey, chainId, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, lazyFund = true, gasOpts) {
159
- const config = ARWeaveService.getBundlrNetworkConfig(chainId);
160
- try {
161
- const tags = [
162
- { name: 'Content-Type', value: 'application/json' },
163
- { name: 'appName', value: 'HumaFinance' },
164
- { name: 'poolName', value: poolName },
165
- { name: 'poolType', value: poolType },
166
- { name: 'referenceId', value: referenceId },
167
- ...extraTags,
168
- ];
169
- const response = await ARWeaveService.storeData(config, signerOrProvider instanceof Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
170
- console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
171
- return await createReceivable(signerOrProvider instanceof Web3Provider
172
- ? signerOrProvider.getSigner()
173
- : signerOrProvider, poolName, poolType, currencyCode, receivableAmount, maturityDate, `https://arweave.net/${response.id}`, gasOpts);
174
- }
175
- catch (e) {
176
- console.error(e);
177
- throw e;
178
- }
179
- }
180
- /**
181
- * An object that contains functions to interact with Huma's receivables.
182
- * @namespace ReceivableService
183
- */
184
- export const ReceivableService = {
185
- createReceivableWithMetadata,
186
- createReceivable,
187
- declareReceivablePaymentByTokenId,
188
- declareReceivablePaymentByReferenceId,
189
- };
1
+ import { Web3Provider } from '@ethersproject/providers';
2
+ import { ethers } from 'ethers';
3
+ import { PoolContractMap, PoolSubgraphMap, SupplementaryContracts, SupplementaryContractsMap, } from '@huma-finance/shared';
4
+ import request, { gql } from 'graphql-request';
5
+ import { ARWeaveService } from './ARWeaveService';
6
+ import { getRealWorldReceivableContract } from '../helpers';
7
+ import { getDefaultGasOptions, getChainIdFromSignerOrProvider } from '../utils';
8
+ /**
9
+ * Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
10
+ *
11
+ * @async
12
+ * @function
13
+ * @memberof ReceivableService
14
+ * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
15
+ * @param {string} referenceId - An internal identifier value added as a tag on ARWeave
16
+ * @param {number} paymentAmount - The amount to declare paid to the receivable.
17
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
18
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
19
+ */
20
+ async function declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount, gasOpts = {}) {
21
+ var _a, _b, _c;
22
+ const chainId = await getChainIdFromSignerOrProvider(signer);
23
+ const signerAddress = await signer.getAddress();
24
+ if (!chainId) {
25
+ throw new Error('No Chain ID found');
26
+ }
27
+ // Get ARWeave ID
28
+ const dataID = await ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
29
+ // Fetch receivables with the same ARWeave ID
30
+ const receivablesQuery = gql `
31
+ query ReceivablesByURIQuery($owner: String!, $uri: String!) {
32
+ receivables(where: { owner: $owner, uri: $uri }) {
33
+ ...ReceivableFields
34
+ }
35
+ }
36
+
37
+ fragment ReceivableFields on Receivable {
38
+ tokenId
39
+ }
40
+ `;
41
+ const receivableSubgraph = PoolSubgraphMap[chainId].receivablesSubgraph;
42
+ if (!receivableSubgraph) {
43
+ throw new Error('No receivable subgraph exists for this chain');
44
+ }
45
+ const receivablesData = await request(receivableSubgraph, receivablesQuery, {
46
+ owner: signerAddress,
47
+ uri: `https://arweave.net/${dataID}`,
48
+ });
49
+ if (!(receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) || !((_a = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _a === void 0 ? void 0 : _a.length)) {
50
+ throw new Error('No receivables found with this ARWeave ID.');
51
+ }
52
+ else if (((_b = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _b === void 0 ? void 0 : _b.length) > 1) {
53
+ throw new Error(`This owner has multiple receivables with the same URI. Please burn
54
+ unnecessary receivables or pay the correct token manually using declareReceivablePaymentByTokenId`);
55
+ }
56
+ const contract = getRealWorldReceivableContract(signer, chainId);
57
+ if (!contract) {
58
+ throw new Error('Could not find RealWorldReceivable contract');
59
+ }
60
+ gasOpts = await getDefaultGasOptions(gasOpts, chainId);
61
+ return contract.declarePayment((_c = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables[0]) === null || _c === void 0 ? void 0 : _c.tokenId, paymentAmount, gasOpts);
62
+ }
63
+ /**
64
+ * Declares a payment on a RealWorldReceivable given a tokenID of the receivable.
65
+ *
66
+ * @async
67
+ * @function
68
+ * @memberof ReceivableService
69
+ * @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
70
+ * @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
71
+ * @param {number} paymentAmount - The amount to pay the receivable.
72
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
73
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
74
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
75
+ */
76
+ async function declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount, gasOpts = {}) {
77
+ var _a;
78
+ const chainId = await getChainIdFromSignerOrProvider(signer);
79
+ if (!chainId) {
80
+ throw new Error('No Chain ID found');
81
+ }
82
+ const realWorldReceivable = (_a = SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[SupplementaryContracts.RealWorldReceivable];
83
+ if (!realWorldReceivable) {
84
+ throw new Error('RealWorldReceivable is not available on this network');
85
+ }
86
+ const contract = getRealWorldReceivableContract(signer, chainId);
87
+ if (!contract) {
88
+ throw new Error('Could not find RealWorldReceivable contract');
89
+ }
90
+ gasOpts = await getDefaultGasOptions(gasOpts, chainId);
91
+ return contract.declarePayment(receivableTokenId, paymentAmount, gasOpts);
92
+ }
93
+ /**
94
+ * Creates a new RealWorldReceivable token on the given chain of the signer
95
+ *
96
+ * @async
97
+ * @function
98
+ * @memberof ReceivableService
99
+ * @param {ethers.Signer} signer - The signer used to send the transaction.
100
+ * @param {POOL_NAME} poolName - The name of the credit pool to mint the receivable token from. Used to lookup the pool address.
101
+ * @param {POOL_TYPE} poolType - The type of the credit pool to mint the receivable token from. Used to lookup the pool address.
102
+ * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
103
+ * @param {number} receivableAmount - The amount of the receivable token to mint.
104
+ * @param {number} maturityDate - The maturity date of the receivable token, in UNIX timestamp format.
105
+ * @param {string} uri - The URI of the receivable token metadata.
106
+ * @param {Overrides} [gasOpts] - The gas options to use for the transaction.
107
+ * @returns {Promise<TransactionResponse>} - A Promise of the transaction response.
108
+ * @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
109
+ */
110
+ async function createReceivable(signer, poolName, poolType, currencyCode, receivableAmount, maturityDate, uri, gasOpts = {}) {
111
+ var _a, _b;
112
+ const chainId = await getChainIdFromSignerOrProvider(signer);
113
+ if (!chainId) {
114
+ throw new Error('No Chain ID found');
115
+ }
116
+ const poolInfo = chainId
117
+ ? (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[poolType]) === null || _b === void 0 ? void 0 : _b[poolName]
118
+ : undefined;
119
+ if (!poolInfo) {
120
+ throw new Error('RealWorldReceivable is not available on this network');
121
+ }
122
+ const contract = getRealWorldReceivableContract(signer, chainId);
123
+ if (!contract) {
124
+ throw new Error('Could not find RealWorldReceivable contract');
125
+ }
126
+ gasOpts = await getDefaultGasOptions(gasOpts, chainId);
127
+ return contract.createRealWorldReceivable(poolInfo.pool, currencyCode, receivableAmount, maturityDate, uri, gasOpts);
128
+ }
129
+ /**
130
+ * Creates a RealWorldReceivable token with metadata uploaded onto ARWeave
131
+ *
132
+ * @async
133
+ * @function
134
+ * @memberof ReceivableService
135
+ * @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
136
+ * If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
137
+ * from server calls.
138
+ * @param {string | null} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
139
+ * @param {number} chainId - The chain ID to mint the receivable token on and pay ARWeave funds from.
140
+ * @param {string} recipient - The receivable token recipient.
141
+ * @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
142
+ * @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
143
+ * @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
144
+ * @param {number} receivableAmount - The receivable amount.
145
+ * @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
146
+ * @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
147
+ * @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
148
+ * @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
149
+ * ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
150
+ * @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
151
+ * metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
152
+ * @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
153
+ * @returns {Promise<TransactionResponse>} - The transaction receipt.
154
+ */
155
+ async function createReceivableWithMetadata(signerOrProvider, privateKey, chainId, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, lazyFund = true, gasOpts) {
156
+ const config = ARWeaveService.getBundlrNetworkConfig(chainId);
157
+ try {
158
+ const tags = [
159
+ { name: 'Content-Type', value: 'application/json' },
160
+ { name: 'appName', value: 'HumaFinance' },
161
+ { name: 'poolName', value: poolName },
162
+ { name: 'poolType', value: poolType },
163
+ { name: 'referenceId', value: referenceId },
164
+ ...extraTags,
165
+ ];
166
+ const response = await ARWeaveService.storeData(config, signerOrProvider instanceof Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
167
+ console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
168
+ return await createReceivable(signerOrProvider instanceof Web3Provider
169
+ ? signerOrProvider.getSigner()
170
+ : signerOrProvider, poolName, poolType, currencyCode, receivableAmount, maturityDate, `https://arweave.net/${response.id}`, gasOpts);
171
+ }
172
+ catch (e) {
173
+ console.error(e);
174
+ throw e;
175
+ }
176
+ }
177
+ /**
178
+ * Creates a RealWorldReceivable token with metadata uploaded onto ARWeave
179
+ *
180
+ * @async
181
+ * @function
182
+ * @memberof ReceivableService
183
+ * @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
184
+ * If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
185
+ * from server calls.
186
+ * @param {string} owner - The receivable token owner to query from.
187
+ * @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
188
+ * @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
189
+ * @returns {Promise<RealWorldReceivableInfo[]>} - An array of receivables owned by the owner for the pool.
190
+ */
191
+ async function loadReceivablesOfOwnerWithMetadata(signerOrProvider, owner, poolName, poolType) {
192
+ var _a, _b;
193
+ if (!ethers.utils.isAddress(owner)) {
194
+ throw new Error('Invalid owner address');
195
+ }
196
+ const chainId = await getChainIdFromSignerOrProvider(signerOrProvider);
197
+ if (!chainId) {
198
+ throw new Error('No Chain ID found');
199
+ }
200
+ const poolInfo = chainId
201
+ ? (_b = (_a = PoolContractMap[chainId]) === null || _a === void 0 ? void 0 : _a[poolType]) === null || _b === void 0 ? void 0 : _b[poolName]
202
+ : undefined;
203
+ if (!poolInfo) {
204
+ throw new Error('RealWorldReceivable is not available on this network');
205
+ }
206
+ const rwrContract = getRealWorldReceivableContract(signerOrProvider, chainId);
207
+ if (!rwrContract) {
208
+ throw new Error('Could not find RealWorldReceivable contract');
209
+ }
210
+ // Load all receivables of owner
211
+ const balance = await rwrContract.balanceOf(owner);
212
+ // Create empty array with length of balance
213
+ const tokens = Array.from(Array(balance.toNumber()));
214
+ const fetchPromises = tokens.map(async (_, tokenIndex) => {
215
+ const tokenId = await rwrContract.tokenOfOwnerByIndex(owner, tokenIndex);
216
+ const rwrInfo = await rwrContract.rwrInfoMapping(tokenId);
217
+ // If a RWR uploaded by an owner is not for this specific pool, skip it
218
+ if (rwrInfo.poolAddress.toLowerCase() !== poolInfo.pool.toLowerCase()) {
219
+ return undefined;
220
+ }
221
+ const tokenURI = await rwrContract.tokenURI(tokenId);
222
+ const metadata = await ARWeaveService.fetchMetadataFromUrl(tokenURI);
223
+ return {
224
+ tokenId,
225
+ poolAddress: rwrInfo.poolAddress,
226
+ receivableAmount: rwrInfo.receivableAmount,
227
+ paidAmount: rwrInfo.paidAmount,
228
+ creationDate: rwrInfo.creationDate,
229
+ maturityDate: rwrInfo.maturityDate,
230
+ currencyCode: rwrInfo.currencyCode,
231
+ tokenURI,
232
+ metadata,
233
+ };
234
+ });
235
+ const tokenData = await Promise.all(fetchPromises);
236
+ // Filter undefined
237
+ return tokenData.filter((token) => token !== undefined);
238
+ }
239
+ /**
240
+ * An object that contains functions to interact with Huma's receivables.
241
+ * @namespace ReceivableService
242
+ */
243
+ export const ReceivableService = {
244
+ createReceivableWithMetadata,
245
+ createReceivable,
246
+ declareReceivablePaymentByTokenId,
247
+ declareReceivablePaymentByReferenceId,
248
+ loadReceivablesOfOwnerWithMetadata,
249
+ };
190
250
  //# sourceMappingURL=ReceivableService.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../src/services/ReceivableService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAE5E,OAAO,EACL,SAAS,EAGT,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,YAAY,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAA;AAG/E;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,qCAAqC,CAClD,MAAqB,EACrB,WAAmB,EACnB,aAAqB,EACrB,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAC5D,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAA;IAE/C,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,iBAAiB;IACjB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,gBAAgB,CAClD,OAAO,EACP,aAAa,EACb,WAAW,CACZ,CAAA;IAED,6CAA6C;IAC7C,MAAM,gBAAgB,GAAG,GAAG,CAAA;;;;;;;;;;GAU3B,CAAA;IAED,IAAI,kBAAkB,CAAA;IACtB,QAAQ,OAAO,EAAE;QACf,KAAK,SAAS,CAAC,MAAM;YACnB,kBAAkB,GAAG,wEAAwE,CAAA;YAC7F,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAClE;IAED,MAAM,eAAe,GAAkC,MAAM,OAAO,CAClE,kBAAkB,EAClB,gBAAgB,EAChB;QACE,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,uBAAuB,MAAM,EAAE;KACrC,CACF,CAAA;IAED,IAAI,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAA,IAAI,CAAC,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAA,EAAE;QAC1E,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;KAC9D;SAAM,IAAI,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,IAAG,CAAC,EAAE;QACnD,MAAM,IAAI,KAAK,CACb;wGACkG,CACnG,CAAA;KACF;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,cAAc,CAC5B,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAC,CAAC,CAAC,0CAAE,OAAQ,EACzC,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,iCAAiC,CAC9C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB,EACrB,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,mBAAmB,GACvB,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,gBAAgB,CAC7B,MAAqB,EACrB,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,GAAW,EACX,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC;QAClD,CAAC,CAAC,SAAS,CAAA;IAEb,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,yBAAyB,CACvC,QAAQ,CAAC,IAAI,EACb,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,GAAG,EACH,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,KAAK,UAAU,4BAA4B,CACzC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,QAAc,EACd,WAAmB,EACnB,SAA4C,EAC5C,WAAoB,IAAI,EACxB,OAAmB;IAEnB,MAAM,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,IAAI;QACF,MAAM,IAAI,GAAG;YACX,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE;YACnD,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE;YACzC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE;YAC3C,GAAG,SAAS;SACb,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,SAAS,CAC7C,MAAM,EACN,gBAAgB,YAAY,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAW,EACzE,QAAQ,EACR,IAAI,EACJ,QAAQ,CACT,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,yCAAyC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,OAAO,MAAM,gBAAgB,CAC3B,gBAAgB,YAAY,YAAY;YACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC9B,CAAC,CAAC,gBAAgB,EACpB,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,QAAQ,CAAC,EAAE,EAAE,EACpC,OAAO,CACR,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAChB,MAAM,CAAC,CAAA;KACR;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;CACtC,CAAA"}
1
+ {"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../src/services/ReceivableService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAC5E,OAAO,EAAgB,MAAM,EAAa,MAAM,QAAQ,CAAA;AACxD,OAAO,EAGL,eAAe,EACf,eAAe,EAEf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,YAAY,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAA;AAG/E;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,qCAAqC,CAClD,MAAqB,EACrB,WAAmB,EACnB,aAAqB,EACrB,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAC5D,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAA;IAE/C,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,iBAAiB;IACjB,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,gBAAgB,CAClD,OAAO,EACP,aAAa,EACb,WAAW,CACZ,CAAA;IAED,6CAA6C;IAC7C,MAAM,gBAAgB,GAAG,GAAG,CAAA;;;;;;;;;;GAU3B,CAAA;IAED,MAAM,kBAAkB,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,mBAAmB,CAAA;IACvE,IAAI,CAAC,kBAAkB,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;IAED,MAAM,eAAe,GAAkC,MAAM,OAAO,CAClE,kBAAkB,EAClB,gBAAgB,EAChB;QACE,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,uBAAuB,MAAM,EAAE;KACrC,CACF,CAAA;IAED,IAAI,CAAC,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAA,IAAI,CAAC,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,CAAA,EAAE;QAC1E,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;KAC9D;SAAM,IAAI,CAAA,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,0CAAE,MAAM,IAAG,CAAC,EAAE;QACnD,MAAM,IAAI,KAAK,CACb;wGACkG,CACnG,CAAA;KACF;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,cAAc,CAC5B,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAC,CAAC,CAAC,0CAAE,OAAQ,EACzC,aAAa,EACb,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,iCAAiC,CAC9C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB,EACrB,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,mBAAmB,GACvB,MAAA,yBAAyB,CAAC,OAAO,CAAC,0CAChC,sBAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,gBAAgB,CAC7B,MAAqB,EACrB,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,GAAW,EACX,UAAqB,EAAE;;IAEvB,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC;QAClD,CAAC,CAAC,SAAS,CAAA;IAEb,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,8BAA8B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAEtD,OAAO,QAAQ,CAAC,yBAAyB,CACvC,QAAQ,CAAC,IAAI,EACb,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,GAAG,EACH,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,KAAK,UAAU,4BAA4B,CACzC,gBAA8C,EAC9C,UAAyB,EACzB,OAAe,EACf,QAAmB,EACnB,QAAmB,EACnB,YAAoB,EACpB,gBAAwB,EACxB,YAAoB,EACpB,QAAc,EACd,WAAmB,EACnB,SAA4C,EAC5C,WAAoB,IAAI,EACxB,OAAmB;IAEnB,MAAM,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,IAAI;QACF,MAAM,IAAI,GAAG;YACX,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE;YACnD,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE;YACzC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE;YAC3C,GAAG,SAAS;SACb,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,SAAS,CAC7C,MAAM,EACN,gBAAgB,YAAY,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAW,EACzE,QAAQ,EACR,IAAI,EACJ,QAAQ,CACT,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,yCAAyC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,OAAO,MAAM,gBAAgB,CAC3B,gBAAgB,YAAY,YAAY;YACtC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC9B,CAAC,CAAC,gBAAgB,EACpB,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,uBAAuB,QAAQ,CAAC,EAAE,EAAE,EACpC,OAAO,CACR,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAChB,MAAM,CAAC,CAAA;KACR;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,kCAAkC,CAC/C,gBAA8C,EAC9C,KAAa,EACb,QAAmB,EACnB,QAAmB;;IAEnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,MAAM,OAAO,GAAG,MAAM,8BAA8B,CAAC,gBAAgB,CAAC,CAAA;IAEtE,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,MAAA,MAAA,eAAe,CAAC,OAAO,CAAC,0CAAG,QAAQ,CAAC,0CAAG,QAAQ,CAAC;QAClD,CAAC,CAAC,SAAS,CAAA;IAEb,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,WAAW,GAAG,8BAA8B,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;IAC7E,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,gCAAgC;IAChC,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAElD,4CAA4C;IAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;IACpD,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE;QACvD,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,mBAAmB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAExE,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QAEzD,uEAAuE;QACvE,IAAI,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;YACrE,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAA;QAEpE,OAAO;YACL,OAAO;YACP,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;YAC1C,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,QAAQ;YACR,QAAQ;SACT,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IAElD,mBAAmB;IACnB,OAAO,SAAS,CAAC,MAAM,CACrB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CACF,CAAA;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;IACrC,kCAAkC;CACnC,CAAA"}
@@ -1,53 +1,53 @@
1
- import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
2
- /**
3
- * Returns the subgraph URL for a given chain ID.
4
- *
5
- * @memberof SubgraphService
6
- * @param {number} chainId - The ID of the chain.
7
- * @returns {string} The subgraph URL for the given chain ID.
8
- */
9
- declare function getSubgraphUrlForChainId(chainId: number): string;
10
- /**
11
- * Represents the payload of a credit event.
12
- * @typedef {Object} CreditEventPayload
13
- */
14
- export type CreditEventPayload = {
15
- amount?: string;
16
- timestamp?: string;
17
- owner?: string;
18
- pool?: string;
19
- event?: string;
20
- };
21
- /**
22
- * Returns the credit events for a given user.
23
- *
24
- * @memberof SubgraphService
25
- * @param {string} userAddress - The address of the user.
26
- * @param {number} chainId - The ID of the chain.
27
- * @param {POOL_NAME} poolName - The name of the pool.
28
- * @param {POOL_TYPE} poolType - The type of the pool.
29
- * @param {number[]} event - The event types to filter by.
30
- * @returns {Promise<CreditEventPayload[]>} The credit events for the given user.
31
- */
32
- declare function getCreditEventsForUser(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, event: number[]): Promise<CreditEventPayload[]>;
33
- /**
34
- * Returns the last factorized amount for a given user and pool.
35
- *
36
- * @memberof SubgraphService
37
- * @param {string} userAddress - The address of the user.
38
- * @param {number} chainId - The ID of the chain.
39
- * @param {POOL_NAME} poolName - The name of the pool.
40
- * @param {POOL_TYPE} poolType - The type of the pool.
41
- * @returns {Promise<number>} The last factorized amount for the given user and pool.
42
- */
43
- declare function getLastFactorizedAmountFromPool(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<number>;
44
- /**
45
- * An object that contains functions to interact with Huma's Subgraph storage.
46
- * @namespace SubgraphService
47
- */
48
- export declare const SubgraphService: {
49
- getSubgraphUrlForChainId: typeof getSubgraphUrlForChainId;
50
- getCreditEventsForUser: typeof getCreditEventsForUser;
51
- getLastFactorizedAmountFromPool: typeof getLastFactorizedAmountFromPool;
52
- };
53
- export {};
1
+ import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
2
+ /**
3
+ * Returns the subgraph URL for a given chain ID.
4
+ *
5
+ * @memberof SubgraphService
6
+ * @param {number} chainId - The ID of the chain.
7
+ * @returns {string} The subgraph URL for the given chain ID.
8
+ */
9
+ declare function getSubgraphUrlForChainId(chainId: number): string;
10
+ /**
11
+ * Represents the payload of a credit event.
12
+ * @typedef {Object} CreditEventPayload
13
+ */
14
+ export type CreditEventPayload = {
15
+ amount?: string;
16
+ timestamp?: string;
17
+ owner?: string;
18
+ pool?: string;
19
+ event?: string;
20
+ };
21
+ /**
22
+ * Returns the credit events for a given user.
23
+ *
24
+ * @memberof SubgraphService
25
+ * @param {string} userAddress - The address of the user.
26
+ * @param {number} chainId - The ID of the chain.
27
+ * @param {POOL_NAME} poolName - The name of the pool.
28
+ * @param {POOL_TYPE} poolType - The type of the pool.
29
+ * @param {number[]} event - The event types to filter by.
30
+ * @returns {Promise<CreditEventPayload[]>} The credit events for the given user.
31
+ */
32
+ declare function getCreditEventsForUser(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE, event: number[]): Promise<CreditEventPayload[]>;
33
+ /**
34
+ * Returns the last factorized amount for a given user and pool.
35
+ *
36
+ * @memberof SubgraphService
37
+ * @param {string} userAddress - The address of the user.
38
+ * @param {number} chainId - The ID of the chain.
39
+ * @param {POOL_NAME} poolName - The name of the pool.
40
+ * @param {POOL_TYPE} poolType - The type of the pool.
41
+ * @returns {Promise<number>} The last factorized amount for the given user and pool.
42
+ */
43
+ declare function getLastFactorizedAmountFromPool(userAddress: string, chainId: number, poolName: POOL_NAME, poolType: POOL_TYPE): Promise<number>;
44
+ /**
45
+ * An object that contains functions to interact with Huma's Subgraph storage.
46
+ * @namespace SubgraphService
47
+ */
48
+ export declare const SubgraphService: {
49
+ getSubgraphUrlForChainId: typeof getSubgraphUrlForChainId;
50
+ getCreditEventsForUser: typeof getCreditEventsForUser;
51
+ getLastFactorizedAmountFromPool: typeof getLastFactorizedAmountFromPool;
52
+ };
53
+ export {};