chain

Documentation

Overview

Package chain contains tools to obtain metadata for Ethereum chains.

Index

• Constants
• Variables
• type Bridge
• type Chain
  • func ChainById(chainId uint64) (*Chain, error)
  • func Chains() ([]Chain, error)
  • func ChainsDir(dir string) ([]Chain, error)
• type ChainMini
  • func ChainMiniById(chainId uint64) (*ChainMini, error)
  • func ChainsMini() ([]ChainMini, error)
  • func ChainsMiniDir(dir string) ([]ChainMini, error)
• type Currency
• type Ens
• type Explorer
• type Feature
• type Parent

Constants

const (
	ChainIdEthereumMainnet = 1
	ChainIdHolesky         = 17000
	ChainIdSepolia         = 11155111
)

well-known ChainId

Variables

var (
	EthereumMainnet func() *Chain
	Holesky         func() *Chain
	Sepolia         func() *Chain
)

Types

type Bridge

type Bridge struct {
	Url string `json:"url"`
}

type Chain

type Chain struct {
	ChainMini
	Chain     string     `json:"chain"`
	Ens       Ens        `json:"ens,omitempty"`
	Explorers []Explorer `json:"explorers,omitempty"`
	Features  []Feature  `json:"features,omitempty"`
	Icon      string     `json:"icon,omitempty"`
	Parent    Parent     `json:"parent,omitempty"`
	Slip44    uint64     `json:"slip44,omitempty"`
	Status    string     `json:"status,omitempty"`
}

func ChainById

func ChainById(chainId uint64) (*Chain, error)

ChainById returns Chain by 'chainId'.

Chains data ('chains.json' file) are stored in current directory.

func Chains

func Chains() ([]Chain, error)

Chains returns slice of Chain.

Chains data are loaded from 'chains.json' file in current directory (if it does not exist, it is downloaded from 'https://chainid.network/chains.json'). To renew 'chains.json' file, remove it.

func ChainsDir

func ChainsDir(dir string) ([]Chain, error)

ChainsDir returns slice of Chain.

Chains data are loaded from 'chains.json' file in 'dir' directory (if it does not exist, it is downloaded from 'https://chainid.network/chains.json'). To renew 'chains.json' file, remove it.

type ChainMini

type ChainMini struct {
	ChainId        uint64   `json:"chainId"`
	Faucets        []string `json:"faucets"`
	InfoURL        string   `json:"infoURL"`
	Name           string   `json:"name"`
	NativeCurrency Currency `json:"nativeCurrency"`
	NetworkId      uint64   `json:"networkId"`
	Rpc            []string `json:"rpc"`
	ShortName      string   `json:"shortName"`
}

func ChainMiniById

func ChainMiniById(chainId uint64) (*ChainMini, error)

ChainMiniById returns ChainMini by 'chainId'.

ChainsMini data ('chains_mini.json' file) are stored in current directory.

func ChainsMini

func ChainsMini() ([]ChainMini, error)

ChainsMini returns slice of ChainMini.

ChainsMini data are loaded from 'chains_mini.json' file in current directory (if it does not exist, it is downloaded from 'https://chainid.network/chains_mini.json'). To renew 'chains_mini.json' file, remove it.

func ChainsMiniDir

func ChainsMiniDir(dir string) ([]ChainMini, error)

ChainsMiniDir returns slice of ChainMini.

ChainsMini data are loaded from 'chains_mini.json' file in 'dir' directory (if it does not exist, it is downloaded from 'https://chainid.network/chains_mini.json'). To renew 'chains_mini.json' file, remove it.

type Currency

type Currency struct {
	Decimals uint64 `json:"decimals"`
	Name     string `json:"name"`
	Symbol   string `json:"symbol"`
}

type Ens

type Ens struct {
	Registry string `json:"registry"`
}

Ethereum Name Service

type Explorer

type Explorer struct {
	Icon     string `json:"icon,omitempty"`
	Name     string `json:"name"`
	Standard string `json:"standard"`
	Url      string `json:"url"`
}

type Feature

type Feature struct {
	Name string `json:"name"`
}

type Parent

type Parent struct {
	Bridges []Bridge `json:"bridges,omitempty"`
	Chain   string   `json:"chain"`
	Type    string   `json:"type"`
}