clients: update the init method on clients (#89)

## Description

Updates the init method on the clients.

## Additional Information

Before submitting this issue, please make sure you do the following.

- [x] Added documentation related to the changes made.
- [x] Added or updated tests related to the changes made.

README.md

@@ -45,18 +45,18 @@ pub fn main() !void {
     var iter = try std.process.argsWithAllocator(gpa.allocator());
     defer iter.deinit();
 
-    // Allocations are only made to pointer types.
     const parsed = args_parser.parseArgs(CliOptions, gpa.allocator(), &iter);
 
     const uri = try std.Uri.parse(parsed.url);
 
-    var wallet: Wallet = undefined;
-    try wallet.init(parsed.priv_key, .{ .allocator = gpa.allocator(), .uri = uri });
+    var wallet = try Wallet.init(parsed.priv_key, .{ .allocator = gpa.allocator(), .uri = uri });
     defer wallet.deinit();
 
     const message = try wallet.signEthereumMessage("Hello World");
+
     const hexed = try message.toHex(wallet.allocator);
-    defer wallet.allocator.free(hexed);
+    defer gpa.allocator().free(hexed);
+
     std.debug.print("Ethereum message: {s}\n", .{hexed});
 }
 ```

bench/benchmark.zig

@@ -55,14 +55,13 @@ pub fn main() !void {
     const allocator = std.heap.page_allocator;
     const printer = BenchmarkPrinter.init(std.io.getStdErr().writer());
 
-    var client: HttpRpcClient = undefined;
-    defer client.deinit();
-
     const uri = try std.Uri.parse("https://ethereum-rpc.publicnode.com");
-    try client.init(.{
+
+    var client = try HttpRpcClient.init(.{
         .allocator = allocator,
         .uri = uri,
     });
+    defer client.deinit();
 
     printer.print("{s}Benchmark running in {s} mode\n", .{ " " ** 20, @tagName(@import("builtin").mode) });
     printer.print("\x1b[1;32m\n{s}\n{s}{s}\n{s}\n", .{ BORDER, PADDING, "Human-Readable ABI", BORDER });
@@ -83,7 +82,7 @@ pub fn main() !void {
         const result = try benchmark.benchmark(
             allocator,
             HttpRpcClient.getChainId,
-            .{&client},
+            .{client},
             .{ .runs = 5, .warmup_runs = 1 },
         );
         result.printSummary();

docs/pages/index.mdx

@@ -36,18 +36,18 @@ pub fn main() !void {
     var iter = try std.process.argsWithAllocator(gpa.allocator());
     defer iter.deinit();
 
-    // Allocations are only made to pointer types.
     const parsed = args_parser.parseArgs(CliOptions, gpa.allocator(), &iter);
 
     const uri = try std.Uri.parse(parsed.url);
 
-    var wallet: Wallet = undefined;
-    try wallet.init(parsed.priv_key, .{ .allocator = gpa.allocator(), .uri = uri });
+    var wallet = try Wallet.init(parsed.priv_key, .{ .allocator = gpa.allocator(), .uri = uri });
     defer wallet.deinit();
 
     const message = try wallet.signEthereumMessage("Hello World");
+
     const hexed = try message.toHex(wallet.allocator);
-    defer wallet.allocator.free(hexed);
+    defer gpa.allocator().free(hexed);
+
     std.debug.print("Ethereum message: {s}\n", .{hexed});
 }
 ```

examples/contract/contract.zig

@@ -33,17 +33,15 @@ pub fn main() !void {
     var abi_parsed = try human.parseHumanReadable(Abi, gpa.allocator(), slice);
     defer abi_parsed.deinit();
 
-    var contract: Contract = undefined;
-    defer contract.deinit();
-
-    try contract.init(.{
+    var contract = try Contract.init(.{
         .private_key = parsed.priv_key,
         .abi = abi_parsed.value,
         .wallet_opts = .{
             .allocator = gpa.allocator(),
             .uri = uri,
         },
     });
+    defer contract.deinit();
 
     const approve = try contract.writeContractFunction("transfer", .{ try utils.addressToBytes("0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"), 0 }, .{
         .type = .london,

examples/transfer/transfer.zig

@@ -21,9 +21,7 @@ pub fn main() !void {
 
     const uri = try std.Uri.parse(parsed.url);
 
-    var wallet: Wallet = undefined;
-
-    try wallet.init(parsed.priv_key, .{
+    var wallet = try Wallet.init(parsed.priv_key, .{
         .allocator = gpa.allocator(),
         .uri = uri,
         .chain_id = .sepolia,

examples/wallet/wallet.zig

@@ -19,12 +19,13 @@ pub fn main() !void {
 
     const uri = try std.Uri.parse(parsed.url);
 
-    var wallet: Wallet = undefined;
-    try wallet.init(parsed.priv_key, .{ .allocator = gpa.allocator(), .uri = uri });
+    var wallet = try Wallet.init(parsed.priv_key, .{ .allocator = gpa.allocator(), .uri = uri });
     defer wallet.deinit();
 
     const message = try wallet.signEthereumMessage("Hello World");
+
     const hexed = try message.toHex(wallet.allocator);
     defer gpa.allocator().free(hexed);
+
     std.debug.print("Ethereum message: {s}\n", .{hexed});
 }

examples/watch/logs.zig

@@ -2,6 +2,8 @@ const args_parser = zabi.args;
 const std = @import("std");
 const zabi = @import("zabi");
 
+const WebSocket = zabi.clients.WebSocket;
+
 pub const CliOptions = struct {
     url: []const u8,
 };
@@ -17,11 +19,9 @@ pub fn main() !void {
 
     const uri = try std.Uri.parse(parsed.url);
 
-    var socket: zabi.clients.WebSocket = undefined;
+    var socket = try WebSocket.init(.{ .uri = uri, .allocator = gpa.allocator() });
     defer socket.deinit();
 
-    try socket.init(.{ .uri = uri, .allocator = gpa.allocator() });
-
     const id = try socket.watchLogs(.{
         .address = try zabi.utils.addressToBytes("0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"),
         .topics = &.{@constCast(&try zabi.utils.hashToBytes("0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"))},

examples/watch/watch.zig

@@ -2,6 +2,8 @@ const args_parser = zabi.args;
 const std = @import("std");
 const zabi = @import("zabi");
 
+const WebSocket = zabi.clients.WebSocket;
+
 pub const CliOptions = struct {
     url: []const u8,
 };
@@ -17,11 +19,9 @@ pub fn main() !void {
 
     const uri = try std.Uri.parse(parsed.url);
 
-    var socket: zabi.clients.WebSocket = undefined;
+    var socket = try WebSocket.init(.{ .uri = uri, .allocator = gpa.allocator() });
     defer socket.deinit();
 
-    try socket.init(.{ .uri = uri, .allocator = gpa.allocator() });
-
     const id = try socket.watchTransactions();
     defer id.deinit();
 

src/clients/Client.zig

@@ -142,26 +142,30 @@ const PubClient = @This();
 /// Init the client instance. Caller must call `deinit` to free the memory.
 /// Most of the client method are replicas of the JSON RPC methods name with the `eth_` start.
 /// The client will handle request with 429 errors via exponential backoff but not the rest.
-pub fn init(self: *PubClient, opts: InitOptions) !void {
+pub fn init(opts: InitOptions) !*PubClient {
     const chain: Chains = opts.chain_id orelse .ethereum;
     const id = switch (chain) {
         inline else => |id| @intFromEnum(id),
     };
 
+    const self = try opts.allocator.create(PubClient);
+    errdefer opts.allocator.destroy(self);
+
     self.* = .{
         .uri = opts.uri,
         .allocator = opts.allocator,
         .chain_id = id,
         .retries = opts.retries,
         .pooling_interval = opts.pooling_interval,
         .base_fee_multiplier = opts.base_fee_multiplier,
-        .client = http.Client{ .allocator = self.allocator },
+        .client = http.Client{ .allocator = opts.allocator },
         .connection = undefined,
     };
-
     errdefer self.client.deinit();
 
     self.connection = try self.connectRpcServer();
+
+    return self;
 }
 /// Clears the memory arena and destroys all pointers created
 pub fn deinit(self: *PubClient) void {
@@ -179,10 +183,16 @@ pub fn deinit(self: *PubClient) void {
 
         self.client = undefined;
 
+        const allocator = self.allocator;
+        allocator.destroy(self);
+
         return;
     }
 
     self.client.deinit();
+
+    const allocator = self.allocator;
+    allocator.destroy(self);
 }
 /// Connects to the RPC server and relases the connection from the client pool.
 /// This is done so that future fetchs can use the connection that is already freed.

src/clients/IPC.zig

@@ -151,9 +151,12 @@ sub_channel: Channel(JsonParsed(Value)),
 
 /// Starts the IPC client and create the connection.
 /// This will also start the read loop in a seperate thread.
-pub fn init(self: *IPC, opts: InitOptions) !void {
+pub fn init(opts: InitOptions) !*IPC {
     const chain_id: Chains = opts.chain_id orelse .ethereum;
 
+    const self = try opts.allocator.create(IPC);
+    errdefer opts.allocator.destroy(self);
+
     self.* = .{
         .allocator = opts.allocator,
         .base_fee_multiplier = opts.base_fee_multiplier,
@@ -163,8 +166,8 @@ pub fn init(self: *IPC, opts: InitOptions) !void {
         .onEvent = opts.onEvent,
         .pooling_interval = opts.pooling_interval,
         .retries = opts.retries,
-        .rpc_channel = Stack(JsonParsed(Value)).init(self.allocator, null),
-        .sub_channel = Channel(JsonParsed(Value)).init(self.allocator),
+        .rpc_channel = Stack(JsonParsed(Value)).init(opts.allocator, null),
+        .sub_channel = Channel(JsonParsed(Value)).init(opts.allocator),
         .ipc_reader = undefined,
     };
 
@@ -185,6 +188,8 @@ pub fn init(self: *IPC, opts: InitOptions) !void {
 
     const thread = try std.Thread.spawn(.{}, readLoopOwnedThread, .{self});
     thread.detach();
+
+    return self;
 }
 /// Clears memory, closes the stream and destroys any
 /// previously created pointers.
@@ -204,6 +209,9 @@ pub fn deinit(self: *IPC) void {
     self.rpc_channel.deinit();
     self.sub_channel.deinit();
     self.ipc_reader.deinit();
+
+    const allocator = self.allocator;
+    allocator.destroy(self);
 }
 /// Connects to the socket. Will try to reconnect in case of failures.
 /// Fails when match retries are reached or a invalid ipc path is provided

src/clients/WebSocket.zig

@@ -193,9 +193,12 @@ pub fn serverMessage(self: *WebSocketHandler, message: []u8, message_type: ws.Me
 
 /// Populates the WebSocketHandler pointer.
 /// Starts the connection in a seperate process.
-pub fn init(self: *WebSocketHandler, opts: InitOptions) InitErrors!void {
+pub fn init(opts: InitOptions) InitErrors!*WebSocketHandler {
     const chain: Chains = opts.chain_id orelse .ethereum;
 
+    const self = try opts.allocator.create(WebSocketHandler);
+    errdefer opts.allocator.destroy(self);
+
     self.* = .{
         .allocator = opts.allocator,
         .base_fee_multiplier = opts.base_fee_multiplier,
@@ -205,8 +208,8 @@ pub fn init(self: *WebSocketHandler, opts: InitOptions) InitErrors!void {
         .onEvent = opts.onEvent,
         .pooling_interval = opts.pooling_interval,
         .retries = opts.retries,
-        .rpc_channel = Stack(JsonParsed(Value)).init(self.allocator, null),
-        .sub_channel = Channel(JsonParsed(Value)).init(self.allocator),
+        .rpc_channel = Stack(JsonParsed(Value)).init(opts.allocator, null),
+        .sub_channel = Channel(JsonParsed(Value)).init(opts.allocator),
         .uri = opts.uri,
         .ws_client = undefined,
     };
@@ -220,6 +223,8 @@ pub fn init(self: *WebSocketHandler, opts: InitOptions) InitErrors!void {
 
     const thread = try std.Thread.spawn(.{}, readLoopOwned, .{self});
     thread.detach();
+
+    return self;
 }
 /// All future interactions will deadlock
 /// If you are using the subscription channel this operation can take time
@@ -245,6 +250,9 @@ pub fn deinit(self: *WebSocketHandler) void {
     self.sub_channel.deinit();
     self.rpc_channel.deinit();
     self.ws_client.deinit();
+
+    const allocator = self.allocator;
+    allocator.destroy(self);
 }
 /// Connects to a socket client. This is a blocking operation.
 pub fn connect(self: *WebSocketHandler) ConnectionErrors!ws.Client {