starknet

Documentation

Index

• func NewChain(cfg *StarknetConfig, opts ChainOpts) (starkchain.Chain, error)
• func NewConfigs(cfgs chains.ConfigsV2[string, starknetdb.Node]) types.Configs
• type ChainOpts
  • func (o *ChainOpts) ConfigsAndLogger() (chains.Configs[string, db.Node], logger.Logger)
  • func (o *ChainOpts) Name() string
  • func (o *ChainOpts) Validate() (err error)
• type RelayExtender
  • func NewRelayExtender(cfg *StarknetConfig, opts ChainOpts) (*RelayExtender, error)
  • func (r *RelayExtender) GetChainStatus(ctx context.Context) (relaytypes.ChainStatus, error)
  • func (r *RelayExtender) ListNodeStatuses(ctx context.Context, pageSize int32, pageToken string) (stats []relaytypes.NodeStatus, nextPageToken string, total int, err error)
  • func (r *RelayExtender) Transact(ctx context.Context, from, to string, amount *big.Int, balanceCheck bool) error
• type StarknetConfig
  • func (c *StarknetConfig) ConfirmationPoll() time.Duration
  • func (c *StarknetConfig) IsEnabled() bool
  • func (c *StarknetConfig) OCR2CachePollPeriod() time.Duration
  • func (c *StarknetConfig) OCR2CacheTTL() time.Duration
  • func (c *StarknetConfig) RequestTimeout() time.Duration
  • func (c *StarknetConfig) SetFrom(f *StarknetConfig)
  • func (c *StarknetConfig) TOMLString() (string, error)
  • func (c *StarknetConfig) TxTimeout() time.Duration
  • func (c *StarknetConfig) ValidateConfig() (err error)
• type StarknetConfigs
  • func (cs StarknetConfigs) Chains(ids ...string) (r []types.ChainStatus, err error)
  • func (cs StarknetConfigs) Node(name string) (n db.Node, err error)
  • func (cs StarknetConfigs) NodeStatus(name string) (n types.NodeStatus, err error)
  • func (cs StarknetConfigs) NodeStatuses(chainIDs ...string) (ns []types.NodeStatus, err error)
  • func (cs StarknetConfigs) Nodes(chainID string) (ns []db.Node, err error)
  • func (cs *StarknetConfigs) SetFrom(fs *StarknetConfigs) (err error)
  • func (cs StarknetConfigs) ValidateConfig() (err error)
• type StarknetNodes
  • func (ns *StarknetNodes) SetFrom(fs *StarknetNodes)

Functions

func NewChain

func NewChain(cfg *StarknetConfig, opts ChainOpts) (starkchain.Chain, error)

func NewConfigs

func NewConfigs(cfgs chains.ConfigsV2[string, starknetdb.Node]) types.Configs

Types

type ChainOpts

type ChainOpts struct {
	Logger logger.Logger
	// the implementation used here needs to be co-ordinated with the starknet transaction manager keystore adapter
	KeyStore loop.Keystore
	Configs  types.Configs
}

func (*ChainOpts) ConfigsAndLogger

func (o *ChainOpts) ConfigsAndLogger() (chains.Configs[string, db.Node], logger.Logger)

func (*ChainOpts) Name

func (o *ChainOpts) Name() string

func (*ChainOpts) Validate

func (o *ChainOpts) Validate() (err error)

type RelayExtender

type RelayExtender struct {
	starkchain.Chain
	// contains filtered or unexported fields
}

TODO remove these wrappers after BCF-2441

func NewRelayExtender

func NewRelayExtender(cfg *StarknetConfig, opts ChainOpts) (*RelayExtender, error)

func (*RelayExtender) GetChainStatus

func (r *RelayExtender) GetChainStatus(ctx context.Context) (relaytypes.ChainStatus, error)

func (*RelayExtender) ListNodeStatuses

func (r *RelayExtender) ListNodeStatuses(ctx context.Context, pageSize int32, pageToken string) (stats []relaytypes.NodeStatus, nextPageToken string, total int, err error)

func (*RelayExtender) Transact

func (r *RelayExtender) Transact(ctx context.Context, from, to string, amount *big.Int, balanceCheck bool) error

type StarknetConfig

type StarknetConfig struct {
	ChainID *string
	// Do not access directly. Use [IsEnabled]
	Enabled *bool
	stkcfg.Chain
	Nodes StarknetNodes
}

func (*StarknetConfig) ConfirmationPoll

func (c *StarknetConfig) ConfirmationPoll() time.Duration

func (*StarknetConfig) IsEnabled

func (c *StarknetConfig) IsEnabled() bool

func (*StarknetConfig) OCR2CachePollPeriod

func (c *StarknetConfig) OCR2CachePollPeriod() time.Duration

func (*StarknetConfig) OCR2CacheTTL

func (c *StarknetConfig) OCR2CacheTTL() time.Duration

func (*StarknetConfig) RequestTimeout

func (c *StarknetConfig) RequestTimeout() time.Duration

func (*StarknetConfig) SetFrom

func (c *StarknetConfig) SetFrom(f *StarknetConfig)

func (*StarknetConfig) TOMLString

func (c *StarknetConfig) TOMLString() (string, error)

func (*StarknetConfig) TxTimeout

func (c *StarknetConfig) TxTimeout() time.Duration

func (*StarknetConfig) ValidateConfig

func (c *StarknetConfig) ValidateConfig() (err error)

type StarknetConfigs

type StarknetConfigs []*StarknetConfig

func (StarknetConfigs) Chains

func (cs StarknetConfigs) Chains(ids ...string) (r []types.ChainStatus, err error)

func (StarknetConfigs) Node

func (cs StarknetConfigs) Node(name string) (n db.Node, err error)

func (StarknetConfigs) NodeStatus

func (cs StarknetConfigs) NodeStatus(name string) (n types.NodeStatus, err error)

func (StarknetConfigs) NodeStatuses

func (cs StarknetConfigs) NodeStatuses(chainIDs ...string) (ns []types.NodeStatus, err error)

func (StarknetConfigs) Nodes

func (cs StarknetConfigs) Nodes(chainID string) (ns []db.Node, err error)

func (*StarknetConfigs) SetFrom

func (cs *StarknetConfigs) SetFrom(fs *StarknetConfigs) (err error)

func (StarknetConfigs) ValidateConfig

func (cs StarknetConfigs) ValidateConfig() (err error)

type StarknetNodes

type StarknetNodes []*stkcfg.Node

func (*StarknetNodes) SetFrom

func (ns *StarknetNodes) SetFrom(fs *StarknetNodes)