domains

Documentation

Overview

Package domains contains adapters for each domain

Index

• Variables
• type AttestationCollectorContract
• type DestinationContract
• type DomainClient
• type OriginContract
• type PingPongClientContract
• type TestClientContract

Variables

var ErrNoUpdate = errors.New("no update produced")

ErrNoUpdate indicates no update has been produced.

Types

type AttestationCollectorContract

type AttestationCollectorContract interface {
	// AddAgent adds an agent (guard or notary) to the attesation collector
	AddAgent(transactOpts *bind.TransactOpts, domain uint32, signer signer.Signer) error
	// SubmitAttestation submits an attestation to the attestation collector.
	SubmitAttestation(ctx context.Context, signer signer.Signer, attestation types.SignedAttestation) error
	// GetLatestNonce gets the latest nonce signed by the bondedAgentSigner for the domain on the attestation collector
	GetLatestNonce(ctx context.Context, origin uint32, destination uint32, bondedAgentSigner signer.Signer) (nonce uint32, err error)
	// GetAttestation gets the attestation if any for the given origin, destination and nonce
	GetAttestation(ctx context.Context, origin, destination, nonce uint32) (types.SignedAttestation, error)
	// GetRoot gets the root if any for the given origin, destination and nonce
	GetRoot(ctx context.Context, origin, destination, nonce uint32) ([32]byte, error)
	// PrimeNonce primes the nonce for the signer
	PrimeNonce(ctx context.Context, signer signer.Signer) error
}

AttestationCollectorContract contains the interface for the attestation collector.

type DestinationContract

type DestinationContract interface {
	// SubmitAttestation submits an attestation to the destination.
	SubmitAttestation(ctx context.Context, signer signer.Signer, attestation types.SignedAttestation) error
	// Execute executes a message on the destination.
	Execute(ctx context.Context, signer signer.Signer, message types.Message, proof [32][32]byte, index *big.Int) error
	// SubmittedAt retrieves the time a given Merkle root from the given origin was submitted on the destination.
	SubmittedAt(ctx context.Context, origin uint32, root [32]byte) (*time.Time, error)
	// PrimeNonce primes the nonce for the signer
	PrimeNonce(ctx context.Context, signer signer.Signer) error
}

DestinationContract contains the interface for the destination.

type DomainClient

type DomainClient interface {
	// Name gets the name of the client. This can be used for logging.
	Name() string
	// Config gets the config that was used to create the client.
	Config() config.DomainConfig
	// BlockNumber gets the latest block
	BlockNumber(ctx context.Context) (uint32, error)
	// Origin retrieves a handle for the origin contract
	Origin() OriginContract
	// AttestationCollector is the attestation collector
	AttestationCollector() AttestationCollectorContract
	// Destination retrieves a handle for the destination contract
	Destination() DestinationContract
}

DomainClient represents a client used for interacting with contracts in a particular domain. The goal of a domain is that the particulars of interacting with an eth vs a solana contract are abstracted away and can be done through a set of common interfaces.

type OriginContract

type OriginContract interface {
	// FetchSortedMessages fetches all messages in order form lowest->highest in a given block range
	FetchSortedMessages(ctx context.Context, from uint32, to uint32) (messages []types.CommittedMessage, err error)
	// ProduceAttestation suggests an update from the origin contract
	// TODO (joe): this will be changed to "ProduceAttestations" and return an attestation per destination
	ProduceAttestation(ctx context.Context) (types.Attestation, error)
	// GetHistoricalAttestation gets the root corresponding to destination and nonce,
	// as well as the block number the message was dispatched and the current block number
	GetHistoricalAttestation(ctx context.Context, destinationID, nonce uint32) (types.Attestation, uint64, error)
	// SuggestAttestation gets the latest attestation on the origin for the given destination
	SuggestAttestation(ctx context.Context, destinationID uint32) (types.Attestation, error)
}

OriginContract represents the origin contract on a particular chain.

type PingPongClientContract

type PingPongClientContract interface {
	// DoPing sends a ping message through the PingPongClient.
	DoPing(ctx context.Context, signer signer.Signer, destination uint32, recipient common.Address, pings uint16) error
	WatchPingSent(ctx context.Context, sink chan<- *pingpongclient.PingPongClientPingSent) (event.Subscription, error)
	WatchPongReceived(ctx context.Context, sink chan<- *pingpongclient.PingPongClientPongReceived) (event.Subscription, error)
}

PingPongClientContract contains the interface for the ping pong test client.

type TestClientContract

type TestClientContract interface {
	// SendMessage sends a message through the TestClient.
	SendMessage(ctx context.Context, signer signer.Signer, destination uint32, recipient common.Address, optimisticSeconds uint32, message []byte) error
}

TestClientContract contains the interface for the test client.