Trait SolTypeEncode

pub trait SolTypeEncode: SolTokenType + Sealed {
    type AlloyType: AlloySolType;

    const DEFAULT_VALUE: Self::DefaultType;

    // Required method
    fn tokenize(&self) -> Self::TokenType<'_>;

    // Provided method
    fn encode(&self) -> Vec<u8> ⓘ { ... }
}

Expand description

A Rust/ink! equivalent of a Solidity ABI type that implements logic for Solidity ABI encoding.

§Rust/ink! to Solidity ABI type mapping

Rust/ink! type	Solidity ABI type	Notes
`bool`	`bool`
`iN` for `N ∈ {8,16,32,64,128}`	`intN`	e.g `i8` ↔ `int8`
`uN` for `N ∈ {8,16,32,64,128}`	`uintN`	e.g `u8` ↔ `uint8`
`U256`	`uint256`
`String`	`string`
`Box<str>`	`string`
`Address` / `H160`	`address`	`Address` is a type alias for the `H160` type used for addresses in `pallet-revive`
`[T; N]` for `const N: usize`	`T[N]`	e.g. `[i8; 64]` ↔ `int8[64]`
`Vec<T>`	`T[]`	e.g. `Vec<i8>` ↔ `int8[]`
`Box<[T]>`	`T[]`	e.g. `Box<[i8]>` ↔ `int8[]`
`SolBytes<u8>`	`bytes1`
`SolBytes<[u8; N]>` for `1 <= N <= 32`	`bytesN`	e.g. `SolBytes<[u8; 32]>` ↔ `bytes32`
`SolBytes<Vec<u8>>`	`bytes`
`SolBytes<Box<[u8]>>`	`bytes`
`(T1, T2, T3, ... T12)`	`(U1, U2, U3, ... U12)`	where `T1` ↔ `U1`, … `T12` ↔ `U12` e.g. `(bool, u8, Address)` ↔ `(bool, uint8, address)`
`&str`, `&mut str`	`string`
`&T`, `&mut T`, `Box<T>`	`T`	e.g. `&i8 ↔ int8`
`&[T]`, `&mut [T]`	`T[]`	e.g. `&[i8]` ↔ `int8[]`

§Note

This trait is sealed and cannot be implemented for types outside ink_primitives.

Required Associated Constants§

An encodable representation of the default value for this type.

Required Associated Types§

Equivalent Solidity ABI type from [alloy_sol_types].

Required Methods§

Tokenizes the given value into a Self::AlloyType token.

Provided Methods§

Solidity ABI encode the value.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

Implementors§

Trait SolTypeEncodeCopy item path

§Rust/ink! to Solidity ABI type mapping

§Note

Required Associated Constants§

const DEFAULT_VALUE: Self::DefaultType

Required Associated Types§

type AlloyType: AlloySolType

Required Methods§

fn tokenize(&self) -> Self::TokenType<'_>

Provided Methods§

fn encode(&self) -> Vec<u8> ⓘ

Dyn Compatibility§

Implementations on Foreign Types§

impl SolTypeEncode for &str

const DEFAULT_VALUE: Self::DefaultType = DynSizeDefault

type AlloyType = String

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for &mut str

const DEFAULT_VALUE: Self::DefaultType = DynSizeDefault

type AlloyType = String

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for Cow<'_, str>

const DEFAULT_VALUE: Self::DefaultType = DynSizeDefault

type AlloyType = String

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for bool

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <bool as sol::types::SolTokenType>::DefaultType}

type AlloyType = Bool

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for i8

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <i8 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Int<8>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for i16

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <i16 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Int<16>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for i32

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <i32 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Int<32>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for i64

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <i64 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Int<64>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for i128

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <i128 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Int<128>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for u8

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <u8 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Uint<8>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for u16

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <u16 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Uint<16>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for u32

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <u32 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Uint<32>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for u64

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <u64 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Uint<64>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for u128

const DEFAULT_VALUE: Self::DefaultType = {transmute(0x0000000000000001): <u128 as sol::types::SolTokenType>::DefaultType}

type AlloyType = Uint<128>

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for ()

const DEFAULT_VALUE: Self::DefaultType = ()

type AlloyType = ()

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for Box<str>

const DEFAULT_VALUE: Self::DefaultType = DynSizeDefault

type AlloyType = String

fn tokenize(&self) -> Self::TokenType<'_>

impl SolTypeEncode for String

const DEFAULT_VALUE: Self::DefaultType = DynSizeDefault

type AlloyType = String

Trait SolTypeEncode

impl<T> SolTypeEncode for Cow<'_, [T]>
where T: SolTypeEncode + Clone, [T]: ToOwned,

impl<T> SolTypeEncode for Option<T>
where T: SolTypeEncode,