Skip to content

Commit 52f287a

Browse files
committed
added field docs
1 parent e3994aa commit 52f287a

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

stackslib/src/net/api/blockreplay.rs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,30 +239,51 @@ impl RPCNakamotoBlockReplayRequestHandler {
239239

240240
#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
241241
pub struct RPCReplayedBlockTransaction {
242+
/// transaction id
242243
pub txid: Txid,
244+
/// index of transaction in the block
243245
pub tx_index: u32,
246+
/// body (headers + payload) of transaction
244247
pub data: Option<StacksTransaction>,
248+
/// hex representation of the transaction body
245249
pub hex: String,
250+
/// result of transaction execution (clarity value)
246251
pub result: Value,
252+
/// amount of burned stx
247253
pub stx_burned: u128,
254+
/// execution cost infos
248255
pub execution_cost: ExecutionCost,
256+
/// generated events
249257
pub events: Vec<serde_json::Value>,
250258
}
251259

252260
#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
253261
pub struct RPCReplayedBlock {
262+
/// block id (index_block_hash)
254263
pub block_id: StacksBlockId,
264+
/// block hash
255265
pub block_hash: BlockHeaderHash,
266+
/// height of the block
256267
pub block_height: u64,
268+
/// index_block_hash of the parent
257269
pub parent_block_id: StacksBlockId,
270+
/// consensus hash of the tenure containing the block
258271
pub consensus_hash: ConsensusHash,
272+
/// total fees for the transactions in the block
259273
pub fees: u128,
274+
/// merkle tree root hash of the included transactions
260275
pub tx_merkle_root: Sha512Trunc256Sum,
276+
/// state index of the MARF
261277
pub state_index_root: TrieHash,
278+
/// block timestamp
262279
pub timestamp: u64,
280+
/// signature of the miner
263281
pub miner_signature: MessageSignature,
282+
/// list of signers signatures
264283
pub signer_signature: Vec<MessageSignature>,
284+
/// the list of block transactions
265285
pub transactions: Vec<RPCReplayedBlockTransaction>,
286+
/// check if the computed merkle tree root hash matches the one from the original block
266287
pub valid_merkle_root: bool,
267288
}
268289

0 commit comments

Comments
 (0)