@d8x/perpetuals-sdk 0.5.0 → 0.5.2
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/README.md +0 -12
- package/dist/cjs/abi/testnet/ShareToken.json +428 -0
- package/dist/cjs/abi/zkevmTestnet/ShareToken.json +428 -0
- package/dist/cjs/config/defaultConfig.json +2 -0
- package/dist/cjs/liquidityProviderTool.d.ts +0 -26
- package/dist/cjs/liquidityProviderTool.js +0 -54
- package/dist/cjs/liquidityProviderTool.js.map +1 -1
- package/dist/cjs/marketData.d.ts +45 -0
- package/dist/cjs/marketData.js +116 -1
- package/dist/cjs/marketData.js.map +1 -1
- package/dist/cjs/nodeSDKTypes.d.ts +2 -0
- package/dist/cjs/nodeSDKTypes.js +1 -0
- package/dist/cjs/nodeSDKTypes.js.map +1 -1
- package/dist/cjs/perpetualDataHandler.d.ts +9 -3
- package/dist/cjs/perpetualDataHandler.js +13 -5
- package/dist/cjs/perpetualDataHandler.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/abi/testnet/ShareToken.json +428 -0
- package/dist/esm/abi/zkevmTestnet/ShareToken.json +428 -0
- package/dist/esm/config/defaultConfig.json +2 -0
- package/dist/esm/liquidityProviderTool.d.ts +0 -26
- package/dist/esm/liquidityProviderTool.js +1 -55
- package/dist/esm/liquidityProviderTool.js.map +1 -1
- package/dist/esm/marketData.d.ts +45 -0
- package/dist/esm/marketData.js +117 -2
- package/dist/esm/marketData.js.map +1 -1
- package/dist/esm/nodeSDKTypes.d.ts +2 -0
- package/dist/esm/nodeSDKTypes.js +1 -0
- package/dist/esm/nodeSDKTypes.js.map +1 -1
- package/dist/esm/perpetualDataHandler.d.ts +9 -3
- package/dist/esm/perpetualDataHandler.js +13 -5
- package/dist/esm/perpetualDataHandler.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/doc/d8x-perpetuals-sdk.md +322 -83
- package/doc/liquidityProviderTool.md +0 -30
- package/doc/marketData.md +70 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,18 +12,6 @@ Node TypeScript SDK for D8X Perpetual Futures
|
|
|
12
12
|
- clone this repo
|
|
13
13
|
- open directory of repo and type `yarn` to install packages
|
|
14
14
|
|
|
15
|
-
#### Optional
|
|
16
|
-
|
|
17
|
-
- Pyth recommends to run your own Pyth-price service
|
|
18
|
-
- Follow the instructions on [Wormhole Spy](https://github.com/pyth-network/pyth-crosschain/tree/main/price_service/server), specifically
|
|
19
|
-
- Copy `.env.example` into `.env` and edit as described in the Readme
|
|
20
|
-
- To run the price service, you need to build the image as described in the last [paragraph of the Readme here](https://github.com/pyth-network/pyth-crosschain/tree/main/price_service/server).
|
|
21
|
-
Ensure your own price server is enabled in docker-compose:
|
|
22
|
-
```
|
|
23
|
-
# image: public.ecr.aws/pyth-network/xc-server:v3.0.0
|
|
24
|
-
image: pyth_price_server
|
|
25
|
-
```
|
|
26
|
-
|
|
27
15
|
### Test
|
|
28
16
|
|
|
29
17
|
`yarn test`
|
|
@@ -0,0 +1,428 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"inputs": [
|
|
4
|
+
{
|
|
5
|
+
"internalType": "uint8",
|
|
6
|
+
"name": "_poolId",
|
|
7
|
+
"type": "uint8"
|
|
8
|
+
}
|
|
9
|
+
],
|
|
10
|
+
"stateMutability": "nonpayable",
|
|
11
|
+
"type": "constructor"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"anonymous": false,
|
|
15
|
+
"inputs": [
|
|
16
|
+
{
|
|
17
|
+
"indexed": true,
|
|
18
|
+
"internalType": "address",
|
|
19
|
+
"name": "owner",
|
|
20
|
+
"type": "address"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"indexed": true,
|
|
24
|
+
"internalType": "address",
|
|
25
|
+
"name": "spender",
|
|
26
|
+
"type": "address"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"indexed": false,
|
|
30
|
+
"internalType": "uint256",
|
|
31
|
+
"name": "value",
|
|
32
|
+
"type": "uint256"
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"name": "Approval",
|
|
36
|
+
"type": "event"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"anonymous": false,
|
|
40
|
+
"inputs": [
|
|
41
|
+
{
|
|
42
|
+
"indexed": true,
|
|
43
|
+
"internalType": "address",
|
|
44
|
+
"name": "previousOwner",
|
|
45
|
+
"type": "address"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"indexed": true,
|
|
49
|
+
"internalType": "address",
|
|
50
|
+
"name": "newOwner",
|
|
51
|
+
"type": "address"
|
|
52
|
+
}
|
|
53
|
+
],
|
|
54
|
+
"name": "OwnershipTransferred",
|
|
55
|
+
"type": "event"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"anonymous": false,
|
|
59
|
+
"inputs": [
|
|
60
|
+
{
|
|
61
|
+
"indexed": false,
|
|
62
|
+
"internalType": "address",
|
|
63
|
+
"name": "from",
|
|
64
|
+
"type": "address"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"indexed": false,
|
|
68
|
+
"internalType": "address",
|
|
69
|
+
"name": "to",
|
|
70
|
+
"type": "address"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"indexed": false,
|
|
74
|
+
"internalType": "uint256",
|
|
75
|
+
"name": "amountD18",
|
|
76
|
+
"type": "uint256"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"indexed": false,
|
|
80
|
+
"internalType": "uint256",
|
|
81
|
+
"name": "priceD18",
|
|
82
|
+
"type": "uint256"
|
|
83
|
+
}
|
|
84
|
+
],
|
|
85
|
+
"name": "P2PTransfer",
|
|
86
|
+
"type": "event"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"anonymous": false,
|
|
90
|
+
"inputs": [
|
|
91
|
+
{
|
|
92
|
+
"indexed": true,
|
|
93
|
+
"internalType": "address",
|
|
94
|
+
"name": "from",
|
|
95
|
+
"type": "address"
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"indexed": true,
|
|
99
|
+
"internalType": "address",
|
|
100
|
+
"name": "to",
|
|
101
|
+
"type": "address"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"indexed": false,
|
|
105
|
+
"internalType": "uint256",
|
|
106
|
+
"name": "value",
|
|
107
|
+
"type": "uint256"
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"name": "Transfer",
|
|
111
|
+
"type": "event"
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"inputs": [
|
|
115
|
+
{
|
|
116
|
+
"internalType": "address",
|
|
117
|
+
"name": "owner",
|
|
118
|
+
"type": "address"
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"internalType": "address",
|
|
122
|
+
"name": "spender",
|
|
123
|
+
"type": "address"
|
|
124
|
+
}
|
|
125
|
+
],
|
|
126
|
+
"name": "allowance",
|
|
127
|
+
"outputs": [
|
|
128
|
+
{
|
|
129
|
+
"internalType": "uint256",
|
|
130
|
+
"name": "",
|
|
131
|
+
"type": "uint256"
|
|
132
|
+
}
|
|
133
|
+
],
|
|
134
|
+
"stateMutability": "view",
|
|
135
|
+
"type": "function"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"inputs": [
|
|
139
|
+
{
|
|
140
|
+
"internalType": "address",
|
|
141
|
+
"name": "spender",
|
|
142
|
+
"type": "address"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"internalType": "uint256",
|
|
146
|
+
"name": "amount",
|
|
147
|
+
"type": "uint256"
|
|
148
|
+
}
|
|
149
|
+
],
|
|
150
|
+
"name": "approve",
|
|
151
|
+
"outputs": [
|
|
152
|
+
{
|
|
153
|
+
"internalType": "bool",
|
|
154
|
+
"name": "",
|
|
155
|
+
"type": "bool"
|
|
156
|
+
}
|
|
157
|
+
],
|
|
158
|
+
"stateMutability": "nonpayable",
|
|
159
|
+
"type": "function"
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"inputs": [
|
|
163
|
+
{
|
|
164
|
+
"internalType": "address",
|
|
165
|
+
"name": "account",
|
|
166
|
+
"type": "address"
|
|
167
|
+
}
|
|
168
|
+
],
|
|
169
|
+
"name": "balanceOf",
|
|
170
|
+
"outputs": [
|
|
171
|
+
{
|
|
172
|
+
"internalType": "uint256",
|
|
173
|
+
"name": "",
|
|
174
|
+
"type": "uint256"
|
|
175
|
+
}
|
|
176
|
+
],
|
|
177
|
+
"stateMutability": "view",
|
|
178
|
+
"type": "function"
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"inputs": [
|
|
182
|
+
{
|
|
183
|
+
"internalType": "address",
|
|
184
|
+
"name": "_account",
|
|
185
|
+
"type": "address"
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"internalType": "uint256",
|
|
189
|
+
"name": "_amount",
|
|
190
|
+
"type": "uint256"
|
|
191
|
+
}
|
|
192
|
+
],
|
|
193
|
+
"name": "burn",
|
|
194
|
+
"outputs": [],
|
|
195
|
+
"stateMutability": "nonpayable",
|
|
196
|
+
"type": "function"
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"inputs": [],
|
|
200
|
+
"name": "decimals",
|
|
201
|
+
"outputs": [
|
|
202
|
+
{
|
|
203
|
+
"internalType": "uint8",
|
|
204
|
+
"name": "",
|
|
205
|
+
"type": "uint8"
|
|
206
|
+
}
|
|
207
|
+
],
|
|
208
|
+
"stateMutability": "view",
|
|
209
|
+
"type": "function"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"inputs": [
|
|
213
|
+
{
|
|
214
|
+
"internalType": "address",
|
|
215
|
+
"name": "spender",
|
|
216
|
+
"type": "address"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"internalType": "uint256",
|
|
220
|
+
"name": "subtractedValue",
|
|
221
|
+
"type": "uint256"
|
|
222
|
+
}
|
|
223
|
+
],
|
|
224
|
+
"name": "decreaseAllowance",
|
|
225
|
+
"outputs": [
|
|
226
|
+
{
|
|
227
|
+
"internalType": "bool",
|
|
228
|
+
"name": "",
|
|
229
|
+
"type": "bool"
|
|
230
|
+
}
|
|
231
|
+
],
|
|
232
|
+
"stateMutability": "nonpayable",
|
|
233
|
+
"type": "function"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"inputs": [
|
|
237
|
+
{
|
|
238
|
+
"internalType": "address",
|
|
239
|
+
"name": "spender",
|
|
240
|
+
"type": "address"
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"internalType": "uint256",
|
|
244
|
+
"name": "addedValue",
|
|
245
|
+
"type": "uint256"
|
|
246
|
+
}
|
|
247
|
+
],
|
|
248
|
+
"name": "increaseAllowance",
|
|
249
|
+
"outputs": [
|
|
250
|
+
{
|
|
251
|
+
"internalType": "bool",
|
|
252
|
+
"name": "",
|
|
253
|
+
"type": "bool"
|
|
254
|
+
}
|
|
255
|
+
],
|
|
256
|
+
"stateMutability": "nonpayable",
|
|
257
|
+
"type": "function"
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"inputs": [
|
|
261
|
+
{
|
|
262
|
+
"internalType": "address",
|
|
263
|
+
"name": "_account",
|
|
264
|
+
"type": "address"
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"internalType": "uint256",
|
|
268
|
+
"name": "_amount",
|
|
269
|
+
"type": "uint256"
|
|
270
|
+
}
|
|
271
|
+
],
|
|
272
|
+
"name": "mint",
|
|
273
|
+
"outputs": [],
|
|
274
|
+
"stateMutability": "nonpayable",
|
|
275
|
+
"type": "function"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"inputs": [],
|
|
279
|
+
"name": "name",
|
|
280
|
+
"outputs": [
|
|
281
|
+
{
|
|
282
|
+
"internalType": "string",
|
|
283
|
+
"name": "",
|
|
284
|
+
"type": "string"
|
|
285
|
+
}
|
|
286
|
+
],
|
|
287
|
+
"stateMutability": "view",
|
|
288
|
+
"type": "function"
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"inputs": [],
|
|
292
|
+
"name": "owner",
|
|
293
|
+
"outputs": [
|
|
294
|
+
{
|
|
295
|
+
"internalType": "address",
|
|
296
|
+
"name": "",
|
|
297
|
+
"type": "address"
|
|
298
|
+
}
|
|
299
|
+
],
|
|
300
|
+
"stateMutability": "view",
|
|
301
|
+
"type": "function"
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"inputs": [],
|
|
305
|
+
"name": "poolId",
|
|
306
|
+
"outputs": [
|
|
307
|
+
{
|
|
308
|
+
"internalType": "uint8",
|
|
309
|
+
"name": "",
|
|
310
|
+
"type": "uint8"
|
|
311
|
+
}
|
|
312
|
+
],
|
|
313
|
+
"stateMutability": "view",
|
|
314
|
+
"type": "function"
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"inputs": [],
|
|
318
|
+
"name": "renounceOwnership",
|
|
319
|
+
"outputs": [],
|
|
320
|
+
"stateMutability": "nonpayable",
|
|
321
|
+
"type": "function"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"inputs": [
|
|
325
|
+
{
|
|
326
|
+
"internalType": "address",
|
|
327
|
+
"name": "_account",
|
|
328
|
+
"type": "address"
|
|
329
|
+
}
|
|
330
|
+
],
|
|
331
|
+
"name": "setTransferRestricted",
|
|
332
|
+
"outputs": [],
|
|
333
|
+
"stateMutability": "nonpayable",
|
|
334
|
+
"type": "function"
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"inputs": [],
|
|
338
|
+
"name": "symbol",
|
|
339
|
+
"outputs": [
|
|
340
|
+
{
|
|
341
|
+
"internalType": "string",
|
|
342
|
+
"name": "",
|
|
343
|
+
"type": "string"
|
|
344
|
+
}
|
|
345
|
+
],
|
|
346
|
+
"stateMutability": "view",
|
|
347
|
+
"type": "function"
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
"inputs": [],
|
|
351
|
+
"name": "totalSupply",
|
|
352
|
+
"outputs": [
|
|
353
|
+
{
|
|
354
|
+
"internalType": "uint256",
|
|
355
|
+
"name": "",
|
|
356
|
+
"type": "uint256"
|
|
357
|
+
}
|
|
358
|
+
],
|
|
359
|
+
"stateMutability": "view",
|
|
360
|
+
"type": "function"
|
|
361
|
+
},
|
|
362
|
+
{
|
|
363
|
+
"inputs": [
|
|
364
|
+
{
|
|
365
|
+
"internalType": "address",
|
|
366
|
+
"name": "to",
|
|
367
|
+
"type": "address"
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"internalType": "uint256",
|
|
371
|
+
"name": "amount",
|
|
372
|
+
"type": "uint256"
|
|
373
|
+
}
|
|
374
|
+
],
|
|
375
|
+
"name": "transfer",
|
|
376
|
+
"outputs": [
|
|
377
|
+
{
|
|
378
|
+
"internalType": "bool",
|
|
379
|
+
"name": "",
|
|
380
|
+
"type": "bool"
|
|
381
|
+
}
|
|
382
|
+
],
|
|
383
|
+
"stateMutability": "nonpayable",
|
|
384
|
+
"type": "function"
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"inputs": [
|
|
388
|
+
{
|
|
389
|
+
"internalType": "address",
|
|
390
|
+
"name": "from",
|
|
391
|
+
"type": "address"
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"internalType": "address",
|
|
395
|
+
"name": "to",
|
|
396
|
+
"type": "address"
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"internalType": "uint256",
|
|
400
|
+
"name": "amount",
|
|
401
|
+
"type": "uint256"
|
|
402
|
+
}
|
|
403
|
+
],
|
|
404
|
+
"name": "transferFrom",
|
|
405
|
+
"outputs": [
|
|
406
|
+
{
|
|
407
|
+
"internalType": "bool",
|
|
408
|
+
"name": "",
|
|
409
|
+
"type": "bool"
|
|
410
|
+
}
|
|
411
|
+
],
|
|
412
|
+
"stateMutability": "nonpayable",
|
|
413
|
+
"type": "function"
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"inputs": [
|
|
417
|
+
{
|
|
418
|
+
"internalType": "address",
|
|
419
|
+
"name": "newOwner",
|
|
420
|
+
"type": "address"
|
|
421
|
+
}
|
|
422
|
+
],
|
|
423
|
+
"name": "transferOwnership",
|
|
424
|
+
"outputs": [],
|
|
425
|
+
"stateMutability": "nonpayable",
|
|
426
|
+
"type": "function"
|
|
427
|
+
}
|
|
428
|
+
]
|