@d8x/perpetuals-sdk 0.9.20 → 0.9.21
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/cjs/accountTrade.d.ts +40 -37
- package/dist/cjs/accountTrade.js +42 -39
- package/dist/cjs/accountTrade.js.map +1 -1
- package/dist/cjs/brokerTool.d.ts +46 -14
- package/dist/cjs/brokerTool.js +46 -14
- package/dist/cjs/brokerTool.js.map +1 -1
- package/dist/cjs/d8XMath.d.ts +5 -5
- package/dist/cjs/d8XMath.js +5 -5
- package/dist/cjs/liquidatorTool.d.ts +7 -7
- package/dist/cjs/liquidatorTool.js +7 -7
- package/dist/cjs/liquidityProviderTool.d.ts +5 -5
- package/dist/cjs/liquidityProviderTool.js +5 -5
- package/dist/cjs/marketData.d.ts +333 -68
- package/dist/cjs/marketData.js +323 -70
- package/dist/cjs/marketData.js.map +1 -1
- package/dist/cjs/nodeSDKTypes.d.ts +34 -35
- package/dist/cjs/orderExecutorTool.d.ts +68 -10
- package/dist/cjs/orderExecutorTool.js +68 -10
- package/dist/cjs/orderExecutorTool.js.map +1 -1
- package/dist/cjs/perpetualDataHandler.d.ts +17 -2
- package/dist/cjs/perpetualDataHandler.js +17 -2
- package/dist/cjs/perpetualDataHandler.js.map +1 -1
- package/dist/cjs/traderDigests.d.ts +1 -1
- package/dist/cjs/traderDigests.js +1 -1
- package/dist/cjs/traderDigests.js.map +1 -1
- package/dist/cjs/traderInterface.d.ts +100 -2
- package/dist/cjs/traderInterface.js +100 -6
- package/dist/cjs/traderInterface.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/accountTrade.d.ts +40 -37
- package/dist/esm/accountTrade.js +42 -39
- package/dist/esm/accountTrade.js.map +1 -1
- package/dist/esm/brokerTool.d.ts +46 -14
- package/dist/esm/brokerTool.js +46 -14
- package/dist/esm/brokerTool.js.map +1 -1
- package/dist/esm/d8XMath.d.ts +5 -5
- package/dist/esm/d8XMath.js +5 -5
- package/dist/esm/liquidatorTool.d.ts +7 -7
- package/dist/esm/liquidatorTool.js +7 -7
- package/dist/esm/liquidityProviderTool.d.ts +5 -5
- package/dist/esm/liquidityProviderTool.js +5 -5
- package/dist/esm/marketData.d.ts +333 -68
- package/dist/esm/marketData.js +323 -70
- package/dist/esm/marketData.js.map +1 -1
- package/dist/esm/nodeSDKTypes.d.ts +34 -35
- package/dist/esm/orderExecutorTool.d.ts +68 -10
- package/dist/esm/orderExecutorTool.js +68 -10
- package/dist/esm/orderExecutorTool.js.map +1 -1
- package/dist/esm/perpetualDataHandler.d.ts +17 -2
- package/dist/esm/perpetualDataHandler.js +17 -2
- package/dist/esm/perpetualDataHandler.js.map +1 -1
- package/dist/esm/traderDigests.d.ts +1 -1
- package/dist/esm/traderDigests.js +1 -1
- package/dist/esm/traderDigests.js.map +1 -1
- package/dist/esm/traderInterface.d.ts +100 -2
- package/dist/esm/traderInterface.js +100 -6
- package/dist/esm/traderInterface.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/doc/accountTrade.md +44 -38
- package/doc/brokerTool.md +55 -14
- package/doc/d8x-perpetuals-sdk.md +1236 -635
- package/doc/liquidatorTool.md +7 -7
- package/doc/liquidityProviderTool.md +5 -5
- package/doc/marketData.md +351 -238
- package/doc/orderExecutorTool.md +83 -29
- package/package.json +1 -1
- package/src/accountTrade.ts +42 -39
- package/src/brokerTool.ts +46 -14
- package/src/d8XMath.ts +5 -5
- package/src/liquidatorTool.ts +7 -7
- package/src/liquidityProviderTool.ts +5 -5
- package/src/marketData.ts +336 -71
- package/src/nodeSDKTypes.ts +34 -35
- package/src/orderExecutorTool.ts +68 -10
- package/src/perpetualDataHandler.ts +22 -3
- package/src/traderDigests.ts +1 -1
- package/src/traderInterface.ts +100 -7
- package/src/version.ts +1 -1
- package/doc/orderReferrerTool.md +0 -0
|
@@ -20,8 +20,8 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
20
20
|
* import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
21
21
|
* async function main() {
|
|
22
22
|
* console.log(AccountTrade);
|
|
23
|
-
* // load configuration for
|
|
24
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
23
|
+
* // load configuration for Polygon zkEVM Tesnet
|
|
24
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
25
25
|
* // AccountTrade (authentication required, PK is an environment variable with a private key)
|
|
26
26
|
* const pk: string = <string>process.env.PK;
|
|
27
27
|
* let accTrade = new AccountTrade(config, pk);
|
|
@@ -42,7 +42,7 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
42
42
|
* async function main() {
|
|
43
43
|
* console.log(AccountTrade);
|
|
44
44
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
45
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
45
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
46
46
|
* const pk: string = <string>process.env.PK;
|
|
47
47
|
* let accTrade = new AccountTrade(config, pk);
|
|
48
48
|
* await accTrade.createProxyInstance();
|
|
@@ -64,14 +64,14 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
64
64
|
* async function main() {
|
|
65
65
|
* console.log(AccountTrade);
|
|
66
66
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
67
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
67
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
68
68
|
* const pk: string = <string>process.env.PK;
|
|
69
|
-
*
|
|
69
|
+
* const accTrade = new AccountTrade(config, pk);
|
|
70
70
|
* await accTrade.createProxyInstance();
|
|
71
71
|
* // set allowance
|
|
72
72
|
* await accTrade.setAllowance("MATIC");
|
|
73
73
|
* // set an order
|
|
74
|
-
*
|
|
74
|
+
* const order: Order = {
|
|
75
75
|
* symbol: "MATIC-USD-MATIC",
|
|
76
76
|
* side: "BUY",
|
|
77
77
|
* type: "MARKET",
|
|
@@ -79,34 +79,7 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
79
79
|
* leverage: 2,
|
|
80
80
|
* executionTimestamp: Date.now()/1000,
|
|
81
81
|
* };
|
|
82
|
-
*
|
|
83
|
-
* console.log(orderTransaction);
|
|
84
|
-
* }
|
|
85
|
-
* main();
|
|
86
|
-
*
|
|
87
|
-
* @example
|
|
88
|
-
* import { AccountTrade, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
|
|
89
|
-
* async function main() {
|
|
90
|
-
* console.log(AccountTrade);
|
|
91
|
-
* // setup (authentication required, PK is an environment variable with a private key)
|
|
92
|
-
* const config = PerpetualDataHandler.readSDKConfig("testnet");
|
|
93
|
-
* const pk: string = <string>process.env.PK;
|
|
94
|
-
* let accTrade = new AccountTrade(config, pk);
|
|
95
|
-
* await accTrade.createProxyInstance();
|
|
96
|
-
* // set allowance
|
|
97
|
-
* await accTrade.setAllowance("MATIC");
|
|
98
|
-
* // set an order
|
|
99
|
-
* let order: Order = {
|
|
100
|
-
* symbol: "MATIC-USD-MATIC",
|
|
101
|
-
* side: "BUY",
|
|
102
|
-
* type: "LIMIT",
|
|
103
|
-
* limitPrice: 1,
|
|
104
|
-
* quantity: 5,
|
|
105
|
-
* leverage: 2,
|
|
106
|
-
* executionTimestamp: Date.now() / 1000,
|
|
107
|
-
* deadline: Date.now() / 1000 + 8*60*60, // order expires 8 hours from now
|
|
108
|
-
* };
|
|
109
|
-
* let orderTransaction = await accTrade.order(order);
|
|
82
|
+
* const orderTransaction = await accTrade.order(order);
|
|
110
83
|
* console.log(orderTransaction);
|
|
111
84
|
* }
|
|
112
85
|
* main();
|
|
@@ -126,7 +99,7 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
126
99
|
* async function main() {
|
|
127
100
|
* console.log(AccountTrade);
|
|
128
101
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
129
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
102
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
130
103
|
* const pk: string = <string>process.env.PK;
|
|
131
104
|
* let accTrade = new AccountTrade(config, pk);
|
|
132
105
|
* await accTrade.createProxyInstance();
|
|
@@ -148,7 +121,7 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
148
121
|
* async function main() {
|
|
149
122
|
* console.log(AccountTrade);
|
|
150
123
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
151
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
124
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
152
125
|
* const pk: string = <string>process.env.PK;
|
|
153
126
|
* let accTrade = new AccountTrade(config, pk);
|
|
154
127
|
* await accTrade.createProxyInstance();
|
|
@@ -169,7 +142,7 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
169
142
|
* async function main() {
|
|
170
143
|
* console.log(AccountTrade);
|
|
171
144
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
172
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
145
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
173
146
|
* const pk: string = <string>process.env.PK;
|
|
174
147
|
* let accTrade = new AccountTrade(config, pk);
|
|
175
148
|
* await accTrade.createProxyInstance();
|
|
@@ -212,12 +185,42 @@ export default class AccountTrade extends WriteAccessHandler {
|
|
|
212
185
|
*
|
|
213
186
|
* @param {string} symbol Symbol of the form ETH-USD-MATIC.
|
|
214
187
|
* @param {number} amount How much collateral to add, in units of collateral currency, e.g. MATIC
|
|
188
|
+
* @example
|
|
189
|
+
* import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
190
|
+
*
|
|
191
|
+
* async function main() {
|
|
192
|
+
* // setup (authentication required, PK is an environment variable with a private key)
|
|
193
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
194
|
+
* const pk: string = <string>process.env.PK;
|
|
195
|
+
* let accTrade = new AccountTrade(config, pk);
|
|
196
|
+
* await accTrade.createProxyInstance();
|
|
197
|
+
* // add collateral to margin account
|
|
198
|
+
* const tx = await accTrade.addCollateral("MATIC-USD-MATIC", 10.9);
|
|
199
|
+
* console.log(orderIds);
|
|
200
|
+
* }
|
|
201
|
+
*
|
|
202
|
+
* main();
|
|
215
203
|
*/
|
|
216
204
|
addCollateral(symbol: string, amount: number, submission?: PriceFeedSubmission, overrides?: PayableOverrides): Promise<ContractTransaction>;
|
|
217
205
|
/**
|
|
218
206
|
*
|
|
219
207
|
* @param {string} symbol Symbol of the form ETH-USD-MATIC.
|
|
220
208
|
* @param {number} amount How much collateral to remove, in units of collateral currency, e.g. MATIC
|
|
209
|
+
* @example
|
|
210
|
+
* import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
211
|
+
*
|
|
212
|
+
* async function main() {
|
|
213
|
+
* // setup (authentication required, PK is an environment variable with a private key)
|
|
214
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
215
|
+
* const pk: string = <string>process.env.PK;
|
|
216
|
+
* let accTrade = new AccountTrade(config, pk);
|
|
217
|
+
* await accTrade.createProxyInstance();
|
|
218
|
+
* // remove collateral from margin account
|
|
219
|
+
* const tx = await accTrade.removeCollateral("MATIC-USD-MATIC", 3.14);
|
|
220
|
+
* console.log(orderIds);
|
|
221
|
+
* }
|
|
222
|
+
*
|
|
223
|
+
* main();
|
|
221
224
|
*/
|
|
222
225
|
removeCollateral(symbol: string, amount: number, submission?: PriceFeedSubmission, overrides?: PayableOverrides): Promise<ContractTransaction>;
|
|
223
226
|
}
|
package/dist/cjs/accountTrade.js
CHANGED
|
@@ -25,8 +25,8 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
25
25
|
* import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
26
26
|
* async function main() {
|
|
27
27
|
* console.log(AccountTrade);
|
|
28
|
-
* // load configuration for
|
|
29
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
28
|
+
* // load configuration for Polygon zkEVM Tesnet
|
|
29
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
30
30
|
* // AccountTrade (authentication required, PK is an environment variable with a private key)
|
|
31
31
|
* const pk: string = <string>process.env.PK;
|
|
32
32
|
* let accTrade = new AccountTrade(config, pk);
|
|
@@ -50,7 +50,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
50
50
|
* async function main() {
|
|
51
51
|
* console.log(AccountTrade);
|
|
52
52
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
53
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
53
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
54
54
|
* const pk: string = <string>process.env.PK;
|
|
55
55
|
* let accTrade = new AccountTrade(config, pk);
|
|
56
56
|
* await accTrade.createProxyInstance();
|
|
@@ -81,14 +81,14 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
81
81
|
* async function main() {
|
|
82
82
|
* console.log(AccountTrade);
|
|
83
83
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
84
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
84
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
85
85
|
* const pk: string = <string>process.env.PK;
|
|
86
|
-
*
|
|
86
|
+
* const accTrade = new AccountTrade(config, pk);
|
|
87
87
|
* await accTrade.createProxyInstance();
|
|
88
88
|
* // set allowance
|
|
89
89
|
* await accTrade.setAllowance("MATIC");
|
|
90
90
|
* // set an order
|
|
91
|
-
*
|
|
91
|
+
* const order: Order = {
|
|
92
92
|
* symbol: "MATIC-USD-MATIC",
|
|
93
93
|
* side: "BUY",
|
|
94
94
|
* type: "MARKET",
|
|
@@ -96,34 +96,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
96
96
|
* leverage: 2,
|
|
97
97
|
* executionTimestamp: Date.now()/1000,
|
|
98
98
|
* };
|
|
99
|
-
*
|
|
100
|
-
* console.log(orderTransaction);
|
|
101
|
-
* }
|
|
102
|
-
* main();
|
|
103
|
-
*
|
|
104
|
-
* @example
|
|
105
|
-
* import { AccountTrade, PerpetualDataHandler, Order } from '@d8x/perpetuals-sdk';
|
|
106
|
-
* async function main() {
|
|
107
|
-
* console.log(AccountTrade);
|
|
108
|
-
* // setup (authentication required, PK is an environment variable with a private key)
|
|
109
|
-
* const config = PerpetualDataHandler.readSDKConfig("testnet");
|
|
110
|
-
* const pk: string = <string>process.env.PK;
|
|
111
|
-
* let accTrade = new AccountTrade(config, pk);
|
|
112
|
-
* await accTrade.createProxyInstance();
|
|
113
|
-
* // set allowance
|
|
114
|
-
* await accTrade.setAllowance("MATIC");
|
|
115
|
-
* // set an order
|
|
116
|
-
* let order: Order = {
|
|
117
|
-
* symbol: "MATIC-USD-MATIC",
|
|
118
|
-
* side: "BUY",
|
|
119
|
-
* type: "LIMIT",
|
|
120
|
-
* limitPrice: 1,
|
|
121
|
-
* quantity: 5,
|
|
122
|
-
* leverage: 2,
|
|
123
|
-
* executionTimestamp: Date.now() / 1000,
|
|
124
|
-
* deadline: Date.now() / 1000 + 8*60*60, // order expires 8 hours from now
|
|
125
|
-
* };
|
|
126
|
-
* let orderTransaction = await accTrade.order(order);
|
|
99
|
+
* const orderTransaction = await accTrade.order(order);
|
|
127
100
|
* console.log(orderTransaction);
|
|
128
101
|
* }
|
|
129
102
|
* main();
|
|
@@ -154,7 +127,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
154
127
|
* async function main() {
|
|
155
128
|
* console.log(AccountTrade);
|
|
156
129
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
157
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
130
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
158
131
|
* const pk: string = <string>process.env.PK;
|
|
159
132
|
* let accTrade = new AccountTrade(config, pk);
|
|
160
133
|
* await accTrade.createProxyInstance();
|
|
@@ -186,7 +159,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
186
159
|
* async function main() {
|
|
187
160
|
* console.log(AccountTrade);
|
|
188
161
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
189
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
162
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
190
163
|
* const pk: string = <string>process.env.PK;
|
|
191
164
|
* let accTrade = new AccountTrade(config, pk);
|
|
192
165
|
* await accTrade.createProxyInstance();
|
|
@@ -214,7 +187,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
214
187
|
* async function main() {
|
|
215
188
|
* console.log(AccountTrade);
|
|
216
189
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
217
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
190
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
218
191
|
* const pk: string = <string>process.env.PK;
|
|
219
192
|
* let accTrade = new AccountTrade(config, pk);
|
|
220
193
|
* await accTrade.createProxyInstance();
|
|
@@ -254,7 +227,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
254
227
|
// let tx: ContractTransaction;
|
|
255
228
|
// all orders are sent to the order-book
|
|
256
229
|
let [signature, digest] = await this._createSignature(scOrder, chainId, true, signer, proxyContract.address);
|
|
257
|
-
const txData =
|
|
230
|
+
const txData = orderBookContract.interface.encodeFunctionData("postOrders", [[clientOrder], [signature]]);
|
|
258
231
|
let unsignedTx = {
|
|
259
232
|
to: orderBookContract.address,
|
|
260
233
|
from: this.traderAddr,
|
|
@@ -267,7 +240,7 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
267
240
|
chainId: this.chainId,
|
|
268
241
|
};
|
|
269
242
|
let tx = await signer.sendTransaction(unsignedTx);
|
|
270
|
-
let id =
|
|
243
|
+
let id = traderDigests_1.default.createOrderId(digest);
|
|
271
244
|
return { tx: tx, orderId: id };
|
|
272
245
|
}
|
|
273
246
|
async _cancelOrder(symbol, orderId, orderBookContract, submission, overrides) {
|
|
@@ -309,6 +282,21 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
309
282
|
*
|
|
310
283
|
* @param {string} symbol Symbol of the form ETH-USD-MATIC.
|
|
311
284
|
* @param {number} amount How much collateral to add, in units of collateral currency, e.g. MATIC
|
|
285
|
+
* @example
|
|
286
|
+
* import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
287
|
+
*
|
|
288
|
+
* async function main() {
|
|
289
|
+
* // setup (authentication required, PK is an environment variable with a private key)
|
|
290
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
291
|
+
* const pk: string = <string>process.env.PK;
|
|
292
|
+
* let accTrade = new AccountTrade(config, pk);
|
|
293
|
+
* await accTrade.createProxyInstance();
|
|
294
|
+
* // add collateral to margin account
|
|
295
|
+
* const tx = await accTrade.addCollateral("MATIC-USD-MATIC", 10.9);
|
|
296
|
+
* console.log(orderIds);
|
|
297
|
+
* }
|
|
298
|
+
*
|
|
299
|
+
* main();
|
|
312
300
|
*/
|
|
313
301
|
async addCollateral(symbol, amount, submission, overrides) {
|
|
314
302
|
if (this.proxyContract == null || this.signer == null) {
|
|
@@ -332,6 +320,21 @@ class AccountTrade extends writeAccessHandler_1.default {
|
|
|
332
320
|
*
|
|
333
321
|
* @param {string} symbol Symbol of the form ETH-USD-MATIC.
|
|
334
322
|
* @param {number} amount How much collateral to remove, in units of collateral currency, e.g. MATIC
|
|
323
|
+
* @example
|
|
324
|
+
* import { AccountTrade, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
325
|
+
*
|
|
326
|
+
* async function main() {
|
|
327
|
+
* // setup (authentication required, PK is an environment variable with a private key)
|
|
328
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
329
|
+
* const pk: string = <string>process.env.PK;
|
|
330
|
+
* let accTrade = new AccountTrade(config, pk);
|
|
331
|
+
* await accTrade.createProxyInstance();
|
|
332
|
+
* // remove collateral from margin account
|
|
333
|
+
* const tx = await accTrade.removeCollateral("MATIC-USD-MATIC", 3.14);
|
|
334
|
+
* console.log(orderIds);
|
|
335
|
+
* }
|
|
336
|
+
*
|
|
337
|
+
* main();
|
|
335
338
|
*/
|
|
336
339
|
async removeCollateral(symbol, amount, submission, overrides) {
|
|
337
340
|
if (this.proxyContract == null || this.signer == null) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accountTrade.js","sourceRoot":"","sources":["../../src/accountTrade.ts"],"names":[],"mappings":";;;;;AAEA,mCAAgC;AAChC,2CAA2C;AAE3C,uCAA6D;AAC7D,8DAAsC;AAStC,kFAA0D;AAC1D,oEAA4C;AAC5C,8EAAsD;AAEtD;;;;;GAKG;AACH,MAAqB,YAAa,SAAQ,4BAAkB;IAG1D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAmB,MAAqB,EAAE,MAAuB;QAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAa,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,WAAW,CACtB,MAAc,EACd,OAAe,EACf,UAAgC,EAChC,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,UAAU,IAAI,SAAS,EAAE;YAC3B,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;SAC1D;QACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC5F,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"accountTrade.js","sourceRoot":"","sources":["../../src/accountTrade.ts"],"names":[],"mappings":";;;;;AAEA,mCAAgC;AAChC,2CAA2C;AAE3C,uCAA6D;AAC7D,8DAAsC;AAStC,kFAA0D;AAC1D,oEAA4C;AAC5C,8EAAsD;AAEtD;;;;;GAKG;AACH,MAAqB,YAAa,SAAQ,4BAAkB;IAG1D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAmB,MAAqB,EAAE,MAAuB;QAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAa,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,WAAW,CACtB,MAAc,EACd,OAAe,EACf,UAAgC,EAChC,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,UAAU,IAAI,SAAS,EAAE;YAC3B,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;SAC1D;QACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACI,KAAK,CAAC,KAAK,CAAC,KAAY,EAAE,cAAiC,EAAE,SAAqB;QACvF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,OAAO,GAAG,8BAAoB,CAAC,uBAAuB,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACtG,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,OAAO,EAAE;YACtC,MAAM,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACrC;QACD,IAAI,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAChE,IAAI,GAAG,GAAkB,MAAM,IAAI,CAAC,MAAM,CACxC,KAAK,EACL,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,sBAAsB,EAC3B,IAAI,CAAC,aAAa,EAClB,iBAAiB,EACjB,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,MAAM,EACX,cAAc,EACd,SAAS,CACV,CAAC;QACF,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,gBAAgB,CAAC,cAAsB,EAAE,UAAmB,EAAE,SAAqB;QAC9F,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;YAC9B,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,OAAO,UAAU,IAAI,WAAW,EAAE;YACpC,UAAU,GAAG,wBAAY,CAAC;SAC3B;QACD,IAAI,MAAM,GAAG,8BAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;QAC9G,OAAO,OAAO,GAAG,MAAO,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,SAAyB;QACnF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,4BAAkB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3F,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;QACvG,OAAO,IAAA,yBAAe,EAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,WAAW,CAAC,MAAc,EAAE,SAAyB;QAChE,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,MAAM,oBAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,MAAM,CACjB,KAAY,EACZ,UAAkB,EAClB,oBAAsD,EACtD,aAAgC,EAChC,iBAAiC,EACjC,OAAe,EACf,MAAc,EACd,cAAiC,EACjC,SAAqB;QAErB,IAAI,OAAO,GAAG,YAAY,CAAC,oBAAoB,CAAC,KAAK,EAAE,UAAU,EAAE,oBAAoB,CAAC,CAAC;QACzF,IAAI,WAAW,GAAG,YAAY,CAAC,kCAAkC,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC3F,wCAAwC;QACxC,8EAA8E;QAC9E,+BAA+B;QAC/B,wCAAwC;QACxC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;QAE7G,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC1G,IAAI,UAAU,GAAG;YACf,EAAE,EAAE,iBAAiB,CAAC,OAAO;YAC7B,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,KAAK,EAAE,SAAS,EAAE,KAAK;YACvB,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;YAC9C,0DAA0D;YAC1D,QAAQ,EAAE,SAAS,EAAE,QAAQ;YAC7B,2EAA2E;YAC3E,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QACF,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAElD,IAAI,EAAE,GAAG,uBAAa,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC7C,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC;IAES,KAAK,CAAC,YAAY,CAC1B,MAAc,EACd,OAAe,EACf,iBAAiC,EACjC,UAAgC,EAChC,SAA4B;QAE5B,IAAI,iBAAiB,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACpD,MAAM,KAAK,CAAC,kCAAkC,MAAM,wBAAwB,CAAC,CAAC;SAC/E;QACD,IAAI,UAAU,IAAI,SAAS,EAAE;YAC3B,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;SAC1D;QACD,IAAI,OAAO,GAAuB,MAAM,iBAAiB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACzG,8DAA8D;QAC9D,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,EAAE;YAC9C,SAAS,GAAG;gBACV,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB;gBAChE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;gBAC9C,GAAG,SAAS;aACO,CAAC;SACvB;QAED,OAAO,MAAM,iBAAiB,CAAC,WAAW,CACxC,OAAO,EACP,SAAS,EACT,UAAU,CAAC,aAAa,EACxB,UAAU,CAAC,UAAU,EACrB,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,gBAAgB,CAC5B,KAAyB,EACzB,OAAe,EACf,UAAmB,EACnB,MAAc,EACd,YAAoB;QAEpB,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QAC1F,IAAI,YAAY,GAAG,eAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1E,IAAI,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACvD,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,aAAa,CACxB,MAAc,EACd,MAAc,EACd,UAAgC,EAChC,SAA4B;QAE5B,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,SAAS,GAAG,IAAA,yBAAe,EAAC,MAAM,CAAC,CAAC;QACxC,IAAI,UAAU,IAAI,SAAS,EAAE;YAC3B,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;SAC1D;QACD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,EAAE;YAC9C,SAAS,GAAG;gBACV,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB;gBAChE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;gBAC9C,GAAG,SAAS;aACO,CAAC;SACvB;QACD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CACrC,MAAM,EACN,IAAI,CAAC,UAAU,EACf,SAAS,EACT,UAAU,CAAC,aAAa,EACxB,UAAU,CAAC,UAAU,EACrB,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,gBAAgB,CAC3B,MAAc,EACd,MAAc,EACd,UAAgC,EAChC,SAA4B;QAE5B,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,SAAS,GAAG,IAAA,yBAAe,EAAC,MAAM,CAAC,CAAC;QACxC,IAAI,UAAU,IAAI,SAAS,EAAE;YAC3B,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;SAC1D;QACD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,EAAE;YAC9C,SAAS,GAAG;gBACV,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB;gBAChE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;gBAC9C,GAAG,SAAS;aACO,CAAC;SACvB;QACD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CACtC,MAAM,EACN,IAAI,CAAC,UAAU,EACf,SAAS,EACT,UAAU,CAAC,aAAa,EACxB,UAAU,CAAC,UAAU,EACrB,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;IACJ,CAAC;CACF;AAraD,+BAqaC"}
|
package/dist/cjs/brokerTool.d.ts
CHANGED
|
@@ -19,8 +19,8 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
19
19
|
* import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
20
20
|
* async function main() {
|
|
21
21
|
* console.log(BrokerTool);
|
|
22
|
-
* // load configuration for testnet
|
|
23
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
22
|
+
* // load configuration for Polygon zkEVM (testnet)
|
|
23
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
24
24
|
* // BrokerTool (authentication required, PK is an environment variable with a private key)
|
|
25
25
|
* const pk: string = <string>process.env.PK;
|
|
26
26
|
* let brokTool = new BrokerTool(config, pk);
|
|
@@ -40,7 +40,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
40
40
|
* async function main() {
|
|
41
41
|
* console.log(BrokerTool);
|
|
42
42
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
43
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
43
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
44
44
|
* const pk: string = <string>process.env.PK;
|
|
45
45
|
* let brokTool = new BrokerTool(config, pk);
|
|
46
46
|
* await brokTool.createProxyInstance();
|
|
@@ -64,7 +64,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
64
64
|
* async function main() {
|
|
65
65
|
* console.log(BrokerTool);
|
|
66
66
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
67
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
67
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
68
68
|
* const pk: string = <string>process.env.PK;
|
|
69
69
|
* let brokTool = new BrokerTool(config, pk);
|
|
70
70
|
* await brokTool.createProxyInstance();
|
|
@@ -87,7 +87,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
87
87
|
* async function main() {
|
|
88
88
|
* console.log(BrokerTool);
|
|
89
89
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
90
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
90
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
91
91
|
* const pk: string = <string>process.env.PK;
|
|
92
92
|
* let brokTool = new BrokerTool(config, pk);
|
|
93
93
|
* await brokTool.createProxyInstance();
|
|
@@ -110,7 +110,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
110
110
|
* async function main() {
|
|
111
111
|
* console.log(BrokerTool);
|
|
112
112
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
113
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
113
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
114
114
|
* const pk: string = <string>process.env.PK;
|
|
115
115
|
* let brokTool = new BrokerTool(config, pk);
|
|
116
116
|
* await brokTool.createProxyInstance();
|
|
@@ -138,7 +138,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
138
138
|
* async function main() {
|
|
139
139
|
* console.log(BrokerTool);
|
|
140
140
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
141
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
141
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
142
142
|
* const pk: string = <string>process.env.PK;
|
|
143
143
|
* let brokTool = new BrokerTool(config, pk);
|
|
144
144
|
* await brokTool.createProxyInstance();
|
|
@@ -168,7 +168,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
168
168
|
* async function main() {
|
|
169
169
|
* console.log(BrokerTool);
|
|
170
170
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
171
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
171
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
172
172
|
* const pk: string = <string>process.env.PK;
|
|
173
173
|
* let brokTool = new BrokerTool(config, pk);
|
|
174
174
|
* await brokTool.createProxyInstance();
|
|
@@ -190,7 +190,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
190
190
|
* async function main() {
|
|
191
191
|
* console.log(BrokerTool);
|
|
192
192
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
193
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
193
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
194
194
|
* const pk: string = <string>process.env.PK;
|
|
195
195
|
* let brokTool = new BrokerTool(config, pk);
|
|
196
196
|
* await brokTool.createProxyInstance();
|
|
@@ -212,7 +212,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
212
212
|
* async function main() {
|
|
213
213
|
* console.log(BrokerTool);
|
|
214
214
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
215
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
215
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
216
216
|
* const pk: string = <string>process.env.PK;
|
|
217
217
|
* let brokTool = new BrokerTool(config, pk);
|
|
218
218
|
* await brokTool.createProxyInstance();
|
|
@@ -234,7 +234,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
234
234
|
* async function main() {
|
|
235
235
|
* console.log(BrokerTool);
|
|
236
236
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
237
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
237
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
238
238
|
* const pk: string = <string>process.env.PK;
|
|
239
239
|
* let brokTool = new BrokerTool(config, pk);
|
|
240
240
|
* await brokTool.createProxyInstance();
|
|
@@ -249,7 +249,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
249
249
|
*/
|
|
250
250
|
depositBrokerLots(poolSymbolName: string, lots: number, overrides?: Overrides): Promise<ContractTransaction>;
|
|
251
251
|
/**
|
|
252
|
-
* Adds this white-label partner's signature to
|
|
252
|
+
* Adds this white-label partner's signature to a user-friendly order. An order signed by a white-label partner is considered
|
|
253
253
|
* to be routed through this white-label partner and benefits from the white-label partner's fee conditions.
|
|
254
254
|
* @param {Order} order Order to sign. It must contain valid white-label partner fee, white-label partner address, and order deadline.
|
|
255
255
|
* @param {string} traderAddr Address of trader submitting the order.
|
|
@@ -258,7 +258,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
258
258
|
* async function main() {
|
|
259
259
|
* console.log(BrokerTool);
|
|
260
260
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
261
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
261
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
262
262
|
* const pk: string = <string>process.env.PK;
|
|
263
263
|
* let brokTool = new BrokerTool(config, pk);
|
|
264
264
|
* await brokTool.createProxyInstance();
|
|
@@ -281,6 +281,38 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
281
281
|
* @returns {Order} An order signed by this white-label partner, which can be submitted directly with AccountTrade.order.
|
|
282
282
|
*/
|
|
283
283
|
signOrder(order: Order, traderAddr: string): Promise<Order>;
|
|
284
|
+
/**
|
|
285
|
+
* Generates a white-label partner's signature of a smart-contract ready order. An order signed by a white-label partner is considered
|
|
286
|
+
* to be routed through this white-label partner and benefits from the white-label partner's fee conditions.
|
|
287
|
+
* @param {SmartContractOrder} scOrder Order to sign. It must contain valid white-label partner fee, white-label partner address, and order deadline.
|
|
288
|
+
* @param {string} traderAddr Address of trader submitting the order.
|
|
289
|
+
* @example
|
|
290
|
+
* import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
291
|
+
* async function main() {
|
|
292
|
+
* console.log(BrokerTool);
|
|
293
|
+
* // setup (authentication required, PK is an environment variable with a private key)
|
|
294
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
295
|
+
* const pk: string = <string>process.env.PK;
|
|
296
|
+
* const brokTool = new BrokerTool(config, pk);
|
|
297
|
+
* const traderAPI = new TraderInterface(config);
|
|
298
|
+
* await brokTool.createProxyInstance();
|
|
299
|
+
* await traderAPI.createProxyInstance();
|
|
300
|
+
* // sign order
|
|
301
|
+
* const order = {symbol: "ETH-USD-MATIC",
|
|
302
|
+
* side: "BUY",
|
|
303
|
+
* type: "MARKET",
|
|
304
|
+
* quantity: 1,
|
|
305
|
+
* executionTimestamp: Date.now()/1000
|
|
306
|
+
* };
|
|
307
|
+
* const scOrder = await traderAPI.createSmartContractOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B")
|
|
308
|
+
* const signature = await brokTool.signSCOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
|
|
309
|
+
* 0.0001, 1669723339);
|
|
310
|
+
* console.log(signature);
|
|
311
|
+
* }
|
|
312
|
+
* main();
|
|
313
|
+
*
|
|
314
|
+
* @returns {string} Signature of order.
|
|
315
|
+
*/
|
|
284
316
|
signSCOrder(scOrder: SmartContractOrder): Promise<string>;
|
|
285
317
|
/**
|
|
286
318
|
* Creates a signature that a trader can use to place orders with this white-label partner.
|
|
@@ -306,7 +338,7 @@ export default class BrokerTool extends WriteAccessHandler {
|
|
|
306
338
|
* async function main() {
|
|
307
339
|
* console.log(BrokerTool);
|
|
308
340
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
309
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
341
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
310
342
|
* const pk: string = <string>process.env.PK;
|
|
311
343
|
* let brokTool = new BrokerTool(config, pk);
|
|
312
344
|
* await brokTool.createProxyInstance();
|
package/dist/cjs/brokerTool.js
CHANGED
|
@@ -27,8 +27,8 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
27
27
|
* import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
28
28
|
* async function main() {
|
|
29
29
|
* console.log(BrokerTool);
|
|
30
|
-
* // load configuration for testnet
|
|
31
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
30
|
+
* // load configuration for Polygon zkEVM (testnet)
|
|
31
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
32
32
|
* // BrokerTool (authentication required, PK is an environment variable with a private key)
|
|
33
33
|
* const pk: string = <string>process.env.PK;
|
|
34
34
|
* let brokTool = new BrokerTool(config, pk);
|
|
@@ -51,7 +51,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
51
51
|
* async function main() {
|
|
52
52
|
* console.log(BrokerTool);
|
|
53
53
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
54
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
54
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
55
55
|
* const pk: string = <string>process.env.PK;
|
|
56
56
|
* let brokTool = new BrokerTool(config, pk);
|
|
57
57
|
* await brokTool.createProxyInstance();
|
|
@@ -86,7 +86,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
86
86
|
* async function main() {
|
|
87
87
|
* console.log(BrokerTool);
|
|
88
88
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
89
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
89
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
90
90
|
* const pk: string = <string>process.env.PK;
|
|
91
91
|
* let brokTool = new BrokerTool(config, pk);
|
|
92
92
|
* await brokTool.createProxyInstance();
|
|
@@ -124,7 +124,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
124
124
|
* async function main() {
|
|
125
125
|
* console.log(BrokerTool);
|
|
126
126
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
127
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
127
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
128
128
|
* const pk: string = <string>process.env.PK;
|
|
129
129
|
* let brokTool = new BrokerTool(config, pk);
|
|
130
130
|
* await brokTool.createProxyInstance();
|
|
@@ -154,7 +154,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
154
154
|
* async function main() {
|
|
155
155
|
* console.log(BrokerTool);
|
|
156
156
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
157
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
157
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
158
158
|
* const pk: string = <string>process.env.PK;
|
|
159
159
|
* let brokTool = new BrokerTool(config, pk);
|
|
160
160
|
* await brokTool.createProxyInstance();
|
|
@@ -191,7 +191,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
191
191
|
* async function main() {
|
|
192
192
|
* console.log(BrokerTool);
|
|
193
193
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
194
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
194
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
195
195
|
* const pk: string = <string>process.env.PK;
|
|
196
196
|
* let brokTool = new BrokerTool(config, pk);
|
|
197
197
|
* await brokTool.createProxyInstance();
|
|
@@ -229,7 +229,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
229
229
|
* async function main() {
|
|
230
230
|
* console.log(BrokerTool);
|
|
231
231
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
232
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
232
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
233
233
|
* const pk: string = <string>process.env.PK;
|
|
234
234
|
* let brokTool = new BrokerTool(config, pk);
|
|
235
235
|
* await brokTool.createProxyInstance();
|
|
@@ -259,7 +259,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
259
259
|
* async function main() {
|
|
260
260
|
* console.log(BrokerTool);
|
|
261
261
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
262
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
262
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
263
263
|
* const pk: string = <string>process.env.PK;
|
|
264
264
|
* let brokTool = new BrokerTool(config, pk);
|
|
265
265
|
* await brokTool.createProxyInstance();
|
|
@@ -289,7 +289,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
289
289
|
* async function main() {
|
|
290
290
|
* console.log(BrokerTool);
|
|
291
291
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
292
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
292
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
293
293
|
* const pk: string = <string>process.env.PK;
|
|
294
294
|
* let brokTool = new BrokerTool(config, pk);
|
|
295
295
|
* await brokTool.createProxyInstance();
|
|
@@ -318,7 +318,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
318
318
|
* async function main() {
|
|
319
319
|
* console.log(BrokerTool);
|
|
320
320
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
321
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
321
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
322
322
|
* const pk: string = <string>process.env.PK;
|
|
323
323
|
* let brokTool = new BrokerTool(config, pk);
|
|
324
324
|
* await brokTool.createProxyInstance();
|
|
@@ -341,7 +341,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
341
341
|
}
|
|
342
342
|
// Signatures
|
|
343
343
|
/**
|
|
344
|
-
* Adds this white-label partner's signature to
|
|
344
|
+
* Adds this white-label partner's signature to a user-friendly order. An order signed by a white-label partner is considered
|
|
345
345
|
* to be routed through this white-label partner and benefits from the white-label partner's fee conditions.
|
|
346
346
|
* @param {Order} order Order to sign. It must contain valid white-label partner fee, white-label partner address, and order deadline.
|
|
347
347
|
* @param {string} traderAddr Address of trader submitting the order.
|
|
@@ -350,7 +350,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
350
350
|
* async function main() {
|
|
351
351
|
* console.log(BrokerTool);
|
|
352
352
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
353
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
353
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
354
354
|
* const pk: string = <string>process.env.PK;
|
|
355
355
|
* let brokTool = new BrokerTool(config, pk);
|
|
356
356
|
* await brokTool.createProxyInstance();
|
|
@@ -383,6 +383,38 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
383
383
|
order.brokerSignature = await BrokerTool._signOrder(order.symbol, order.brokerFeeTbps, traderAddr, order.deadline, this.signer, this.chainId, this.proxyAddr, this.symbolToPerpStaticInfo);
|
|
384
384
|
return order;
|
|
385
385
|
}
|
|
386
|
+
/**
|
|
387
|
+
* Generates a white-label partner's signature of a smart-contract ready order. An order signed by a white-label partner is considered
|
|
388
|
+
* to be routed through this white-label partner and benefits from the white-label partner's fee conditions.
|
|
389
|
+
* @param {SmartContractOrder} scOrder Order to sign. It must contain valid white-label partner fee, white-label partner address, and order deadline.
|
|
390
|
+
* @param {string} traderAddr Address of trader submitting the order.
|
|
391
|
+
* @example
|
|
392
|
+
* import { BrokerTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
|
|
393
|
+
* async function main() {
|
|
394
|
+
* console.log(BrokerTool);
|
|
395
|
+
* // setup (authentication required, PK is an environment variable with a private key)
|
|
396
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
397
|
+
* const pk: string = <string>process.env.PK;
|
|
398
|
+
* const brokTool = new BrokerTool(config, pk);
|
|
399
|
+
* const traderAPI = new TraderInterface(config);
|
|
400
|
+
* await brokTool.createProxyInstance();
|
|
401
|
+
* await traderAPI.createProxyInstance();
|
|
402
|
+
* // sign order
|
|
403
|
+
* const order = {symbol: "ETH-USD-MATIC",
|
|
404
|
+
* side: "BUY",
|
|
405
|
+
* type: "MARKET",
|
|
406
|
+
* quantity: 1,
|
|
407
|
+
* executionTimestamp: Date.now()/1000
|
|
408
|
+
* };
|
|
409
|
+
* const scOrder = await traderAPI.createSmartContractOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B")
|
|
410
|
+
* const signature = await brokTool.signSCOrder(order, "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
|
|
411
|
+
* 0.0001, 1669723339);
|
|
412
|
+
* console.log(signature);
|
|
413
|
+
* }
|
|
414
|
+
* main();
|
|
415
|
+
*
|
|
416
|
+
* @returns {string} Signature of order.
|
|
417
|
+
*/
|
|
386
418
|
async signSCOrder(scOrder) {
|
|
387
419
|
return await BrokerTool._signOrderFromRawData(scOrder.iPerpetualId, scOrder.brokerFeeTbps, scOrder.traderAddr, scOrder.iDeadline, this.signer, this.chainId, this.proxyAddr);
|
|
388
420
|
}
|
|
@@ -431,7 +463,7 @@ class BrokerTool extends writeAccessHandler_1.default {
|
|
|
431
463
|
* async function main() {
|
|
432
464
|
* console.log(BrokerTool);
|
|
433
465
|
* // setup (authentication required, PK is an environment variable with a private key)
|
|
434
|
-
* const config = PerpetualDataHandler.readSDKConfig("
|
|
466
|
+
* const config = PerpetualDataHandler.readSDKConfig("zkevmTestnet");
|
|
435
467
|
* const pk: string = <string>process.env.PK;
|
|
436
468
|
* let brokTool = new BrokerTool(config, pk);
|
|
437
469
|
* await brokTool.createProxyInstance();
|