warp

Documentation

Index

• func NewWarpAPIFetcher(clients map[ids.NodeID]Client) *warpAPIFetcher
• type Backend
  • func NewBackend(warpSigner odysseyWarp.Signer, db database.Database, cacheSize int) Backend
• type Client
  • func NewClient(uri, chain string) (Client, error)
• type WarpAPI
  • func NewWarpAPI(backend Backend, aggregator *aggregator.Aggregator) *WarpAPI
  • func (api *WarpAPI) GetAggregateSignature(ctx context.Context, messageID ids.ID, quorumNum uint64) (signedMessageBytes hexutil.Bytes, err error)
  • func (api *WarpAPI) GetSignature(ctx context.Context, messageID ids.ID) (hexutil.Bytes, error)

Functions

func NewWarpAPIFetcher

func NewWarpAPIFetcher(clients map[ids.NodeID]Client) *warpAPIFetcher

Types

type Backend

type Backend interface {
	// AddMessage signs [unsignedMessage] and adds it to the warp backend database
	AddMessage(unsignedMessage *odysseyWarp.UnsignedMessage) error

	// GetSignature returns the signature of the requested message hash.
	GetSignature(messageHash ids.ID) ([bls.SignatureLen]byte, error)

	// GetMessage retrieves the [unsignedMessage] from the warp backend database if available
	GetMessage(messageHash ids.ID) (*odysseyWarp.UnsignedMessage, error)

	// Clear clears the entire db
	Clear() error
}

Backend tracks signature-eligible warp messages and provides an interface to fetch them. The backend is also used to query for warp message signatures by the signature request handler.

func NewBackend

func NewBackend(warpSigner odysseyWarp.Signer, db database.Database, cacheSize int) Backend

NewBackend creates a new Backend, and initializes the signature cache and message tracking database.

type Client

type Client interface {
	// GetSignature requests the BLS signature associated with a messageID
	GetSignature(ctx context.Context, messageID ids.ID) ([]byte, error)
	// GetAggregateSignature requests the aggregate signature associated with messageID
	GetAggregateSignature(ctx context.Context, messageID ids.ID, quorumNum uint64) ([]byte, error)
}

func NewClient

func NewClient(uri, chain string) (Client, error)

NewClient returns a Client for interacting with EVM [chain]

type WarpAPI

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

WarpAPI introduces snowman specific functionality to the evm

func NewWarpAPI

func NewWarpAPI(backend Backend, aggregator *aggregator.Aggregator) *WarpAPI

func (*WarpAPI) GetAggregateSignature

func (api *WarpAPI) GetAggregateSignature(ctx context.Context, messageID ids.ID, quorumNum uint64) (signedMessageBytes hexutil.Bytes, err error)

GetAggregateSignature fetches the aggregate signature for the requested [messageID]

func (*WarpAPI) GetSignature

func (api *WarpAPI) GetSignature(ctx context.Context, messageID ids.ID) (hexutil.Bytes, error)

GetSignature returns the BLS signature associated with a messageID.