diff --git a/types/abci.pb.go b/types/abci.pb.go index e1cc43e..5bbf177 100644 --- a/types/abci.pb.go +++ b/types/abci.pb.go @@ -23,7 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package +// InjectedData represents a message containing data that has been injected. type InjectedData struct { + // PendingBlocks contains information about blocks that are pending. PendingBlocks PendingBlocks `protobuf:"bytes,1,opt,name=pending_blocks,json=pendingBlocks,proto3" json:"pending_blocks"` } @@ -67,6 +69,7 @@ func (m *InjectedData) GetPendingBlocks() PendingBlocks { return PendingBlocks{} } +// The PendingBlocks message includes a list of block heights that are currently pending. type PendingBlocks struct { BlockHeights []int64 `protobuf:"varint,1,rep,packed,name=block_heights,json=blockHeights,proto3" json:"block_heights,omitempty"` } @@ -111,6 +114,7 @@ func (m *PendingBlocks) GetBlockHeights() []int64 { return nil } +// UnprovenBlock represents a message containing data about a block that has not yet been proven. type UnprovenBlock struct { Height int64 `protobuf:"varint,1,opt,name=height,proto3" json:"height,omitempty"` Block []byte `protobuf:"bytes,2,opt,name=block,proto3" json:"block,omitempty"` diff --git a/types/genesis.pb.go b/types/genesis.pb.go index 50c0873..a91d26b 100644 --- a/types/genesis.pb.go +++ b/types/genesis.pb.go @@ -23,7 +23,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState defines the auth module's genesis state. +// GenesisState defines the avail da module's genesis state. type GenesisState struct { Validators []Validator `protobuf:"bytes,1,rep,name=validators,proto3" json:"validators"` // the height of the last block that was proven to be posted to Avail. diff --git a/types/query.pb.go b/types/query.pb.go index db109f8..62aaa03 100644 --- a/types/query.pb.go +++ b/types/query.pb.go @@ -30,7 +30,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// query request +// QuerySubmitBlobStatusRequest is the request type for the SubmitBlobStatus RPC method. type QuerySubmittedBlobStatusRequest struct { } @@ -67,11 +67,19 @@ func (m *QuerySubmittedBlobStatusRequest) XXX_DiscardUnknown() { var xxx_messageInfo_QuerySubmittedBlobStatusRequest proto.InternalMessageInfo -// query response +// QuerySubmitBlobStatusResponse is the response type for the SubmitBlobStatus RPC method. type QuerySubmittedBlobStatusResponse struct { - Range *Range `protobuf:"bytes,1,opt,name=range,proto3" json:"range,omitempty"` - Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"` + // range specifies the range of blocks that are being submitted. + // It contains information about the starting and ending block heights. + Range *Range `protobuf:"bytes,1,opt,name=range,proto3" json:"range,omitempty"` + // status indicates the current status of the blob submission. + // Possible values might include statuses like "pending", "in_voting", "success", or "failure". + Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"` + // proven_height represents the height up to which data has been successfully proven. + // This height indicates the extent of posted data to avail light client. ProvenHeight uint64 `protobuf:"varint,3,opt,name=proven_height,json=provenHeight,proto3" json:"proven_height,omitempty"` + // voting_ends_at denotes the block height at which the last voting on the blob ended. + // This provides information on when the last voting period for the blob concluded. VotingEndsAt uint64 `protobuf:"varint,4,opt,name=voting_ends_at,json=votingEndsAt,proto3" json:"voting_ends_at,omitempty"` } @@ -185,7 +193,7 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type QueryClient interface { - // submit Blob Status + // SubmitBlobStatus queries the current status of blob submissions. SubmittedBlobStatus(ctx context.Context, in *QuerySubmittedBlobStatusRequest, opts ...grpc.CallOption) (*QuerySubmittedBlobStatusResponse, error) } @@ -208,7 +216,7 @@ func (c *queryClient) SubmittedBlobStatus(ctx context.Context, in *QuerySubmitte // QueryServer is the server API for Query service. type QueryServer interface { - // submit Blob Status + // SubmitBlobStatus queries the current status of blob submissions. SubmittedBlobStatus(context.Context, *QuerySubmittedBlobStatusRequest) (*QuerySubmittedBlobStatusResponse, error) } diff --git a/types/tx.pb.go b/types/tx.pb.go index 4f01415..92419f8 100644 --- a/types/tx.pb.go +++ b/types/tx.pb.go @@ -29,14 +29,18 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// status of submitblob +// BlobStatus defines the statuses for a blob submission type BlobStatus int32 const ( + // Indicates that the blob status is unspecified or not set. BLOB_STATUS_UNSPECIFIED BlobStatus = 0 - BLOB_STATUS_FAILURE BlobStatus = 1 - BLOB_STATUS_SUCCESS BlobStatus = 2 - BLOB_STATUS_PENDING BlobStatus = 3 + // Indicates that the blob submission failed. + BLOB_STATUS_FAILURE BlobStatus = 1 + // Indicates that the blob submission was successful. + BLOB_STATUS_SUCCESS BlobStatus = 2 + // Indicates that the blob submission is still pending and has not yet been processed. + BLOB_STATUS_PENDING BlobStatus = 3 ) var BlobStatus_name = map[int32]string{ @@ -61,10 +65,12 @@ func (BlobStatus) EnumDescriptor() ([]byte, []int) { return fileDescriptor_7f88203cb33986bc, []int{0} } -// blocks range from to to +// Range defines the range of blocks for which the blob is being submitted. type Range struct { + // The starting block height in the range. Indicates the beginning of the block range. From uint64 `protobuf:"varint,1,opt,name=from,proto3" json:"from,omitempty"` - To uint64 `protobuf:"varint,2,opt,name=to,proto3" json:"to,omitempty"` + // The ending block height in the range. Indicates the end of the block range. + To uint64 `protobuf:"varint,2,opt,name=to,proto3" json:"to,omitempty"` } func (m *Range) Reset() { *m = Range{} } @@ -114,12 +120,16 @@ func (m *Range) GetTo() uint64 { return 0 } -// message update blob state response +// MsgUpdateBlobStatusRequest define a message to update the status of a previously submitted blob. type MsgUpdateBlobStatusRequest struct { + // Address of the validator updating the blob status. ValidatorAddress string `protobuf:"bytes,1,opt,name=validator_address,json=validatorAddress,proto3" json:"validator_address,omitempty"` - BlocksRange *Range `protobuf:"bytes,2,opt,name=blocks_range,json=blocksRange,proto3" json:"blocks_range,omitempty"` - AvailHeight uint64 `protobuf:"varint,3,opt,name=avail_height,json=availHeight,proto3" json:"avail_height,omitempty"` - IsSuccess bool `protobuf:"varint,4,opt,name=is_success,json=isSuccess,proto3" json:"is_success,omitempty"` + // range of blocks for which the blob status is being updated. + BlocksRange *Range `protobuf:"bytes,2,opt,name=blocks_range,json=blocksRange,proto3" json:"blocks_range,omitempty"` + // The height at which the blob is stored in the Avail system. This indicates where the blob data is available. + AvailHeight uint64 `protobuf:"varint,3,opt,name=avail_height,json=availHeight,proto3" json:"avail_height,omitempty"` + // The status of the blob submission. + IsSuccess bool `protobuf:"varint,4,opt,name=is_success,json=isSuccess,proto3" json:"is_success,omitempty"` } func (m *MsgUpdateBlobStatusRequest) Reset() { *m = MsgUpdateBlobStatusRequest{} } @@ -183,7 +193,7 @@ func (m *MsgUpdateBlobStatusRequest) GetIsSuccess() bool { return false } -// message update blob state response +// MsgUpdateBlobStatusResponse is the response type for the Msg/UpdateBlobStatus RPC method. type MsgUpdateBlobStatusResponse struct { } @@ -275,7 +285,7 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type MsgClient interface { - // UpdateBlobStatus + // UpdateBlobStatus updates the status of a blob submission. UpdateBlobStatus(ctx context.Context, in *MsgUpdateBlobStatusRequest, opts ...grpc.CallOption) (*MsgUpdateBlobStatusResponse, error) } @@ -298,7 +308,7 @@ func (c *msgClient) UpdateBlobStatus(ctx context.Context, in *MsgUpdateBlobStatu // MsgServer is the server API for Msg service. type MsgServer interface { - // UpdateBlobStatus + // UpdateBlobStatus updates the status of a blob submission. UpdateBlobStatus(context.Context, *MsgUpdateBlobStatusRequest) (*MsgUpdateBlobStatusResponse, error) } diff --git a/types/vote_extensions.pb.go b/types/vote_extensions.pb.go index 9a98901..6601e17 100644 --- a/types/vote_extensions.pb.go +++ b/types/vote_extensions.pb.go @@ -22,10 +22,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// AvailVoteExtension +// AvailVoteExtension defines the info which includes in vote extensions type AvailVoteExtension struct { - AvailHeight int64 `protobuf:"varint,1,opt,name=avail_height,json=availHeight,proto3" json:"avail_height,omitempty"` - Range *Range `protobuf:"bytes,2,opt,name=range,proto3" json:"range,omitempty"` + // avail_height specifies the height in the Avail chain at which the data has been posted. + AvailHeight int64 `protobuf:"varint,1,opt,name=avail_height,json=availHeight,proto3" json:"avail_height,omitempty"` + // range defines the range of blocks that have been posted to the Avail Data Availability (DA) layer. + Range *Range `protobuf:"bytes,2,opt,name=range,proto3" json:"range,omitempty"` } func (m *AvailVoteExtension) Reset() { *m = AvailVoteExtension{} }