da

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
	// Error is the error returned by the DA layer
	Error error
}

type BatchRetriever interface {
	// RetrieveBatches returns blocks at given data layer height from data availability layer.
	RetrieveBatches(daMetaData *DASubmitMetaData) ResultRetrieveBatch
	// CheckBatchAvailability checks the availability of the blob received getting proofs and validating them
	CheckBatchAvailability(daMetaData *DASubmitMetaData) ResultCheckBatch
}

type Blob = []byte

type Client string

type Commitment = []byte

type DACheckMetaData struct {
	// Height is the height of the block in the da layer
	Height uint64
	// Client is the client to use to fetch data from the da layer
	Client Client
	// Submission index in the Hub
	SLIndex uint64
	// Namespace ID
	Namespace []byte
	// Share commitment, for each blob, used to obtain blobs and proofs
	Commitment Commitment
	// Initial position for each blob in the NMT
	Index int
	// Number of shares of each blob
	Length int
	// Proofs necessary to validate blob inclusion in the specific height
	Proofs []*blob.Proof
	// NMT roots for each NMT Proof
	NMTRoots []byte
	// Proofs necessary to validate blob inclusion in the specific height
	RowProofs []*merkle.Proof
	// any NMT root for the specific height, necessary for non-inclusion proof
	Root []byte
}

type DASubmitMetaData struct {
	// Height is the height of the block in the da layer
	Height uint64
	// Namespace ID
	Namespace []byte
	// Client is the client to use to fetch data from the da layer
	Client Client
	// Share commitment, for each blob, used to obtain blobs and proofs
	Commitment Commitment
	// Initial position for each blob in the NMT
	Index int
	// Number of shares of each blob
	Length int
	// any NMT root for the specific height, necessary for non-inclusion proof
	Root []byte
}

type DataAvailabilityLayerClient interface {
	// Init is called once to allow DA client to read configuration and initialize resources.
	Init(config []byte, pubsubServer *pubsub.Server, kvStore store.KVStore, logger types.Logger, options ...Option) 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

	// SubmitBatch submits the passed in block to the DA layer.
	// This should create a transaction which (potentially)
	// triggers a state transition in the DA layer.
	SubmitBatch(batch *types.Batch) ResultSubmitBatch

	GetClientType() Client

	// CheckBatchAvailability checks the availability of the blob submitted getting proofs and validating them
	CheckBatchAvailability(daMetaData *DASubmitMetaData) ResultCheckBatch
}

type EventDataHealth struct {
	// Error is the error that was encountered in case of a health check failure, nil implies healthy
	Error error
}

type Option func(DataAvailabilityLayerClient)

type ResultCheckBatch struct {
	BaseResult
	// DAHeight informs about a height on Data Availability Layer for given result.
	CheckMetaData *DACheckMetaData
}

type ResultRetrieveBatch struct {
	BaseResult
	// Block is the full block retrieved from Data Availability Layer.
	// If Code is not equal to StatusSuccess, it has to be nil.
	Batches []*types.Batch
	// DAHeight informs about a height on Data Availability Layer for given result.
	CheckMetaData *DACheckMetaData
}

type ResultSubmitBatch struct {
	BaseResult
	// DAHeight informs about a height on Data Availability Layer for given result.
	SubmitMetaData *DASubmitMetaData
}

type StatusCode uint64