zeus-userop-kit 0.1.0

ERC-4337 user operation builder and bundler client for EntryPoint 0.7 and 0.8
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

use alloy_eips::eip7702::{Authorization as AlloyAuthorization, SignedAuthorization};
use alloy_primitives::{Address, B256, Bytes, U256};
use alloy_rpc_types::{Log, ReceiptWithBloom, TransactionReceipt};

use serde::{Deserialize, Serialize};

use crate::abis::entry_point::EntryPoint::PackedUserOperation;

/// ERC-4337 UserOperation in unpacked JSON-RPC wire format.
///
/// EntryPoint 0.7 & 0.8
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct UserOperation {
   pub sender: Address,

   pub nonce: U256,

   #[serde(skip_serializing_if = "Option::is_none")]
   pub factory: Option<Address>,

   #[serde(skip_serializing_if = "Option::is_none")]
   pub factory_data: Option<Bytes>,

   pub call_data: Bytes,

   #[serde(with = "alloy_serde::quantity")]
   pub call_gas_limit: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub verification_gas_limit: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub pre_verification_gas: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub max_fee_per_gas: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub max_priority_fee_per_gas: u128,

   #[serde(skip_serializing_if = "Option::is_none")]
   pub paymaster: Option<Address>,

   #[serde(
      default,
      skip_serializing_if = "Option::is_none",
      with = "alloy_serde::quantity::opt"
   )]
   pub paymaster_verification_gas_limit: Option<u128>,

   #[serde(
      default,
      skip_serializing_if = "Option::is_none",
      with = "alloy_serde::quantity::opt"
   )]
   pub paymaster_post_op_gas_limit: Option<u128>,

   #[serde(skip_serializing_if = "Option::is_none")]
   pub paymaster_data: Option<Bytes>,

   #[serde(
      rename = "eip7702Auth",
      default,
      skip_serializing_if = "Authorization::is_none"
   )]
   pub authorization: Authorization,

   pub signature: Bytes,
}

/// Eip-7702 authorization
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Authorization {
   #[default]
   None,
   SignedEip7702(SignedAuthorization),
   Eip7702(AlloyAuthorization),
}

impl Authorization {
   fn is_none(&self) -> bool {
      matches!(self, Authorization::None)
   }
}

/// A submitted user operation hash.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct UserOperationHash(pub B256);

/// Gas estimates returned by `eth_estimateUserOperationGas`.
///
/// EntryPoint 0.7 & 0.8
#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UserOperationGasEstimate {
   #[serde(with = "alloy_serde::quantity")]
   pub pre_verification_gas: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub verification_gas_limit: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub call_gas_limit: u128,

   #[serde(default, with = "alloy_serde::quantity::opt")]
   pub paymaster_verification_gas_limit: Option<u128>,

   #[serde(default, with = "alloy_serde::quantity::opt")]
   pub paymaster_post_op_gas_limit: Option<u128>,

   #[serde(with = "alloy_serde::quantity")]
   pub max_fee_per_gas: u128,

   #[serde(with = "alloy_serde::quantity")]
   pub max_priority_fee_per_gas: u128,
}

/// Receipt returned by `eth_getUserOperationReceipt`.
///
/// EntryPoint 0.7 & 0.8
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UserOperationReceipt {
   pub entry_point: Address,

   pub user_op_hash: B256,

   pub sender: Address,

   pub nonce: U256,

   pub actual_gas_used: U256,

   pub actual_gas_cost: U256,

   pub success: bool,

   #[serde(skip_serializing_if = "Option::is_none")]
   pub reason: Option<Bytes>,
   pub logs: Vec<Log>,
   pub receipt: TransactionReceipt<ReceiptWithBloom>,
}

impl UserOperation {
   pub fn into_packed(&self) -> PackedUserOperation {
      self.into()
   }

   /// Returns the total gas limit for this UserOperation, including paymaster gas limits if
   /// applicable.
   pub fn total_gas_limit(&self) -> u128 {
      let mut total = self.pre_verification_gas + self.verification_gas_limit + self.call_gas_limit;
      if let Some(paymaster_verification_gas_limit) = self.paymaster_verification_gas_limit {
         total += paymaster_verification_gas_limit;
      }
      if let Some(paymaster_post_op_gas_limit) = self.paymaster_post_op_gas_limit {
         total += paymaster_post_op_gas_limit;
      }
      total
   }
}