Skip to content

DecoderErrors

Set of possible errors when the decoder runs.

error{ NoJunkDataAllowed, BufferOverrun, InvalidBitFound } || Allocator.Error

DecodeOptions

Set of options to control the abi decoder behaviour.

Properties

struct {
  /// Max amount of bytes allowed to be read by the decoder.
  /// This avoid a DoS vulnerability discovered here:
  /// https://github.com/paulmillr/micro-eth-signer/discussions/20
  max_bytes: u16 = 1024
  /// By default this is false.
  allow_junk_data: bool = false
  /// Tell the decoder if an allocation should be made.
  /// Allocations are always made if dealing with a type that will require a list i.e `[]const u64`.
  allocate_when: enum { alloc_always, alloc_if_needed } = .alloc_if_needed
  /// Tells the endianess of the bytes that you want to decode
  /// Addresses are encoded in big endian and bytes1..32 are encoded in little endian.
  /// There might be some cases where you will need to decode a bytes20 and address at the same time.
  /// Since they can represent the same type it's advised to decode the address as `u160` and change this value to `little`.
  /// since it already decodes as big-endian and then `std.mem.writeInt` the value to the expected endianess.
  bytes_endian: Endian = .big
}

Decoded

Result type of decoded objects.

Signature

pub fn Decoded(comptime T: type) type

AbiDecoded

Result type of a abi decoded slice. Allocations are managed via an arena.

Allocations: Bool, Int, Enum, Array => false. Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

If the type provided doesn't make allocations consider using decodeAbiParameterLeaky.

Signature

pub fn AbiDecoded(comptime T: type) type

Deinit

Signature

pub fn deinit(self: @This()) void

DecodeAbiFunction

Decodes the abi encoded slice. All allocations are managed in an ArenaAllocator. Assumes that the encoded slice contains the function signature and removes it from the encoded slice.

Allocations: Bool, Int, Enum, Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

Example: 
var buffer: [1024]u8 = undefined;
const bytes = try std.fmt.hexToBytes(&buffer, "00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000");
const decoded =  try decodeAbiFunction([]const i256, testing.allocator, bytes, .{});
defer decoded.deinit();

If the type provided doesn't make allocations consider using decodeAbiParameterLeaky.

Signature

pub fn decodeAbiFunction(comptime T: type, allocator: Allocator, encoded: []u8, options: DecodeOptions) DecoderErrors!AbiDecoded(T)

DecodeAbiError

Decodes the abi encoded slice. All allocations are managed in an ArenaAllocator. Assumes that the encoded slice contracts the error signature and removes it from the encoded slice.

Allocations: Bool, Int, Enum, Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

Example: 
var buffer: [1024]u8 = undefined;
const bytes = try std.fmt.hexToBytes(&buffer, "00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000");
const decoded =  try decodeAbiError([]const i256, testing.allocator, bytes, .{});
defer decoded.deinit();

If the type provided doesn't make allocations consider using decodeAbiParameterLeaky.

Signature

pub fn decodeAbiError(comptime T: type, allocator: Allocator, encoded: []u8, options: DecodeOptions) DecoderErrors!AbiDecoded(T)

DecodeAbiFunctionOutputs

Decodes the abi encoded slice. All allocations are managed in an ArenaAllocator. Since abi encoded function output values don't have signature in the encoded slice this is essentially a wrapper for decodeAbiParameter.

Allocations: Bool, Int, Enum, Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

Example: 
var buffer: [1024]u8 = undefined;
const bytes = try std.fmt.hexToBytes(&buffer, "00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000");
const decoded =  try decodeAbiFunctionOutputs([]const i256, testing.allocator, bytes, .{});
defer decoded.deinit();

If the type provided doesn't make allocations consider using decodeAbiParameterLeaky.

Signature

pub fn decodeAbiFunctionOutputs(comptime T: type, allocator: Allocator, encoded: []u8, options: DecodeOptions) DecoderErrors!AbiDecoded(T)

DecodeAbiConstructor

Decodes the abi encoded slice. All allocations are managed in an ArenaAllocator. Since abi encoded constructor values don't have signature in the encoded slice this is essentially a wrapper for decodeAbiParameter.

Allocations: Bool, Int, Enum, Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

Example: 
var buffer: [1024]u8 = undefined;
const bytes = try std.fmt.hexToBytes(&buffer, "00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000");
const decoded =  try decodeAbiConstructor([]const i256, testing.allocator, bytes, .{});
defer decoded.deinit();

If the type provided doesn't make allocations consider using decodeAbiParameterLeaky.

Signature

pub fn decodeAbiConstructor(comptime T: type, allocator: Allocator, encoded: []u8, options: DecodeOptions) DecoderErrors!AbiDecoded(T)

DecodeAbiParameter

Decodes the abi encoded slice. All allocations are managed in an ArenaAllocator. This is usefull when you have to grab ownership of the memory from the slice or the type you need requires the creation of an ArrayList.

Allocations: Bool, Int, Enum, Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

Example: 
var buffer: [1024]u8 = undefined;
const bytes = try std.fmt.hexToBytes(&buffer, "00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000");
const decoded =  try decodeParameter([]const i256, testing.allocator, bytes, .{});
defer decoded.deinit();

If the type provided doesn't make allocations consider using decodeAbiParameterLeaky.

Signature

pub fn decodeAbiParameter(comptime T: type, allocator: Allocator, encoded: []u8, options: DecodeOptions) DecoderErrors!AbiDecoded(T)

DecodeAbiParameterLeaky

Decodes the abi encoded slice. This doesn't clean any allocated memory. Usefull if the type that you want do decode to doesn't create any allocations or you already own the memory that this will decode from. Otherwise you will be better off using decodeAbiParameter.

Allocations: Bool, Int, Enum, Array => false. Pointer => true. If the child is u8 only allocates if the option alloc_always is passed. Optional => Depends on the child. Struct => Depends on the child. Other types are not supported.

Example: 
var buffer: [1024]u8 = undefined;
const bytes = try std.fmt.hexToBytes(&buffer, "00000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000002");
const decoded =  try decodeParameter([2]i256, testing.allocator, bytes, .{});
defer decoded.deinit();

Signature

pub fn decodeAbiParameterLeaky(comptime T: type, allocator: Allocator, encoded: []u8, options: DecodeOptions) DecoderErrors!T