shard

Documentation

Index

• type Adapter
  • func NewAdapter(cfg AdapterConfig, opts ...Option) (Adapter, error)
• type AdapterConfig
• type Option
  • func WithCredentials(credPath string) Option
• type QueryAdapter
• type WriteAdapter

Types

type Adapter

type Adapter interface {
	WriteAdapter
	QueryAdapter
}

Adapter is a type that helps facilitate communication with the EVM base shard.

func NewAdapter

func NewAdapter(cfg AdapterConfig, opts ...Option) (Adapter, error)

type AdapterConfig

type AdapterConfig struct {
	// ShardSequencerAddr is the address to submit transactions to the EVM base shard's game shard sequencer server.
	ShardSequencerAddr string

	// EVMBaseShardAddr is the address to query the EVM base shard's shard storage cosmos module.
	EVMBaseShardAddr string
}

type Option

type Option func(adapter *adapterImpl)

func WithCredentials

func WithCredentials(credPath string) Option

type QueryAdapter

type QueryAdapter interface {
	// QueryTransactions queries transactions stored on-chain. This is primarily used to rebuild state during world
	// recovery.
	QueryTransactions(
		context.Context,
		*shardtypes.QueryTransactionsRequest) (*shardtypes.QueryTransactionsResponse, error)
}

QueryAdapter provides the functionality to query transactions from the EVM base shard.

type WriteAdapter

type WriteAdapter interface {
	// Submit submits a transaction to the EVM base shard's game tx sequencer, where the tx data will be sequenced and
	// stored on chain.
	Submit(ctx context.Context, p *sign.Transaction, txID, epoch uint64) error
}

WriteAdapter provides the functionality to send transactions to the EVM base shard.