@huma-finance/sdk 0.0.21 → 0.0.24
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.
- package/API.md +482 -482
- package/LICENSE +660 -660
- package/README.md +34 -34
- package/dist/cjs/graphql/generatedTypes.d.ts +40 -40
- package/dist/cjs/graphql/generatedTypes.js +8 -8
- package/dist/cjs/graphql/index.d.ts +1 -1
- package/dist/cjs/graphql/index.js +4 -4
- package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.d.ts +10 -10
- package/dist/cjs/helpers/ERC20TransferableReceivableContractHelper.js +21 -21
- package/dist/cjs/helpers/PoolContractHelper.d.ts +104 -104
- package/dist/cjs/helpers/PoolContractHelper.js +102 -104
- package/dist/cjs/helpers/PoolContractHelper.js.map +1 -1
- package/dist/cjs/helpers/RealWorldReceivableContractHelper.d.ts +10 -10
- package/dist/cjs/helpers/RealWorldReceivableContractHelper.js +21 -21
- package/dist/cjs/helpers/index.d.ts +3 -3
- package/dist/cjs/helpers/index.js +6 -6
- package/dist/cjs/hooks/index.d.ts +4 -4
- package/dist/cjs/hooks/index.js +7 -7
- package/dist/cjs/hooks/useContract.d.ts +13 -13
- package/dist/cjs/hooks/useContract.js +30 -30
- package/dist/cjs/hooks/useERC20TransferableReceivableContract.d.ts +12 -12
- package/dist/cjs/hooks/useERC20TransferableReceivableContract.js +20 -20
- package/dist/cjs/hooks/usePoolContract.d.ts +60 -60
- package/dist/cjs/hooks/usePoolContract.js +53 -53
- package/dist/cjs/hooks/useRealWorldReceivableContract.d.ts +10 -10
- package/dist/cjs/hooks/useRealWorldReceivableContract.js +19 -19
- package/dist/cjs/index.d.ts +4 -4
- package/dist/cjs/index.js +7 -7
- package/dist/cjs/services/ARWeaveService.d.ts +81 -81
- package/dist/cjs/services/ARWeaveService.js +140 -145
- package/dist/cjs/services/ARWeaveService.js.map +1 -1
- package/dist/cjs/services/EAService.d.ts +18 -20
- package/dist/cjs/services/EAService.js +12 -33
- package/dist/cjs/services/EAService.js.map +1 -1
- package/dist/cjs/services/ReceivableService.d.ts +87 -89
- package/dist/cjs/services/ReceivableService.js +188 -193
- package/dist/cjs/services/ReceivableService.js.map +1 -1
- package/dist/cjs/services/SubgraphService.d.ts +53 -53
- package/dist/cjs/services/SubgraphService.js +100 -93
- package/dist/cjs/services/SubgraphService.js.map +1 -1
- package/dist/cjs/services/index.d.ts +4 -4
- package/dist/cjs/services/index.js +7 -7
- package/dist/cjs/utils/chain.d.ts +14 -15
- package/dist/cjs/utils/chain.js +33 -37
- package/dist/cjs/utils/chain.js.map +1 -1
- package/dist/cjs/utils/index.d.ts +3 -4
- package/dist/cjs/utils/index.js +6 -7
- package/dist/cjs/utils/index.js.map +1 -1
- package/dist/cjs/utils/poolInfo.d.ts +8 -8
- package/dist/cjs/utils/poolInfo.js +12 -12
- package/dist/cjs/utils/web3.d.ts +4 -4
- package/dist/cjs/utils/web3.js +28 -28
- package/dist/graphql/generatedTypes.d.ts +40 -40
- package/dist/graphql/generatedTypes.js +4 -4
- package/dist/graphql/index.d.ts +1 -1
- package/dist/graphql/index.js +1 -1
- package/dist/helpers/ERC20TransferableReceivableContractHelper.d.ts +10 -10
- package/dist/helpers/ERC20TransferableReceivableContractHelper.js +17 -17
- package/dist/helpers/PoolContractHelper.d.ts +104 -104
- package/dist/helpers/PoolContractHelper.js +94 -96
- package/dist/helpers/PoolContractHelper.js.map +1 -1
- package/dist/helpers/RealWorldReceivableContractHelper.d.ts +10 -10
- package/dist/helpers/RealWorldReceivableContractHelper.js +17 -17
- package/dist/helpers/index.d.ts +3 -3
- package/dist/helpers/index.js +3 -3
- package/dist/hooks/index.d.ts +4 -4
- package/dist/hooks/index.js +4 -4
- package/dist/hooks/useContract.d.ts +13 -13
- package/dist/hooks/useContract.js +26 -26
- package/dist/hooks/useERC20TransferableReceivableContract.d.ts +12 -12
- package/dist/hooks/useERC20TransferableReceivableContract.js +16 -16
- package/dist/hooks/usePoolContract.d.ts +60 -60
- package/dist/hooks/usePoolContract.js +48 -48
- package/dist/hooks/useRealWorldReceivableContract.d.ts +10 -10
- package/dist/hooks/useRealWorldReceivableContract.js +15 -15
- package/dist/index.d.ts +4 -4
- package/dist/index.js +4 -4
- package/dist/services/ARWeaveService.d.ts +81 -81
- package/dist/services/ARWeaveService.js +135 -140
- package/dist/services/ARWeaveService.js.map +1 -1
- package/dist/services/EAService.d.ts +18 -20
- package/dist/services/EAService.js +9 -30
- package/dist/services/EAService.js.map +1 -1
- package/dist/services/ReceivableService.d.ts +87 -89
- package/dist/services/ReceivableService.js +184 -189
- package/dist/services/ReceivableService.js.map +1 -1
- package/dist/services/SubgraphService.d.ts +53 -53
- package/dist/services/SubgraphService.js +97 -90
- package/dist/services/SubgraphService.js.map +1 -1
- package/dist/services/index.d.ts +4 -4
- package/dist/services/index.js +4 -4
- package/dist/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/utils/chain.d.ts +14 -15
- package/dist/utils/chain.js +28 -31
- package/dist/utils/chain.js.map +1 -1
- package/dist/utils/index.d.ts +3 -4
- package/dist/utils/index.js +3 -4
- package/dist/utils/index.js.map +1 -1
- package/dist/utils/poolInfo.d.ts +8 -8
- package/dist/utils/poolInfo.js +8 -8
- package/dist/utils/web3.d.ts +4 -4
- package/dist/utils/web3.js +23 -23
- package/getting-started.md +190 -190
- package/package.json +3 -3
- package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.d.ts +0 -10
- package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js +0 -22
- package/dist/cjs/helpers/BaseCreditPoolReceivableContractHelper.js.map +0 -1
- package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.d.ts +0 -10
- package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js +0 -20
- package/dist/cjs/hooks/useBaseCreditPoolReceivableContract.js.map +0 -1
- package/dist/cjs/hooks/useReceivableFactoringPoolContract.d.ts +0 -10
- package/dist/cjs/hooks/useReceivableFactoringPoolContract.js +0 -17
- package/dist/cjs/hooks/useReceivableFactoringPoolContract.js.map +0 -1
- package/dist/cjs/utils/maticGasStation.d.ts +0 -3
- package/dist/cjs/utils/maticGasStation.js +0 -39
- package/dist/cjs/utils/maticGasStation.js.map +0 -1
- package/dist/helpers/BaseCreditPoolReceivableContractHelper.d.ts +0 -10
- package/dist/helpers/BaseCreditPoolReceivableContractHelper.js +0 -18
- package/dist/helpers/BaseCreditPoolReceivableContractHelper.js.map +0 -1
- package/dist/hooks/useBaseCreditPoolReceivableContract.d.ts +0 -10
- package/dist/hooks/useBaseCreditPoolReceivableContract.js +0 -16
- package/dist/hooks/useBaseCreditPoolReceivableContract.js.map +0 -1
- package/dist/hooks/usePool.d.ts +0 -0
- package/dist/hooks/usePool.js +0 -2
- package/dist/hooks/usePool.js.map +0 -1
- package/dist/hooks/useReceivableFactoringPoolContract.d.ts +0 -10
- package/dist/hooks/useReceivableFactoringPoolContract.js +0 -13
- package/dist/hooks/useReceivableFactoringPoolContract.js.map +0 -1
- package/dist/utils/maticGasStation.d.ts +0 -3
- package/dist/utils/maticGasStation.js +0 -33
- package/dist/utils/maticGasStation.js.map +0 -1
|
@@ -1,194 +1,189 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ReceivableService = void 0;
|
|
4
|
-
const tslib_1 = require("tslib");
|
|
5
|
-
const providers_1 = require("@ethersproject/providers");
|
|
6
|
-
const shared_1 = require("@huma-finance/shared");
|
|
7
|
-
const graphql_request_1 = tslib_1.__importStar(require("graphql-request"));
|
|
8
|
-
const ARWeaveService_1 = require("./ARWeaveService");
|
|
9
|
-
const helpers_1 = require("../helpers");
|
|
10
|
-
const
|
|
11
|
-
/**
|
|
12
|
-
* Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
|
|
13
|
-
*
|
|
14
|
-
* @async
|
|
15
|
-
* @function
|
|
16
|
-
* @memberof ReceivableService
|
|
17
|
-
* @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
|
|
18
|
-
* @param {string} referenceId - An internal identifier value added as a tag on ARWeave
|
|
19
|
-
* @param {number} paymentAmount - The amount to declare paid to the receivable.
|
|
20
|
-
* @
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
const
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* @
|
|
74
|
-
* @
|
|
75
|
-
* @
|
|
76
|
-
* @param {
|
|
77
|
-
* @
|
|
78
|
-
* @
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
* @
|
|
104
|
-
* @
|
|
105
|
-
* @
|
|
106
|
-
* @param {
|
|
107
|
-
* @param {
|
|
108
|
-
* @param {
|
|
109
|
-
* @param {
|
|
110
|
-
* @
|
|
111
|
-
* @
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
const
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
if (!
|
|
127
|
-
throw new Error('
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
* @function
|
|
141
|
-
* @
|
|
142
|
-
* @param {
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {number}
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {
|
|
151
|
-
*
|
|
152
|
-
* @param {
|
|
153
|
-
*
|
|
154
|
-
* @param {
|
|
155
|
-
* @
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
createReceivableWithMetadata,
|
|
190
|
-
createReceivable,
|
|
191
|
-
declareReceivablePaymentByTokenId,
|
|
192
|
-
declareReceivablePaymentByReferenceId,
|
|
193
|
-
};
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ReceivableService = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const providers_1 = require("@ethersproject/providers");
|
|
6
|
+
const shared_1 = require("@huma-finance/shared");
|
|
7
|
+
const graphql_request_1 = tslib_1.__importStar(require("graphql-request"));
|
|
8
|
+
const ARWeaveService_1 = require("./ARWeaveService");
|
|
9
|
+
const helpers_1 = require("../helpers");
|
|
10
|
+
const chain_1 = require("../utils/chain");
|
|
11
|
+
/**
|
|
12
|
+
* Declares a payment on a RealWorldReceivable given a reference ID of the receivable, which was used as an index for ARWeave data.
|
|
13
|
+
*
|
|
14
|
+
* @async
|
|
15
|
+
* @function
|
|
16
|
+
* @memberof ReceivableService
|
|
17
|
+
* @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
|
|
18
|
+
* @param {string} referenceId - An internal identifier value added as a tag on ARWeave
|
|
19
|
+
* @param {number} paymentAmount - The amount to declare paid to the receivable.
|
|
20
|
+
* @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
|
|
21
|
+
*/
|
|
22
|
+
async function declareReceivablePaymentByReferenceId(signer, referenceId, paymentAmount) {
|
|
23
|
+
var _a, _b, _c;
|
|
24
|
+
const chainId = await (0, chain_1.getChainIdFromSignerOrProvider)(signer);
|
|
25
|
+
const signerAddress = await signer.getAddress();
|
|
26
|
+
if (!chainId) {
|
|
27
|
+
throw new Error('No Chain ID found');
|
|
28
|
+
}
|
|
29
|
+
// Get ARWeave ID
|
|
30
|
+
const dataID = await ARWeaveService_1.ARWeaveService.queryForMetadata(chainId, signerAddress, referenceId);
|
|
31
|
+
// Fetch receivables with the same ARWeave ID
|
|
32
|
+
const receivablesQuery = (0, graphql_request_1.gql) `
|
|
33
|
+
query ReceivablesByURIQuery($owner: String!, $uri: String!) {
|
|
34
|
+
receivables(where: { owner: $owner, uri: $uri }) {
|
|
35
|
+
...ReceivableFields
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
fragment ReceivableFields on Receivable {
|
|
40
|
+
tokenId
|
|
41
|
+
}
|
|
42
|
+
`;
|
|
43
|
+
let receivableSubgraph;
|
|
44
|
+
switch (chainId) {
|
|
45
|
+
case shared_1.ChainEnum.Goerli:
|
|
46
|
+
receivableSubgraph = `https://api.thegraph.com/subgraphs/name/00labs/huma-receivables-goerli`;
|
|
47
|
+
break;
|
|
48
|
+
default:
|
|
49
|
+
throw new Error('No receivable subgraph exists for this chain');
|
|
50
|
+
}
|
|
51
|
+
const receivablesData = await (0, graphql_request_1.default)(receivableSubgraph, receivablesQuery, {
|
|
52
|
+
owner: signerAddress,
|
|
53
|
+
uri: `https://arweave.net/${dataID}`,
|
|
54
|
+
});
|
|
55
|
+
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)) {
|
|
56
|
+
throw new Error('No receivables found with this ARWeave ID.');
|
|
57
|
+
}
|
|
58
|
+
else if (((_b = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables) === null || _b === void 0 ? void 0 : _b.length) > 1) {
|
|
59
|
+
throw new Error(`This owner has multiple receivables with the same URI. Please burn
|
|
60
|
+
unnecessary receivables or pay the correct token manually using declareReceivablePaymentByTokenId`);
|
|
61
|
+
}
|
|
62
|
+
const contract = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);
|
|
63
|
+
if (!contract) {
|
|
64
|
+
throw new Error('Could not find RealWorldReceivable contract');
|
|
65
|
+
}
|
|
66
|
+
return contract.declarePayment((_c = receivablesData === null || receivablesData === void 0 ? void 0 : receivablesData.receivables[0]) === null || _c === void 0 ? void 0 : _c.tokenId, paymentAmount);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Declares a payment on a RealWorldReceivable given a tokenID of the receivable.
|
|
70
|
+
*
|
|
71
|
+
* @async
|
|
72
|
+
* @function
|
|
73
|
+
* @memberof ReceivableService
|
|
74
|
+
* @param {ethers.Signer} signer - The signer used to send the transaction. Note only the receivable owner can pay the receivable.
|
|
75
|
+
* @param {BigNumberish} receivableTokenId - The ID of the receivable token to pay.
|
|
76
|
+
* @param {number} paymentAmount - The amount to pay the receivable.
|
|
77
|
+
* @returns {Promise<TransactionResponse>} - A Promise of the transaction receipt.
|
|
78
|
+
* @throws {Error} - Throws an error if the RealWorldReceivable contract is not available on the network.
|
|
79
|
+
*/
|
|
80
|
+
async function declareReceivablePaymentByTokenId(signer, receivableTokenId, paymentAmount) {
|
|
81
|
+
var _a;
|
|
82
|
+
const chainId = await (0, chain_1.getChainIdFromSignerOrProvider)(signer);
|
|
83
|
+
if (!chainId) {
|
|
84
|
+
throw new Error('No Chain ID found');
|
|
85
|
+
}
|
|
86
|
+
const realWorldReceivable = (_a = shared_1.SupplementaryContractsMap[chainId]) === null || _a === void 0 ? void 0 : _a[shared_1.SupplementaryContracts.RealWorldReceivable];
|
|
87
|
+
if (!realWorldReceivable) {
|
|
88
|
+
throw new Error('RealWorldReceivable is not available on this network');
|
|
89
|
+
}
|
|
90
|
+
const contract = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);
|
|
91
|
+
if (!contract) {
|
|
92
|
+
throw new Error('Could not find RealWorldReceivable contract');
|
|
93
|
+
}
|
|
94
|
+
return contract.declarePayment(receivableTokenId, paymentAmount);
|
|
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 (0, chain_1.getChainIdFromSignerOrProvider)(signer);
|
|
116
|
+
if (!chainId) {
|
|
117
|
+
throw new Error('No Chain ID found');
|
|
118
|
+
}
|
|
119
|
+
const poolInfo = chainId
|
|
120
|
+
? (_b = (_a = shared_1.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 = (0, helpers_1.getRealWorldReceivableContract)(signer, chainId);
|
|
126
|
+
if (!contract) {
|
|
127
|
+
throw new Error('Could not find RealWorldReceivable contract');
|
|
128
|
+
}
|
|
129
|
+
return contract.createRealWorldReceivable(poolInfo.pool, currencyCode, receivableAmount, maturityDate, uri, gasOpts);
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Creates a RealWorldReceivable token with metadata uploaded onto ARWeave
|
|
133
|
+
*
|
|
134
|
+
* @async
|
|
135
|
+
* @function
|
|
136
|
+
* @memberof ReceivableService
|
|
137
|
+
* @param {Web3Provider | ethers.Signer} signerOrProvider - If calling this function from a browser, this function expects a Web3Provider.
|
|
138
|
+
* If calling this function from a server, this function expects an ethers Signer. Note that privateKey only needs to be included
|
|
139
|
+
* from server calls.
|
|
140
|
+
* @param {string | null} privateKey - Private key of the wallet used to upload metadata to ARWeave. Only required if calling this function from a server.
|
|
141
|
+
* @param {number} chainId - The chain ID to mint the receivable token on and pay ARWeave funds from.
|
|
142
|
+
* @param {string} recipient - The receivable token recipient.
|
|
143
|
+
* @param {POOL_NAME} poolName - The pool name. Used to lookup the pool address to pay to.
|
|
144
|
+
* @param {POOL_TYPE} poolType - The pool type. Used to lookup the pool address to pay to.
|
|
145
|
+
* @param {number} currencyCode - The ISO 4217 currency code that the receivable is denominated in
|
|
146
|
+
* @param {number} receivableAmount - The receivable amount.
|
|
147
|
+
* @param {number} maturityDate - The maturity date of the receivable, in UNIX timestamp format.
|
|
148
|
+
* @param {JSON} metadata - The metadata in JSON format. This will be uploaded onto ARWeave
|
|
149
|
+
* @param {number} referenceId - An internal identifier value added as a tag on ARWeave, for easily querying the metadata later.
|
|
150
|
+
* @param {Array<{ name: string, value: string }>} extraTags - Any extraTags you'd like to tag your metadata with. Note that metadata on
|
|
151
|
+
* ARWeave is indexed by these tags, so make sure to include any tags that you'd like to be able to query by.
|
|
152
|
+
* @param {boolean} [lazyFund=true] - Whether to lazy fund the ARWeave uploads. If true, the ARWeave uploads will be paid for by the
|
|
153
|
+
* metadata uploader immediately before uploading. If false, the ARWeave node must be pre-funded before calling this function.
|
|
154
|
+
* @param {Overrides} [gasOpts] - Optional gas overrides for the transaction.
|
|
155
|
+
* @returns {Promise<TransactionResponse>} - The transaction receipt.
|
|
156
|
+
*/
|
|
157
|
+
async function createReceivableWithMetadata(signerOrProvider, privateKey, chainId, poolName, poolType, currencyCode, receivableAmount, maturityDate, metadata, referenceId, extraTags, lazyFund = true, gasOpts) {
|
|
158
|
+
const config = ARWeaveService_1.ARWeaveService.getBundlrNetworkConfig(chainId);
|
|
159
|
+
try {
|
|
160
|
+
const tags = [
|
|
161
|
+
{ name: 'Content-Type', value: 'application/json' },
|
|
162
|
+
{ name: 'appName', value: 'HumaFinance' },
|
|
163
|
+
{ name: 'poolName', value: poolName },
|
|
164
|
+
{ name: 'poolType', value: poolType },
|
|
165
|
+
{ name: 'referenceId', value: referenceId },
|
|
166
|
+
...extraTags,
|
|
167
|
+
];
|
|
168
|
+
const response = await ARWeaveService_1.ARWeaveService.storeData(config, signerOrProvider instanceof providers_1.Web3Provider ? signerOrProvider : privateKey, metadata, tags, lazyFund);
|
|
169
|
+
console.log(`Data uploaded ==> https://arweave.net/${response.id}`);
|
|
170
|
+
return await createReceivable(signerOrProvider instanceof providers_1.Web3Provider
|
|
171
|
+
? signerOrProvider.getSigner()
|
|
172
|
+
: signerOrProvider, poolName, poolType, currencyCode, receivableAmount, maturityDate, `https://arweave.net/${response.id}`, gasOpts);
|
|
173
|
+
}
|
|
174
|
+
catch (e) {
|
|
175
|
+
console.error(e);
|
|
176
|
+
throw e;
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* An object that contains functions to interact with Huma's receivables.
|
|
181
|
+
* @namespace ReceivableService
|
|
182
|
+
*/
|
|
183
|
+
exports.ReceivableService = {
|
|
184
|
+
createReceivableWithMetadata,
|
|
185
|
+
createReceivable,
|
|
186
|
+
declareReceivablePaymentByTokenId,
|
|
187
|
+
declareReceivablePaymentByReferenceId,
|
|
188
|
+
};
|
|
194
189
|
//# sourceMappingURL=ReceivableService.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../../src/services/ReceivableService.ts"],"names":[],"mappings":";;;;AAAA,wDAA4E;AAE5E,iDAO6B;AAC7B,2EAA8C;AAE9C,qDAAiD;AACjD,wCAA2D;AAC3D,
|
|
1
|
+
{"version":3,"file":"ReceivableService.js","sourceRoot":"","sources":["../../../src/services/ReceivableService.ts"],"names":[],"mappings":";;;;AAAA,wDAA4E;AAE5E,iDAO6B;AAC7B,2EAA8C;AAE9C,qDAAiD;AACjD,wCAA2D;AAC3D,0CAA+D;AAG/D;;;;;;;;;;GAUG;AACH,KAAK,UAAU,qCAAqC,CAClD,MAAqB,EACrB,WAAmB,EACnB,aAAqB;;IAErB,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,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,+BAAc,CAAC,gBAAgB,CAClD,OAAO,EACP,aAAa,EACb,WAAW,CACZ,CAAA;IAED,6CAA6C;IAC7C,MAAM,gBAAgB,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;GAU3B,CAAA;IAED,IAAI,kBAAkB,CAAA;IACtB,QAAQ,OAAO,EAAE;QACf,KAAK,kBAAS,CAAC,MAAM;YACnB,kBAAkB,GAAG,wEAAwE,CAAA;YAC7F,MAAK;QACP;YACE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAClE;IAED,MAAM,eAAe,GAAkC,MAAM,IAAA,yBAAO,EAClE,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,IAAA,wCAA8B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,cAAc,CAC5B,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,WAAW,CAAC,CAAC,CAAC,0CAAE,OAAQ,EACzC,aAAa,CACd,CAAA;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,iCAAiC,CAC9C,MAAqB,EACrB,iBAA+B,EAC/B,aAAqB;;IAErB,MAAM,OAAO,GAAG,MAAM,IAAA,sCAA8B,EAAC,MAAM,CAAC,CAAA;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;KACrC;IAED,MAAM,mBAAmB,GACvB,MAAA,kCAAyB,CAAC,OAAO,CAAC,0CAChC,+BAAsB,CAAC,mBAAmB,CAC3C,CAAA;IAEH,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IAED,MAAM,QAAQ,GAAG,IAAA,wCAA8B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;AAClE,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,IAAA,sCAA8B,EAAC,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,wBAAe,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,IAAA,wCAA8B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChE,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,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,+BAAc,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,+BAAc,CAAC,SAAS,CAC7C,MAAM,EACN,gBAAgB,YAAY,wBAAY,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,wBAAY;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;AACU,QAAA,iBAAiB,GAAG;IAC/B,4BAA4B;IAC5B,gBAAgB;IAChB,iCAAiC;IACjC,qCAAqC;CACtC,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 {
|
|
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:
|
|
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 {string[]} 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: string[]): 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 {};
|