-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(p2p/messages): add getblocktxn (#150)
- Loading branch information
Showing
4 changed files
with
177 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| const std = @import("std"); | ||
| const protocol = @import("../lib.zig"); | ||
|
|
||
| const BlockHeader = @import("../../../types/block_header.zig"); | ||
| const CompactSizeUint = @import("bitcoin-primitives").types.CompatSizeUint; | ||
| const genericChecksum = @import("lib.zig").genericChecksum; | ||
| const genericSerialize = @import("lib.zig").genericSerialize; | ||
| const genericDeserializeSlice = @import("lib.zig").genericDeserializeSlice; | ||
| /// GetBlockTxnMessage represents the "GetBlockTxn" message | ||
| /// | ||
| /// https://developer.bitcoin.org/reference/p2p_networking.html#getblocktxn | ||
| pub const GetBlockTxnMessage = struct { | ||
| block_hash: [32]u8, | ||
| indexes: []u64, | ||
|
|
||
| const Self = @This(); | ||
|
|
||
| pub fn name() *const [12]u8 { | ||
| return protocol.CommandNames.GETBLOCKTXN ++ [_]u8{0}; | ||
| } | ||
|
|
||
| /// Returns the message checksum | ||
| pub fn checksum(self: *const Self) [4]u8 { | ||
| return genericChecksum(self); | ||
| } | ||
|
|
||
| /// Free the allocated memory | ||
| pub fn deinit(self: *const Self, allocator: std.mem.Allocator) void { | ||
| allocator.free(self.indexes); | ||
| } | ||
|
|
||
| /// Serialize the message as bytes and write them to the Writer. | ||
| pub fn serializeToWriter(self: *const Self, w: anytype) !void { | ||
| comptime { | ||
| if (!std.meta.hasFn(@TypeOf(w), "writeAll")) @compileError("Expects r to have fn 'writeAll"); | ||
| } | ||
| try w.writeAll(&self.block_hash); | ||
| const indexes_count = CompactSizeUint.new(self.indexes.len); | ||
| try indexes_count.encodeToWriter(w); | ||
| for (self.indexes) |*index| { | ||
| const compact_index = CompactSizeUint.new(index.*); | ||
| try compact_index.encodeToWriter(w); | ||
| } | ||
| } | ||
|
|
||
| /// Serialize a message as bytes and write them to the buffer. | ||
| /// | ||
| /// buffer.len must be >= than self.hintSerializedLen() | ||
| pub fn serializeToSlice(self: *const Self, buffer: []u8) !void { | ||
| var fbs = std.io.fixedBufferStream(buffer); | ||
| try self.serializeToWriter(fbs.writer()); | ||
| } | ||
|
|
||
| /// Serialize a message as bytes and return them. | ||
| pub fn serialize(self: *const Self, allocator: std.mem.Allocator) ![]u8 { | ||
| return try genericSerialize(self, allocator); | ||
| } | ||
|
|
||
| /// Returns the hint of the serialized length of the message. | ||
| pub fn hintSerializedLen(self: *const Self) usize { | ||
| // 32 bytes for the block hash | ||
| const fixed_length = 32; | ||
|
|
||
| const indexes_count_length: usize = CompactSizeUint.new(self.indexes.len).hint_encoded_len(); | ||
|
|
||
| var compact_indexes_length: usize = 0; | ||
| for (self.indexes) |index| { | ||
| compact_indexes_length += CompactSizeUint.new(index).hint_encoded_len(); | ||
| } | ||
|
|
||
| const variable_length = indexes_count_length + compact_indexes_length; | ||
|
|
||
| return fixed_length + variable_length; | ||
| } | ||
|
|
||
| pub fn deserializeReader(allocator: std.mem.Allocator, r: anytype) !Self { | ||
| var blockhash: [32]u8 = undefined; | ||
| try r.readNoEof(&blockhash); | ||
|
|
||
| const indexes_count = try CompactSizeUint.decodeReader(r); | ||
| const indexes = try allocator.alloc(u64, indexes_count.value()); | ||
| errdefer allocator.free(indexes); | ||
|
|
||
| for (indexes) |*index| { | ||
| const compact_index = try CompactSizeUint.decodeReader(r); | ||
| index.* = compact_index.value(); | ||
| } | ||
|
|
||
| return new(blockhash, indexes); | ||
| } | ||
|
|
||
| /// Deserialize bytes into a `GetBlockTxnMessage` | ||
| pub fn deserializeSlice(allocator: std.mem.Allocator, bytes: []const u8) !Self { | ||
| return try genericDeserializeSlice(GetBlockTxnMessage, allocator, bytes); | ||
| } | ||
|
|
||
| pub fn new(block_hash: [32]u8, indexes: []u64) Self { | ||
| return .{ | ||
| .block_hash = block_hash, | ||
| .indexes = indexes, | ||
| }; | ||
| } | ||
| }; | ||
|
|
||
| test "GetBlockTxnMessage serialization and deserialization" { | ||
| const test_allocator = std.testing.allocator; | ||
|
|
||
| const block_hash: [32]u8 = [_]u8{0} ** 32; | ||
| const indexes = try test_allocator.alloc(u64, 1); | ||
| indexes[0] = 123; | ||
| const msg = GetBlockTxnMessage.new(block_hash, indexes); | ||
|
|
||
| defer msg.deinit(test_allocator); | ||
|
|
||
| const serialized = try msg.serialize(test_allocator); | ||
| defer test_allocator.free(serialized); | ||
|
|
||
| const deserialized = try GetBlockTxnMessage.deserializeSlice(test_allocator, serialized); | ||
| defer deserialized.deinit(test_allocator); | ||
|
|
||
| try std.testing.expectEqual(msg.block_hash, deserialized.block_hash); | ||
| try std.testing.expectEqual(msg.indexes[0], msg.indexes[0]); | ||
| try std.testing.expectEqual(msg.hintSerializedLen(), 32 + 1 + 1); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters