Enum AbiSubcommand 

pub enum AbiSubcommand {
    CalldataEncode {
        sig: String,
        args: Vec<String>,
        file: Option<PathBuf>,
    },
    DecodeCalldata {
        sig: String,
        calldata: Option<String>,
        file: Option<PathBuf>,
    },
    DecodeString {
        data: String,
    },
    DecodeEvent {
        sig: Option<String>,
        data: String,
    },
    DecodeError {
        sig: Option<String>,
        data: String,
    },
    DecodeAbi {
        sig: String,
        calldata: String,
        input: bool,
    },
    AbiEncode {
        sig: String,
        packed: bool,
        args: Vec<String>,
    },
    AbiEncodeEvent {
        sig: String,
        args: Vec<String>,
    },
    FourByte {
        selector: Option<Selector>,
    },
    FourByteCalldata {
        calldata: Option<String>,
    },
    FourByteEvent {
        topic: Option<B256>,
    },
    UploadSignature {
        signatures: Vec<String>,
    },
    PrettyCalldata {
        calldata: Option<String>,
        offline: bool,
    },
    CreationCode(CreationCodeArgs),
    Artifact(ArtifactArgs),
    ConstructorArgs(ConstructorArgsArgs),
    Interface(InterfaceArgs),
    Bind(BindArgs),
    B2EPayload(B2EPayloadArgs),
    Sig {
        sig: Option<String>,
        optimize: Option<usize>,
    },
}

ABI encoding and decoding, selector and contract artifact subcommands.

Variants

CalldataEncode

ABI-encode a function with arguments.

Fields

sig: String

The function signature in the format <name>(<in-types>)(<out-types>)

args: Vec<String>

The arguments to encode.

file: Option<PathBuf>

DecodeCalldata

Decode ABI-encoded input data

Similar to abi-decode --input, but function selector MUST be prefixed in calldata.

Examples:

• cast decode-calldata “transfer(address,uint256)” $CALLDATA
• cast decode-calldata –json “transfer(address,uint256)” $CALLDATA

Fields

sig: String

The function signature in the format <name>(<in-types>)(<out-types>).

calldata: Option<String>

The ABI-encoded calldata.

file: Option<PathBuf>

Load ABI-encoded calldata from a file instead.

DecodeString

Decode ABI-encoded string.

Similar to calldata-decode --input, but the function argument is a string

Fields

data: String

The ABI-encoded string.

DecodeEvent

Decode event data

Parameters marked indexed in the supplied signature are emitted as log topics rather than data, so they are ignored when decoding. With --sig, DATA must contain only the encoded non-indexed event data, without topics.

Examples:

• cast decode-event –sig “Transfer(address indexed from, address indexed to, uint256 value)” $DATA
• cast decode-event $DATA (topic0-prefixed data; looks up the signature)

Fields

sig: Option<String>

The event signature. If none provided then tries to decode from local cache or https://4byte.sourcify.dev.

data: String

The event data to decode.

DecodeError

Decode custom error data.

Fields

sig: Option<String>

The error signature. If none provided then tries to decode from local cache or https://4byte.sourcify.dev.

data: String

The error data to decode.

DecodeAbi

Decode ABI-encoded input or output data

Defaults to decoding output data. To decode input data pass –input.

When passing --input, function selector must NOT be prefixed in calldata string.

Examples:

• cast decode-abi “balanceOf(address)(uint256)” $DATA
• cast decode-abi –input “transfer(address,uint256)” $CALLDATA

Fields

sig: String

The function signature in the format <name>(<in-types>)(<out-types>).

calldata: String

The ABI-encoded calldata.

input: bool

Whether to decode the input or output data.

AbiEncode

ABI encode the given function argument, excluding the selector

Examples:

• cast abi-encode “transfer(address,uint256)” $ADDRESS 100
• cast abi-encode –packed “f(string,uint64)” hello 100

Fields

sig: String

The function signature.

packed: bool

Whether to use packed encoding.

args: Vec<String>

The arguments of the function.

AbiEncodeEvent

ABI encode an event and its arguments to generate topics and data.

Fields

sig: String

The event signature.

args: Vec<String>

The arguments of the event.

FourByte

Get the function signatures for the given selector from https://4byte.sourcify.dev.

Fields

selector: Option<Selector>

The function selector.

FourByteCalldata

Decode ABI-encoded calldata using https://4byte.sourcify.dev.

Fields

calldata: Option<String>

The ABI-encoded calldata.

FourByteEvent

Get the event signature for a given topic 0 from https://4byte.sourcify.dev.

Fields

topic: Option<B256>

Topic 0

UploadSignature

Upload the given signatures to https://4byte.sourcify.dev.

Example inputs:

• “transfer(address,uint256)”
• “function transfer(address,uint256)”
• “function transfer(address,uint256)” “event Transfer(address,address,uint256)”
• “./out/Contract.sol/Contract.json”

Fields

signatures: Vec<String>

The signatures to upload.

Prefix with ‘function’, ‘event’, or ‘error’. Defaults to function if no prefix given. Can also take paths to contract artifact JSON.

PrettyCalldata

Pretty print calldata.

Tries to decode the calldata using https://4byte.sourcify.dev unless –offline is passed.

Fields

calldata: Option<String>

The calldata.

offline: bool

Skip the https://4byte.sourcify.dev lookup.

CreationCode(CreationCodeArgs)

Download a contract creation code from Etherscan and RPC.

Artifact(ArtifactArgs)

Generate an artifact file, that can be used to deploy a contract locally.

ConstructorArgs(ConstructorArgsArgs)

Display constructor arguments used for the contract initialization.

Interface(InterfaceArgs)

Generate a Solidity interface from a given ABI

Currently does not support ABI encoder v2.

Examples:

• cast interface $TOKEN –etherscan-api-key $KEY (fetch the ABI from Etherscan)
• cast interface ./out/Counter.sol/Counter.json (load a local ABI file)

Bind(BindArgs)

Generate a rust binding from a given ABI.

B2EPayload(B2EPayloadArgs)

Convert Beacon payload to execution payload.

Sig

Get the selector for a function

Examples:

• cast sig “transfer(address,uint256)”
• cast sig “deposit(uint256)” 2 (optimize for 2 leading zero bytes)

Fields

sig: Option<String>

The function signature, e.g. transfer(address,uint256).

optimize: Option<usize>

Optimize signature to contain provided amount of leading zeroes in selector.

Trait Implementations

impl FromArgMatches for AbiSubcommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for AbiSubcommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 232 bytes

Size for each variant:

• CalldataEncode: 80 bytes
• DecodeCalldata: 80 bytes
• DecodeString: 32 bytes
• DecodeEvent: 56 bytes
• DecodeError: 56 bytes
• DecodeAbi: 64 bytes
• AbiEncode: 64 bytes
• AbiEncodeEvent: 56 bytes
• FourByte: 13 bytes
• FourByteCalldata: 32 bytes
• FourByteEvent: 41 bytes
• UploadSignature: 32 bytes
• PrettyCalldata: 40 bytes
• CreationCode: 216 bytes
• Artifact: 232 bytes
• ConstructorArgs: 216 bytes
• Interface: 152 bytes
• Bind: 32 bytes
• B2EPayload: 32 bytes
• Sig: 48 bytes