Skip to content

Commit

Permalink
feat(core): impl consensus encoding for bool (#4120)
Browse files Browse the repository at this point in the history
Description
---
Adds Consensus(Encoding|Decoding) for `bool`

Motivation and Context
---
Bool type encoding is required for future side chain structs.

How Has This Been Tested?
---
New unit tests
  • Loading branch information
sdbondi authored May 25, 2022
1 parent 491475a commit 682aa5d
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
1 change: 1 addition & 0 deletions base_layer/core/src/consensus/consensus_encoding.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

mod bool;
mod bytes;
mod crypto;
mod epoch_time;
Expand Down
79 changes: 79 additions & 0 deletions base_layer/core/src/consensus/consensus_encoding/bool.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
// Copyright 2022, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::io;

use crate::consensus::{ConsensusDecoding, ConsensusEncoding, ConsensusEncodingSized};

impl ConsensusEncoding for bool {
fn consensus_encode<W: io::Write>(&self, writer: &mut W) -> Result<(), io::Error> {
writer.write_all(&[*self as u8])?;
Ok(())
}
}

impl ConsensusEncodingSized for bool {
fn consensus_encode_exact_size(&self) -> usize {
1
}
}

impl ConsensusDecoding for bool {
fn consensus_decode<R: io::Read>(reader: &mut R) -> Result<Self, io::Error> {
let mut buf = [0u8; 1];
reader.read_exact(&mut buf)?;
match buf[0] {
0 => Ok(false),
1 => Ok(true),
b => Err(io::Error::new(
io::ErrorKind::InvalidInput,
format!("valid bool values are 0 or 1, got '{}'", b),
)),
}
}
}

#[cfg(test)]
mod test {
use rand::{rngs::OsRng, RngCore};

use super::*;
use crate::consensus::check_consensus_encoding_correctness;

#[test]
fn it_encodes_and_decodes_correctly() {
let subject = true;
check_consensus_encoding_correctness(subject).unwrap();

let subject = false;
check_consensus_encoding_correctness(subject).unwrap();
}

#[test]
fn it_fails_decoding_for_invalid_values() {
let mut buf = [0u8];
while buf[0] == 0 || buf[0] == 1 {
OsRng.fill_bytes(&mut buf);
}
bool::consensus_decode(&mut buf.as_slice()).unwrap_err();
}
}

0 comments on commit 682aa5d

Please sign in to comment.