l1

Documentation

Index

• type Client
  • func NewClient(l1 Subscriber, chain *blockchain.Blockchain, log utils.SimpleLogger) *Client
  • func (c *Client) Run(ctx context.Context) error
  • func (c *Client) WithEventListener(l EventListener) *Client
  • func (c *Client) WithPollFinalisedInterval(delay time.Duration) *Client
  • func (c *Client) WithResubscribeDelay(delay time.Duration) *Client
• type EthSubscriber
  • func NewEthSubscriber(ethClientAddress string, coreContractAddress common.Address) (*EthSubscriber, error)
  • func (s *EthSubscriber) ChainID(ctx context.Context) (*big.Int, error)
  • func (s *EthSubscriber) Close()
  • func (s *EthSubscriber) FinalisedHeight(ctx context.Context) (uint64, error)
  • func (s *EthSubscriber) WatchLogStateUpdate(ctx context.Context, sink chan<- *contract.StarknetLogStateUpdate) (event.Subscription, error)
• type EventListener
• type SelectiveListener
  • func (l SelectiveListener) OnNewL1Head(head *core.L1Head)
• type Subscriber

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(l1 Subscriber, chain *blockchain.Blockchain, log utils.SimpleLogger) *Client

func (*Client) Run

func (c *Client) Run(ctx context.Context) error

func (*Client) WithEventListener

func (c *Client) WithEventListener(l EventListener) *Client

func (*Client) WithPollFinalisedInterval

func (c *Client) WithPollFinalisedInterval(delay time.Duration) *Client

WithPollFinalisedInterval sets the time to wait before checking for an update to the finalised L1 block.

func (*Client) WithResubscribeDelay

func (c *Client) WithResubscribeDelay(delay time.Duration) *Client

type EthSubscriber

type EthSubscriber struct {
	// contains filtered or unexported fields
}

func NewEthSubscriber

func NewEthSubscriber(ethClientAddress string, coreContractAddress common.Address) (*EthSubscriber, error)

func (*EthSubscriber) ChainID

func (s *EthSubscriber) ChainID(ctx context.Context) (*big.Int, error)

func (*EthSubscriber) Close

func (s *EthSubscriber) Close()

func (*EthSubscriber) FinalisedHeight

func (s *EthSubscriber) FinalisedHeight(ctx context.Context) (uint64, error)

func (*EthSubscriber) WatchLogStateUpdate

func (s *EthSubscriber) WatchLogStateUpdate(ctx context.Context, sink chan<- *contract.StarknetLogStateUpdate) (event.Subscription, error)

type EventListener

type EventListener interface {
	OnNewL1Head(head *core.L1Head)
}

type SelectiveListener

type SelectiveListener struct {
	OnNewL1HeadCb func(head *core.L1Head)
}

func (SelectiveListener) OnNewL1Head

func (l SelectiveListener) OnNewL1Head(head *core.L1Head)

type Subscriber

type Subscriber interface {
	FinalisedHeight(ctx context.Context) (uint64, error)
	WatchLogStateUpdate(ctx context.Context, sink chan<- *contract.StarknetLogStateUpdate) (event.Subscription, error)
	ChainID(ctx context.Context) (*big.Int, error)

	Close()
}