From 056df6caddb696d732d6513dc87c5dba529398d8 Mon Sep 17 00:00:00 2001 From: Rootul P Date: Tue, 18 Jun 2024 11:43:48 -0600 Subject: [PATCH] chore: improve request prepare proposal comments (#1393) Closes https://github.com/celestiaorg/celestia-core/issues/1390 --- abci/types/types.pb.go | 8 ++++---- proto/tendermint/abci/types.proto | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/abci/types/types.pb.go b/abci/types/types.pb.go index 1aac7257a8..c4af564c5e 100644 --- a/abci/types/types.pb.go +++ b/abci/types/types.pb.go @@ -1270,11 +1270,11 @@ func (m *RequestApplySnapshotChunk) GetSender() string { } type RequestPrepareProposal struct { - // block_data is an array of transactions that will be included in a block, - // sent to the app for possible modifications. - // applications can not exceed the size of the data passed to it. + // BlockData is a slice of candidate transactions that may be included in a + // block. BlockData is sent to the application so that the application can + // filter and re-arrange the slice of candidate transactions. BlockData *types1.Data `protobuf:"bytes,1,opt,name=block_data,json=blockData,proto3" json:"block_data,omitempty"` - // If an application decides to populate block_data with extra information, they can not exceed this value. + // BlockDataSize is the maximum size (in bytes) that BlockData should be. BlockDataSize int64 `protobuf:"varint,2,opt,name=block_data_size,json=blockDataSize,proto3" json:"block_data_size,omitempty"` // chain_id is a unique identifier for the blockchain network this proposal // belongs to (e.g. mocha-1). diff --git a/proto/tendermint/abci/types.proto b/proto/tendermint/abci/types.proto index 12fd717e8d..deb439745d 100644 --- a/proto/tendermint/abci/types.proto +++ b/proto/tendermint/abci/types.proto @@ -127,11 +127,11 @@ message RequestApplySnapshotChunk { } message RequestPrepareProposal { - // block_data is an array of transactions that will be included in a block, - // sent to the app for possible modifications. - // applications can not exceed the size of the data passed to it. + // BlockData is a slice of candidate transactions that may be included in a + // block. BlockData is sent to the application so that the application can + // filter and re-arrange the slice of candidate transactions. tendermint.types.Data block_data = 1; - // If an application decides to populate block_data with extra information, they can not exceed this value. + // BlockDataSize is the maximum size (in bytes) that BlockData should be. int64 block_data_size = 2; // chain_id is a unique identifier for the blockchain network this proposal // belongs to (e.g. mocha-1).