Skip to content

refactor: FeeVault's withdraw #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xiamflux merged 2 commits into from
Sep 3, 2025
Merged

refactor: FeeVault's withdraw #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f02eff5
refactor: add FeeVault.withdraw refactor
0xiamflux Sep 2, 2025
a8038b5
chore: add totalProcessed invariant
0xiamflux Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions specs/protocol/jovian/predeploys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [`recipient`](#recipient)
- [`minWithdrawalAmount`](#minwithdrawalamount)
- [`withdrawalNetwork`](#withdrawalnetwork)
- [`withdraw`](#withdraw)
- [Events](#events)
- [`MinWithdrawalAmountUpdated`](#minwithdrawalamountupdated)
- [`RecipientUpdated`](#recipientupdated)
Expand Down Expand Up @@ -96,6 +97,8 @@ sequenceDiagram

Legacy immutables are preserved for network-specific config, and storage-based overrides are enabled via getters. Each getter returns the storage value if set; otherwise, it falls back to the immutable. Setters write the storage value to opt-in to overrides. There will be a flag to track whether the storage variable was set or not.

The `withdraw` function returns the value that was withdrawn from the vault at the time of the function call.

### Functions

#### `setMinWithdrawalAmount`
Expand Down Expand Up @@ -169,6 +172,20 @@ function withdrawalNetwork() external view returns (WithdrawalNetwork)
- MUST return the storage-configured network if a storage override has been set via `setWithdrawalNetwork`.
- MUST otherwise return the legacy immutable withdrawal network.

#### `withdraw`

Withdraws the funds stored in the vault to the recipient. If the recipient is an address on L2, a `SafeCall.send` is performed; if it's an address on L1, `IL2ToL1MessagePasser.initiateWithdrawal` is used. Returns the value of the withdrawal.

```solidity
function withdraw() external returns(uint256)
```

- MUST revert if the vault's balance is below `minWithdrawalAmount()`.
- MUST increment `totalProcessed` by the balance the vault had at the time of the function call.
- MUST emit the `Withdrawal(uint256 value, address to, address from)` event.
- MUST emit the `Withdrawal(uint256 value, address to, address from, WithdrawalNetwork withdrawalNetwork)` event.
- MUST send the vault's total balance to the appropriate recipient.

Copy link
Copy Markdown
Member

@0xChin 0xChin Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we add something related to this line? totalProcessed += value_; like "MUST increment the totalProcessed variable by value

Copy link
Copy Markdown
Author

@0xiamflux 0xiamflux Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that, adding it.

### Events

#### `MinWithdrawalAmountUpdated`
Expand Down