Cartouche.Chain (Cartouche v0.5.0)

Copy Markdown View Source

Chain registry and chain-id parsing helpers.

API Functions

FunctionArityDescriptionParam Kinds
chain_id_value1Resolve a chain id for transaction construction, defaulting to the application chain.chain_id: value
parse_id1Parse an Ethereum chain id from either a numeric id or a known chain name.chain_id: value

Summary

Functions

Resolves a chain id for transaction construction, defaulting to the application chain.

Parses a chain id, which can be given as an integer or an atom of a known network.

Functions

chain_id_value(chain_id)

@spec chain_id_value(atom() | integer() | nil) :: integer()

Resolves a chain id for transaction construction, defaulting to the application chain.

Examples

iex> Cartouche.Chain.chain_id_value(:goerli)
5

iex> Cartouche.Chain.chain_id_value(42)
42

parse_id(chain_id)

@spec parse_id(atom() | integer()) :: integer() | no_return()

Parses a chain id, which can be given as an integer or an atom of a known network.

Examples

iex> Cartouche.Chain.parse_id(5)
5

iex> Cartouche.Chain.parse_id(:unichain)
130