Skip to content

Commit fa8f6b0

Browse files
committed
Misc doc comments
1 parent 170a4f2 commit fa8f6b0

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

crates/enclave/core/src/event.rs

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ use tendermint_rpc::event::Event as TmEvent;
44

55
use crate::{chain_client::ChainClient, handler::Handler};
66

7+
/// An event wrapper used to parse the contract address for internal handling.
78
#[derive(Clone, Debug)]
89
pub struct QuartzEvent<E> {
910
pub contract: AccountId,

crates/enclave/core/src/grpc.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
//! gRPC service implementation for core enclave requests (handshake)
12
use cosmrs::AccountId;
23
use quartz_proto::quartz::{
34
core_server::Core, InstantiateRequest, InstantiateResponse, SessionCreateRequest,

crates/enclave/core/src/proof_of_publication.rs

+7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ use tendermint_light_client::{
1414
types::{LightBlock, TrustThreshold},
1515
};
1616

17+
/// A proof of publication for a given message/request.
18+
///
19+
/// This structure provides evidence that a message was published on-chain by combining:
20+
///
21+
/// - A **light client proof**
22+
/// - A **Merkle proof**
23+
/// - The original **message** that is claimed to have been published.
1724
#[derive(Clone, Debug, Serialize, Deserialize)]
1825
pub struct ProofOfPublication<M> {
1926
light_client_proof: Vec<LightBlock>,

crates/enclave/core/src/types.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
//! Core types used in the handshake
12
use std::{
23
fmt::{Display, Formatter},
34
marker::PhantomData,

0 commit comments

Comments
 (0)