@imtbl/sdk 0.31.1 → 0.31.2-alpha

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 (53) hide show
  1. package/.eslintrc +13 -0
  2. package/.gitignore +8 -0
  3. package/blockchain_data.js +1 -0
  4. package/checkout_sdk.js +9 -0
  5. package/config.js +1 -0
  6. package/dist/browser/checkout/sdk.js +2 -2
  7. package/dist/browser/checkout/widgets.js +1 -1
  8. package/dist/index.browser.js +4 -4
  9. package/dist/index.browser.js.map +1 -1
  10. package/immutablex_client.js +1 -0
  11. package/index.cjs +9 -0
  12. package/index.d.ts +18603 -0
  13. package/index.js +9 -0
  14. package/module-release.json +30 -0
  15. package/orderbook.js +1 -0
  16. package/package.json +24 -18
  17. package/passport.js +1 -0
  18. package/provider.js +1 -0
  19. package/rollup.config.js +158 -0
  20. package/scripts/copyBrowserBundles.js +62 -0
  21. package/scripts/generate-package-list.sh +5 -0
  22. package/scripts/generateIndex.js +44 -0
  23. package/scripts/updateDependencies.js +137 -0
  24. package/scripts/updateExports.js +62 -0
  25. package/src/blockchain_data.ts +1 -0
  26. package/src/checkout_sdk.ts +1 -0
  27. package/src/checkout_widgets.ts +1 -0
  28. package/src/config.ts +1 -0
  29. package/src/immutablex_client.ts +1 -0
  30. package/src/index.ts +7 -0
  31. package/src/orderbook.ts +1 -0
  32. package/src/passport.ts +1 -0
  33. package/src/provider.ts +1 -0
  34. package/tsconfig.json +27 -0
  35. package/typedoc.json +4 -0
  36. package/workspace-packages.json +31 -0
  37. package/dist/blockchain_data.js +0 -4010
  38. package/dist/checkout_sdk.js +0 -26016
  39. package/dist/config.js +0 -37
  40. package/dist/immutablex_client.js +0 -523
  41. package/dist/index.cjs +0 -34452
  42. package/dist/index.js +0 -34424
  43. package/dist/orderbook.js +0 -1583
  44. package/dist/passport.js +0 -9159
  45. package/dist/provider.js +0 -1165
  46. /package/{dist/blockchain_data.d.ts → blockchain_data.d.ts} +0 -0
  47. /package/{dist/checkout_sdk.d.ts → checkout_sdk.d.ts} +0 -0
  48. /package/{dist/config.d.ts → config.d.ts} +0 -0
  49. /package/{dist/immutablex_client.d.ts → immutablex_client.d.ts} +0 -0
  50. /package/{dist/index.d.ts → index.d.cts} +0 -0
  51. /package/{dist/orderbook.d.ts → orderbook.d.ts} +0 -0
  52. /package/{dist/passport.d.ts → passport.d.ts} +0 -0
  53. /package/{dist/provider.d.ts → provider.d.ts} +0 -0
package/dist/provider.js DELETED
@@ -1,1165 +0,0 @@
1
- import { Config, TransfersApi, OrdersApi, UsersApi, Contracts, TradesApi, ExchangesApi, WithdrawalsApi, MintsApi, DepositsApi, EncodingApi, TokensApi } from '@imtbl/core-sdk';
2
- import BN from 'bn.js';
3
- import * as encUtils from 'enc-utils';
4
- import { AxiosError } from 'axios';
5
- import { parseUnits } from '@ethersproject/units';
6
- import { BigNumber } from '@ethersproject/bignumber';
7
- import { ethers } from 'ethers';
8
- import detectEthereumProvider from '@metamask/detect-provider';
9
-
10
- // used to sign message with L1 keys. Used for registration
11
- function serializeEthSignature(sig) {
12
- // This is because golang appends a recovery param
13
- // https://github.com/ethers-io/ethers.js/issues/823
14
- return encUtils.addHexPrefix(encUtils.padLeft(sig.r.toString(16), 64)
15
- + encUtils.padLeft(sig.s.toString(16), 64)
16
- + encUtils.padLeft(sig.recoveryParam?.toString(16) || '', 2));
17
- }
18
- function importRecoveryParam(v) {
19
- const isValidBigNumber = new BN(v, 16).cmp(new BN(27)) !== -1
20
- ? new BN(v, 16).sub(new BN(27)).toNumber()
21
- : new BN(v, 16).toNumber();
22
- return v.trim()
23
- ? isValidBigNumber
24
- : undefined;
25
- }
26
- // used chained with serializeEthSignature. serializeEthSignature(deserializeSignature(...))
27
- function deserializeSignature(sig, size = 64) {
28
- const removedHexPrefixSig = encUtils.removeHexPrefix(sig);
29
- return {
30
- r: new BN(removedHexPrefixSig.substring(0, size), 'hex'),
31
- s: new BN(removedHexPrefixSig.substring(size, size * 2), 'hex'),
32
- recoveryParam: importRecoveryParam(removedHexPrefixSig.substring(size * 2, size * 2 + 2)),
33
- };
34
- }
35
- async function signRaw(payload, signer) {
36
- const signature = deserializeSignature(await signer.signMessage(payload));
37
- return serializeEthSignature(signature);
38
- }
39
- async function signMessage(message, signer) {
40
- const ethAddress = await signer.getAddress();
41
- const ethSignature = await signRaw(message, signer);
42
- return {
43
- message,
44
- ethAddress,
45
- ethSignature,
46
- };
47
- }
48
-
49
- /**
50
- * Helper method to convert token type to a SignableToken type
51
- * @param token - the token type to convert to a SignableToken type
52
- * @returns the converted SignableToken
53
- */
54
- function convertToSignableToken(token) {
55
- switch (token.type) {
56
- case 'ERC721':
57
- return {
58
- type: 'ERC721',
59
- data: {
60
- token_id: token.tokenId,
61
- token_address: token.tokenAddress,
62
- },
63
- };
64
- case 'ERC20':
65
- return {
66
- type: 'ERC20',
67
- data: {
68
- token_address: token.tokenAddress,
69
- },
70
- };
71
- case 'ETH':
72
- default:
73
- return {
74
- type: 'ETH',
75
- data: {
76
- decimals: 18,
77
- },
78
- };
79
- }
80
- }
81
-
82
- var Environment;
83
- (function (Environment) {
84
- Environment["PRODUCTION"] = "production";
85
- Environment["SANDBOX"] = "sandbox";
86
- })(Environment || (Environment = {}));
87
-
88
- function isChainValid(chainID, config) {
89
- return chainID === config.ethConfiguration.chainID;
90
- }
91
- async function validateChain(signer, config) {
92
- const chainID = await signer.getChainId();
93
- if (!isChainValid(chainID, config)) {
94
- throw new Error('The wallet used for this operation is not connected to the correct network.');
95
- }
96
- }
97
-
98
- async function transfer({ signers: { ethSigner, starkSigner }, request, config, }) {
99
- await validateChain(ethSigner, config.immutableXConfig);
100
- const ethAddress = await ethSigner.getAddress();
101
- const transfersApi = new TransfersApi(config.immutableXConfig.apiConfiguration);
102
- const transferAmount = request.type === 'ERC721' ? '1' : request.amount;
103
- const signableResult = await transfersApi.getSignableTransferV1({
104
- getSignableTransferRequest: {
105
- sender: ethAddress,
106
- token: convertToSignableToken(request),
107
- amount: transferAmount,
108
- receiver: request.receiver,
109
- },
110
- });
111
- const { signable_message: signableMessage, payload_hash: payloadHash } = signableResult.data;
112
- const ethSignature = await signRaw(signableMessage, ethSigner);
113
- const starkSignature = await starkSigner.signMessage(payloadHash);
114
- const transferSigningParams = {
115
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
116
- sender_stark_key: signableResult.data.sender_stark_key,
117
- sender_vault_id: signableResult.data.sender_vault_id,
118
- receiver_stark_key: signableResult.data.receiver_stark_key,
119
- receiver_vault_id: signableResult.data.receiver_vault_id,
120
- asset_id: signableResult.data.asset_id,
121
- amount: signableResult.data.amount,
122
- nonce: signableResult.data.nonce,
123
- expiration_timestamp: signableResult.data.expiration_timestamp,
124
- stark_signature: starkSignature,
125
- };
126
- const response = await transfersApi.createTransferV1({
127
- createTransferRequest: transferSigningParams,
128
- xImxEthAddress: ethAddress,
129
- xImxEthSignature: ethSignature,
130
- });
131
- return {
132
- sent_signature: response?.data.sent_signature,
133
- status: response?.data.status?.toString(),
134
- time: response?.data.time,
135
- transfer_id: response?.data.transfer_id,
136
- };
137
- }
138
- async function batchTransfer({ signers: { ethSigner, starkSigner }, request, config, }) {
139
- await validateChain(ethSigner, config.immutableXConfig);
140
- const ethAddress = await ethSigner.getAddress();
141
- const transfersApi = new TransfersApi(config.immutableXConfig.apiConfiguration);
142
- const signableRequests = request.map((nftTransfer) => ({
143
- amount: '1',
144
- token: convertToSignableToken({
145
- type: 'ERC721',
146
- tokenId: nftTransfer.tokenId,
147
- tokenAddress: nftTransfer.tokenAddress,
148
- }),
149
- receiver: nftTransfer.receiver,
150
- }));
151
- const signableResult = await transfersApi.getSignableTransfer({
152
- getSignableTransferRequestV2: {
153
- sender_ether_key: ethAddress,
154
- signable_requests: signableRequests,
155
- },
156
- });
157
- const signableMessage = signableResult.data.signable_message;
158
- if (signableMessage === undefined) {
159
- throw new Error('Invalid response from Signable registration offchain');
160
- }
161
- const ethSignature = await signRaw(signableMessage, ethSigner);
162
- const requests = [];
163
- for (const resp of signableResult.data.signable_responses) {
164
- // TODO: remove once fixed
165
- // eslint-disable-next-line no-await-in-loop
166
- const starkSignature = await starkSigner.signMessage(resp.payload_hash);
167
- const req = {
168
- sender_vault_id: resp.sender_vault_id,
169
- receiver_stark_key: resp.receiver_stark_key,
170
- receiver_vault_id: resp.receiver_vault_id,
171
- asset_id: resp.asset_id,
172
- amount: resp.amount,
173
- nonce: resp.nonce,
174
- expiration_timestamp: resp.expiration_timestamp,
175
- stark_signature: starkSignature,
176
- };
177
- requests.push(req);
178
- }
179
- // TODO: throw error on missing payload hash?
180
- const transferSigningParams = {
181
- sender_stark_key: signableResult.data.sender_stark_key,
182
- requests,
183
- };
184
- const response = await transfersApi.createTransfer({
185
- createTransferRequestV2: transferSigningParams,
186
- xImxEthAddress: ethAddress,
187
- xImxEthSignature: ethSignature,
188
- });
189
- return {
190
- transfer_ids: response?.data.transfer_ids,
191
- };
192
- }
193
-
194
- async function createOrder({ signers, request, config, }) {
195
- await validateChain(signers.ethSigner, config.immutableXConfig);
196
- const ethAddress = await signers.ethSigner.getAddress();
197
- const ordersApi = new OrdersApi(config.immutableXConfig.apiConfiguration);
198
- const amountSell = request.sell.type === 'ERC721' ? '1' : request.sell.amount;
199
- const amountBuy = request.buy.type === 'ERC721' ? '1' : request.buy.amount;
200
- const getSignableOrderRequest = {
201
- user: ethAddress,
202
- amount_buy: amountBuy,
203
- token_buy: convertToSignableToken(request.buy),
204
- amount_sell: amountSell,
205
- token_sell: convertToSignableToken(request.sell),
206
- fees: request.fees,
207
- expiration_timestamp: request.expiration_timestamp,
208
- };
209
- const getSignableOrderResponse = await ordersApi.getSignableOrder({
210
- getSignableOrderRequestV3: getSignableOrderRequest,
211
- });
212
- const { signable_message: signableMessage, payload_hash: payloadHash } = getSignableOrderResponse.data;
213
- const ethSignature = await signRaw(signableMessage, signers.ethSigner);
214
- const starkSignature = await signers.starkSigner.signMessage(payloadHash);
215
- const resp = getSignableOrderResponse.data;
216
- const orderParams = {
217
- createOrderRequest: {
218
- amount_buy: resp.amount_buy,
219
- amount_sell: resp.amount_sell,
220
- asset_id_buy: resp.asset_id_buy,
221
- asset_id_sell: resp.asset_id_sell,
222
- expiration_timestamp: resp.expiration_timestamp,
223
- fees: request.fees,
224
- nonce: resp.nonce,
225
- stark_key: resp.stark_key,
226
- stark_signature: starkSignature,
227
- vault_id_buy: resp.vault_id_buy,
228
- vault_id_sell: resp.vault_id_sell,
229
- },
230
- xImxEthAddress: ethAddress,
231
- xImxEthSignature: ethSignature,
232
- };
233
- const createOrderResponse = await ordersApi.createOrderV3(orderParams);
234
- return {
235
- ...createOrderResponse.data,
236
- };
237
- }
238
- async function cancelOrder({ signers, request, config, }) {
239
- const ordersApi = new OrdersApi(config.immutableXConfig.apiConfiguration);
240
- const getSignableCancelOrderResponse = await ordersApi.getSignableCancelOrderV3({
241
- getSignableCancelOrderRequest: {
242
- order_id: request.order_id,
243
- },
244
- });
245
- const { signable_message: signableMessage, payload_hash: payloadHash } = getSignableCancelOrderResponse.data;
246
- const ethSignature = await signRaw(signableMessage, signers.ethSigner);
247
- const starkSignature = await signers.starkSigner.signMessage(payloadHash);
248
- const ethAddress = await signers.ethSigner.getAddress();
249
- const cancelOrderResponse = await ordersApi.cancelOrderV3({
250
- id: request.order_id.toString(),
251
- cancelOrderRequest: {
252
- order_id: request.order_id,
253
- stark_signature: starkSignature,
254
- },
255
- xImxEthAddress: ethAddress,
256
- xImxEthSignature: ethSignature,
257
- });
258
- return {
259
- order_id: cancelOrderResponse.data.order_id,
260
- status: cancelOrderResponse.data.status,
261
- };
262
- }
263
-
264
- async function registerOffchain(signers, config) {
265
- await validateChain(signers.ethSigner, config.immutableXConfig);
266
- const usersApi = new UsersApi(config.immutableXConfig.apiConfiguration);
267
- const userAddress = await signers.ethSigner.getAddress();
268
- const starkPublicKey = await signers.starkSigner.getAddress();
269
- const signableResult = await usersApi.getSignableRegistrationOffchain({
270
- getSignableRegistrationRequest: {
271
- ether_key: userAddress,
272
- stark_key: starkPublicKey,
273
- },
274
- });
275
- const { signable_message: signableMessage, payload_hash: payloadHash } = signableResult.data;
276
- const ethSignature = await signRaw(signableMessage, signers.ethSigner);
277
- const starkSignature = await signers.starkSigner.signMessage(payloadHash);
278
- const registeredUser = await usersApi.registerUser({
279
- registerUserRequest: {
280
- eth_signature: ethSignature,
281
- ether_key: userAddress,
282
- stark_signature: starkSignature,
283
- stark_key: starkPublicKey,
284
- },
285
- });
286
- return registeredUser.data;
287
- }
288
- async function isRegisteredOffchain(ethAddress, config) {
289
- try {
290
- const usersApi = new UsersApi(config.immutableXConfig.apiConfiguration);
291
- const getUsersResult = await usersApi.getUsers({
292
- user: ethAddress,
293
- });
294
- const { accounts } = getUsersResult.data;
295
- return accounts?.length > 0;
296
- }
297
- catch (ex) {
298
- if (ex instanceof AxiosError && ex.response?.status === 404) {
299
- return false;
300
- }
301
- throw ex;
302
- }
303
- }
304
- async function isRegisteredOnChain(starkPublicKey, ethSigner, config) {
305
- await validateChain(ethSigner, config.immutableXConfig);
306
- const registrationContract = Contracts.Registration.connect(config.immutableXConfig.ethConfiguration.registrationContractAddress, ethSigner);
307
- try {
308
- return await registrationContract.isRegistered(starkPublicKey);
309
- }
310
- catch (ex) {
311
- if (ex.reason === 'USER_UNREGISTERED') {
312
- return false;
313
- }
314
- throw ex;
315
- }
316
- }
317
- async function getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi) {
318
- const response = await usersApi.getSignableRegistration({
319
- getSignableRegistrationRequest: {
320
- ether_key: etherKey,
321
- stark_key: starkPublicKey,
322
- },
323
- });
324
- return {
325
- operator_signature: response.data.operator_signature,
326
- payload_hash: response.data.payload_hash,
327
- readable_transaction: response.data.readable_transaction,
328
- verification_signature: response.data.verification_signature,
329
- };
330
- }
331
-
332
- const assertIsDefined = (value) => {
333
- if (value !== undefined)
334
- return value;
335
- throw new Error('undefined field exception');
336
- };
337
- async function prepareWithdrawalAction(params) {
338
- const { signers: { ethSigner, starkSigner }, type, config, } = params;
339
- await validateChain(ethSigner, params.config);
340
- const withdrawalsApi = new WithdrawalsApi(config.apiConfiguration);
341
- const withdrawalAmount = type === 'ERC721' ? '1' : params.amount;
342
- const signableWithdrawalResult = await withdrawalsApi.getSignableWithdrawal({
343
- getSignableWithdrawalRequest: {
344
- user: await ethSigner.getAddress(),
345
- token: convertToSignableToken(params),
346
- amount: withdrawalAmount,
347
- },
348
- });
349
- const { signable_message: signableMessage, payload_hash: payloadHash } = signableWithdrawalResult.data;
350
- const starkSignature = await starkSigner.signMessage(payloadHash);
351
- const { ethAddress, ethSignature } = await signMessage(signableMessage, ethSigner);
352
- const prepareWithdrawalResponse = await withdrawalsApi.createWithdrawal({
353
- createWithdrawalRequest: {
354
- stark_key: assertIsDefined(signableWithdrawalResult.data.stark_key),
355
- amount: withdrawalAmount,
356
- asset_id: assertIsDefined(signableWithdrawalResult.data.asset_id),
357
- vault_id: assertIsDefined(signableWithdrawalResult.data.vault_id),
358
- nonce: assertIsDefined(signableWithdrawalResult.data.nonce),
359
- stark_signature: starkSignature,
360
- },
361
- xImxEthAddress: ethAddress,
362
- xImxEthSignature: ethSignature,
363
- });
364
- return prepareWithdrawalResponse.data;
365
- }
366
-
367
- async function getEncodeAssetInfo(assetType, tokenType, config, tokenData) {
368
- const encodingApi = new EncodingApi(config.apiConfiguration);
369
- const result = await encodingApi.encodeAsset({
370
- assetType,
371
- encodeAssetRequest: {
372
- token: {
373
- type: tokenType,
374
- ...(tokenData && { data: tokenData }),
375
- },
376
- },
377
- });
378
- return result.data;
379
- }
380
-
381
- async function executeRegisterAndWithdrawERC20({ ethSigner, assetType, starkPublicKey, config, }) {
382
- const etherKey = await ethSigner.getAddress();
383
- const imxConfig = config.immutableXConfig;
384
- const usersApi = new UsersApi(imxConfig.apiConfiguration);
385
- const signableResult = await getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi);
386
- const contract = Contracts.Registration.connect(config.immutableXConfig.ethConfiguration.registrationContractAddress, ethSigner);
387
- const populatedTransaction = await contract.populateTransaction.registerAndWithdraw(etherKey, starkPublicKey, signableResult.operator_signature, assetType);
388
- return ethSigner.sendTransaction(populatedTransaction);
389
- }
390
- async function executeWithdrawERC20(ethSigner, assetType, starkPublicKey, config) {
391
- const contract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
392
- const populatedTransaction = await contract.populateTransaction.withdraw(starkPublicKey, assetType);
393
- return ethSigner.sendTransaction(populatedTransaction);
394
- }
395
- async function completeERC20WithdrawalAction({ ethSigner, starkPublicKey, token, config, }) {
396
- await validateChain(ethSigner, config.immutableXConfig);
397
- const imxConfig = config.immutableXConfig;
398
- const assetType = await getEncodeAssetInfo('asset', 'ERC20', imxConfig, {
399
- token_address: token.tokenAddress,
400
- });
401
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
402
- if (!isRegistered) {
403
- return executeRegisterAndWithdrawERC20({
404
- ethSigner,
405
- assetType: assetType.asset_type,
406
- starkPublicKey,
407
- config,
408
- });
409
- }
410
- return executeWithdrawERC20(ethSigner, assetType.asset_type, starkPublicKey, imxConfig);
411
- }
412
-
413
- async function executeWithdrawMintableERC721(ethSigner, assetType, starkPublicKey, mintingBlob, config) {
414
- const contract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
415
- const populatedTransaction = await contract.populateTransaction.withdrawAndMint(starkPublicKey, assetType, mintingBlob);
416
- return ethSigner.sendTransaction(populatedTransaction);
417
- }
418
- async function executeRegisterAndWithdrawMintableERC721(ethSigner, assetType, starkPublicKey, mintingBlob, config) {
419
- const etherKey = await ethSigner.getAddress();
420
- const usersApi = new UsersApi(config.apiConfiguration);
421
- const signableResult = await getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi);
422
- const contract = Contracts.Registration.connect(config.ethConfiguration.registrationContractAddress, ethSigner);
423
- const populatedTransaction = await contract.populateTransaction.regsiterAndWithdrawAndMint(etherKey, starkPublicKey, signableResult.operator_signature, assetType, mintingBlob);
424
- return ethSigner.sendTransaction(populatedTransaction);
425
- }
426
- function getMintingBlob(token) {
427
- const { id } = token.data;
428
- const blueprint = token.data.blueprint || '';
429
- return encUtils.sanitizeHex(encUtils.utf8ToHex(`{${id}}:{${blueprint}}`));
430
- }
431
- async function completeMintableERC721Withdrawal(ethSigner, starkPublicKey, token, config) {
432
- const imxConfig = config.immutableXConfig;
433
- const assetType = await getEncodeAssetInfo('mintable-asset', 'ERC721', imxConfig, {
434
- id: token.data.id,
435
- token_address: token.data.tokenAddress,
436
- ...(token.data.blueprint && { blueprint: token.data.blueprint }),
437
- });
438
- const mintingBlob = getMintingBlob(token);
439
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
440
- if (!isRegistered) {
441
- return executeRegisterAndWithdrawMintableERC721(ethSigner, assetType.asset_type, starkPublicKey, mintingBlob, imxConfig);
442
- }
443
- return executeWithdrawMintableERC721(ethSigner, assetType.asset_type, starkPublicKey, mintingBlob, imxConfig);
444
- }
445
- async function executeRegisterAndWithdrawERC721(ethSigner, assetType, starkPublicKey, tokenId, config) {
446
- const etherKey = await ethSigner.getAddress();
447
- const usersApi = new UsersApi(config.apiConfiguration);
448
- const signableResult = await getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi);
449
- const contract = Contracts.Registration.connect(config.ethConfiguration.registrationContractAddress, ethSigner);
450
- const populatedTransaction = await contract.populateTransaction.registerAndWithdrawNft(etherKey, starkPublicKey, signableResult.operator_signature, assetType, tokenId);
451
- return ethSigner.sendTransaction(populatedTransaction);
452
- }
453
- async function executeWithdrawERC721(ethSigner, assetType, starkPublicKey, tokenId, config) {
454
- const contract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
455
- const populatedTransaction = await contract.populateTransaction.withdrawNft(starkPublicKey, assetType, tokenId);
456
- return ethSigner.sendTransaction(populatedTransaction);
457
- }
458
- async function completeERC721Withdrawal(ethSigner, starkPublicKey, token, config) {
459
- const imxConfig = config.immutableXConfig;
460
- const assetType = await getEncodeAssetInfo('asset', 'ERC721', imxConfig, {
461
- token_id: token.tokenId,
462
- token_address: token.tokenAddress,
463
- });
464
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
465
- if (!isRegistered) {
466
- return executeRegisterAndWithdrawERC721(ethSigner, assetType.asset_type, starkPublicKey, token.tokenId, imxConfig);
467
- }
468
- return executeWithdrawERC721(ethSigner, assetType.asset_type, starkPublicKey, token.tokenId, imxConfig);
469
- }
470
- async function completeERC721WithdrawalAction({ ethSigner, starkPublicKey, token, config, }) {
471
- await validateChain(ethSigner, config.immutableXConfig);
472
- const { tokenAddress } = token;
473
- const { tokenId } = token;
474
- const imxConfig = config.immutableXConfig;
475
- const mintsApi = new MintsApi(imxConfig.apiConfiguration);
476
- return await mintsApi
477
- .getMintableTokenDetailsByClientTokenId({
478
- tokenAddress,
479
- tokenId,
480
- })
481
- .then((mintableToken) => completeMintableERC721Withdrawal(ethSigner, starkPublicKey, {
482
- type: 'ERC721',
483
- data: {
484
- id: tokenId,
485
- tokenAddress,
486
- blueprint: mintableToken.data.blueprint,
487
- },
488
- }, config))
489
- .catch((error) => {
490
- if (error.response?.status === 404) {
491
- // token is already minted on L1
492
- return completeERC721Withdrawal(ethSigner, starkPublicKey, token, config);
493
- }
494
- throw error; // unable to recover from any other kind of error
495
- });
496
- }
497
-
498
- async function executeRegisterAndWithdrawEth(ethSigner, assetType, starkPublicKey, config) {
499
- const etherKey = await ethSigner.getAddress();
500
- const usersApi = new UsersApi(config.apiConfiguration);
501
- const signableResult = await getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi);
502
- const contract = Contracts.Registration.connect(config.ethConfiguration.registrationContractAddress, ethSigner);
503
- const populatedTransaction = await contract.populateTransaction.registerAndWithdraw(etherKey, starkPublicKey, signableResult.operator_signature, assetType);
504
- return ethSigner.sendTransaction(populatedTransaction);
505
- }
506
- async function executeWithdrawEth(ethSigner, assetType, starkPublicKey, config) {
507
- const contract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
508
- const populatedTransaction = await contract.populateTransaction.withdraw(starkPublicKey, assetType);
509
- return ethSigner.sendTransaction(populatedTransaction);
510
- }
511
- async function completeEthWithdrawalAction({ ethSigner, starkPublicKey, config, }) {
512
- await validateChain(ethSigner, config.immutableXConfig);
513
- const imxConfig = config.immutableXConfig;
514
- const assetType = await getEncodeAssetInfo('asset', 'ETH', imxConfig);
515
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
516
- if (!isRegistered) {
517
- return executeRegisterAndWithdrawEth(ethSigner, assetType.asset_type, starkPublicKey, imxConfig);
518
- }
519
- return executeWithdrawEth(ethSigner, assetType.asset_type, starkPublicKey, imxConfig);
520
- }
521
-
522
- async function prepareWithdrawal({ signers, withdrawal, config, }) {
523
- return prepareWithdrawalAction({
524
- signers,
525
- config: config.immutableXConfig,
526
- ...withdrawal,
527
- });
528
- }
529
- // TODO: remove once fixed
530
- // eslint-disable-next-line consistent-return
531
- async function completeWithdrawal({ signers: { ethSigner }, starkPublicKey, token, config, }) {
532
- // TODO: please add a reasonable default here
533
- // eslint-disable-next-line default-case
534
- switch (token.type) {
535
- case 'ETH':
536
- return completeEthWithdrawalAction({ ethSigner, starkPublicKey, config });
537
- case 'ERC20':
538
- return completeERC20WithdrawalAction({
539
- ethSigner,
540
- starkPublicKey,
541
- token,
542
- config,
543
- });
544
- case 'ERC721':
545
- return completeERC721WithdrawalAction({
546
- ethSigner,
547
- starkPublicKey,
548
- token,
549
- config,
550
- });
551
- }
552
- }
553
-
554
- async function createTrade({ signers: { ethSigner, starkSigner }, request, config, }) {
555
- await validateChain(ethSigner, config.immutableXConfig);
556
- const ethAddress = await ethSigner.getAddress();
557
- const tradesApi = new TradesApi(config.immutableXConfig.apiConfiguration);
558
- const signableResult = await tradesApi.getSignableTrade({
559
- getSignableTradeRequest: {
560
- user: ethAddress,
561
- order_id: request.order_id,
562
- fees: request.fees,
563
- },
564
- });
565
- const { signable_message: signableMessage, payload_hash: payloadHash } = signableResult.data;
566
- const ethSignature = await signRaw(signableMessage, ethSigner);
567
- const starkSignature = await starkSigner.signMessage(payloadHash);
568
- const createTradeResponse = await tradesApi.createTradeV3({
569
- createTradeRequest: {
570
- amount_buy: signableResult.data.amount_buy,
571
- amount_sell: signableResult.data.amount_sell,
572
- asset_id_buy: signableResult.data.asset_id_buy,
573
- asset_id_sell: signableResult.data.asset_id_sell,
574
- expiration_timestamp: signableResult.data.expiration_timestamp,
575
- fee_info: signableResult.data.fee_info,
576
- fees: request.fees,
577
- include_fees: true,
578
- nonce: signableResult.data.nonce,
579
- order_id: request.order_id,
580
- stark_key: signableResult.data.stark_key,
581
- vault_id_buy: signableResult.data.vault_id_buy,
582
- vault_id_sell: signableResult.data.vault_id_sell,
583
- stark_signature: starkSignature,
584
- },
585
- xImxEthAddress: ethAddress,
586
- xImxEthSignature: ethSignature,
587
- });
588
- return createTradeResponse.data;
589
- }
590
-
591
- async function executeRegisterAndDepositEth(ethSigner, amount, assetType, starkPublicKey, vaultId, config, usersApi) {
592
- const etherKey = await ethSigner.getAddress();
593
- const coreContract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
594
- const signableResult = await getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi);
595
- const populatedTransaction = await coreContract.populateTransaction.registerAndDepositEth(etherKey, starkPublicKey, signableResult.operator_signature, assetType, vaultId);
596
- return ethSigner.sendTransaction({ ...populatedTransaction, value: amount });
597
- }
598
- async function executeDepositEth(ethSigner, amount, assetType, starkPublicKey, vaultId, config) {
599
- const coreContract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
600
- const populatedTransaction = await coreContract.populateTransaction['deposit(uint256,uint256,uint256)'](starkPublicKey, assetType, vaultId);
601
- return ethSigner.sendTransaction({ ...populatedTransaction, value: amount });
602
- }
603
- async function depositEth({ signers: { ethSigner }, deposit, config, }) {
604
- await validateChain(ethSigner, config.immutableXConfig);
605
- const user = await ethSigner.getAddress();
606
- const data = {
607
- decimals: 18,
608
- };
609
- const amount = parseUnits(deposit.amount, 'wei');
610
- const imxConfig = config.immutableXConfig;
611
- const depositsApi = new DepositsApi(imxConfig.apiConfiguration);
612
- const encodingApi = new EncodingApi(imxConfig.apiConfiguration);
613
- const usersApi = new UsersApi(imxConfig.apiConfiguration);
614
- const getSignableDepositRequest = {
615
- user,
616
- token: {
617
- type: deposit.type,
618
- data,
619
- },
620
- amount: amount.toString(),
621
- };
622
- const signableDepositResult = await depositsApi.getSignableDeposit({
623
- getSignableDepositRequest,
624
- });
625
- const encodingResult = await encodingApi.encodeAsset({
626
- assetType: 'asset',
627
- encodeAssetRequest: {
628
- token: {
629
- type: deposit.type,
630
- },
631
- },
632
- });
633
- const assetType = encodingResult.data.asset_type;
634
- const starkPublicKey = signableDepositResult.data.stark_key;
635
- const vaultId = signableDepositResult.data.vault_id;
636
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
637
- if (!isRegistered) {
638
- return executeRegisterAndDepositEth(ethSigner, amount, assetType, starkPublicKey, vaultId, imxConfig, usersApi);
639
- }
640
- return executeDepositEth(ethSigner, amount, assetType, starkPublicKey, vaultId, imxConfig);
641
- }
642
-
643
- async function executeRegisterAndDepositERC20(ethSigner, quantizedAmount, assetType, starkPublicKey, vaultId, config, usersApi) {
644
- const etherKey = await ethSigner.getAddress();
645
- const coreContract = Contracts.Core.connect(config.coreContractAddress, ethSigner);
646
- const signableResult = await getSignableRegistrationOnchain(etherKey, starkPublicKey, usersApi);
647
- const populatedTransaction = await coreContract.populateTransaction.registerAndDepositERC20(etherKey, starkPublicKey, signableResult.operator_signature, assetType, vaultId, quantizedAmount);
648
- return ethSigner.sendTransaction(populatedTransaction);
649
- }
650
- async function executeDepositERC20(ethSigner, quantizedAmount, assetType, starkPublicKey, vaultId, config) {
651
- const coreContract = Contracts.Core.connect(config.coreContractAddress, ethSigner);
652
- const populatedTransaction = await coreContract.populateTransaction.depositERC20(starkPublicKey, assetType, vaultId, quantizedAmount);
653
- return ethSigner.sendTransaction(populatedTransaction);
654
- }
655
- async function depositERC20({ signers: { ethSigner }, deposit, config, }) {
656
- await validateChain(ethSigner, config.immutableXConfig);
657
- const { apiConfiguration, ethConfiguration } = config.immutableXConfig;
658
- const user = await ethSigner.getAddress();
659
- const tokensApi = new TokensApi(apiConfiguration);
660
- const depositsApi = new DepositsApi(apiConfiguration);
661
- const encodingApi = new EncodingApi(apiConfiguration);
662
- const usersApi = new UsersApi(apiConfiguration);
663
- // Get decimals for this specific ERC20
664
- const token = await tokensApi.getToken({ address: deposit.tokenAddress });
665
- // TODO: remove once fixed
666
- // eslint-disable-next-line radix
667
- const decimals = parseInt(token.data.decimals);
668
- const data = {
669
- decimals,
670
- token_address: deposit.tokenAddress,
671
- };
672
- const amount = parseUnits(deposit.amount, 0); // 0 to always use undecimalized value
673
- // Approve whether an amount of token from an account can be spent by a third-party account
674
- const tokenContract = Contracts.IERC20.connect(deposit.tokenAddress, ethSigner);
675
- const approveTransaction = await tokenContract.populateTransaction.approve(ethConfiguration.coreContractAddress, amount);
676
- await ethSigner.sendTransaction(approveTransaction);
677
- const getSignableDepositRequest = {
678
- user,
679
- token: {
680
- type: deposit.type,
681
- data,
682
- },
683
- amount: amount.toString(),
684
- };
685
- const signableDepositResult = await depositsApi.getSignableDeposit({
686
- getSignableDepositRequest,
687
- });
688
- // Perform encoding on asset details to get an assetType (required for stark contract request)
689
- const encodingResult = await encodingApi.encodeAsset({
690
- assetType: 'asset',
691
- encodeAssetRequest: {
692
- token: {
693
- type: deposit.type,
694
- data: {
695
- token_address: deposit.tokenAddress,
696
- },
697
- },
698
- },
699
- });
700
- const assetType = encodingResult.data.asset_type;
701
- const starkPublicKey = signableDepositResult.data.stark_key;
702
- const vaultId = signableDepositResult.data.vault_id;
703
- const quantizedAmount = BigNumber.from(signableDepositResult.data.amount);
704
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
705
- if (!isRegistered) {
706
- return executeRegisterAndDepositERC20(ethSigner, quantizedAmount, assetType, starkPublicKey, vaultId, ethConfiguration, usersApi);
707
- }
708
- return executeDepositERC20(ethSigner, quantizedAmount, assetType, starkPublicKey, vaultId, ethConfiguration);
709
- }
710
-
711
- async function executeDepositERC721(ethSigner, tokenId, assetType, starkPublicKey, vaultId, config) {
712
- const coreContract = Contracts.Core.connect(config.ethConfiguration.coreContractAddress, ethSigner);
713
- const populatedTransaction = await coreContract.populateTransaction.depositNft(starkPublicKey, assetType, vaultId, tokenId);
714
- return ethSigner.sendTransaction(populatedTransaction);
715
- }
716
- async function depositERC721({ signers: { ethSigner }, deposit, config, }) {
717
- await validateChain(ethSigner, config.immutableXConfig);
718
- const user = await ethSigner.getAddress();
719
- const { immutableXConfig } = config;
720
- const depositsApi = new DepositsApi(immutableXConfig.apiConfiguration);
721
- const encodingApi = new EncodingApi(immutableXConfig.apiConfiguration);
722
- const usersApi = new UsersApi(immutableXConfig.apiConfiguration);
723
- const data = {
724
- token_address: deposit.tokenAddress,
725
- token_id: deposit.tokenId,
726
- };
727
- const amount = '1';
728
- const getSignableDepositRequest = {
729
- user,
730
- token: {
731
- type: deposit.type,
732
- data,
733
- },
734
- amount: amount.toString(),
735
- };
736
- const signableDepositResult = await depositsApi.getSignableDeposit({
737
- getSignableDepositRequest,
738
- });
739
- // Perform encoding on asset details to get an assetType (required for stark contract request)
740
- const encodingResult = await encodingApi.encodeAsset({
741
- assetType: 'asset',
742
- encodeAssetRequest: {
743
- token: {
744
- type: deposit.type,
745
- data: {
746
- token_address: deposit.tokenAddress,
747
- token_id: deposit.tokenId,
748
- },
749
- },
750
- },
751
- });
752
- const assetType = encodingResult.data.asset_type;
753
- const starkPublicKey = signableDepositResult.data.stark_key;
754
- const vaultId = signableDepositResult.data.vault_id;
755
- const isRegistered = await isRegisteredOnChain(starkPublicKey, ethSigner, config);
756
- // Approve whether an amount of token from an account can be spent by a third-party account
757
- const tokenContract = Contracts.IERC721.connect(deposit.tokenAddress, ethSigner);
758
- const operator = immutableXConfig.ethConfiguration.coreContractAddress;
759
- const isApprovedForAll = await tokenContract.isApprovedForAll(user, operator);
760
- if (!isApprovedForAll) {
761
- await tokenContract.setApprovalForAll(operator, true);
762
- }
763
- if (!isRegistered) {
764
- const signableResult = await getSignableRegistrationOnchain(user, starkPublicKey, usersApi);
765
- const coreContract = Contracts.Core.connect(immutableXConfig.ethConfiguration.coreContractAddress, ethSigner);
766
- // Note: proxy registration contract registerAndDepositNft method is not used as
767
- // it currently fails erc721 transfer ownership check
768
- await coreContract.registerUser(user, starkPublicKey, signableResult.operator_signature);
769
- }
770
- return executeDepositERC721(ethSigner, deposit.tokenId, assetType, starkPublicKey, vaultId, immutableXConfig);
771
- }
772
-
773
- // TODO: remove once fixed deposit variable shadowing
774
- // eslint-disable-next-line consistent-return, @typescript-eslint/no-shadow
775
- async function deposit({ signers, deposit, config }) {
776
- // TODO: please add a reasonable default here
777
- // eslint-disable-next-line default-case
778
- switch (deposit.type) {
779
- case 'ETH':
780
- return depositEth({ signers, deposit, config });
781
- case 'ERC20':
782
- return depositERC20({ signers, deposit, config });
783
- case 'ERC721':
784
- return depositERC721({ signers, deposit, config });
785
- }
786
- }
787
-
788
- async function exchangeTransfer({ signers, request, config, }) {
789
- await validateChain(signers.ethSigner, config.immutableXConfig);
790
- const exchangeApi = new ExchangesApi(config.immutableXConfig.apiConfiguration);
791
- const ethAddress = await signers.ethSigner.getAddress();
792
- const transferAmount = request.amount;
793
- const signableResult = await exchangeApi.getExchangeSignableTransfer({
794
- id: request.transactionID,
795
- getSignableTransferRequest: {
796
- sender: ethAddress,
797
- token: convertToSignableToken(request),
798
- amount: transferAmount,
799
- receiver: request.receiver,
800
- },
801
- });
802
- const { signable_message: signableMessage, payload_hash: payloadHash } = signableResult.data;
803
- const ethSignature = await signRaw(signableMessage, signers.ethSigner);
804
- const starkSignature = await signers.starkSigner.signMessage(payloadHash);
805
- const transferSigningParams = {
806
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
807
- sender_stark_key: signableResult.data.sender_stark_key,
808
- sender_vault_id: signableResult.data.sender_vault_id,
809
- receiver_stark_key: signableResult.data.receiver_stark_key,
810
- receiver_vault_id: signableResult.data.receiver_vault_id,
811
- asset_id: signableResult.data.asset_id,
812
- amount: signableResult.data.amount,
813
- nonce: signableResult.data.nonce,
814
- expiration_timestamp: signableResult.data.expiration_timestamp,
815
- stark_signature: starkSignature,
816
- };
817
- const response = await exchangeApi.createExchangeTransfer({
818
- id: request.transactionID,
819
- createTransferRequest: transferSigningParams,
820
- xImxEthAddress: ethAddress,
821
- xImxEthSignature: ethSignature,
822
- });
823
- return {
824
- sent_signature: response?.data.sent_signature,
825
- status: response?.data.status?.toString(),
826
- time: response?.data.time,
827
- transfer_id: response?.data.transfer_id,
828
- };
829
- }
830
-
831
- class GenericIMXProvider {
832
- config;
833
- signers;
834
- constructor(config, ethSigner, starkSigner) {
835
- this.config = config;
836
- this.signers = { ethSigner, starkSigner };
837
- }
838
- async getAddress() {
839
- return this.signers.ethSigner.getAddress();
840
- }
841
- async isRegisteredOffchain() {
842
- const ethAddress = await this.getAddress();
843
- return isRegisteredOffchain(ethAddress, this.config);
844
- }
845
- registerOffchain() {
846
- return registerOffchain(this.signers, this.config);
847
- }
848
- batchNftTransfer(request) {
849
- return batchTransfer({
850
- signers: this.signers,
851
- request,
852
- config: this.config,
853
- });
854
- }
855
- cancelOrder(request) {
856
- return cancelOrder({
857
- signers: this.signers,
858
- request,
859
- config: this.config,
860
- });
861
- }
862
- completeWithdrawal(starkPublicKey, token) {
863
- return completeWithdrawal({
864
- config: this.config,
865
- signers: this.signers,
866
- token,
867
- starkPublicKey,
868
- });
869
- }
870
- createOrder(request) {
871
- return createOrder({
872
- signers: this.signers,
873
- request,
874
- config: this.config,
875
- });
876
- }
877
- createTrade(request) {
878
- return createTrade({
879
- signers: this.signers,
880
- request,
881
- config: this.config,
882
- });
883
- }
884
- deposit(tokenAmount) {
885
- return deposit({
886
- signers: this.signers,
887
- deposit: tokenAmount,
888
- config: this.config,
889
- });
890
- }
891
- exchangeTransfer(request) {
892
- return exchangeTransfer({
893
- signers: this.signers,
894
- request,
895
- config: this.config,
896
- });
897
- }
898
- async isRegisteredOnchain() {
899
- const starkPublicKey = await this.signers.starkSigner.getAddress();
900
- return isRegisteredOnChain(starkPublicKey, this.signers.ethSigner, this.config);
901
- }
902
- prepareWithdrawal(request) {
903
- return prepareWithdrawal({
904
- signers: this.signers,
905
- withdrawal: request,
906
- config: this.config,
907
- });
908
- }
909
- transfer(request) {
910
- return transfer({
911
- signers: this.signers,
912
- request,
913
- config: this.config,
914
- });
915
- }
916
- }
917
-
918
- const WALLET_ACTION = {
919
- // TODO: remove once fixed - consider using an enum
920
- // eslint-disable-next-line @typescript-eslint/naming-convention
921
- SWITCH_CHAIN: 'wallet_switchEthereumChain',
922
- // eslint-disable-next-line @typescript-eslint/naming-convention
923
- CONNECT: 'eth_requestAccounts',
924
- };
925
- function isRequestableProvider(provider) {
926
- return !!provider?.request;
927
- }
928
- async function connectProvider(provider, chainID) {
929
- await provider.request({ method: WALLET_ACTION.CONNECT });
930
- if (chainID) {
931
- await provider.request({
932
- method: WALLET_ACTION.SWITCH_CHAIN,
933
- params: [{ chainId: `0x${chainID.toString(16)}` }],
934
- });
935
- }
936
- }
937
-
938
- const ERRORS = {
939
- // TODO: remove once fixed - consider using something in line with the naming convention
940
- // eslint-disable-next-line @typescript-eslint/naming-convention
941
- PROVIDER_NOT_FOUND: 'The Metamask provider was not found',
942
- };
943
- async function connect$1({ chainID, }) {
944
- const provider = (await detectEthereumProvider());
945
- if (!isRequestableProvider(provider)) {
946
- throw new Error(ERRORS.PROVIDER_NOT_FOUND);
947
- }
948
- await connectProvider(provider, chainID);
949
- // NOTE: if we want to listen to Metamask events in the future, we can add a
950
- // listener here.
951
- return new ethers.providers.Web3Provider(provider);
952
- }
953
-
954
- const COMMUNICATION_TYPE = 'message';
955
- var RequestEventType;
956
- (function (RequestEventType) {
957
- RequestEventType["GET_CONNECTION_REQUEST"] = "GET_CONNECTION_REQUEST";
958
- RequestEventType["CONNECT_WALLET_REQUEST"] = "CONNECT_WALLET_REQUEST";
959
- RequestEventType["SIGN_MESSAGE_REQUEST"] = "SIGN_MESSAGE_REQUEST";
960
- RequestEventType["DISCONNECT_WALLET_REQUEST"] = "DISCONNECT_WALLET_REQUEST";
961
- })(RequestEventType || (RequestEventType = {}));
962
- var ResponseEventType;
963
- (function (ResponseEventType) {
964
- ResponseEventType["CONNECT_WALLET_RESPONSE"] = "CONNECT_WALLET_RESPONSE";
965
- ResponseEventType["SIGN_MESSAGE_RESPONSE"] = "SIGN_MESSAGE_RESPONSE";
966
- ResponseEventType["GET_CONNECTION_RESPONSE"] = "GET_CONNECTION_RESPONSE";
967
- ResponseEventType["DISCONNECT_WALLET_RESPONSE"] = "DISCONNECT_WALLET_RESPONSE";
968
- })(ResponseEventType || (ResponseEventType = {}));
969
-
970
- function postRequestMessage(iframe, payload) {
971
- if (iframe && iframe.contentWindow) {
972
- iframe.contentWindow.postMessage(payload, new URL(iframe.src).origin);
973
- }
974
- }
975
-
976
- function messageResponseListener(iframe, event, eventType, callback) {
977
- if (iframe && event.source !== iframe.contentWindow) {
978
- return;
979
- }
980
- const l2WalletMessage = event.data;
981
- if (l2WalletMessage.type !== eventType) {
982
- return;
983
- }
984
- callback(l2WalletMessage.details);
985
- }
986
-
987
- class ImxSigner {
988
- publicAddress;
989
- iframe;
990
- constructor(publicAddress, iframe) {
991
- this.publicAddress = publicAddress;
992
- this.iframe = iframe;
993
- }
994
- getAddress() {
995
- return this.publicAddress;
996
- }
997
- signMessage(rawMessage) {
998
- return new Promise((resolve, reject) => {
999
- const listener = (event) => {
1000
- messageResponseListener(this.iframe, event, ResponseEventType.SIGN_MESSAGE_RESPONSE, (messageDetails) => {
1001
- window.removeEventListener(COMMUNICATION_TYPE, listener);
1002
- if (!messageDetails.success) {
1003
- reject(new Error(messageDetails.error?.message));
1004
- }
1005
- resolve(messageDetails.data.signedMessage);
1006
- });
1007
- };
1008
- window.addEventListener(COMMUNICATION_TYPE, listener);
1009
- postRequestMessage(this.iframe, {
1010
- type: RequestEventType.SIGN_MESSAGE_REQUEST,
1011
- details: { starkPublicKey: this.publicAddress, message: rawMessage },
1012
- });
1013
- });
1014
- }
1015
- getIFrame() {
1016
- return this.iframe;
1017
- }
1018
- }
1019
-
1020
- const IMX_WALLET_IFRAME_ID = 'imx-wallet-app';
1021
- const IMX_WALLET_IFRAME_HOSTS = {
1022
- [Environment.SANDBOX]: 'https://wallets.sandbox.immutable.com',
1023
- [Environment.PRODUCTION]: 'https://wallets.immutable.com',
1024
- };
1025
- const IMX_WALLET_IFRAME_STYLE = 'display: none;';
1026
- function getIFrame() {
1027
- return document.querySelector(`iframe#${IMX_WALLET_IFRAME_ID}`);
1028
- }
1029
- async function setupIFrame(env) {
1030
- return new Promise((resolve) => {
1031
- const iframe = document.createElement('iframe');
1032
- iframe.setAttribute('id', IMX_WALLET_IFRAME_ID);
1033
- iframe.setAttribute('src', IMX_WALLET_IFRAME_HOSTS[env]);
1034
- iframe.setAttribute('style', IMX_WALLET_IFRAME_STYLE);
1035
- document.body.appendChild(iframe);
1036
- iframe.onload = () => resolve(iframe);
1037
- });
1038
- }
1039
- async function getOrSetupIFrame(env) {
1040
- const iframe = getIFrame();
1041
- if (iframe)
1042
- return iframe;
1043
- return await setupIFrame(env);
1044
- }
1045
-
1046
- const DEFAULT_CONNECTION_MESSAGE = 'Only sign this request if you’ve initiated an action with Immutable X.';
1047
- const CONNECTION_FAILED_ERROR = 'The L2 IMX Wallet connection has failed';
1048
- async function connect(l1Provider, env) {
1049
- const l1Signer = l1Provider.getSigner();
1050
- const address = await l1Signer.getAddress();
1051
- const signature = await l1Signer.signMessage(DEFAULT_CONNECTION_MESSAGE);
1052
- const iframe = await getOrSetupIFrame(env);
1053
- return new Promise((resolve, reject) => {
1054
- const listener = (event) => {
1055
- messageResponseListener(iframe, event, ResponseEventType.CONNECT_WALLET_RESPONSE, (messageDetails) => {
1056
- window.removeEventListener(COMMUNICATION_TYPE, listener);
1057
- if (!messageDetails.success) {
1058
- reject(new Error(CONNECTION_FAILED_ERROR));
1059
- }
1060
- resolve(new ImxSigner(messageDetails.data.starkPublicKey, iframe));
1061
- });
1062
- };
1063
- window.addEventListener(COMMUNICATION_TYPE, listener);
1064
- postRequestMessage(iframe, {
1065
- type: RequestEventType.CONNECT_WALLET_REQUEST,
1066
- details: { ethAddress: address, signature },
1067
- });
1068
- });
1069
- }
1070
- async function disconnect(imxSigner) {
1071
- const iframe = imxSigner.getIFrame();
1072
- return new Promise((resolve, reject) => {
1073
- const listener = (event) => {
1074
- messageResponseListener(iframe, event, ResponseEventType.DISCONNECT_WALLET_RESPONSE, (messageDetails) => {
1075
- window.removeEventListener(COMMUNICATION_TYPE, listener);
1076
- if (!messageDetails.success && messageDetails.error) {
1077
- reject(messageDetails.error);
1078
- }
1079
- iframe.remove();
1080
- resolve();
1081
- });
1082
- };
1083
- window.addEventListener(COMMUNICATION_TYPE, listener);
1084
- postRequestMessage(iframe, {
1085
- type: RequestEventType.DISCONNECT_WALLET_REQUEST,
1086
- details: { starkPublicKey: imxSigner.getAddress() },
1087
- });
1088
- });
1089
- }
1090
-
1091
- var ProviderErrorType;
1092
- (function (ProviderErrorType) {
1093
- ProviderErrorType["PROVIDER_CONNECTION_ERROR"] = "PROVIDER_CONNECTION_ERROR";
1094
- ProviderErrorType["WALLET_CONNECTION_ERROR"] = "WALLET_CONNECTION_ERROR";
1095
- })(ProviderErrorType || (ProviderErrorType = {}));
1096
- class ProviderError extends Error {
1097
- type;
1098
- constructor(message, type) {
1099
- super(message);
1100
- this.type = type;
1101
- }
1102
- }
1103
- const withProviderError = async (fn, customError) => {
1104
- try {
1105
- return await fn();
1106
- }
1107
- catch (error) {
1108
- const errorMessage = customError.message || `${error.message}` || 'UnknownError';
1109
- throw new ProviderError(errorMessage, customError.type);
1110
- }
1111
- };
1112
-
1113
- class MetaMaskIMXProvider extends GenericIMXProvider {
1114
- static imxSigner;
1115
- static async connect(config) {
1116
- return await withProviderError(async () => {
1117
- const metaMaskProvider = await connect$1({
1118
- chainID: config.immutableXConfig.ethConfiguration.chainID,
1119
- });
1120
- this.imxSigner = await connect(metaMaskProvider, config.baseConfig.environment);
1121
- return new MetaMaskIMXProvider(config, metaMaskProvider.getSigner(), this.imxSigner);
1122
- }, { type: ProviderErrorType.WALLET_CONNECTION_ERROR });
1123
- }
1124
- static async disconnect() {
1125
- if (!this.imxSigner) {
1126
- throw new ProviderError('Attempted to disconnect from the MetaMask IMX provider without an established connection', ProviderErrorType.PROVIDER_CONNECTION_ERROR);
1127
- }
1128
- return withProviderError(async () => {
1129
- await disconnect(this.imxSigner);
1130
- }, { type: ProviderErrorType.PROVIDER_CONNECTION_ERROR });
1131
- }
1132
- static async signMessage(message) {
1133
- if (!this.imxSigner) {
1134
- throw new ProviderError('Attempted to sign a message with the MetaMask IMX provider without an established connection', ProviderErrorType.PROVIDER_CONNECTION_ERROR);
1135
- }
1136
- return withProviderError(async () => await this.imxSigner.signMessage(message), { type: ProviderErrorType.PROVIDER_CONNECTION_ERROR });
1137
- }
1138
- }
1139
-
1140
- class ProviderConfiguration {
1141
- immutableXConfig;
1142
- baseConfig;
1143
- constructor({ baseConfig, overrides }) {
1144
- this.baseConfig = baseConfig;
1145
- if (overrides) {
1146
- this.immutableXConfig = overrides.immutableXConfig;
1147
- }
1148
- else {
1149
- // TODO: remove once a sensible default is chosen
1150
- // eslint-disable-next-line default-case
1151
- switch (baseConfig.environment) {
1152
- case Environment.SANDBOX: {
1153
- this.immutableXConfig = Config.SANDBOX;
1154
- break;
1155
- }
1156
- case Environment.PRODUCTION: {
1157
- this.immutableXConfig = Config.PRODUCTION;
1158
- break;
1159
- }
1160
- }
1161
- }
1162
- }
1163
- }
1164
-
1165
- export { GenericIMXProvider, MetaMaskIMXProvider, ProviderConfiguration };