perpl-sdk 0.2.4

Rust SDK for the Perpl decentralized perpetuals exchange
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
//! Local Anvil-based testing environment.
//!
//! [`TestExchange`] spins up Anvil instance with collateral token and exchange
//! smart contracts deployed and provides convenience methods for perpetual
//! contracts setup and account creation.
//!
//! [`TestPerp`] then can be used to configure perpetual contracts and post
//! orders, while [`TestAccount`] provides basic information about exchange
//! account.
//!
//! [`Indexer`] wraps snapshot creation and event processing, while providing
//! convenience methods for synchronization in tests.
mod account;
mod indexer;
mod perp;

use std::{
    str::FromStr,
    sync::{
        Arc,
        atomic::{AtomicBool, Ordering},
    },
    time::Duration,
};

pub use account::*;
use alloy::{
    hex::ToHexExt,
    network::TransactionBuilder,
    node_bindings::{Anvil, AnvilInstance},
    primitives::{Address, Bytes, U256, address, hex},
    providers::{DynProvider, Provider, ProviderBuilder, ext::AnvilApi},
    rpc::{client::RpcClient, types::TransactionRequest},
};
use dashmap::{DashMap, DashSet};
use fastnum::{UD64, udec64};
pub use indexer::*;
pub use perp::*;

use crate::{
    Chain,
    abi::{dex::Exchange, erc1967_proxy::ERC1967Proxy, testing::TestToken},
    error::DexError,
    num, state, types,
};

const CHAIN_ID: u64 = 1337;
const BLOCK_TIME_SEC: f64 = 0.4;
const POLL_INTERVAL_MS: u64 = 50;

const USD_DECIMALS: u8 = 6;

/// Creation bytecode of the previous exchange implementation
/// (`rc_v1.1.7-99-g3afdb99`, contract generation v1.1.7.3b), deployed by
/// [`TestExchange::new_at_previous_version`].
///
/// Only the bytecode is kept: every function the pre-upgrade path calls has an
/// unchanged signature, so the current bindings drive it, and the current
/// `ExchangeEvents` still decodes its events - the V1 event signatures are
/// retained in the ABI for exactly this reason.
const PREVIOUS_IMPLEMENTATION: &str = include_str!("../../abi/dex/legacy/Exchange.v1.1.7.3.bin");

#[derive(Debug)]
pub struct TestExchange {
    pub chain_id: u64,
    pub rpc_url: String,
    pub provider: DynProvider,
    pub exchange: Exchange::ExchangeInstance<DynProvider>,
    pub token: TestToken::TestTokenInstance<DynProvider>,
    pub owner: Address,
    pub owner_pk: String,
    pub admin: Address,
    pub admin_pk: String,
    pub price_admin: Address,
    pub price_admin_pk: String,
    pub collateral_converter: num::Converter,
    perpetual_ids: Arc<DashSet<types::PerpetualId>>,
    account_address: Arc<DashMap<types::AccountId, Address>>,
    // True while the deployed generation predates v1.1.7.4 (set by
    // `new_at_previous_version`, cleared by `upgrade`). That generation's
    // `addContract` carries two extra genesis-fee args, so `perp` must reach it
    // through the legacy interface; a v1.1.7.4 deployment uses the current one.
    legacy: AtomicBool,
    anvil: AnvilInstance,
}

impl TestExchange {
    /// Spins up the environment running the exchange implementation the SDK
    /// targets ([`state::Exchange::revision`]).
    pub async fn new() -> Self { Self::deploy(None).await }

    /// Spins up the environment running the *previous* contract generation
    /// (v1.1.7.3b: V2 information getters, but no version getter, keyed fee
    /// schedules, builder attribution or existence bitmap) - the generation
    /// deployed on mainnet before the v1.1.7.4 upgrade.
    ///
    /// Use with [`Self::upgrade`] to exercise the SDK across the upgrade
    /// itself.
    pub async fn new_at_previous_version() -> Self {
        Self::deploy(Some(PREVIOUS_IMPLEMENTATION)).await
    }

    /// Upgrades the proxy to the implementation the SDK targets, seeding the
    /// exchange-wide fee schedules and repointing every listed perpetual
    /// contract at the default one.
    ///
    /// Runs `initializeV3` in the upgrade transaction, exactly as the real
    /// upgrade does, so the log sequence a live indexer observes is the real
    /// one.
    pub async fn upgrade(
        &self,
        taker_fees: [UD64; state::FEE_TIERS],
        maker_fees: [UD64; state::FEE_TIERS],
    ) {
        let implementation = Exchange::deploy(self.provider.clone())
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap();
        let fee_converter = num::fee_converter();
        let initialize = self
            .exchange
            .initializeV3(
                taker_fees.map(|fee| fee_converter.to_unsigned(fee)),
                maker_fees.map(|fee| fee_converter.to_unsigned(fee)),
                // RWA schedule left blank, as in the real upgrade configuration
                [U256::ZERO; state::FEE_TIERS],
                [U256::ZERO; state::FEE_TIERS],
                // Must list every live perpetual: `initializeV3` rejects an
                // incomplete list rather than leave one on a stale fee key
                self.perpetual_ids.iter().map(|p| U256::from(*p)).collect(),
            )
            .calldata()
            .clone();
        self.exchange
            .upgradeToAndCall(*implementation.address(), initialize)
            .gas(30_000_000)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
        // The proxy now runs the v1.1.7.4 implementation, whose `addContract`
        // dropped the two genesis-fee args, so subsequent listings use it.
        self.legacy.store(false, Ordering::Relaxed);
    }

    async fn deploy(implementation: Option<&str>) -> Self {
        let anvil = Anvil::new()
            .block_time_f64(BLOCK_TIME_SEC)
            .chain_id(CHAIN_ID)
            .args(vec!["--code-size-limit", "131072"])
            .args(vec!["--gas-limit", "200000000"])
            .args(vec!["--base-fee", "100000000000"])
            .args(vec!["--order", "fifo"])
            .args(vec!["--max-persisted-states", "1000"])
            .args(vec!["--slots-in-an-epoch", "0"])
            .try_spawn()
            .unwrap();
        let client = RpcClient::builder().http(anvil.endpoint_url());
        client.set_poll_interval(Duration::from_millis(POLL_INTERVAL_MS));
        let provider = DynProvider::new(
            ProviderBuilder::new()
                .wallet(anvil.wallet().unwrap())
                .connect_client(client),
        );
        // Deploy multicall3 contract (see https://github.com/mds1/multicall3?tab=readme-ov-file#new-deployments)
        provider
            .anvil_set_balance(
                address!("0x05f32b3cc3888453ff71b01135b34ff8e41263f2"),
                U256::from(1e18 as u64),
            )
            .await
            .unwrap();
        _ = provider.send_raw_transaction(&hex!("0xf90f538085174876e800830f42408080b90f00608060405234801561001057600080fd5b50610ee0806100206000396000f3fe6080604052600436106100f35760003560e01c80634d2301cc1161008a578063a8b0574e11610059578063a8b0574e1461025a578063bce38bd714610275578063c3077fa914610288578063ee82ac5e1461029b57600080fd5b80634d2301cc146101ec57806372425d9d1461022157806382ad56cb1461023457806386d516e81461024757600080fd5b80633408e470116100c65780633408e47014610191578063399542e9146101a45780633e64a696146101c657806342cbb15c146101d957600080fd5b80630f28c97d146100f8578063174dea711461011a578063252dba421461013a57806327e86d6e1461015b575b600080fd5b34801561010457600080fd5b50425b6040519081526020015b60405180910390f35b61012d610128366004610a85565b6102ba565b6040516101119190610bbe565b61014d610148366004610a85565b6104ef565b604051610111929190610bd8565b34801561016757600080fd5b50437fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0140610107565b34801561019d57600080fd5b5046610107565b6101b76101b2366004610c60565b610690565b60405161011193929190610cba565b3480156101d257600080fd5b5048610107565b3480156101e557600080fd5b5043610107565b3480156101f857600080fd5b50610107610207366004610ce2565b73ffffffffffffffffffffffffffffffffffffffff163190565b34801561022d57600080fd5b5044610107565b61012d610242366004610a85565b6106ab565b34801561025357600080fd5b5045610107565b34801561026657600080fd5b50604051418152602001610111565b61012d610283366004610c60565b61085a565b6101b7610296366004610a85565b610a1a565b3480156102a757600080fd5b506101076102b6366004610d18565b4090565b60606000828067ffffffffffffffff8111156102d8576102d8610d31565b60405190808252806020026020018201604052801561031e57816020015b6040805180820190915260008152606060208201528152602001906001900390816102f65790505b5092503660005b8281101561047757600085828151811061034157610341610d60565b6020026020010151905087878381811061035d5761035d610d60565b905060200281019061036f9190610d8f565b6040810135958601959093506103886020850185610ce2565b73ffffffffffffffffffffffffffffffffffffffff16816103ac6060870187610dcd565b6040516103ba929190610e32565b60006040518083038185875af1925050503d80600081146103f7576040519150601f19603f3d011682016040523d82523d6000602084013e6103fc565b606091505b50602080850191909152901515808452908501351761046d577f08c379a000000000000000000000000000000000000000000000000000000000600052602060045260176024527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060445260846000fd5b5050600101610325565b508234146104e6576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f4d756c746963616c6c333a2076616c7565206d69736d6174636800000000000060448201526064015b60405180910390fd5b50505092915050565b436060828067ffffffffffffffff81111561050c5761050c610d31565b60405190808252806020026020018201604052801561053f57816020015b606081526020019060019003908161052a5790505b5091503660005b8281101561068657600087878381811061056257610562610d60565b90506020028101906105749190610e42565b92506105836020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff166105a66020850185610dcd565b6040516105b4929190610e32565b6000604051808303816000865af19150503d80600081146105f1576040519150601f19603f3d011682016040523d82523d6000602084013e6105f6565b606091505b5086848151811061060957610609610d60565b602090810291909101015290508061067d576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060448201526064016104dd565b50600101610546565b5050509250929050565b43804060606106a086868661085a565b905093509350939050565b6060818067ffffffffffffffff8111156106c7576106c7610d31565b60405190808252806020026020018201604052801561070d57816020015b6040805180820190915260008152606060208201528152602001906001900390816106e55790505b5091503660005b828110156104e657600084828151811061073057610730610d60565b6020026020010151905086868381811061074c5761074c610d60565b905060200281019061075e9190610e76565b925061076d6020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff166107906040850185610dcd565b60405161079e929190610e32565b6000604051808303816000865af19150503d80600081146107db576040519150601f19603f3d011682016040523d82523d6000602084013e6107e0565b606091505b506020808401919091529015158083529084013517610851577f08c379a000000000000000000000000000000000000000000000000000000000600052602060045260176024527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060445260646000fd5b50600101610714565b6060818067ffffffffffffffff81111561087657610876610d31565b6040519080825280602002602001820160405280156108bc57816020015b6040805180820190915260008152606060208201528152602001906001900390816108945790505b5091503660005b82811015610a105760008482815181106108df576108df610d60565b602002602001015190508686838181106108fb576108fb610d60565b905060200281019061090d9190610e42565b925061091c6020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff1661093f6020850185610dcd565b60405161094d929190610e32565b6000604051808303816000865af19150503d806000811461098a576040519150601f19603f3d011682016040523d82523d6000602084013e61098f565b606091505b506020830152151581528715610a07578051610a07576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060448201526064016104dd565b506001016108c3565b5050509392505050565b6000806060610a2b60018686610690565b919790965090945092505050565b60008083601f840112610a4b57600080fd5b50813567ffffffffffffffff811115610a6357600080fd5b6020830191508360208260051b8501011115610a7e57600080fd5b9250929050565b60008060208385031215610a9857600080fd5b823567ffffffffffffffff811115610aaf57600080fd5b610abb85828601610a39565b90969095509350505050565b6000815180845260005b81811015610aed57602081850181015186830182015201610ad1565b81811115610aff576000602083870101525b50601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b600082825180855260208086019550808260051b84010181860160005b84811015610bb1578583037fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe001895281518051151584528401516040858501819052610b9d81860183610ac7565b9a86019a9450505090830190600101610b4f565b5090979650505050505050565b602081526000610bd16020830184610b32565b9392505050565b600060408201848352602060408185015281855180845260608601915060608160051b870101935082870160005b82811015610c52577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa0888703018452610c40868351610ac7565b95509284019290840190600101610c06565b509398975050505050505050565b600080600060408486031215610c7557600080fd5b83358015158114610c8557600080fd5b9250602084013567ffffffffffffffff811115610ca157600080fd5b610cad86828701610a39565b9497909650939450505050565b838152826020820152606060408201526000610cd96060830184610b32565b95945050505050565b600060208284031215610cf457600080fd5b813573ffffffffffffffffffffffffffffffffffffffff81168114610bd157600080fd5b600060208284031215610d2a57600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fd5b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff81833603018112610dc357600080fd5b9190910192915050565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe1843603018112610e0257600080fd5b83018035915067ffffffffffffffff821115610e1d57600080fd5b602001915036819003821315610a7e57600080fd5b8183823760009101908152919050565b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc1833603018112610dc357600080fd5b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa1833603018112610dc357600080fdfea2646970667358221220bb2b5c71a328032f97c676ae39a1ec2148d3e5d6f73d95e9b17910152d61f16264736f6c634300080c00331ca0edce47092c0f398cebf3ffc267f05c8e7076e3b89445e0fe50f6332273d4569ba01b0b9d000e19b24c5869b0fc3b22b0d6fa47cd63316875cbbd577d76e6fde086")).await.unwrap();

        let (owner, admin, price_admin) =
            (anvil.addresses()[0], anvil.addresses()[1], anvil.addresses()[2]);

        // Test USD
        let token = TestToken::deploy(
            provider.clone(),
            "Test USD".to_string(),
            "USD".to_string(),
            USD_DECIMALS,
        )
        .await
        .unwrap();

        // Some allocation to owner for the faucet
        token
            .mint(owner, usd(1_000_000_000))
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();

        // Exchange implementation and upgradeable proxy. `initialize` is
        // unchanged across the generations, so its calldata can be built from the
        // current bindings whichever implementation is deployed.
        let exchange_impl = match implementation {
            None => *Exchange::deploy(provider.clone())
                .await
                .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
                .unwrap()
                .address(),
            Some(bytecode) => deploy_bytecode(&provider, bytecode).await,
        };
        let init_calldata = Exchange::new(exchange_impl, provider.clone())
            .initialize(*token.address())
            .calldata()
            .clone();
        let proxy = ERC1967Proxy::deploy(provider.clone(), exchange_impl, init_calldata)
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap();
        let exchange = Exchange::new(*proxy.address(), provider.clone());

        // Disable account whitelisting
        exchange
            .setWhitelistingEnabled(false)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();

        // Setup roles
        exchange
            .setAdministrator(admin, true)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
        exchange
            .setPriceAdministrator(price_admin, true)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();

        Self {
            chain_id: anvil.chain_id(),
            rpc_url: anvil.endpoint_url().to_string(),
            provider,
            exchange,
            token,
            owner,
            owner_pk: anvil.nth_key(0).unwrap().to_bytes().encode_hex(),
            admin,
            admin_pk: anvil.nth_key(1).unwrap().to_bytes().encode_hex(),
            price_admin,
            price_admin_pk: anvil.nth_key(2).unwrap().to_bytes().encode_hex(),
            collateral_converter: num::Converter::new(USD_DECIMALS),
            perpetual_ids: Arc::new(DashSet::new()),
            account_address: Arc::new(DashMap::new()),
            // A specific implementation is only ever requested by
            // `new_at_previous_version`, so this marks the pre-upgrade generation.
            legacy: AtomicBool::new(implementation.is_some()),
            anvil,
        }
    }

    pub fn chain(&self) -> Chain {
        Chain::custom(
            self.chain_id,
            *self.token.address(),
            0,
            *self.exchange.address(),
            self.perpetual_ids.iter().map(|p| *p).collect(),
        )
    }

    /// Same chain with no perpetual contracts configured, so clients discover
    /// every listed contract on-chain instead.
    pub fn chain_with_perpetual_discovery(&self) -> Chain { self.chain().with_perpetuals(vec![]) }

    pub async fn account(&self, idx: usize, usd_balance: u64) -> TestAccount<'_> {
        let address = self.anvil.addresses()[idx + 3]; // skipping owner, admin and price admin
        let target_balance = usd(usd_balance);
        let cur_balance = self.token.balanceOf(address).call().await.unwrap();
        if target_balance > cur_balance {
            self.token
                .mint(address, target_balance - cur_balance)
                .send()
                .await
                .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
                .unwrap()
                .get_receipt()
                .await
                .unwrap();
        }
        self.token
            .approve(*self.exchange.address(), target_balance)
            .from(address)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
        let receipt = self
            .exchange
            .createAccount(target_balance)
            .from(address)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
        let log = receipt.decoded_log::<Exchange::AccountCreated>().unwrap();
        self.account_address.insert(log.id.to(), log.account);
        TestAccount { id: log.id.to(), address: log.account, exchange: self }
    }

    /// Sets the exchange-wide default fee schedule, eight `(taker, maker)`
    /// rates indexed by an account's fee tier. Every perpetual contract
    /// that has not been repointed resolves its fees from this schedule.
    pub async fn set_fee_schedule(
        &self,
        taker_fees: [UD64; state::FEE_TIERS],
        maker_fees: [UD64; state::FEE_TIERS],
    ) {
        let fee_converter = num::fee_converter();
        self.exchange
            .setDefaultPerpFeeSchedValues(
                taker_fees.map(|fee| fee_converter.to_unsigned(fee)),
                maker_fees.map(|fee| fee_converter.to_unsigned(fee)),
            )
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
    }

    /// Sets the exchange-wide RWA default fee schedule, see
    /// [`Self::set_fee_schedule`].
    pub async fn set_rwa_fee_schedule(
        &self,
        taker_fees: [UD64; state::FEE_TIERS],
        maker_fees: [UD64; state::FEE_TIERS],
    ) {
        let fee_converter = num::fee_converter();
        self.exchange
            .setDefaultRwaFeeSchedValues(
                taker_fees.map(|fee| fee_converter.to_unsigned(fee)),
                maker_fees.map(|fee| fee_converter.to_unsigned(fee)),
            )
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
    }

    /// Assigns fee tiers to accounts, indexing the fee schedule of every
    /// perpetual contract they trade.
    pub async fn set_account_fee_tiers(&self, tiers: Vec<(types::AccountId, types::FeeTier)>) {
        self.exchange
            .setAccountFeeTiers(
                tiers
                    .into_iter()
                    .map(|(account_id, tier)| Exchange::AccountFeeTier {
                        accountId: U256::from(account_id),
                        tier: U256::from(tier),
                    })
                    .collect(),
            )
            .from(self.admin)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
    }

    /// Adds a perpetual contract, placed on the exchange-wide default fee
    /// schedule.
    ///
    /// Fees are not a listing parameter: the schedule is seeded once at
    /// deployment, and `addContract` retains its fee arguments for ABI
    /// stability while ignoring them (v1.1.7.4). Use
    /// [`Self::set_fee_schedule`] to retune the shared schedule, or
    /// [`TestPerp::set_fee_schedule`] to give this contract its own.
    #[allow(clippy::too_many_arguments)]
    pub async fn perp(
        &self,
        name: &str,
        perp_id: types::PerpetualId,
        base_price: UD64,
        price_decimals: u8,
        size_decimals: u8,
        initial_margin: UD64,
        maintenance_margin: UD64,
    ) -> TestPerp<'_> {
        let price_converter = num::Converter::new(price_decimals);
        let leverage_converter = num::Converter::new(2); // Margin and leverage are in 100th
        if self.legacy.load(Ordering::Relaxed) {
            // The pre-v1.1.7.4 generation's `addContract` still carries the two
            // genesis-fee args (dropped in v1.1.7.4); reach it through the legacy
            // interface so the selector matches the deployed contract. Genesis
            // fees are seeded to zero and set separately via
            // `TestPerp::with_legacy_fees`.
            crate::abi::dex_legacy::LegacyExchange::new(
                *self.exchange.address(),
                self.provider.clone(),
            )
            .addContract(
                name.to_string(),
                name.to_string(),
                U256::from(perp_id),
                price_converter.to_unsigned(base_price),
                U256::from(price_decimals),
                U256::from(size_decimals),
                U256::ZERO,
                U256::ZERO,
                leverage_converter.to_unsigned(initial_margin),
                leverage_converter.to_unsigned(maintenance_margin),
            )
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
        } else {
            self.exchange
                .addContract(
                    name.to_string(),
                    name.to_string(),
                    U256::from(perp_id),
                    price_converter.to_unsigned(base_price),
                    U256::from(price_decimals),
                    U256::from(size_decimals),
                    leverage_converter.to_unsigned(initial_margin),
                    leverage_converter.to_unsigned(maintenance_margin),
                )
                .send()
                .await
                .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
                .unwrap()
                .get_receipt()
                .await
                .unwrap();
        }
        // Ignore oracle to eliminate ChainLink dependency
        self.exchange
            .setIgnOracle(U256::from(perp_id), true)
            .send()
            .await
            .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
            .unwrap()
            .get_receipt()
            .await
            .unwrap();
        self.perpetual_ids.insert(perp_id);
        TestPerp {
            id: perp_id,
            name: name.to_string(),
            price_converter,
            size_converter: num::Converter::new(size_decimals),
            leverage_converter,
            exchange: self,
        }
    }

    pub async fn btc_perp(&self) -> TestPerp<'_> {
        self.perp("BTC", 0x10, udec64!(5000), 1, 5, udec64!(10), udec64!(20))
            .await
            .with_mark_price(udec64!(100000))
            .await
            .unpause()
            .await
    }

    pub async fn eth_perp(&self) -> TestPerp<'_> {
        self.perp("ETH", 0x20, udec64!(1), 2, 3, udec64!(10), udec64!(20))
            .await
            .with_mark_price(udec64!(4000))
            .await
            .unpause()
            .await
    }

    pub async fn sol_perp(&self) -> TestPerp<'_> {
        self.perp("SOL", 0x30, udec64!(1), 2, 3, udec64!(10), udec64!(20))
            .await
            .with_mark_price(udec64!(200))
            .await
            .unpause()
            .await
    }

    pub async fn trx_perp(&self) -> TestPerp<'_> {
        self.perp("TRX", 0x40, udec64!(1), 5, 0, udec64!(10), udec64!(20))
            .await
            .with_mark_price(udec64!(0.3))
            .await
            .unpause()
            .await
    }
}

/// Deploys a contract from raw creation bytecode, for an implementation the SDK
/// has no bindings for.
async fn deploy_bytecode(provider: &DynProvider, bytecode: &str) -> Address {
    let code = Bytes::from_str(bytecode.trim()).expect("implementation bytecode");
    provider
        .send_transaction(TransactionRequest::default().with_deploy_code(code))
        .await
        .map_err::<DexError, _>(|err| DexError::Provider(err.into()))
        .unwrap()
        .get_receipt()
        .await
        .unwrap()
        .contract_address
        .expect("implementation deployed")
}

pub fn scale(amount: u64, decimals: u8) -> U256 {
    U256::from(amount) * U256::from(10).pow(U256::from(decimals))
}

pub fn usd(amount: u64) -> U256 { scale(amount, USD_DECIMALS) }