Abitype

Set of possible abi values according to the abi spec.

Properties

enum {
  function
  @"error"
  event
  constructor
  fallback
  receive
}

PrepareErrors

Set of possible errors when running allocPrepare

Allocator.Error || error{NoSpaceLeft}

Function

Solidity Abi function representation. Reference: "function"

Properties

struct {
  type: Extract(Abitype, "function")
  /// Deprecated. Use either 'pure' or 'view'.
  ///
  /// https://github.com/ethereum/solidity/issues/992
  constant: ?bool = null
  /// Deprecated. Older vyper compiler versions used to provide gas estimates.
  ///
  /// https://github.com/vyperlang/vyper/issues/2151
  gas: ?i64 = null
  inputs: []const AbiParameter
  name: []const u8
  outputs: []const AbiParameter
  /// Deprecated. Use 'nonpayable' or 'payable'. Consider using `StateMutability`.
  ///
  /// https://github.com/ethereum/solidity/issues/992
  payable: ?bool = null
  stateMutability: StateMutability
}

Deinit

Signature

pub fn deinit(self: @This(), allocator: std.mem.Allocator) void

Encode

Encode the struct signature based on the values provided. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values

Caller owns the memory.

Consider using EncodeAbiFunctionComptime if the struct is comptime know and you want better typesafety from the compiler

Signature

pub fn encode(self: @This(), allocator: Allocator, values: anytype) EncodeErrors![]u8

EncodeOutputs

Encode the struct signature based on the values provided. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values. This methods will run the values against the outputs proprety.

Caller owns the memory.

Consider using EncodeAbiFunctionComptime if the struct is comptime know and you want better typesafety from the compiler

Signature

pub fn encodeOutputs(self: @This(), allocator: Allocator, values: anytype) EncodeErrors![]u8

Decode

Decode a encoded function based on itself. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values. This methods will run the values against the inputs proprety.

Caller owns the memory.

Consider using decodeAbiFunction if the struct is comptime know and you dont want to provided the return type.

Signature

pub fn decode(self: @This(), comptime T: type, allocator: Allocator, encoded: []const u8, options: DecodeOptions) DecodeErrors!AbiDecoded(T)

DecodeOutputs

Decode a encoded function based on itself. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values. This methods will run the values against the outputs proprety.

Caller owns the memory.

Consider using decodeAbiFunction if the struct is comptime know and you dont want to provided the return type.

Signature

pub fn decodeOutputs(self: @This(), comptime T: type, allocator: Allocator, encoded: []const u8, options: DecodeOptions) DecodeErrors!AbiDecoded(T)

AllocPrepare

Format the struct into a human readable string. Intended to use for hashing purposes.

Caller owns the memory.

Signature

pub fn allocPrepare(self: @This(), allocator: Allocator) PrepareErrors![]u8

Prepare

Format the struct into a human readable string. Intended to use for hashing purposes.

Signature

pub fn prepare(self: @This(), writer: anytype) PrepareErrors!void

Event

Solidity Abi function representation. Reference: "event"

Properties

struct {
  type: Extract(Abitype, "event")
  name: []const u8
  inputs: []const AbiEventParameter
  anonymous: ?bool = null
}

Deinit

Signature

pub fn deinit(self: @This(), allocator: std.mem.Allocator) void

Encode

Encode the struct signature based it's hash.

Caller owns the memory.

Consider using EncodeAbiEventComptime if the struct is comptime know and you want better typesafety from the compiler

Signature

pub fn encode(self: @This(), allocator: Allocator) EncodeErrors!Hash

EncodeLogTopics

Encode the struct signature based on the values provided. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values

Caller owns the memory.

Signature

pub fn encodeLogTopics(self: @This(), allocator: Allocator, values: anytype) EncodeLogsErrors![]const ?Hash

DecodeLogTopics

Decode the encoded log topics based on the event signature and the provided type.

Caller owns the memory.

Signature

pub fn decodeLogTopics(self: @This(), comptime T: type, encoded: []const ?Hash, options: LogDecoderOptions) LogsDecoderErrors!T

AllocPrepare

Format the struct into a human readable string. Intended to use for hashing purposes.

Caller owns the memory.

Signature

pub fn allocPrepare(self: @This(), allocator: Allocator) PrepareErrors![]u8

Prepare

Format the struct into a human readable string. Intended to use for hashing purposes.

Signature

pub fn prepare(self: @This(), writer: anytype) PrepareErrors!void

Error

Solidity Abi function representation. Reference: "error"

Properties

struct {
  type: Extract(Abitype, "error")
  name: []const u8
  inputs: []const AbiParameter
}

Deinit

Signature

pub fn deinit(self: @This(), allocator: Allocator) void

Encode

Encode the struct signature based on the values provided. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values

Caller owns the memory.

Consider using EncodeAbiErrorComptime if the struct is comptime know and you want better typesafety from the compiler

Signature

pub fn encode(self: @This(), allocator: Allocator, values: anytype) EncodeErrors![]u8

Decode

Decode a encoded error based on itself. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values. This methods will run the values against the inputs proprety.

Caller owns the memory.

Consider using decodeAbiError if the struct is comptime know and you dont want to provided the return type.

Signature

pub fn decode(self: @This(), comptime T: type, allocator: Allocator, encoded: []const u8, options: DecodeOptions) DecodeErrors!AbiDecoded(T)

AllocPrepare

Format the struct into a human readable string. Intended to use for hashing purposes.

Caller owns the memory.

Signature

pub fn allocPrepare(self: @This(), allocator: Allocator) PrepareErrors![]u8

Prepare

Format the struct into a human readable string. Intended to use for hashing purposes.

Signature

pub fn prepare(self: @This(), writer: anytype) PrepareErrors!void

Constructor

Solidity Abi function representation. Reference: "constructor"

Properties

struct {
  type: Extract(Abitype, "constructor")
  inputs: []const AbiParameter
  /// Deprecated. Use 'nonpayable' or 'payable'. Consider using `StateMutability`.
  ///
  /// https://github.com/ethereum/solidity/issues/992
  payable: ?bool = null
  stateMutability: Extract(StateMutability, "payable,nonpayable")
}

Deinit

Signature

pub fn deinit(self: @This(), allocator: Allocator) void

Encode

Encode the struct signature based on the values provided. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values

Caller owns the memory.

Consider using EncodeAbiConstructorComptime if the struct is comptime know and you want better typesafety from the compiler

Signature

pub fn encode(self: @This(), allocator: Allocator, values: anytype) EncodeErrors!AbiEncoded

Decode

Decode a encoded constructor arguments based on itself. Runtime reflection based on the provided values will occur to determine what is the correct method to use to encode the values. This methods will run the values against the inputs proprety.

Caller owns the memory.

Consider using decodeAbiConstructor if the struct is comptime know and you dont want to provided the return type.

Signature

pub fn decode(self: @This(), comptime T: type, allocator: Allocator, encoded: []const u8, options: DecodeOptions) DecodeErrors!AbiDecoded(T)

Fallback

Solidity Abi function representation. Reference: "fallback"

Properties

struct {
  type: Extract(Abitype, "fallback")
  /// Deprecated. Use 'nonpayable' or 'payable'. Consider using `StateMutability`.
  ///
  /// https://github.com/ethereum/solidity/issues/992
  payable: ?bool = null
  stateMutability: Extract(StateMutability, "payable,nonpayable")
}

Receive

Solidity Abi function representation. Reference: "receive"

Properties

struct {
  type: Extract(Abitype, "receive")
  stateMutability: Extract(StateMutability, "payable")
}

AbiItem

Union representing all of the possible Abi members.

Properties

union(enum) {
  abiFunction: Function
  abiEvent: Event
  abiError: Error
  abiConstructor: Constructor
  abiFallback: Fallback
  abiReceive: Receive
}

Deinit

Signature

pub fn deinit(self: @This(), allocator: Allocator) void

Abi

Abi representation in ZIG.

[]const AbiItem