Merge pull request #571 from input-output-hk/transaction-validity

add transaction time validity

Author: Mikhail Zabaluev

chain-impl-mockchain/benches/tally.rs

@@ -133,6 +133,7 @@ fn tally_benchmark(
                 );
 
                 res.push(controller.fragment_factory().vote_cast(
+                    BlockDate::first(),
                     private_voter,
                     VoteCast::new(vote_plan.to_id(), proposal_idx as u8, payload),
                 ));
@@ -171,9 +172,11 @@ fn tally_benchmark(
     let mut alice = controller.wallet(ALICE).unwrap();
 
     let encrypted_tally = EncryptedVoteTally::new(vote_plan.to_id());
-    let fragment = controller
-        .fragment_factory()
-        .vote_encrypted_tally(&alice, encrypted_tally);
+    let fragment = controller.fragment_factory().vote_encrypted_tally(
+        BlockDate::first(),
+        &alice,
+        encrypted_tally,
+    );
 
     let parameters = ledger.parameters.clone();
     let date = ledger.date();
@@ -264,9 +267,10 @@ fn tally_benchmark(
 
     let decrypted_tally =
         VoteTally::new_private(vote_plan.to_id(), DecryptedPrivateTally::new(shares));
-    let fragment = controller
-        .fragment_factory()
-        .vote_tally(&alice, decrypted_tally);
+    let fragment =
+        controller
+            .fragment_factory()
+            .vote_tally(BlockDate::first(), &alice, decrypted_tally);
 
     c.bench_function(&format!("vote_tally_{}", benchmark_name), |b| {
         b.iter(|| {

chain-impl-mockchain/doc/format.abnf

@@ -134,7 +134,8 @@ UPDATE-VOTE       = TODO
 ; note: IOW stand for Inputs-Outputs-Witnesses
 ; ####################
 
-IOW               = SIZE-ELEMENT-8BIT ; number of inputs
+IOW               = BLOCK-DATE        ; end validity of this IOW
+                    SIZE-ELEMENT-8BIT ; number of inputs
                     SIZE-ELEMENT-8BIT ; number of outputs
                     *INPUT            ; as many as indicated in the number of inputs
                     *OUTPUT           ; sa many as indicated in the number of outputs

chain-impl-mockchain/src/certificate/pool.rs

@@ -456,6 +456,7 @@ mod tests {
     use super::{PoolOwnersSigned, PoolPermissions};
     use crate::{
         chaintypes::HeaderId,
+        date::BlockDate,
         key::EitherEd25519SecretKey,
         testing::{
             builders::{make_witness, StakePoolBuilder},
@@ -739,6 +740,7 @@ mod tests {
 
         let builder = TxBuilder::new()
             .set_payload(&NoExtra)
+            .set_expiry_date(BlockDate::first().next_epoch())
             .set_ios(&pool_owner_with_sign.inputs(), &[]);
         let auth_data_hash = builder.get_auth_data_for_witness().hash();
         let builder = builder

chain-impl-mockchain/src/config.rs

@@ -82,6 +82,7 @@ pub enum ConfigParam {
     AddCommitteeId(CommitteeId),
     RemoveCommitteeId(CommitteeId),
     PerVoteCertificateFees(PerVoteCertificateFee),
+    TransactionMaxExpiryEpochs(u8),
 }
 
 #[derive(Clone, Debug, Eq, PartialEq)]
@@ -153,6 +154,8 @@ pub enum Tag {
     RemoveCommitteeId = 27,
     #[strum(to_string = "per-vote-certificate-fees")]
     PerVoteCertificateFees = 28,
+    #[strum(to_string = "transaction-maximum-expiry-epochs")]
+    TransactionMaxExpiryEpochs = 29,
 }
 
 impl Tag {
@@ -183,6 +186,7 @@ impl Tag {
             26 => Some(Tag::AddCommitteeId),
             27 => Some(Tag::RemoveCommitteeId),
             28 => Some(Tag::PerVoteCertificateFees),
+            29 => Some(Tag::TransactionMaxExpiryEpochs),
             _ => None,
         }
     }
@@ -218,6 +222,7 @@ impl<'a> From<&'a ConfigParam> for Tag {
             ConfigParam::AddCommitteeId(..) => Tag::AddCommitteeId,
             ConfigParam::RemoveCommitteeId(..) => Tag::RemoveCommitteeId,
             ConfigParam::PerVoteCertificateFees(..) => Tag::PerVoteCertificateFees,
+            ConfigParam::TransactionMaxExpiryEpochs(..) => Tag::TransactionMaxExpiryEpochs,
         }
     }
 }
@@ -298,6 +303,9 @@ impl Readable for ConfigParam {
             Tag::PerVoteCertificateFees => {
                 ConfigParamVariant::from_payload(bytes).map(ConfigParam::PerVoteCertificateFees)
             }
+            Tag::TransactionMaxExpiryEpochs => {
+                ConfigParamVariant::from_payload(bytes).map(ConfigParam::TransactionMaxExpiryEpochs)
+            }
         }
         .map_err(Into::into)
     }
@@ -334,6 +342,7 @@ impl property::Serialize for ConfigParam {
             ConfigParam::AddCommitteeId(data) => data.to_payload(),
             ConfigParam::RemoveCommitteeId(data) => data.to_payload(),
             ConfigParam::PerVoteCertificateFees(data) => data.to_payload(),
+            ConfigParam::TransactionMaxExpiryEpochs(data) => data.to_payload(),
         };
         let taglen = TagLen::new(tag, bytes.len()).ok_or_else(|| {
             io::Error::new(
@@ -858,7 +867,7 @@ mod test {
 
     impl Arbitrary for ConfigParam {
         fn arbitrary<G: Gen>(g: &mut G) -> Self {
-            match u8::arbitrary(g) % 29 {
+            match u8::arbitrary(g) % 30 {
                 0 => ConfigParam::Block0Date(Arbitrary::arbitrary(g)),
                 1 => ConfigParam::Discrimination(Arbitrary::arbitrary(g)),
                 2 => ConfigParam::ConsensusVersion(Arbitrary::arbitrary(g)),
@@ -888,6 +897,7 @@ mod test {
                 26 => ConfigParam::AddCommitteeId(Arbitrary::arbitrary(g)),
                 27 => ConfigParam::RemoveCommitteeId(Arbitrary::arbitrary(g)),
                 28 => ConfigParam::PerCertificateFees(Arbitrary::arbitrary(g)),
+                29 => ConfigParam::TransactionMaxExpiryEpochs(Arbitrary::arbitrary(g)),
                 _ => unreachable!(),
             }
         }

chain-impl-mockchain/src/ledger/check.rs

@@ -1,5 +1,7 @@
 use super::{Block0Error, Error};
 use crate::certificate;
+use crate::date::BlockDate;
+use crate::setting;
 use crate::transaction::*;
 use crate::value::Value;
 use chain_addr::Address;
@@ -142,6 +144,10 @@ pub(super) fn valid_pool_update_certificate(reg: &certificate::PoolUpdate) -> Le
 pub enum TxVerifyError {
     #[error("too many outputs, expected maximum of {expected}, but received {actual}")]
     TooManyOutputs { expected: u8, actual: u8 },
+    #[error("Transaction validity expired")]
+    TransactionExpired,
+    #[error("Transaction validity is too far in the future")]
+    TransactionValidForTooLong,
 }
 
 #[allow(clippy::absurd_extreme_comparisons)]
@@ -164,6 +170,27 @@ pub(super) fn valid_transaction_ios_number<P>(
     Ok(())
 }
 
+pub(super) fn valid_transaction_date<P>(
+    settings: &setting::Settings,
+    tx: &TransactionSlice<P>,
+    date: BlockDate,
+) -> Result<(), TxVerifyError> {
+    let valid_until = tx.valid_until();
+
+    // if current date epoch is less than until.epoch - setting, then
+    // the transaction has a validity range that is too big to be accepted
+    if_cond_fail_with!(
+        date.epoch
+            < valid_until
+                .epoch
+                .saturating_sub(settings.transaction_max_expiry_epochs.into()),
+        TxVerifyError::TransactionValidForTooLong
+    )?;
+    // if current date is passed the validity until, the transaction is expired
+    if_cond_fail_with!(date > valid_until, TxVerifyError::TransactionExpired)?;
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {