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
//! User operations.
use crate::decimals::PositiveDecimal;
use crate::define_enum;
use crate::string::CustomString;
use crate::time::UnixTimestampMicros;
use crate::types::{
AssetId, MarketId, SpotCollateralTransferDirection, TradingMode, TriggerOrderId, TwapId,
};
mod args;
pub use args::*;
define_enum! {
/// User operations requiring account ownership or delegation.
///
/// These operations are authorized via `context.sender()` with optional delegate resolution.
/// Operations include account management, trading, vault deposits, and user-initiated liquidations.
enum UserAction<Address> {
// =========================================================================
// Account Operations (0-19)
// =========================================================================
/// Deposit assets to perp margin account.
Deposit {
asset_id: AssetId,
amount: PositiveDecimal,
} = 0,
/// Withdraw assets from perp margin account.
Withdraw {
asset_id: AssetId,
amount: PositiveDecimal,
} = 1,
/// Deposit assets to spot collateral.
DepositSpotCollateral {
asset_id: AssetId,
amount: PositiveDecimal,
} = 2,
/// Withdraw assets from spot collateral.
WithdrawSpotCollateral {
asset_id: AssetId,
amount: PositiveDecimal,
} = 3,
/// Transfer assets between perp margin and spot collateral.
TransferSpotCollateral {
asset_id: AssetId,
amount: PositiveDecimal,
direction: SpotCollateralTransferDirection,
sub_account_index: Option<u8>,
} = 4,
/// Borrow assets from spot pool.
BorrowSpot {
asset_id: AssetId,
amount: PositiveDecimal,
sub_account_index: Option<u8>,
} = 5,
/// Create a new sub-account.
CreateSubAccount { index: u8 } = 6,
/// Transfer assets between main account and sub-account.
TransferToSubAccount {
asset_id: AssetId,
amount: PositiveDecimal,
sub_account_index: u8,
to_sub_account: bool,
} = 7,
/// Delegate trading permissions to another address.
DelegateUser { delegate: Address, name: CustomString } = 8,
/// Revoke delegation from an address.
RevokeDelegation { delegate: Address } = 9,
/// Update maximum leverage for a market.
UpdateMaxLeverage {
market_id: MarketId,
max_leverage: u16,
sub_account_index: Option<u8>,
} = 10,
/// Claim your own referral rewards.
ClaimReferralRewards { asset_id: AssetId } = 11,
/// Deposit USDC into an isolated market / isolated margin position.
DepositIso {
market_id: MarketId,
amount: PositiveDecimal,
} = 12,
/// Withdraw USDC from an isolated market / isolated margin position.
WithdrawIso {
market_id: MarketId,
amount: PositiveDecimal,
} = 13,
/// Set the trading mode of a perp ledger to cross or iso.
SetPerpLedgerTradingMode {
market_id: MarketId,
trading_mode: TradingMode,
sub_account_index: Option<u8>,
} = 14,
/// Delegate trading permissions to another address allowing for sub accounts to be delegated.
DelegateUserV1 {
delegate: Address,
name: CustomString,
sub_account_index: Option<u8>,
} = 15,
/// Revoke delegation from an address allowing for sub accounts to revoke delegation.
RevokeDelegationV1 {
delegate: Address,
sub_account_index: Option<u8>,
} = 16,
/// Delegate trading permissions with optional expiry and flags
DelegateUserV2 {
delegate: Address,
name: CustomString,
sub_account_index: Option<u8>,
expires_at: Option<UnixTimestampMicros>,
flags: u32,
} = 17,
// Reserved: 18-19
// =========================================================================
// Order Operations (20-39)
// =========================================================================
/// Place new orders on a market.
PlaceOrders {
market_id: MarketId,
orders: Vec<NewOrderArgs>,
replace: bool,
sub_account_index: Option<u8>,
} = 20,
/// Amend existing orders (cancel + place).
AmendOrders {
market_id: MarketId,
orders: Vec<AmendOrderArgs>,
sub_account_index: Option<u8>,
} = 21,
/// Cancel specific orders.
CancelOrders {
market_id: MarketId,
orders: Vec<CancelOrderArgs>,
sub_account_index: Option<u8>,
} = 22,
/// Cancel all orders on a market.
CancelMarketOrders {
market_id: MarketId,
sub_account_index: Option<u8>,
} = 23,
/// Create trigger orders for spot markets.
CreateTriggerOrders {
market_id: MarketId,
trigger_orders: Vec<NewTriggerOrderArgs>,
sub_account_index: Option<u8>,
} = 24,
/// Create take-profit/stop-loss for a perp position.
CreatePositionTpsl {
market_id: MarketId,
tpsl_pair: TpslPair,
size: Option<PositiveDecimal>,
sub_account_index: Option<u8>,
} = 25,
/// Cancel trigger orders.
CancelTriggerOrders {
market_id: MarketId,
trigger_order_ids: Vec<TriggerOrderId>,
sub_account_index: Option<u8>,
} = 26,
/// Create TWAP orders
CreateTwapOrder {
market_id: MarketId,
twap_order_args: NewTwapOrderArgs,
sub_account_index: Option<u8>,
} = 27,
/// Cancel a TWAP order
CancelTwapOrder {
market_id: MarketId,
twap_id: TwapId,
sub_account_index: Option<u8>,
} = 28,
/// Cancel all orders for perp or spot
CancelAllOrders { sub_account_index: Option<u8> } = 29,
// Reserved: 30-39
// =========================================================================
// Pool Operations (40-49)
// =========================================================================
/// Deposit USDC to the PnL pool.
DepositToPnlPool { usdc_amount: PositiveDecimal } = 40,
/// Settle user's PnL from the pool.
SettleFromPnlPool { sub_account_index: Option<u8> } = 41,
/// Deposit to the insurance fund.
DepositToInsuranceFund { usdc_amount: PositiveDecimal } = 42,
/// Deposit to protocol treasury.
DepositToTreasury {
asset_id: AssetId,
amount: PositiveDecimal,
} = 43,
/// Claim accumulated borrow/lend protocol fees.
ClaimBorrowLendFees {} = 44,
/// Deposit to the iso insurance fund.
DepositToIsoInsuranceFund { market_id: MarketId, amount: PositiveDecimal } = 45,
// Reserved: 46-49
// =========================================================================
// Vault User Operations (50-59)
// =========================================================================
/// Create a new vault (caller becomes the vault leader).
CreateVault { args: CreateVaultArgs<Address> } = 50,
/// Deposit assets to a vault.
DepositToVault {
vault_address: Address,
asset_id: AssetId,
amount: PositiveDecimal,
} = 51,
/// Queue a withdrawal from a vault.
QueueWithdrawal {
vault_address: Address,
shares: PositiveDecimal,
} = 52,
/// Cancel a queued withdrawal.
CancelQueuedWithdrawal { vault_address: Address } = 53,
/// Force withdraw from a vault (bypasses queue).
ForceWithdrawVault {
vault_address: Address,
shares: PositiveDecimal,
} = 54,
// Reserved: 55-59
// =========================================================================
// User-Initiated Liquidation Operations (60-69)
// =========================================================================
/// Backstop liquidation for perp positions (user provides capital).
BackstopLiquidatePerpPositions {
address: Address,
positions: Option<Vec<BackstopLiquidatePerpPositionArgs>>,
sub_account_index: Option<u8>,
} = 60,
/// Liquidate borrow/lend liability (user provides capital).
LiquidateBorrowLendLiability {
liquidatee_address: Address,
liability_asset_id: AssetId,
collateral_asset_id: AssetId,
liability_amount: PositiveDecimal,
sub_account_index: Option<u8>,
} = 61,
BackstopLiquidateIsoPerpPosition {
address: Address,
position: BackstopLiquidatePerpPositionArgs,
sub_account_index: Option<u8>,
} = 62,
// Reserved: 63-255
}
}