Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseResult ¶
type BaseResult struct {
// Code is to determine if the action succeeded.
Code StatusCode
// Message may contain DA layer specific information (like DA block height/hash, detailed error message, etc)
Message string
// DAHeight informs about a height on Data Availability Layer for given result.
DAHeight uint64
}
BaseResult contains basic information returned by DA layer.
type BlockRetriever ¶
type BlockRetriever interface {
// RetrieveBlocks returns blocks at given data layer height from data availability layer.
RetrieveBlocks(ctx context.Context, dataLayerHeight uint64) ResultRetrieveBlocks
}
BlockRetriever is additional interface that can be implemented by Data Availability Layer Client that is able to retrieve block data from DA layer. This gives the ability to use it for block synchronization.
type DataAvailabilityLayerClient ¶
type DataAvailabilityLayerClient interface {
// Init is called once to allow DA client to read configuration and initialize resources.
Init(namespaceID types.NamespaceID, config []byte, kvStore ds.Datastore, logger log.Logger) error
// Start is called once, after Init. It's implementation should start operation of DataAvailabilityLayerClient.
Start() error
// Stop is called once, when DataAvailabilityLayerClient is no longer needed.
Stop() error
// SubmitBlock submits the passed in block to the DA layer.
// This should create a transaction which (potentially)
// triggers a state transition in the DA layer.
SubmitBlock(ctx context.Context, block *types.Block) ResultSubmitBlock
// CheckBlockAvailability queries DA layer to check data availability of block corresponding at given height.
CheckBlockAvailability(ctx context.Context, dataLayerHeight uint64) ResultCheckBlock
}
DataAvailabilityLayerClient defines generic interface for DA layer block submission. It also contains life-cycle methods.
type ResultCheckBlock ¶
type ResultCheckBlock struct {
BaseResult
// DataAvailable is the actual answer whether the block is available or not.
// It can be true if and only if Code is equal to StatusSuccess.
DataAvailable bool
}
ResultCheckBlock contains information about block availability, returned from DA layer client.
type ResultRetrieveBlocks ¶
type ResultRetrieveBlocks struct {
BaseResult
// Block is the full block retrieved from Data Availability Layer.
// If Code is not equal to StatusSuccess, it has to be nil.
Blocks []*types.Block
}
ResultRetrieveBlocks contains batch of blocks returned from DA layer client.
type ResultSubmitBlock ¶
type ResultSubmitBlock struct {
BaseResult
}
ResultSubmitBlock contains information returned from DA layer after block submission.
type StatusCode ¶
type StatusCode uint64
StatusCode is a type for DA layer return status. TODO: define an enum of different non-happy-path cases that might need to be handled by Rollkit independent of the underlying DA chain.
const ( StatusUnknown StatusCode = iota StatusSuccess StatusTimeout StatusError )
Data Availability return codes.
Source Files
Directories