Skip to content

Commit 61c48e0

Browse files
committed
Addressing comments
1 parent 02778d8 commit 61c48e0

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

tuxedo-core/src/constraint_checker.rs

+11-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ use parity_scale_codec::{Decode, Encode};
1111
use serde::{Deserialize, Serialize};
1212
use sp_runtime::transaction_validity::TransactionPriority;
1313

14-
/// A single constraint checker that a transaction can choose to call. Checks whether the input
14+
15+
/// A simplified constraint checker that a transaction can choose to call. Checks whether the input
1516
/// and output data from a transaction meets the codified constraints.
1617
///
1718
/// Additional transient information may be passed to the constraint checker by including it in the fields
@@ -29,6 +30,15 @@ pub trait SimpleConstraintChecker: Debug + Encode + Decode + Clone {
2930
) -> Result<TransactionPriority, Self::Error>;
3031
}
3132

33+
/// A single constraint checker that a transaction can choose to call. Checks whether the input
34+
/// and output data from a transaction meets the codified constraints.
35+
///
36+
/// This full ConstraintChecker should only be used if there is more that a piece wants to do such
37+
/// as check the verifier information in some unique way.
38+
///
39+
/// Additional transient information may be passed to the constraint checker by including it in the fields
40+
/// of the constraint checker struct itself. Information passed in this way does not come from state, nor
41+
/// is it stored in state.
3242
pub trait ConstraintChecker: Debug + Encode + Decode + Clone {
3343
/// the error type that this constraint checker may return
3444
type Error: Debug;

tuxedo-core/src/utxo_set.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
//! TODO explanation this type
1+
//! For now this is a higher level description of the default UTXO set features which Tuxedo
2+
//! chooses to use. Future UTXO sets could take a different form especially
3+
//! if being used for Zero-Knowledge. In the future it may likely be abstracted into a trait
4+
//! to support various UTXO set types.
5+
//!
26
37
use crate::{
48
types::{Output, OutputRef},

0 commit comments

Comments
 (0)