Crate alloy_sol_type_parser

Source
Expand description

§alloy-sol-type-parser

Simple and light-weight Solidity type strings parser.

This library is primarily a dependency for the user-facing APIs in alloy-json-abi and alloy-dyn-abi. Please see the documentation for those crates for more information.

This parser generally follows the Solidity spec, however, it supports only a subset of possible types, chosen to support ABI coding.

§Usage

The TypeSpecifier is the top-level type in this crate. It is a wrapper around a section of a string (called a span). It progressively breaks the strings down into subspans, and adds metadata about the type. E.g. it tracks the stem type as well as the sizes of array dimensions. A TypeSpecifier is expected to handle any valid Solidity type string.

use alloy_sol_type_parser::TypeSpecifier;
use core::num::NonZeroUsize;

// Parse a type specifier from a string
let my_type = TypeSpecifier::parse("uint8[2][]").unwrap();

// Read the total span
assert_eq!(
    my_type.span(),
    "uint8[2][]"
);

// A type specifier has a stem type. This is the type string, stripped of its
// array dimensions.
assert_eq!(my_type.stem.span(), "uint8");

// Arrays are represented as a vector of sizes. This allows for deep nesting.
assert_eq!(
    my_type.sizes,
    // `None` is used for dynamic sizes. This is equivalent to `[2][]`
    vec![NonZeroUsize::new(2), None]
);

// Type specifiers also work for complex tuples!
let my_tuple = TypeSpecifier::parse("(uint8,(uint8[],bool))[39]").unwrap();
assert_eq!(
    my_tuple.stem.span(),
    "(uint8,(uint8[],bool))"
);

// Types are NOT resolved, so you can parse custom structs just by name.
let my_struct = TypeSpecifier::parse("MyStruct").unwrap();

§Why not support parse()?

The core::str::FromStr trait is not implemented for TypeSpecifier because of lifetime constraints. Unfortunately, it is impossible to implement this for a type with a lifetime dependent on the input str. Instead, we recommend using the parse associated functions, or TryFrom::<&str>::try_from if a trait is needed.

§Why not use syn?

This is NOT a full syntax library, and is not intended to be used as a replacement for syn-solidity. This crate is intended to be used for parsing type strings present in existing ecosystem tooling, and nothing else. It is not intended to be used for parsing Solidity source code.

This crate is useful for:

  • syntax-checking JSON ABI files
  • providing known-good input to alloy-dyn-abi
  • porting ethers.js code to rust

It is NOT useful for:

  • parsing Solidity source code
  • generating Rust code from Solidity source code
  • generating Solidity source code from rust code

Modules§

Structs§

  • Error
    Parser error.
  • ParameterSpecifier
    Represents a function parameter.
  • Parameters
    Represents a list of function parameters.
  • RootType
    A root type, with no array suffixes. Corresponds to a single, non-sequence type. This is the most basic type specifier.
  • TupleSpecifier
    A tuple specifier, with no array suffixes. Corresponds to a sequence of types.
  • TypeSpecifier
    Represents a type-name. Consists of an identifier and optional array sizes.

Enums§

  • StateMutability
    A JSON ABI function’s state mutability.
  • Storage
    Storage specifier.
  • TypeStem
    A stem of a Solidity array type. It is either a root type, or a tuple type.

Constants§

  • IDENT_REGEX
    The regular expression for a Solidity identifier.

Functions§

  • is_id_continue
    Returns true if the given character is valid in a Solidity identifier.
  • is_id_start
    Returns true if the given character is valid at the start of a Solidity identifier.
  • is_valid_identifier
    Returns true if the given string is a valid Solidity identifier.

Type Aliases§