feat: implement saving ENR/s to file and loading ENR/s from file #1

GrapeBaBa · 2025-08-26T12:49:03Z

Motivition

This pull requests add helper functions to save ENR to file and load ENR from file. It providers both single ENR operation and batch ENRs operation.

Implementation

It re-expose ENR, EncodedENR and SignableENR from the dependency module. EncodedENR only should be used as readonly access.
Single/Batch saving to file and loading from file functions for ENR, EncodedENR and SignableENR.

Signed-off-by: Chen Kai <281165273grape@gmail.com>

gballet

in function names, please rename Enr to ENR, this is an acronym.

build.zig.zon

build.zig

.github/workflows/ci.yml

src/root.zig

Signed-off-by: Chen Kai <281165273grape@gmail.com>

Copilot

Pull Request Overview

This PR implements comprehensive file I/O functionality for Ethereum Node Records (ENR), enabling saving and loading of ENR data to/from disk. It provides both single and batch operations for different ENR types.

Adds helper functions for single and batch ENR file operations with support for custom delimiters
Re-exposes core ENR types (ENR, EncodedENR, SignableENR) from the dependency module for convenient access
Includes comprehensive test coverage with error handling scenarios and various ENR formats

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/root.zig	Implements core ENR file I/O functions with comprehensive test suite
build.zig.zon	Configures project dependencies and metadata
build.zig	Sets up build configuration with dependency imports
README.md	Documents project usage, building, and testing instructions
.github/workflows/ci.yml	Adds CI pipeline for automated testing and formatting checks

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-28T04:02:57Z

src/root.zig

+pub fn loadEncodedENRFromDisk(encoded_enr: *EncodedENR, file_path: []const u8) !void {
+    var buffer: [enrlib.max_enr_size]u8 = undefined;
+    const content = try readFileContent(file_path, &buffer);
+    encoded_enr.* = try EncodedENR.decodeTxtInto(content);


The function name decodeTxtInto suggests it should decode into a provided parameter, but here it's returning a value. Consider using EncodedENR.decodeTxt(content) for consistency with the naming pattern, or update the function to match the ENR.decodeTxtInto pattern that takes a pointer parameter.

Suggested change

encoded_enr.* = try EncodedENR.decodeTxtInto(content);

encoded_enr.* = try EncodedENR.decodeTxt(content);

Copilot · 2025-08-28T04:02:57Z

src/root.zig

+        const trimmed = std.mem.trim(u8, enr_txt, " \t\r\n");
+        if (trimmed.len == 0) continue; // Skip empty entries
+
+        const encoded_enr = try EncodedENR.decodeTxtInto(trimmed);


Same inconsistency as above - decodeTxtInto is returning a value rather than decoding into a provided parameter. This inconsistent API usage could confuse developers.

Copilot · 2025-08-28T04:02:57Z

src/root.zig

+    try readTempEncodedEnr(&tmp_dir, test_file, &loaded_encoded_enr);
+
+    var enr: ENR = undefined;
+    loaded_encoded_enr.decodeIntoENR(&enr);


The function call decodeIntoENR appears to not handle potential errors with try. If this function can fail, it should be called with try loaded_encoded_enr.decodeIntoENR(&enr);

Suggested change

loaded_encoded_enr.decodeIntoENR(&enr);

try loaded_encoded_enr.decodeIntoENR(&enr);

Signed-off-by: Chen Kai <281165273grape@gmail.com>

g11tech · 2025-08-31T16:54:44Z

build.zig.zon

+
+    .dependencies = .{
+        .secp256k1 = .{
+            .url = "git+https://github.com/zig-bitcoin/libsecp256k1-zig#b96922b375a601f3303bf43be1dceb3d101df6c6",


does this solve the signature mismatch issue?

yes, right now it can generate same signature with other implementations

g11tech

lgtm

GrapeBaBa added 2 commits August 26, 2025 20:37

feat:init enr load from file and save to file

e4bacdc

Signed-off-by: Chen Kai <281165273grape@gmail.com>

feat:update ci and readme

4a6393c

Signed-off-by: Chen Kai <281165273grape@gmail.com>

GrapeBaBa requested review from RazorClient, bhaskar1001101, bomanaps, chetanyb, Copilot, g11tech, gballet, noopur23, parithosh and spiral-ladder August 26, 2025 12:51

This comment was marked as outdated.

Sign in to view

fix: fix wrong module expose

403cfd7

Signed-off-by: Chen Kai <281165273grape@gmail.com>

gballet reviewed Aug 26, 2025

View reviewed changes

build.zig.zon Show resolved Hide resolved

build.zig Show resolved Hide resolved

build.zig Outdated Show resolved Hide resolved

build.zig Outdated Show resolved Hide resolved

.github/workflows/ci.yml Outdated Show resolved Hide resolved

src/root.zig Outdated Show resolved Hide resolved

GrapeBaBa added 6 commits August 26, 2025 23:47

fix:remove auto-generated comment and throw error

5f4eea0

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:remove auto generated comment in zon file

c7698ed

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:elimate duplicate code

f7572a5

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:update install zig in CI

72e8c5d

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:elimate duplicate code in test

247fadd

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:remove auto generated comment

95b441c

Signed-off-by: Chen Kai <281165273grape@gmail.com>

GrapeBaBa requested review from Copilot and gballet August 27, 2025 05:10

This comment was marked as outdated.

Sign in to view

GrapeBaBa added 2 commits August 27, 2025 16:31

fix:reduce stack memory used

ae60122

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:fix duplicate and add more tests

1f8aad4

Signed-off-by: Chen Kai <281165273grape@gmail.com>

GrapeBaBa requested a review from Copilot August 28, 2025 04:02

Copilot AI reviewed Aug 28, 2025

View reviewed changes

GrapeBaBa added 2 commits August 31, 2025 11:46

feat:remove discv5 dep

38540b3

Signed-off-by: Chen Kai <281165273grape@gmail.com>

fix:replace setup-zig

de1e4b1

Signed-off-by: Chen Kai <281165273grape@gmail.com>

feat: add helper function for SignableENR

702fc22

Signed-off-by: Chen Kai <281165273grape@gmail.com>

g11tech reviewed Aug 31, 2025

View reviewed changes

g11tech approved these changes Aug 31, 2025

View reviewed changes

g11tech merged commit 5a351cf into main Aug 31, 2025
1 check passed

	encoded_enr.* = try EncodedENR.decodeTxtInto(content);
	encoded_enr.* = try EncodedENR.decodeTxt(content);

	loaded_encoded_enr.decodeIntoENR(&enr);
	try loaded_encoded_enr.decodeIntoENR(&enr);

feat: implement saving ENR/s to file and loading ENR/s from file #1

feat: implement saving ENR/s to file and loading ENR/s from file #1

Uh oh!

Conversation

GrapeBaBa commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivition

Implementation

Uh oh!

This comment was marked as outdated.

Uh oh!

gballet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

g11tech Aug 31, 2025

Choose a reason for hiding this comment

Uh oh!

GrapeBaBa Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

g11tech left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

GrapeBaBa commented Aug 26, 2025 •

edited

Loading