@chainflip/sdk 0.1.20 → 0.2.0

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/dist/swap.d.ts CHANGED
@@ -1,87 +1,87 @@
1
- import ethers, { Signer } from 'ethers';
2
- import { C as Chain, c as chainAssets, A as Asset, a as ChainflipNetwork } from './enums-3131916c.js';
3
- export { d as Assets, e as ChainflipNetworks, b as Chains, f as assetChains, h as assetContractIds, g as assetDecimals, i as chainContractIds } from './enums-3131916c.js';
1
+ import { Signer } from 'ethers';
2
+ import { C as Chain, c as chainAssets, A as Asset, a as ChainflipNetwork, T as TransactionOptions } from './contracts-646d1727.js';
3
+ export { d as Assets, e as ChainflipNetworks, b as Chains, f as assetChains, h as assetContractIds, g as assetDecimals, i as chainContractIds } from './contracts-646d1727.js';
4
4
  import { z } from 'zod';
5
5
 
6
6
  declare const tokenSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
7
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
7
+ amount: z.ZodBigInt;
8
8
  srcChain: z.ZodLiteral<"Ethereum">;
9
9
  destChain: z.ZodLiteral<"Ethereum">;
10
10
  destAddress: z.ZodEffects<z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, `0x${string}`, `0x${string}`>;
11
11
  srcAsset: z.ZodLiteral<"FLIP">;
12
12
  destAsset: z.ZodUnion<[z.ZodLiteral<"USDC">, z.ZodLiteral<"ETH">]>;
13
13
  }, "strip", z.ZodTypeAny, {
14
- amount: string | bigint;
14
+ amount: bigint;
15
15
  srcChain: "Ethereum";
16
16
  srcAsset: "FLIP";
17
17
  destChain: "Ethereum";
18
18
  destAddress: `0x${string}`;
19
19
  destAsset: "USDC" | "ETH";
20
20
  }, {
21
- amount: string | bigint;
21
+ amount: bigint;
22
22
  srcChain: "Ethereum";
23
23
  srcAsset: "FLIP";
24
24
  destChain: "Ethereum";
25
25
  destAddress: `0x${string}`;
26
26
  destAsset: "USDC" | "ETH";
27
27
  }>, z.ZodObject<{
28
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
28
+ amount: z.ZodBigInt;
29
29
  srcChain: z.ZodLiteral<"Ethereum">;
30
30
  destChain: z.ZodLiteral<"Ethereum">;
31
31
  destAddress: z.ZodEffects<z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, `0x${string}`, `0x${string}`>;
32
32
  srcAsset: z.ZodLiteral<"USDC">;
33
33
  destAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"ETH">]>;
34
34
  }, "strip", z.ZodTypeAny, {
35
- amount: string | bigint;
35
+ amount: bigint;
36
36
  srcChain: "Ethereum";
37
37
  srcAsset: "USDC";
38
38
  destChain: "Ethereum";
39
39
  destAddress: `0x${string}`;
40
40
  destAsset: "FLIP" | "ETH";
41
41
  }, {
42
- amount: string | bigint;
42
+ amount: bigint;
43
43
  srcChain: "Ethereum";
44
44
  srcAsset: "USDC";
45
45
  destChain: "Ethereum";
46
46
  destAddress: `0x${string}`;
47
47
  destAsset: "FLIP" | "ETH";
48
48
  }>, z.ZodObject<{
49
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
49
+ amount: z.ZodBigInt;
50
50
  srcChain: z.ZodLiteral<"Ethereum">;
51
51
  destChain: z.ZodLiteral<"Polkadot">;
52
52
  destAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>]>, string | null, string>, string, string>, string, string>;
53
53
  destAsset: z.ZodLiteral<"DOT">;
54
54
  srcAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"USDC">]>;
55
55
  }, "strip", z.ZodTypeAny, {
56
- amount: string | bigint;
56
+ amount: bigint;
57
57
  srcChain: "Ethereum";
58
58
  srcAsset: "FLIP" | "USDC";
59
59
  destChain: "Polkadot";
60
60
  destAddress: string;
61
61
  destAsset: "DOT";
62
62
  }, {
63
- amount: string | bigint;
63
+ amount: bigint;
64
64
  srcChain: "Ethereum";
65
65
  srcAsset: "FLIP" | "USDC";
66
66
  destChain: "Polkadot";
67
67
  destAddress: string;
68
68
  destAsset: "DOT";
69
69
  }>, z.ZodObject<{
70
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
70
+ amount: z.ZodBigInt;
71
71
  srcChain: z.ZodLiteral<"Ethereum">;
72
72
  destChain: z.ZodLiteral<"Bitcoin">;
73
73
  destAddress: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string> | z.ZodEffects<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>, string, string>;
74
74
  destAsset: z.ZodLiteral<"BTC">;
75
75
  srcAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"USDC">]>;
76
76
  }, "strip", z.ZodTypeAny, {
77
- amount: string | bigint;
77
+ amount: bigint;
78
78
  srcChain: "Ethereum";
79
79
  srcAsset: "FLIP" | "USDC";
80
80
  destChain: "Bitcoin";
81
81
  destAddress: string;
82
82
  destAsset: "BTC";
83
83
  }, {
84
- amount: string | bigint;
84
+ amount: bigint;
85
85
  srcChain: "Ethereum";
86
86
  srcAsset: "FLIP" | "USDC";
87
87
  destChain: "Bitcoin";
@@ -89,7 +89,7 @@ declare const tokenSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
89
89
  destAsset: "BTC";
90
90
  }>]>;
91
91
  declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
92
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
92
+ amount: z.ZodBigInt;
93
93
  srcChain: z.ZodLiteral<"Ethereum">;
94
94
  srcAsset: z.ZodLiteral<"ETH">;
95
95
  destChain: z.ZodLiteral<"Ethereum">;
@@ -106,7 +106,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
106
106
  gasBudget: string;
107
107
  }>;
108
108
  }, "strip", z.ZodTypeAny, {
109
- amount: string | bigint;
109
+ amount: bigint;
110
110
  srcChain: "Ethereum";
111
111
  srcAsset: "ETH";
112
112
  destChain: "Ethereum";
@@ -117,7 +117,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
117
117
  gasBudget: string;
118
118
  };
119
119
  }, {
120
- amount: string | bigint;
120
+ amount: bigint;
121
121
  srcChain: "Ethereum";
122
122
  srcAsset: "ETH";
123
123
  destChain: "Ethereum";
@@ -128,7 +128,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
128
128
  gasBudget: string;
129
129
  };
130
130
  }>, z.ZodUnion<[z.ZodObject<{
131
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
131
+ amount: z.ZodBigInt;
132
132
  srcChain: z.ZodLiteral<"Ethereum">;
133
133
  srcAsset: z.ZodLiteral<"FLIP">;
134
134
  destChain: z.ZodLiteral<"Ethereum">;
@@ -145,7 +145,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
145
145
  gasBudget: string;
146
146
  }>;
147
147
  }, "strip", z.ZodTypeAny, {
148
- amount: string | bigint;
148
+ amount: bigint;
149
149
  srcChain: "Ethereum";
150
150
  srcAsset: "FLIP";
151
151
  destChain: "Ethereum";
@@ -156,7 +156,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
156
156
  gasBudget: string;
157
157
  };
158
158
  }, {
159
- amount: string | bigint;
159
+ amount: bigint;
160
160
  srcChain: "Ethereum";
161
161
  srcAsset: "FLIP";
162
162
  destChain: "Ethereum";
@@ -167,7 +167,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
167
167
  gasBudget: string;
168
168
  };
169
169
  }>, z.ZodObject<{
170
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
170
+ amount: z.ZodBigInt;
171
171
  srcChain: z.ZodLiteral<"Ethereum">;
172
172
  srcAsset: z.ZodLiteral<"USDC">;
173
173
  destChain: z.ZodLiteral<"Ethereum">;
@@ -184,7 +184,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
184
184
  gasBudget: string;
185
185
  }>;
186
186
  }, "strip", z.ZodTypeAny, {
187
- amount: string | bigint;
187
+ amount: bigint;
188
188
  srcChain: "Ethereum";
189
189
  srcAsset: "USDC";
190
190
  destChain: "Ethereum";
@@ -195,7 +195,7 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
195
195
  gasBudget: string;
196
196
  };
197
197
  }, {
198
- amount: string | bigint;
198
+ amount: bigint;
199
199
  srcChain: "Ethereum";
200
200
  srcAsset: "USDC";
201
201
  destChain: "Ethereum";
@@ -206,147 +206,147 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
206
206
  gasBudget: string;
207
207
  };
208
208
  }>]>, z.ZodUnion<[z.ZodObject<{
209
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
209
+ amount: z.ZodBigInt;
210
210
  srcChain: z.ZodLiteral<"Ethereum">;
211
211
  srcAsset: z.ZodLiteral<"ETH">;
212
212
  destChain: z.ZodLiteral<"Ethereum">;
213
213
  destAddress: z.ZodEffects<z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, `0x${string}`, `0x${string}`>;
214
214
  destAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"USDC">]>;
215
215
  }, "strip", z.ZodTypeAny, {
216
- amount: string | bigint;
216
+ amount: bigint;
217
217
  srcChain: "Ethereum";
218
218
  srcAsset: "ETH";
219
219
  destChain: "Ethereum";
220
220
  destAddress: `0x${string}`;
221
221
  destAsset: "FLIP" | "USDC";
222
222
  }, {
223
- amount: string | bigint;
223
+ amount: bigint;
224
224
  srcChain: "Ethereum";
225
225
  srcAsset: "ETH";
226
226
  destChain: "Ethereum";
227
227
  destAddress: `0x${string}`;
228
228
  destAsset: "FLIP" | "USDC";
229
229
  }>, z.ZodObject<{
230
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
230
+ amount: z.ZodBigInt;
231
231
  srcChain: z.ZodLiteral<"Ethereum">;
232
232
  srcAsset: z.ZodLiteral<"ETH">;
233
233
  destChain: z.ZodLiteral<"Polkadot">;
234
234
  destAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>]>, string | null, string>, string, string>, string, string>;
235
235
  destAsset: z.ZodLiteral<"DOT">;
236
236
  }, "strip", z.ZodTypeAny, {
237
- amount: string | bigint;
237
+ amount: bigint;
238
238
  srcChain: "Ethereum";
239
239
  srcAsset: "ETH";
240
240
  destChain: "Polkadot";
241
241
  destAddress: string;
242
242
  destAsset: "DOT";
243
243
  }, {
244
- amount: string | bigint;
244
+ amount: bigint;
245
245
  srcChain: "Ethereum";
246
246
  srcAsset: "ETH";
247
247
  destChain: "Polkadot";
248
248
  destAddress: string;
249
249
  destAsset: "DOT";
250
250
  }>, z.ZodObject<{
251
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
251
+ amount: z.ZodBigInt;
252
252
  srcChain: z.ZodLiteral<"Ethereum">;
253
253
  srcAsset: z.ZodLiteral<"ETH">;
254
254
  destChain: z.ZodLiteral<"Bitcoin">;
255
255
  destAddress: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string> | z.ZodEffects<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>, string, string>;
256
256
  destAsset: z.ZodLiteral<"BTC">;
257
257
  }, "strip", z.ZodTypeAny, {
258
- amount: string | bigint;
258
+ amount: bigint;
259
259
  srcChain: "Ethereum";
260
260
  srcAsset: "ETH";
261
261
  destChain: "Bitcoin";
262
262
  destAddress: string;
263
263
  destAsset: "BTC";
264
264
  }, {
265
- amount: string | bigint;
265
+ amount: bigint;
266
266
  srcChain: "Ethereum";
267
267
  srcAsset: "ETH";
268
268
  destChain: "Bitcoin";
269
269
  destAddress: string;
270
270
  destAsset: "BTC";
271
271
  }>]>, z.ZodUnion<[z.ZodObject<{
272
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
272
+ amount: z.ZodBigInt;
273
273
  srcChain: z.ZodLiteral<"Ethereum">;
274
274
  destChain: z.ZodLiteral<"Ethereum">;
275
275
  destAddress: z.ZodEffects<z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, `0x${string}`, `0x${string}`>;
276
276
  srcAsset: z.ZodLiteral<"FLIP">;
277
277
  destAsset: z.ZodUnion<[z.ZodLiteral<"USDC">, z.ZodLiteral<"ETH">]>;
278
278
  }, "strip", z.ZodTypeAny, {
279
- amount: string | bigint;
279
+ amount: bigint;
280
280
  srcChain: "Ethereum";
281
281
  srcAsset: "FLIP";
282
282
  destChain: "Ethereum";
283
283
  destAddress: `0x${string}`;
284
284
  destAsset: "USDC" | "ETH";
285
285
  }, {
286
- amount: string | bigint;
286
+ amount: bigint;
287
287
  srcChain: "Ethereum";
288
288
  srcAsset: "FLIP";
289
289
  destChain: "Ethereum";
290
290
  destAddress: `0x${string}`;
291
291
  destAsset: "USDC" | "ETH";
292
292
  }>, z.ZodObject<{
293
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
293
+ amount: z.ZodBigInt;
294
294
  srcChain: z.ZodLiteral<"Ethereum">;
295
295
  destChain: z.ZodLiteral<"Ethereum">;
296
296
  destAddress: z.ZodEffects<z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, `0x${string}`, `0x${string}`>;
297
297
  srcAsset: z.ZodLiteral<"USDC">;
298
298
  destAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"ETH">]>;
299
299
  }, "strip", z.ZodTypeAny, {
300
- amount: string | bigint;
300
+ amount: bigint;
301
301
  srcChain: "Ethereum";
302
302
  srcAsset: "USDC";
303
303
  destChain: "Ethereum";
304
304
  destAddress: `0x${string}`;
305
305
  destAsset: "FLIP" | "ETH";
306
306
  }, {
307
- amount: string | bigint;
307
+ amount: bigint;
308
308
  srcChain: "Ethereum";
309
309
  srcAsset: "USDC";
310
310
  destChain: "Ethereum";
311
311
  destAddress: `0x${string}`;
312
312
  destAsset: "FLIP" | "ETH";
313
313
  }>, z.ZodObject<{
314
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
314
+ amount: z.ZodBigInt;
315
315
  srcChain: z.ZodLiteral<"Ethereum">;
316
316
  destChain: z.ZodLiteral<"Polkadot">;
317
317
  destAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>]>, string | null, string>, string, string>, string, string>;
318
318
  destAsset: z.ZodLiteral<"DOT">;
319
319
  srcAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"USDC">]>;
320
320
  }, "strip", z.ZodTypeAny, {
321
- amount: string | bigint;
321
+ amount: bigint;
322
322
  srcChain: "Ethereum";
323
323
  srcAsset: "FLIP" | "USDC";
324
324
  destChain: "Polkadot";
325
325
  destAddress: string;
326
326
  destAsset: "DOT";
327
327
  }, {
328
- amount: string | bigint;
328
+ amount: bigint;
329
329
  srcChain: "Ethereum";
330
330
  srcAsset: "FLIP" | "USDC";
331
331
  destChain: "Polkadot";
332
332
  destAddress: string;
333
333
  destAsset: "DOT";
334
334
  }>, z.ZodObject<{
335
- amount: z.ZodUnion<[z.ZodString, z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodBigInt]>;
335
+ amount: z.ZodBigInt;
336
336
  srcChain: z.ZodLiteral<"Ethereum">;
337
337
  destChain: z.ZodLiteral<"Bitcoin">;
338
338
  destAddress: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string> | z.ZodEffects<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodEffects<z.ZodString, string, string>]>, string, string>;
339
339
  destAsset: z.ZodLiteral<"BTC">;
340
340
  srcAsset: z.ZodUnion<[z.ZodLiteral<"FLIP">, z.ZodLiteral<"USDC">]>;
341
341
  }, "strip", z.ZodTypeAny, {
342
- amount: string | bigint;
342
+ amount: bigint;
343
343
  srcChain: "Ethereum";
344
344
  srcAsset: "FLIP" | "USDC";
345
345
  destChain: "Bitcoin";
346
346
  destAddress: string;
347
347
  destAsset: "BTC";
348
348
  }, {
349
- amount: string | bigint;
349
+ amount: bigint;
350
350
  srcChain: "Ethereum";
351
351
  srcAsset: "FLIP" | "USDC";
352
352
  destChain: "Bitcoin";
@@ -355,7 +355,6 @@ declare const executeSwapParamsSchema: z.ZodUnion<[z.ZodObject<{
355
355
  }>]>]>;
356
356
  type ExecuteSwapParams = z.infer<typeof executeSwapParamsSchema>;
357
357
  type TokenSwapParams = z.infer<typeof tokenSwapParamsSchema>;
358
- type Overrides = Omit<ethers.providers.TransactionRequest, 'to' | 'data' | 'value' | 'from'>;
359
358
 
360
359
  declare const ccmMetadataSchema: z.ZodObject<{
361
360
  gasBudget: z.ZodUnion<[z.ZodType<`0x${string}`, z.ZodTypeDef, `0x${string}`>, z.ZodNumber]>;
@@ -553,8 +552,8 @@ declare class SwapSDK {
553
552
  getQuote(quoteRequest: QuoteRequest, options?: RequestOptions): Promise<QuoteResponse>;
554
553
  requestDepositAddress(depositAddressRequest: DepositAddressRequest, options?: RequestOptions): Promise<DepositAddressResponse>;
555
554
  getStatus(swapStatusRequest: SwapStatusRequest, options?: RequestOptions): Promise<SwapStatusResponse>;
556
- executeSwap(params: ExecuteSwapParams, overrides?: Overrides): Promise<TransactionHash>;
557
- approveVault(params: Pick<TokenSwapParams, 'srcAsset' | 'amount'>, overrides?: Overrides): Promise<TransactionHash | null>;
555
+ executeSwap(params: ExecuteSwapParams, txOpts?: TransactionOptions): Promise<TransactionHash>;
556
+ approveVault(params: Pick<TokenSwapParams, 'srcAsset' | 'amount'>, txOpts?: TransactionOptions): Promise<TransactionHash | null>;
558
557
  }
559
558
 
560
559
  export { Asset, AssetData, Chain, ChainData, ChainflipNetwork, DepositAddressRequest, DepositAddressResponse, QuoteRequest, QuoteResponse, SDKOptions, SwapSDK, SwapStatusRequest, SwapStatusResponse, chainAssets };