descriptors

package
v1.13.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 11, 2025 License: MIT Imports: 5 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddressMap

type AddressMap map[string]types.Address

AddressMap is a map of address names to their corresponding addresses

type Chain

type Chain struct {
	Name      string              `json:"name"`
	ID        string              `json:"id,omitempty"`
	Services  RedundantServiceMap `json:"services,omitempty"`
	Nodes     []Node              `json:"nodes"`
	Wallets   WalletMap           `json:"wallets,omitempty"`
	JWT       string              `json:"jwt,omitempty"`
	Config    *params.ChainConfig `json:"config,omitempty"`
	Addresses AddressMap          `json:"addresses,omitempty"`
}

type DepSet added in v1.13.3

type DepSet = json.RawMessage

type DevnetEnvironment

type DevnetEnvironment struct {
	Name string `json:"name"`

	ReverseProxyURL string `json:"reverse_proxy_url,omitempty"`

	L1 *Chain     `json:"l1"`
	L2 []*L2Chain `json:"l2"`

	Features []string          `json:"features,omitempty"`
	DepSets  map[string]DepSet `json:"dep_sets,omitempty"`
}

DevnetEnvironment exposes the relevant information to interact with a devnet.

type EndpointMap

type EndpointMap map[string]*PortInfo

EndpointMap is a map of service names to their endpoints.

type L2Chain added in v1.12.2

type L2Chain struct {
	*Chain
	L1Addresses  AddressMap     `json:"l1_addresses,omitempty"`
	L1Wallets    WalletMap      `json:"l1_wallets,omitempty"`
	RollupConfig *rollup.Config `json:"rollup_config"`
}

type Node

type Node struct {
	Name     string            `json:"name"`
	Services ServiceMap        `json:"services"`
	Labels   map[string]string `json:"labels,omitempty"`
}

Node represents a node for a chain

type PortInfo

type PortInfo struct {
	Host        string `json:"host"`
	Scheme      string `json:"scheme,omitempty"`
	Port        int    `json:"port,omitempty"`
	PrivatePort int    `json:"private_port,omitempty"`

	ReverseProxyHeader http.Header `json:"reverse_proxy_header,omitempty"`
}

type RedundantServiceMap added in v1.13.3

type RedundantServiceMap map[string][]*Service

RedundantServiceMap is a map of service names to services. It is used to represent services that are redundant, i.e. they can have multiple instances.

type Service

type Service struct {
	Name      string            `json:"name"`
	Endpoints EndpointMap       `json:"endpoints"`
	Labels    map[string]string `json:"labels,omitempty"`
}

Service represents a chain service (e.g. batcher, proposer, challenger)

type ServiceMap

type ServiceMap map[string]*Service

ServiceMap is a map of service names to services.

type Wallet

type Wallet struct {
	Address    types.Address `json:"address"`
	PrivateKey string        `json:"private_key,omitempty"`
}

Wallet represents a wallet with an address and optional private key.

type WalletMap

type WalletMap map[string]*Wallet

WalletMap is a map of wallet names to wallets.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL