warp

Documentation

Index

• func NewWarpAPIFetcher(clients map[ids.NodeID]WarpClient) *warpAPIFetcher
• type WarpAPI
  • func NewWarpAPI(backend WarpBackend, 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)
• type WarpBackend
  • func NewWarpBackend(snowCtx *snow.Context, db database.Database, cacheSize int) WarpBackend
• type WarpClient
  • func NewWarpClient(uri, chain string) (WarpClient, error)

Functions

func NewWarpAPIFetcher

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

Types

type WarpAPI

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

WarpAPI introduces snowman specific functionality to the evm

func NewWarpAPI

func NewWarpAPI(backend WarpBackend, 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.

type WarpBackend

type WarpBackend interface {
	// AddMessage signs [unsignedMessage] and adds it to the warp backend database
	AddMessage(unsignedMessage *avalancheWarp.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) (*avalancheWarp.UnsignedMessage, error)

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

WarpBackend 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 NewWarpBackend

func NewWarpBackend(snowCtx *snow.Context, db database.Database, cacheSize int) WarpBackend

NewWarpBackend creates a new WarpBackend, and initializes the signature cache and message tracking database.

type WarpClient

type WarpClient interface {
	GetSignature(ctx context.Context, messageID ids.ID) ([]byte, error)
	GetAggregateSignature(ctx context.Context, messageID ids.ID, quorumNum uint64) ([]byte, error)
}

func NewWarpClient

func NewWarpClient(uri, chain string) (WarpClient, error)

NewWarpClient returns a WarpClient for interacting with EVM [chain]