Skip to content

test(stf): add unit tests for processWithdrawalRequest #294

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

Open
lodekeeper-z wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test(stf): add unit tests for processWithdrawalRequest #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
285 changes: 285 additions & 0 deletions src/state_transition/block/process_withdrawal_request.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,288 @@ fn isValidatorEligibleForWithdrawOrExit(
exit_epoch == c.FAR_FUTURE_EPOCH and
current_epoch >= activation_epoch + config.chain.SHARD_COMMITTEE_PERIOD);
}

// ──── Tests ────

const testing = std.testing;
const Node = @import("persistent_merkle_tree").Node;
const TestCachedBeaconState = @import("../test_utils/generate_state.zig").TestCachedBeaconState;

fn makeWithdrawalRequest(
source_address: [20]u8,
validator_pubkey: [48]u8,
amount: u64,
) WithdrawalRequest {
return WithdrawalRequest{
.source_address = source_address,
.validator_pubkey = validator_pubkey,
.amount = amount,
};
}

fn getValidatorPubkey(state: anytype, index: u64) ![48]u8 {
var validators = try state.validators();
var validator = try validators.get(index);
var pubkey_view = try validator.get("pubkey");
var pubkey: [48]u8 = undefined;
_ = try pubkey_view.getAllInto(&pubkey);
return pubkey;
}

fn setExecutionCredentials(state: anytype, index: u64, address: [20]u8) !void {
var validators = try state.validators();
var validator = try validators.get(index);
var wc: [32]u8 = [_]u8{0} ** 32;
wc[0] = 1; // ETH1_ADDRESS_WITHDRAWAL_PREFIX
@memcpy(wc[12..32], &address);
try validator.setValue("withdrawal_credentials", &wc);
Comment on lines +142 to +145
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 28, 2026

Choose a reason for hiding this comment

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

medium

The variable wc is an abbreviation. The style guide (line 221) advises against abbreviating variable names for clarity. Please use the full name withdrawal_credentials.

    var withdrawal_credentials: [32]u8 = [_]u8{0} ** 32;
    withdrawal_credentials[0] = 1; // ETH1_ADDRESS_WITHDRAWAL_PREFIX
    @memcpy(withdrawal_credentials[12..32], &address);
    try validator.setValue("withdrawal_credentials", &withdrawal_credentials);
References
  1. Do not abbreviate variable names, unless the variable is a primitive integer type used as an argument to a sort function or matrix calculation. (link)

}

fn setCompoundingCredentials(state: anytype, index: u64, address: [20]u8) !void {
var validators = try state.validators();
var validator = try validators.get(index);
var wc: [32]u8 = [_]u8{0} ** 32;
wc[0] = 2; // COMPOUNDING_WITHDRAWAL_PREFIX
@memcpy(wc[12..32], &address);
try validator.setValue("withdrawal_credentials", &wc);
Comment on lines +151 to +154
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 28, 2026

Choose a reason for hiding this comment

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

medium

The variable wc is an abbreviation. The style guide (line 221) advises against abbreviating variable names for clarity. Please use the full name withdrawal_credentials.

    var withdrawal_credentials: [32]u8 = [_]u8{0} ** 32;
    withdrawal_credentials[0] = 2; // COMPOUNDING_WITHDRAWAL_PREFIX
    @memcpy(withdrawal_credentials[12..32], &address);
    try validator.setValue("withdrawal_credentials", &withdrawal_credentials);
References
  1. Do not abbreviate variable names, unless the variable is a primitive integer type used as an argument to a sort function or matrix calculation. (link)

}

test "withdrawal request - unknown validator pubkey is no-op" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
Comment on lines +158 to +165
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 28, 2026

Choose a reason for hiding this comment

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

medium

This test setup boilerplate is repeated in all 9 new tests. This code duplication makes the test suite harder to maintain.

To improve this, you could introduce a TestEnvironment helper struct to encapsulate the setup and teardown logic. This would centralize the common code and make each test more concise and focused on its specific logic.

Here's an example of what that could look like:

const TestEnvironment = struct {
    allocator: std.mem.Allocator,
    pool: Node.Pool,
    test_state: TestCachedBeaconState,
    state: *types.electra.BeaconState.TreeView,

    fn init(allocator: std.mem.Allocator) !TestEnvironment {
        var pool = try Node.Pool.init(allocator, 256 * 5);
        errdefer pool.deinit();

        var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
        errdefer test_state.deinit();

        return TestEnvironment{
            .allocator = allocator,
            .pool = pool,
            .test_state = test_state,
            .state = test_state.cached_state.state.castToFork(.electra),
        };
    }

    fn deinit(self: *TestEnvironment) void {
        self.test_state.deinit();
        self.pool.deinit();
    }
};

Each test could then be simplified to:

test "withdrawal request - unknown validator pubkey is no-op" {
    var env = try TestEnvironment.init(testing.allocator);
    defer env.deinit();

    // ... test logic using env.state, env.test_state etc.
}
References
  1. Code duplication should be avoided to improve maintainability and reduce the chance of errors when making changes.

const unknown_pubkey: [48]u8 = [_]u8{0xFF} ** 48;
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

const request = makeWithdrawalRequest(source_address, unknown_pubkey, c.FULL_EXIT_REQUEST_AMOUNT);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

// No-op: pending partial withdrawals should remain empty
var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 0), try pending.length());
}

test "withdrawal request - validator without execution credentials is no-op" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

// Default credentials are BLS (0x00) — not execution
const request = makeWithdrawalRequest(source_address, pubkey, c.FULL_EXIT_REQUEST_AMOUNT);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 0), try pending.length());
}

test "withdrawal request - mismatched source address is no-op" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const correct_address: [20]u8 = [_]u8{0xAA} ** 20;
const wrong_address: [20]u8 = [_]u8{0xBB} ** 20;

try setExecutionCredentials(state, 0, correct_address);

const request = makeWithdrawalRequest(wrong_address, pubkey, c.FULL_EXIT_REQUEST_AMOUNT);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 0), try pending.length());
}

test "withdrawal request - full exit sets exit epoch" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

try setExecutionCredentials(state, 0, source_address);

const request = makeWithdrawalRequest(source_address, pubkey, c.FULL_EXIT_REQUEST_AMOUNT);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

// Validator should have exit_epoch set (no longer FAR_FUTURE_EPOCH)
var validators = try state.validators();
var validator = try validators.get(0);
const exit_epoch = try validator.get("exit_epoch");
try testing.expect(exit_epoch != c.FAR_FUTURE_EPOCH);

// No partial withdrawal added
var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 0), try pending.length());
}

test "withdrawal request - already exiting validator is no-op" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

try setExecutionCredentials(state, 0, source_address);

// Set exit_epoch to something other than FAR_FUTURE_EPOCH
var validators = try state.validators();
var validator = try validators.get(0);
try validator.set("exit_epoch", 100);

const request = makeWithdrawalRequest(source_address, pubkey, c.FULL_EXIT_REQUEST_AMOUNT);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

// exit_epoch should remain unchanged
var validators2 = try state.validators();
var validator2 = try validators2.get(0);
const exit_epoch = try validator2.get("exit_epoch");
Comment on lines +270 to +272
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Mar 28, 2026

Choose a reason for hiding this comment

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

medium

The variable names validators2 and validator2 are not very descriptive. The style guide (line 211: "Get the nouns and verbs just right") encourages using clear and meaningful names. To improve readability, consider renaming them to something like validators_after and validator_after to clarify that they represent the state after the function call.

    var validators_after = try state.validators();
    var validator_after = try validators_after.get(0);
    const exit_epoch = try validator_after.get("exit_epoch");
References
  1. Great names are the essence of great code, they capture what a thing is or does, and provide a crisp, intuitive mental model. They show that you understand the domain. Take time to find the perfect name. (link)

try testing.expectEqual(@as(u64, 100), exit_epoch);
}

test "withdrawal request - partial withdrawal with compounding credentials" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

// Set compounding credentials (0x02 prefix)
try setCompoundingCredentials(state, 0, source_address);

// Give the validator excess balance
var balances = try state.balances();
try balances.set(0, preset.MIN_ACTIVATION_BALANCE + 5_000_000_000);

const request_amount: u64 = 1_000_000_000;
const request = makeWithdrawalRequest(source_address, pubkey, request_amount);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

// Should have added a pending partial withdrawal
var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 1), try pending.length());

// Validator should NOT be exiting
var validators = try state.validators();
var validator = try validators.get(0);
const exit_epoch = try validator.get("exit_epoch");
try testing.expectEqual(@as(u64, c.FAR_FUTURE_EPOCH), exit_epoch);
}

test "withdrawal request - partial withdrawal with eth1 credentials is no-op" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

// ETH1 credentials (0x01) — NOT compounding, so partial withdrawal should be rejected
try setExecutionCredentials(state, 0, source_address);

var balances = try state.balances();
try balances.set(0, preset.MIN_ACTIVATION_BALANCE + 5_000_000_000);

const request_amount: u64 = 1_000_000_000;
const request = makeWithdrawalRequest(source_address, pubkey, request_amount);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

// No partial withdrawal should be added (ETH1 creds, not compounding)
var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 0), try pending.length());
}

test "withdrawal request - partial withdrawal capped at excess balance" {
const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

try setCompoundingCredentials(state, 0, source_address);

// Set balance to MIN_ACTIVATION_BALANCE + 2 gwei excess
const excess: u64 = 2_000_000_000;
var balances = try state.balances();
try balances.set(0, preset.MIN_ACTIVATION_BALANCE + excess);

// Request more than the excess
const request_amount: u64 = 10_000_000_000;
const request = makeWithdrawalRequest(source_address, pubkey, request_amount);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

// Should be added but capped at the excess
var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 1), try pending.length());
var ppw = try pending.get(0);
try testing.expectEqual(excess, try ppw.get("amount"));
}

test "withdrawal request - insufficient effective balance for partial is no-op" {
Copy link
Copy Markdown
Contributor

@GrapeBaBa GrapeBaBa Apr 7, 2026

Choose a reason for hiding this comment

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

this group tests looks like could be used table driven the approach for simplify

const allocator = testing.allocator;
var pool = try Node.Pool.init(allocator, 256 * 5);
defer pool.deinit();

var test_state = try TestCachedBeaconState.init(allocator, &pool, 256);
defer test_state.deinit();

var state = test_state.cached_state.state.castToFork(.electra);
const pubkey = try getValidatorPubkey(state, 0);
const source_address: [20]u8 = [_]u8{0xAA} ** 20;

try setCompoundingCredentials(state, 0, source_address);

// Set effective_balance below MIN_ACTIVATION_BALANCE
var validators = try state.validators();
var validator = try validators.get(0);
try validator.set("effective_balance", preset.MIN_ACTIVATION_BALANCE - 1);

var balances = try state.balances();
try balances.set(0, preset.MIN_ACTIVATION_BALANCE + 5_000_000_000);

const request = makeWithdrawalRequest(source_address, pubkey, 1_000_000_000);
try processWithdrawalRequest(.electra, test_state.config, test_state.cached_state.epoch_cache, state, &request);

var pending = try state.pendingPartialWithdrawals();
try testing.expectEqual(@as(u64, 0), try pending.length());
}
Loading