@aztec/ethereum 0.0.1-commit.b655e406 → 0.0.1-commit.b6e433891

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.
Files changed (229) hide show
  1. package/dest/account.d.ts +1 -1
  2. package/dest/chain.d.ts +1 -1
  3. package/dest/client.d.ts +10 -2
  4. package/dest/client.d.ts.map +1 -1
  5. package/dest/client.js +13 -3
  6. package/dest/config.d.ts +24 -68
  7. package/dest/config.d.ts.map +1 -1
  8. package/dest/config.js +67 -380
  9. package/dest/constants.d.ts +1 -1
  10. package/dest/contracts/empire_base.d.ts +9 -5
  11. package/dest/contracts/empire_base.d.ts.map +1 -1
  12. package/dest/contracts/empire_base.js +1 -1
  13. package/dest/contracts/empire_slashing_proposer.d.ts +8 -4
  14. package/dest/contracts/empire_slashing_proposer.d.ts.map +1 -1
  15. package/dest/contracts/empire_slashing_proposer.js +39 -17
  16. package/dest/contracts/errors.d.ts +1 -1
  17. package/dest/contracts/errors.d.ts.map +1 -1
  18. package/dest/contracts/fee_asset_handler.d.ts +6 -5
  19. package/dest/contracts/fee_asset_handler.d.ts.map +1 -1
  20. package/dest/contracts/fee_asset_handler.js +11 -9
  21. package/dest/contracts/fee_asset_price_oracle.d.ts +101 -0
  22. package/dest/contracts/fee_asset_price_oracle.d.ts.map +1 -0
  23. package/dest/contracts/fee_asset_price_oracle.js +651 -0
  24. package/dest/contracts/fee_juice.d.ts +1 -1
  25. package/dest/contracts/fee_juice.d.ts.map +1 -1
  26. package/dest/contracts/governance.d.ts +18 -16
  27. package/dest/contracts/governance.d.ts.map +1 -1
  28. package/dest/contracts/governance.js +14 -4
  29. package/dest/contracts/governance_proposer.d.ts +8 -4
  30. package/dest/contracts/governance_proposer.d.ts.map +1 -1
  31. package/dest/contracts/governance_proposer.js +412 -11
  32. package/dest/contracts/gse.d.ts +1 -1
  33. package/dest/contracts/gse.d.ts.map +1 -1
  34. package/dest/contracts/inbox.d.ts +24 -3
  35. package/dest/contracts/inbox.d.ts.map +1 -1
  36. package/dest/contracts/inbox.js +36 -1
  37. package/dest/contracts/index.d.ts +4 -1
  38. package/dest/contracts/index.d.ts.map +1 -1
  39. package/dest/contracts/index.js +3 -0
  40. package/dest/contracts/log.d.ts +13 -0
  41. package/dest/contracts/log.d.ts.map +1 -0
  42. package/dest/contracts/log.js +1 -0
  43. package/dest/contracts/multicall.d.ts +2 -2
  44. package/dest/contracts/multicall.d.ts.map +1 -1
  45. package/dest/contracts/multicall.js +2 -1
  46. package/dest/contracts/outbox.d.ts +41 -0
  47. package/dest/contracts/outbox.d.ts.map +1 -0
  48. package/dest/contracts/outbox.js +86 -0
  49. package/dest/contracts/registry.d.ts +3 -1
  50. package/dest/contracts/registry.d.ts.map +1 -1
  51. package/dest/contracts/registry.js +30 -1
  52. package/dest/contracts/rollup.d.ts +208 -123
  53. package/dest/contracts/rollup.d.ts.map +1 -1
  54. package/dest/contracts/rollup.js +807 -188
  55. package/dest/contracts/slasher_contract.d.ts +1 -1
  56. package/dest/contracts/slasher_contract.d.ts.map +1 -1
  57. package/dest/contracts/tally_slashing_proposer.d.ts +9 -7
  58. package/dest/contracts/tally_slashing_proposer.d.ts.map +1 -1
  59. package/dest/contracts/tally_slashing_proposer.js +11 -4
  60. package/dest/contracts/utils.d.ts +1 -1
  61. package/dest/deploy_aztec_l1_contracts.d.ts +259 -0
  62. package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -0
  63. package/dest/deploy_aztec_l1_contracts.js +413 -0
  64. package/dest/deploy_l1_contract.d.ts +68 -0
  65. package/dest/deploy_l1_contract.d.ts.map +1 -0
  66. package/dest/deploy_l1_contract.js +312 -0
  67. package/dest/eth-signer/eth-signer.d.ts +1 -1
  68. package/dest/eth-signer/index.d.ts +1 -1
  69. package/dest/forwarder_proxy.d.ts +32 -0
  70. package/dest/forwarder_proxy.d.ts.map +1 -0
  71. package/dest/forwarder_proxy.js +93 -0
  72. package/dest/generated/l1-contracts-defaults.d.ts +30 -0
  73. package/dest/generated/l1-contracts-defaults.d.ts.map +1 -0
  74. package/dest/generated/l1-contracts-defaults.js +30 -0
  75. package/dest/l1_artifacts.d.ts +7608 -2048
  76. package/dest/l1_artifacts.d.ts.map +1 -1
  77. package/dest/l1_contract_addresses.d.ts +3 -3
  78. package/dest/l1_contract_addresses.d.ts.map +1 -1
  79. package/dest/l1_contract_addresses.js +3 -3
  80. package/dest/l1_reader.d.ts +5 -1
  81. package/dest/l1_reader.d.ts.map +1 -1
  82. package/dest/l1_reader.js +12 -1
  83. package/dest/l1_tx_utils/config.d.ts +11 -5
  84. package/dest/l1_tx_utils/config.d.ts.map +1 -1
  85. package/dest/l1_tx_utils/config.js +43 -7
  86. package/dest/l1_tx_utils/constants.d.ts +8 -2
  87. package/dest/l1_tx_utils/constants.d.ts.map +1 -1
  88. package/dest/l1_tx_utils/constants.js +27 -2
  89. package/dest/l1_tx_utils/factory.d.ts +18 -10
  90. package/dest/l1_tx_utils/factory.d.ts.map +1 -1
  91. package/dest/l1_tx_utils/factory.js +17 -7
  92. package/dest/l1_tx_utils/fee-strategies/index.d.ts +10 -0
  93. package/dest/l1_tx_utils/fee-strategies/index.d.ts.map +1 -0
  94. package/dest/l1_tx_utils/fee-strategies/index.js +12 -0
  95. package/dest/l1_tx_utils/fee-strategies/p75_competitive.d.ts +8 -0
  96. package/dest/l1_tx_utils/fee-strategies/p75_competitive.d.ts.map +1 -0
  97. package/dest/l1_tx_utils/fee-strategies/p75_competitive.js +129 -0
  98. package/dest/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.d.ts +23 -0
  99. package/dest/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.d.ts.map +1 -0
  100. package/dest/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.js +191 -0
  101. package/dest/l1_tx_utils/fee-strategies/types.d.ts +51 -0
  102. package/dest/l1_tx_utils/fee-strategies/types.d.ts.map +1 -0
  103. package/dest/l1_tx_utils/fee-strategies/types.js +3 -0
  104. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts +41 -0
  105. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts.map +1 -0
  106. package/dest/l1_tx_utils/forwarder_l1_tx_utils.js +42 -0
  107. package/dest/l1_tx_utils/index-blobs.d.ts +3 -0
  108. package/dest/l1_tx_utils/index-blobs.d.ts.map +1 -0
  109. package/dest/l1_tx_utils/index-blobs.js +2 -0
  110. package/dest/l1_tx_utils/index.d.ts +4 -1
  111. package/dest/l1_tx_utils/index.d.ts.map +1 -1
  112. package/dest/l1_tx_utils/index.js +3 -0
  113. package/dest/l1_tx_utils/interfaces.d.ts +2 -2
  114. package/dest/l1_tx_utils/interfaces.d.ts.map +1 -1
  115. package/dest/l1_tx_utils/l1_fee_analyzer.d.ts +233 -0
  116. package/dest/l1_tx_utils/l1_fee_analyzer.d.ts.map +1 -0
  117. package/dest/l1_tx_utils/l1_fee_analyzer.js +506 -0
  118. package/dest/l1_tx_utils/l1_tx_utils.d.ts +18 -8
  119. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  120. package/dest/l1_tx_utils/l1_tx_utils.js +75 -46
  121. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +19 -30
  122. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
  123. package/dest/l1_tx_utils/readonly_l1_tx_utils.js +63 -167
  124. package/dest/l1_tx_utils/signer.d.ts +1 -1
  125. package/dest/l1_tx_utils/tx_delayer.d.ts +56 -0
  126. package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -0
  127. package/dest/{test → l1_tx_utils}/tx_delayer.js +65 -36
  128. package/dest/l1_tx_utils/types.d.ts +1 -1
  129. package/dest/l1_tx_utils/types.d.ts.map +1 -1
  130. package/dest/l1_tx_utils/utils.d.ts +1 -1
  131. package/dest/l1_types.d.ts +1 -1
  132. package/dest/publisher_manager.d.ts +3 -2
  133. package/dest/publisher_manager.d.ts.map +1 -1
  134. package/dest/publisher_manager.js +2 -2
  135. package/dest/queries.d.ts +2 -2
  136. package/dest/queries.d.ts.map +1 -1
  137. package/dest/queries.js +16 -6
  138. package/dest/test/chain_monitor.d.ts +47 -25
  139. package/dest/test/chain_monitor.d.ts.map +1 -1
  140. package/dest/test/chain_monitor.js +66 -38
  141. package/dest/test/eth_cheat_codes.d.ts +11 -3
  142. package/dest/test/eth_cheat_codes.d.ts.map +1 -1
  143. package/dest/test/eth_cheat_codes.js +11 -3
  144. package/dest/test/eth_cheat_codes_with_state.d.ts +1 -1
  145. package/dest/test/eth_cheat_codes_with_state.d.ts.map +1 -1
  146. package/dest/test/index.d.ts +1 -3
  147. package/dest/test/index.d.ts.map +1 -1
  148. package/dest/test/index.js +0 -2
  149. package/dest/test/rollup_cheat_codes.d.ts +17 -13
  150. package/dest/test/rollup_cheat_codes.d.ts.map +1 -1
  151. package/dest/test/rollup_cheat_codes.js +62 -38
  152. package/dest/test/start_anvil.d.ts +18 -2
  153. package/dest/test/start_anvil.d.ts.map +1 -1
  154. package/dest/test/start_anvil.js +129 -28
  155. package/dest/test/upgrade_utils.d.ts +1 -1
  156. package/dest/test/upgrade_utils.js +2 -2
  157. package/dest/types.d.ts +57 -2
  158. package/dest/types.d.ts.map +1 -1
  159. package/dest/utils.d.ts +16 -3
  160. package/dest/utils.d.ts.map +1 -1
  161. package/dest/utils.js +80 -12
  162. package/dest/zkPassportVerifierAddress.d.ts +1 -1
  163. package/package.json +34 -16
  164. package/src/client.ts +10 -2
  165. package/src/config.ts +86 -460
  166. package/src/contracts/README.md +157 -0
  167. package/src/contracts/empire_base.ts +8 -5
  168. package/src/contracts/empire_slashing_proposer.ts +38 -32
  169. package/src/contracts/fee_asset_handler.ts +10 -7
  170. package/src/contracts/fee_asset_price_oracle.ts +280 -0
  171. package/src/contracts/governance.ts +13 -4
  172. package/src/contracts/governance_proposer.ts +26 -6
  173. package/src/contracts/inbox.ts +55 -3
  174. package/src/contracts/index.ts +3 -0
  175. package/src/contracts/log.ts +13 -0
  176. package/src/contracts/multicall.ts +5 -2
  177. package/src/contracts/outbox.ts +98 -0
  178. package/src/contracts/registry.ts +31 -1
  179. package/src/contracts/rollup.ts +485 -162
  180. package/src/contracts/tally_slashing_proposer.ts +15 -8
  181. package/src/deploy_aztec_l1_contracts.ts +650 -0
  182. package/src/deploy_l1_contract.ts +362 -0
  183. package/src/forwarder_proxy.ts +108 -0
  184. package/src/generated/l1-contracts-defaults.ts +32 -0
  185. package/src/l1_contract_addresses.ts +22 -20
  186. package/src/l1_reader.ts +21 -1
  187. package/src/l1_tx_utils/config.ts +52 -11
  188. package/src/l1_tx_utils/constants.ts +13 -2
  189. package/src/l1_tx_utils/factory.ts +31 -31
  190. package/src/l1_tx_utils/fee-strategies/index.ts +22 -0
  191. package/src/l1_tx_utils/fee-strategies/p75_competitive.ts +163 -0
  192. package/src/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.ts +245 -0
  193. package/src/l1_tx_utils/fee-strategies/types.ts +56 -0
  194. package/src/l1_tx_utils/forwarder_l1_tx_utils.ts +108 -0
  195. package/src/l1_tx_utils/index-blobs.ts +2 -0
  196. package/src/l1_tx_utils/index.ts +3 -0
  197. package/src/l1_tx_utils/interfaces.ts +1 -1
  198. package/src/l1_tx_utils/l1_fee_analyzer.ts +803 -0
  199. package/src/l1_tx_utils/l1_tx_utils.ts +84 -36
  200. package/src/l1_tx_utils/readonly_l1_tx_utils.ts +77 -213
  201. package/src/{test → l1_tx_utils}/tx_delayer.ts +82 -52
  202. package/src/publisher_manager.ts +4 -2
  203. package/src/queries.ts +17 -6
  204. package/src/test/chain_monitor.ts +110 -51
  205. package/src/test/eth_cheat_codes.ts +9 -3
  206. package/src/test/index.ts +0 -2
  207. package/src/test/rollup_cheat_codes.ts +63 -43
  208. package/src/test/start_anvil.ts +156 -27
  209. package/src/test/upgrade_utils.ts +2 -2
  210. package/src/types.ts +62 -0
  211. package/src/utils.ts +100 -15
  212. package/dest/deploy_l1_contracts.d.ts +0 -226
  213. package/dest/deploy_l1_contracts.d.ts.map +0 -1
  214. package/dest/deploy_l1_contracts.js +0 -1473
  215. package/dest/index.d.ts +0 -18
  216. package/dest/index.d.ts.map +0 -1
  217. package/dest/index.js +0 -17
  218. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts +0 -26
  219. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts.map +0 -1
  220. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.js +0 -26
  221. package/dest/test/delayed_tx_utils.d.ts +0 -13
  222. package/dest/test/delayed_tx_utils.d.ts.map +0 -1
  223. package/dest/test/delayed_tx_utils.js +0 -28
  224. package/dest/test/tx_delayer.d.ts +0 -36
  225. package/dest/test/tx_delayer.d.ts.map +0 -1
  226. package/src/deploy_l1_contracts.ts +0 -1849
  227. package/src/index.ts +0 -17
  228. package/src/l1_tx_utils/l1_tx_utils_with_blobs.ts +0 -77
  229. package/src/test/delayed_tx_utils.ts +0 -52
@@ -0,0 +1,157 @@
1
+ # L1 Contract Wrappers
2
+
3
+ This folder contains TypeScript wrappers for L1 contracts defined in `l1-contracts/`. These wrappers are used by the node client to interact with the rollup and related contracts on Ethereum.
4
+
5
+ ## Purpose
6
+
7
+ The goal of wrapping is to shield consumers from L1-specific and viem-specific details. Clients using these wrappers interact with domain types and branded types native to the Aztec codebase, without needing to understand viem's ABI type system or deal with raw types like `Hex` and `bigint`.
8
+
9
+ ## Type Safety
10
+
11
+ ### Explicit Return Types
12
+
13
+ Every function in the contract wrappers must declare its return type explicitly. This is critical because viem's type inference over ABI types is slow and significantly impacts IDE performance.
14
+
15
+ ```typescript
16
+ // Good: Explicit return type
17
+ async getSlotNumber(): Promise<SlotNumber> {
18
+ return SlotNumber.fromBigInt(await this.rollup.read.getCurrentSlot());
19
+ }
20
+
21
+ // Bad: Inferred return type (slow)
22
+ async getSlotNumber() {
23
+ return SlotNumber.fromBigInt(await this.rollup.read.getCurrentSlot());
24
+ }
25
+ ```
26
+
27
+ ### Branded and Domain Types
28
+
29
+ Use branded types and domain-specific types instead of viem's autogenerated types for both arguments and return values:
30
+
31
+ - `CheckpointNumber`, `EpochNumber`, `SlotNumber` instead of `bigint`
32
+ - `EthAddress` instead of `` `0x${string}` `` or `Hex`
33
+ - `Fr`, `Buffer32` instead of `Hex` for hashes and field elements
34
+ - Custom domain types (e.g., `CheckpointLog`, `AttesterView`) instead of raw tuples
35
+
36
+ Type conversions happen inside wrapper methods, not at the call site:
37
+
38
+ ```typescript
39
+ async getCheckpoint(checkpointNumber: CheckpointNumber): Promise<CheckpointLog> {
40
+ const result = await this.rollup.read.getCheckpoint([BigInt(checkpointNumber)]);
41
+ return {
42
+ archive: Fr.fromString(result.archive),
43
+ headerHash: Buffer32.fromString(result.headerHash),
44
+ blockCount: result.blockCount,
45
+ };
46
+ }
47
+ ```
48
+
49
+ ## Wrapper Pattern
50
+
51
+ ### Basic Structure
52
+
53
+ Each wrapper follows a consistent structure:
54
+
55
+ ```typescript
56
+ export class FooContract {
57
+ private readonly foo: GetContractReturnType<typeof FooAbi, ViemClient>;
58
+
59
+ constructor(
60
+ public readonly client: ViemClient,
61
+ address: Hex | EthAddress,
62
+ ) {
63
+ if (address instanceof EthAddress) {
64
+ address = address.toString();
65
+ }
66
+ this.foo = getContract({ address, abi: FooAbi, client });
67
+ }
68
+
69
+ public get address(): Hex {
70
+ return this.foo.address;
71
+ }
72
+
73
+ public getContract(): GetContractReturnType<typeof FooAbi, ViemClient> {
74
+ return this.foo;
75
+ }
76
+ }
77
+ ```
78
+
79
+ The raw contract is exposed via `getContract()` for cases where direct access is needed, but most consumers should use the typed wrapper methods. Relying on `getContract()` is a code smell and should be avoided.
80
+
81
+ ### Static Factory Methods
82
+
83
+ Wrappers may provide static factory methods for common initialization patterns:
84
+
85
+ - `getFromConfig(config)` - construct from configuration object
86
+ - `getFromL1ContractsValues(deployResult)` - construct from deployment result
87
+
88
+ ### Wallet Assertions
89
+
90
+ For write operations that require a wallet, use an assertion helper:
91
+
92
+ ```typescript
93
+ private assertWallet(): GetContractReturnType<typeof FooAbi, ExtendedViemWalletClient> {
94
+ if (!isExtendedClient(this.client)) {
95
+ throw new Error('Wallet client is required for this operation');
96
+ }
97
+ return this.foo as GetContractReturnType<typeof FooAbi, ExtendedViemWalletClient>;
98
+ }
99
+ ```
100
+
101
+ ## Event Handling
102
+
103
+ ### Event Log Types
104
+
105
+ Event logs are wrapped in `L1EventLog<T>` to include L1 block context:
106
+
107
+ ```typescript
108
+ type L1EventLog<T> = {
109
+ l1BlockNumber: bigint;
110
+ l1BlockHash: Buffer32;
111
+ l1TransactionHash: Hex;
112
+ args: T;
113
+ };
114
+ ```
115
+
116
+ ### Event Fetching
117
+
118
+ Methods that fetch events convert viem's raw logs to domain types:
119
+
120
+ ```typescript
121
+ async getCheckpointProposedEvents(fromBlock: bigint, toBlock: bigint): Promise<CheckpointProposedLog[]> {
122
+ const logs = await this.rollup.getEvents.CheckpointProposed({}, { fromBlock, toBlock });
123
+ return logs.map(log => ({
124
+ l1BlockNumber: log.blockNumber!,
125
+ l1BlockHash: Buffer32.fromString(log.blockHash!),
126
+ l1TransactionHash: log.transactionHash!,
127
+ args: {
128
+ checkpointNumber: CheckpointNumber.fromBigInt(log.args.checkpointNumber!),
129
+ // ... convert other fields
130
+ },
131
+ }));
132
+ }
133
+ ```
134
+
135
+ ### Event Listeners
136
+
137
+ For reactive event handling, wrapper methods convert arguments before invoking callbacks:
138
+
139
+ ```typescript
140
+ public listenToCheckpointInvalidated(
141
+ callback: (args: { checkpointNumber: CheckpointNumber }) => unknown,
142
+ ): WatchContractEventReturnType {
143
+ return this.rollup.watchEvent.CheckpointInvalidated({}, {
144
+ onLogs: logs => {
145
+ for (const log of logs) {
146
+ if (log.args.checkpointNumber !== undefined) {
147
+ callback({ checkpointNumber: CheckpointNumber.fromBigInt(log.args.checkpointNumber) });
148
+ }
149
+ }
150
+ },
151
+ });
152
+ }
153
+ ```
154
+
155
+ ## Error Handling
156
+
157
+ Custom error classes in `errors.ts` extend `Error` and set `this.name` for proper error identification. Include relevant context as public readonly properties.
@@ -1,3 +1,4 @@
1
+ import type { SlotNumber } from '@aztec/foundation/branded-types';
1
2
  import type { EthAddress } from '@aztec/foundation/eth-address';
2
3
  import { Signature } from '@aztec/foundation/eth-signature';
3
4
  import { EmpireBaseAbi } from '@aztec/l1-artifacts/EmpireBaseAbi';
@@ -11,16 +12,18 @@ export interface IEmpireBase {
11
12
  getRoundInfo(
12
13
  rollupAddress: Hex,
13
14
  round: bigint,
14
- ): Promise<{ lastSignalSlot: bigint; payloadWithMostSignals: Hex; executed: boolean }>;
15
- computeRound(slot: bigint): Promise<bigint>;
15
+ ): Promise<{ lastSignalSlot: SlotNumber; payloadWithMostSignals: Hex; quorumReached: boolean; executed: boolean }>;
16
+ computeRound(slot: SlotNumber): Promise<bigint>;
16
17
  createSignalRequest(payload: Hex): L1TxRequest;
17
18
  createSignalRequestWithSignature(
18
19
  payload: Hex,
19
- round: bigint,
20
+ slot: SlotNumber,
20
21
  chainId: number,
21
22
  signerAddress: Hex,
22
23
  signer: (msg: TypedDataDefinition) => Promise<Hex>,
23
24
  ): Promise<L1TxRequest>;
25
+ /** Checks if a payload was ever submitted to governance via submitRoundWinner. */
26
+ hasPayloadBeenProposed(payload: Hex, fromBlock: bigint): Promise<boolean>;
24
27
  }
25
28
 
26
29
  export function encodeSignal(payload: Hex): Hex {
@@ -51,7 +54,7 @@ export function encodeSignalWithSignature(payload: Hex, signature: Signature) {
51
54
  export async function signSignalWithSig(
52
55
  signer: (msg: TypedDataDefinition) => Promise<Hex>,
53
56
  payload: Hex,
54
- slot: bigint,
57
+ slot: SlotNumber,
55
58
  instance: Hex,
56
59
  verifyingContract: Hex,
57
60
  chainId: number,
@@ -79,7 +82,7 @@ export async function signSignalWithSig(
79
82
 
80
83
  const message = {
81
84
  payload,
82
- slot,
85
+ slot: BigInt(slot),
83
86
  instance,
84
87
  };
85
88
 
@@ -1,3 +1,4 @@
1
+ import { SlotNumber } from '@aztec/foundation/branded-types';
1
2
  import { EthAddress } from '@aztec/foundation/eth-address';
2
3
  import { createLogger } from '@aztec/foundation/log';
3
4
  import { retryUntil } from '@aztec/foundation/retry';
@@ -5,7 +6,6 @@ import { EmpireSlashingProposerAbi } from '@aztec/l1-artifacts/EmpireSlashingPro
5
6
 
6
7
  import EventEmitter from 'events';
7
8
  import {
8
- type EncodeFunctionDataParameters,
9
9
  type GetContractReturnType,
10
10
  type Hex,
11
11
  type Log,
@@ -67,8 +67,8 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
67
67
  return this.proposer.read.getCurrentRound();
68
68
  }
69
69
 
70
- public computeRound(slot: bigint): Promise<bigint> {
71
- return this.proposer.read.computeRound([slot]);
70
+ public computeRound(slot: SlotNumber): Promise<bigint> {
71
+ return this.proposer.read.computeRound([BigInt(slot)]);
72
72
  }
73
73
 
74
74
  public getInstance() {
@@ -78,8 +78,18 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
78
78
  public async getRoundInfo(
79
79
  rollupAddress: Hex,
80
80
  round: bigint,
81
- ): Promise<{ lastSignalSlot: bigint; payloadWithMostSignals: Hex; executed: boolean }> {
82
- return await this.proposer.read.getRoundData([rollupAddress, round]);
81
+ ): Promise<{ lastSignalSlot: SlotNumber; payloadWithMostSignals: Hex; quorumReached: boolean; executed: boolean }> {
82
+ const result = await this.proposer.read.getRoundData([rollupAddress, round]);
83
+ const [signalCount, quorum] = await Promise.all([
84
+ this.proposer.read.signalCount([rollupAddress, round, result.payloadWithMostSignals]),
85
+ this.getQuorumSize(),
86
+ ]);
87
+ return {
88
+ lastSignalSlot: SlotNumber.fromBigInt(result.lastSignalSlot),
89
+ payloadWithMostSignals: result.payloadWithMostSignals,
90
+ quorumReached: signalCount >= quorum,
91
+ executed: result.executed,
92
+ };
83
93
  }
84
94
 
85
95
  public getPayloadSignals(rollupAddress: Hex, round: bigint, payload: Hex): Promise<bigint> {
@@ -89,13 +99,14 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
89
99
  public createSignalRequest(payload: Hex): L1TxRequest {
90
100
  return {
91
101
  to: this.address.toString(),
102
+ abi: EmpireSlashingProposerAbi,
92
103
  data: encodeSignal(payload),
93
104
  };
94
105
  }
95
106
 
96
107
  public async createSignalRequestWithSignature(
97
108
  payload: Hex,
98
- slot: bigint,
109
+ slot: SlotNumber,
99
110
  chainId: number,
100
111
  signerAddress: Hex,
101
112
  signer: (msg: TypedDataDefinition) => Promise<Hex>,
@@ -110,10 +121,17 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
110
121
  );
111
122
  return {
112
123
  to: this.address.toString(),
124
+ abi: EmpireSlashingProposerAbi,
113
125
  data: encodeSignalWithSignature(payload, signature),
114
126
  };
115
127
  }
116
128
 
129
+ /** Checks if a payload was ever submitted to governance via submitRoundWinner. */
130
+ public async hasPayloadBeenProposed(payload: Hex, fromBlock: bigint): Promise<boolean> {
131
+ const events = await this.proposer.getEvents.PayloadSubmitted({ payload }, { fromBlock, strict: true });
132
+ return events.length > 0;
133
+ }
134
+
117
135
  public listenToSubmittablePayloads(callback: (args: { payload: `0x${string}`; round: bigint }) => unknown) {
118
136
  return this.proposer.watchEvent.PayloadSubmittable(
119
137
  {},
@@ -169,6 +187,7 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
169
187
  public buildExecuteRoundRequest(round: bigint): L1TxRequest {
170
188
  return {
171
189
  to: this.address.toString(),
190
+ abi: EmpireSlashingProposerAbi,
172
191
  data: encodeFunctionData({
173
192
  abi: EmpireSlashingProposerAbi,
174
193
  functionName: 'submitRoundWinner',
@@ -211,24 +230,13 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
211
230
  if (typeof round === 'number') {
212
231
  round = BigInt(round);
213
232
  }
214
- const args: EncodeFunctionDataParameters<typeof EmpireSlashingProposerAbi, 'submitRoundWinner'> = {
215
- abi: EmpireSlashingProposerAbi,
216
- functionName: 'submitRoundWinner',
217
- args: [round],
218
- };
219
- const data = encodeFunctionData(args);
233
+ const request = this.buildExecuteRoundRequest(round);
220
234
  const response = await txUtils
221
- .sendAndMonitorTransaction(
222
- {
223
- to: this.address.toString(),
224
- data,
225
- },
226
- {
227
- // Gas estimation is way off for this, likely because we are creating the contract/selector to call
228
- // for the actual slashing dynamically.
229
- gasLimitBufferPercentage: 50, // +50% gas
230
- },
231
- )
235
+ .sendAndMonitorTransaction(request, {
236
+ // Gas estimation is way off for this, likely because we are creating the contract/selector to call
237
+ // for the actual slashing dynamically.
238
+ gasLimitBufferPercentage: 50, // +50% gas
239
+ })
232
240
  .catch(err => {
233
241
  if (err instanceof FormattedViemError && err.message.includes('ProposalAlreadyExecuted')) {
234
242
  throw new ProposalAlreadyExecutedError(round);
@@ -237,15 +245,13 @@ export class EmpireSlashingProposerContract extends EventEmitter implements IEmp
237
245
  });
238
246
 
239
247
  if (response.receipt.status === 'reverted') {
240
- const error = await txUtils.tryGetErrorFromRevertedTx(
241
- data,
242
- {
243
- ...args,
244
- address: this.address.toString(),
245
- },
246
- undefined,
247
- [],
248
- );
248
+ const args = {
249
+ abi: EmpireSlashingProposerAbi,
250
+ functionName: 'submitRoundWinner' as const,
251
+ args: [round] as const,
252
+ address: this.address.toString(),
253
+ };
254
+ const error = await txUtils.tryGetErrorFromRevertedTx(request.data!, args, undefined, []);
249
255
  if (error?.includes('ProposalAlreadyExecuted')) {
250
256
  throw new ProposalAlreadyExecutedError(round);
251
257
  }
@@ -4,13 +4,14 @@ import { FeeAssetHandlerAbi } from '@aztec/l1-artifacts/FeeAssetHandlerAbi';
4
4
  import { type Hex, encodeFunctionData, getContract } from 'viem';
5
5
 
6
6
  import type { L1TxUtils } from '../l1_tx_utils/index.js';
7
+ import type { ViemClient } from '../types.js';
7
8
 
8
9
  export class FeeAssetHandlerContract {
9
10
  public address: EthAddress;
10
11
 
11
12
  constructor(
13
+ public readonly client: ViemClient,
12
14
  address: Hex | EthAddress,
13
- public readonly txUtils: L1TxUtils,
14
15
  ) {
15
16
  if (address instanceof EthAddress) {
16
17
  address = address.toString();
@@ -22,7 +23,7 @@ export class FeeAssetHandlerContract {
22
23
  const contract = getContract({
23
24
  abi: FeeAssetHandlerAbi,
24
25
  address: this.address.toString(),
25
- client: this.txUtils.client,
26
+ client: this.client,
26
27
  });
27
28
  return EthAddress.fromString(await contract.read.owner());
28
29
  }
@@ -31,17 +32,18 @@ export class FeeAssetHandlerContract {
31
32
  const contract = getContract({
32
33
  abi: FeeAssetHandlerAbi,
33
34
  address: this.address.toString(),
34
- client: this.txUtils.client,
35
+ client: this.client,
35
36
  });
36
37
  return contract.read.mintAmount();
37
38
  }
38
39
 
39
- public mint(recipient: Hex | EthAddress) {
40
+ public mint(txUtils: L1TxUtils, recipient: Hex | EthAddress) {
40
41
  if (recipient instanceof EthAddress) {
41
42
  recipient = recipient.toString();
42
43
  }
43
- return this.txUtils.sendAndMonitorTransaction({
44
+ return txUtils.sendAndMonitorTransaction({
44
45
  to: this.address.toString(),
46
+ abi: FeeAssetHandlerAbi,
45
47
  data: encodeFunctionData({
46
48
  abi: FeeAssetHandlerAbi,
47
49
  functionName: 'mint',
@@ -50,9 +52,10 @@ export class FeeAssetHandlerContract {
50
52
  });
51
53
  }
52
54
 
53
- public setMintAmount(amount: bigint) {
54
- return this.txUtils.sendAndMonitorTransaction({
55
+ public setMintAmount(txUtils: L1TxUtils, amount: bigint) {
56
+ return txUtils.sendAndMonitorTransaction({
55
57
  to: this.address.toString(),
58
+ abi: FeeAssetHandlerAbi,
56
59
  data: encodeFunctionData({
57
60
  abi: FeeAssetHandlerAbi,
58
61
  functionName: 'setMintAmount',
@@ -0,0 +1,280 @@
1
+ import { memoize } from '@aztec/foundation/decorators';
2
+ import { EthAddress } from '@aztec/foundation/eth-address';
3
+ import { type Logger, createLogger } from '@aztec/foundation/log';
4
+
5
+ import { type Hex, encodeAbiParameters, getContract, keccak256, parseAbiParameters } from 'viem';
6
+
7
+ import type { ViemClient } from '../types.js';
8
+ import { RollupContract } from './rollup.js';
9
+
10
+ /** Maximum price modifier per checkpoint in basis points. ±100 bps = ±1% */
11
+ export const MAX_FEE_ASSET_PRICE_MODIFIER_BPS = 100n;
12
+
13
+ /**
14
+ * Validates that a fee asset price modifier is within the allowed range.
15
+ * Validators should call this before attesting to a checkpoint proposal.
16
+ *
17
+ * @param modifier - The fee asset price modifier in basis points
18
+ * @returns true if the modifier is valid (between -100 and +100 bps)
19
+ */
20
+ export function validateFeeAssetPriceModifier(modifier: bigint): boolean {
21
+ return modifier >= -MAX_FEE_ASSET_PRICE_MODIFIER_BPS && modifier <= MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
22
+ }
23
+
24
+ /**
25
+ * Oracle for computing fee asset price modifiers based on Uniswap V4 pool prices.
26
+ * Only active on Ethereum mainnet - returns 0 on other chains.
27
+ */
28
+ export class FeeAssetPriceOracle {
29
+ constructor(
30
+ private client: ViemClient,
31
+ private readonly rollupContract: RollupContract,
32
+ private log: Logger = createLogger('fee-asset-price-oracle'),
33
+ ) {}
34
+
35
+ @memoize
36
+ async getUniswapOracle(): Promise<UniswapPriceOracle | undefined> {
37
+ const code = await this.client.getCode({ address: STATE_VIEW_ADDRESS.toString() });
38
+ if (code === undefined || code === '0x') {
39
+ this.log.warn('Uniswap V4 StateView contract not found, skipping fee asset price oracle');
40
+ return undefined;
41
+ }
42
+ this.log.info('Uniswap V4 StateView contract found, initializing fee asset price oracle');
43
+ const oracle = new UniswapPriceOracle(this.client, this.log);
44
+
45
+ try {
46
+ if (!(await oracle.isPoolInitialized())) {
47
+ this.log.warn('Uniswap V4 pool not initialized, skipping fee asset price oracle');
48
+ return undefined;
49
+ }
50
+ } catch (err) {
51
+ this.log.warn(`Failed to check if Uniswap V4 pool is initialized: ${err}`);
52
+ return undefined;
53
+ }
54
+
55
+ return oracle;
56
+ }
57
+
58
+ /**
59
+ * Computes the fee asset price modifier to be used in the next checkpoint proposal.
60
+ *
61
+ * The modifier adjusts the on-chain fee asset price toward the oracle price,
62
+ * clamped to ±1% (±100 basis points) per checkpoint.
63
+ *
64
+ * Returns 0 if not on mainnet or if the oracle query fails.
65
+ *
66
+ * @returns The price modifier in basis points (positive to increase price, negative to decrease)
67
+ */
68
+ async computePriceModifier(): Promise<bigint> {
69
+ const uniswapOracle = await this.getUniswapOracle();
70
+ if (!uniswapOracle) {
71
+ return 0n;
72
+ }
73
+
74
+ try {
75
+ // Get current on-chain price (ETH per fee asset, E12)
76
+ const currentPriceE12 = await this.rollupContract.getEthPerFeeAsset();
77
+
78
+ // Get oracle price (median of last N blocks, ETH per fee asset, E12)
79
+ const oraclePriceE12 = await uniswapOracle.getMeanEthPerFeeAssetE12();
80
+
81
+ // Compute modifier in basis points
82
+ const modifier = this.computePriceModifierBps(currentPriceE12, oraclePriceE12);
83
+
84
+ this.log.debug('Computed price modifier', {
85
+ currentPriceE12: currentPriceE12.toString(),
86
+ oraclePriceE12: oraclePriceE12.toString(),
87
+ modifierBps: modifier.toString(),
88
+ });
89
+
90
+ return modifier;
91
+ } catch (err) {
92
+ this.log.warn(`Failed to compute price modifier, using 0: ${err}`);
93
+ return 0n;
94
+ }
95
+ }
96
+
97
+ /**
98
+ * Gets the current oracle price (ETH per fee asset, scaled by 1e12).
99
+ * Returns undefined if not on mainnet or if the oracle query fails.
100
+ */
101
+ async getOraclePrice(): Promise<bigint | undefined> {
102
+ const uniswapOracle = await this.getUniswapOracle();
103
+ if (!uniswapOracle) {
104
+ return undefined;
105
+ }
106
+
107
+ try {
108
+ return await uniswapOracle.getMeanEthPerFeeAssetE12();
109
+ } catch (err) {
110
+ this.log.warn(`Failed to get oracle price: ${err}`);
111
+ return undefined;
112
+ }
113
+ }
114
+
115
+ /**
116
+ * Computes the basis points modifier needed to move from current price toward target price.
117
+ *
118
+ * @param currentPrice - Current ETH per fee asset (E12 scale)
119
+ * @param targetPrice - Target ETH per fee asset (E12 scale)
120
+ * @returns Basis points modifier clamped to ±100 (±1%)
121
+ */
122
+ computePriceModifierBps(currentPrice: bigint, targetPrice: bigint): bigint {
123
+ if (currentPrice === 0n) {
124
+ return MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
125
+ }
126
+
127
+ // Calculate percentage difference in basis points
128
+ // modifierBps = ((targetPrice - currentPrice) / currentPrice) * 10000
129
+ const diff = targetPrice - currentPrice;
130
+ const rawModifierBps = (diff * 10_000n) / currentPrice;
131
+
132
+ // Clamp to ±MAX_FEE_ASSET_PRICE_MODIFIER_BPS
133
+ if (rawModifierBps > MAX_FEE_ASSET_PRICE_MODIFIER_BPS) {
134
+ return MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
135
+ }
136
+ if (rawModifierBps < -MAX_FEE_ASSET_PRICE_MODIFIER_BPS) {
137
+ return -MAX_FEE_ASSET_PRICE_MODIFIER_BPS;
138
+ }
139
+ return rawModifierBps;
140
+ }
141
+ }
142
+
143
+ /** Mainnet Uniswap V4 StateView contract address */
144
+ export const STATE_VIEW_ADDRESS = EthAddress.fromString('0x7ffe42c4a5deea5b0fec41c94c136cf115597227');
145
+
146
+ const PRECISION_Q192 = 10n ** 12n * 2n ** 192n;
147
+
148
+ /**
149
+ * Converts Uniswap's sqrtPriceX96 directly to ETH per FeeAsset (E12).
150
+ *
151
+ * For an ETH/FeeAsset pool where ETH is currency0 and FeeAsset is currency1:
152
+ * - Uniswap's sqrtPriceX96 = sqrt(FeeAsset/ETH) * 2^96
153
+ * - We need: ETH/FeeAsset with 1e12 precision
154
+ *
155
+ * Math:
156
+ * price = (sqrtPriceX96 / 2^96)^2 = sqrtPriceX96^2 / 2^192 (FeeAsset per ETH)
157
+ * ethPerFeeAsset = 1 / price = 2^192 / sqrtPriceX96^2
158
+ * ethPerFeeAssetE12 = ethPerFeeAsset * 1e12 = 1e12 * 2^192 / sqrtPriceX96^2
159
+ */
160
+ export function sqrtPriceX96ToEthPerFeeAssetE12(sqrtPriceX96: bigint): bigint {
161
+ if (sqrtPriceX96 === 0n) {
162
+ throw new Error('Cannot convert zero sqrtPriceX96');
163
+ }
164
+ return PRECISION_Q192 / (sqrtPriceX96 * sqrtPriceX96);
165
+ }
166
+ /**
167
+ * Uniswap V4 StateView ABI - only the functions we need
168
+ */
169
+ const StateViewAbi = [
170
+ {
171
+ type: 'function',
172
+ name: 'getSlot0',
173
+ inputs: [{ name: 'poolId', type: 'bytes32', internalType: 'PoolId' }],
174
+ outputs: [
175
+ { name: 'sqrtPriceX96', type: 'uint160', internalType: 'uint160' },
176
+ { name: 'tick', type: 'int24', internalType: 'int24' },
177
+ { name: 'protocolFee', type: 'uint24', internalType: 'uint24' },
178
+ { name: 'lpFee', type: 'uint24', internalType: 'uint24' },
179
+ ],
180
+ stateMutability: 'view',
181
+ },
182
+ ] as const;
183
+
184
+ /**
185
+ * Client for querying the ETH/FeeAsset price from Uniswap V4.
186
+ * Returns prices in ETH per FeeAsset format (E12) to match the rollup contract.
187
+ */
188
+ class UniswapPriceOracle {
189
+ private readonly stateView;
190
+ private readonly poolId: Hex;
191
+ private readonly log: Logger;
192
+
193
+ constructor(
194
+ private readonly client: ViemClient,
195
+ log?: Logger,
196
+ ) {
197
+ this.log = log ?? createLogger('uniswap-price-oracle');
198
+ this.stateView = getContract({
199
+ address: STATE_VIEW_ADDRESS.toString(),
200
+ abi: StateViewAbi,
201
+ client,
202
+ });
203
+ this.poolId = this.computePoolId();
204
+ this.log.debug(`Initialized UniswapPriceOracle with poolId: ${this.poolId}`);
205
+ }
206
+
207
+ /**
208
+ * Computes the PoolId from the pool configuration by hashing its components.
209
+ * PoolId = keccak256(abi.encode(currency0, currency1, fee, tickSpacing, hooks))
210
+ * For mainnet, the value is expected to be: 0xce2899b16743cfd5a954d8122d5e07f410305b1aebee39fd73d9f3b9ebf10c2f
211
+ * Derived anyway to make it simpler to change if needed.
212
+ */
213
+ @memoize
214
+ computePoolId(): Hex {
215
+ /** ETH/FeeAsset pool configuration (hardcoded for mainnet) */
216
+ const encoded = encodeAbiParameters(parseAbiParameters('address, address, uint24, int24, address'), [
217
+ EthAddress.ZERO.toString(),
218
+ EthAddress.fromString('0xA27EC0006e59f245217Ff08CD52A7E8b169E62D2').toString(),
219
+ 500, // 0.05%
220
+ 10,
221
+ EthAddress.fromString('0xd53006d1e3110fD319a79AEEc4c527a0d265E080').toString(),
222
+ ]);
223
+ return keccak256(encoded);
224
+ }
225
+
226
+ async isPoolInitialized(): Promise<boolean> {
227
+ const [sqrtPriceX96] = await this.stateView.read.getSlot0([this.poolId], undefined);
228
+ return sqrtPriceX96 !== 0n;
229
+ }
230
+
231
+ /**
232
+ * Gets the price as ETH per FeeAsset, scaled by 1e12.
233
+ * This is the format expected by the rollup contract.
234
+ *
235
+ * @param blockNumber - Optional block number to query at (defaults to latest)
236
+ */
237
+ async getEthPerFeeAssetE12(blockNumber?: bigint): Promise<bigint> {
238
+ const [sqrtPriceX96] = await this.stateView.read.getSlot0(
239
+ [this.poolId],
240
+ blockNumber !== undefined ? { blockNumber } : undefined,
241
+ );
242
+ return sqrtPriceX96ToEthPerFeeAssetE12(sqrtPriceX96);
243
+ }
244
+
245
+ /**
246
+ * Gets the median price over the last N blocks as ETH per FeeAsset (E12).
247
+ * Using median helps protect against single-block manipulation.
248
+ *
249
+ * @param numBlocks - Number of recent blocks to sample (default: 5)
250
+ * @returns Median price as ETH per FeeAsset, scaled by 1e12
251
+ */
252
+ async getMeanEthPerFeeAssetE12(numBlocks: number = 5): Promise<bigint> {
253
+ const currentBlock = await this.client.getBlockNumber();
254
+ const prices: bigint[] = [];
255
+
256
+ for (let i = 0; i < numBlocks; i++) {
257
+ const blockNumber = currentBlock - BigInt(i);
258
+ if (blockNumber < 0n) {
259
+ break;
260
+ }
261
+
262
+ try {
263
+ const price = await this.getEthPerFeeAssetE12(blockNumber);
264
+ prices.push(price);
265
+ } catch (err) {
266
+ this.log.warn(`Failed to get price at block ${blockNumber}: ${err}`);
267
+ // Continue with fewer samples
268
+ }
269
+ }
270
+
271
+ const filteredPrices = prices.filter(price => price !== 0n);
272
+
273
+ if (filteredPrices.length === 0) {
274
+ throw new Error('Failed to get any price samples from Uniswap oracle');
275
+ }
276
+
277
+ const mean = filteredPrices.reduce((a, b) => a + b, 0n) / BigInt(filteredPrices.length);
278
+ return mean;
279
+ }
280
+ }