Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: block serialisation and addition of tests #47

Merged
merged 5 commits into from
Nov 5, 2024
Merged

refactor: block serialisation and addition of tests #47

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
faea29a
added: write_compact_size and test
ogabrielides Oct 31, 2024
e75dc6e
more work
ogabrielides Nov 1, 2024
6b76485
suggestions
ogabrielides Nov 1, 2024
fb58431
suggestions
ogabrielides Nov 1, 2024
603773d
safety check on write_fixed_bitset
ogabrielides Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions dash/src/blockdata/block.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,11 +476,11 @@ mod tests {
"010000004ddccd549d28f385ab457e98d1b11ce80bfea2c5ab93015ade4973e400000000bf4473e53794beae34e64fccc471dace6ae544180816f89591894e0f417a914cd74d6e49ffff001d323b3a7b0201000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0804ffff001d026e04ffffffff0100f2052a0100000043410446ef0102d1ec5240f0d061a4246c1bdef63fc3dbab7733052fbbf0ecd8f41fc26bf049ebb4f9527f374280259e7cfa99c48b0e3f39c51347a19a5819651503a5ac00000000010000000321f75f3139a013f50f315b23b0c9a2b6eac31e2bec98e5891c924664889942260000000049483045022100cb2c6b346a978ab8c61b18b5e9397755cbd17d6eb2fe0083ef32e067fa6c785a02206ce44e613f31d9a6b0517e46f3db1576e9812cc98d159bfdaf759a5014081b5c01ffffffff79cda0945903627c3da1f85fc95d0b8ee3e76ae0cfdc9a65d09744b1f8fc85430000000049483045022047957cdd957cfd0becd642f6b84d82f49b6cb4c51a91f49246908af7c3cfdf4a022100e96b46621f1bffcf5ea5982f88cef651e9354f5791602369bf5a82a6cd61a62501fffffffffe09f5fe3ffbf5ee97a54eb5e5069e9da6b4856ee86fc52938c2f979b0f38e82000000004847304402204165be9a4cbab8049e1af9723b96199bfd3e85f44c6b4c0177e3962686b26073022028f638da23fc003760861ad481ead4099312c60030d4cb57820ce4d33812a5ce01ffffffff01009d966b01000000434104ea1feff861b51fe3f5f8a3b12d0f4712db80e919548a80839fc47c6a21e66d957e9c5d8cd108c7a2d2324bad71f9904ac0ae7336507d785b17a2c115e427a32fac"
);

let prevhash = hex!("85691f6a060e65346c281ed25b99dbd18c139053562ccd001d00000000000000");
let merkle = hex!("377b6aa24658b7a0ae7b73f0673d047a291de5cbc06907038b288b2ebf491c2c");
let prevhash = vec![14, 198, 132, 64, 91, 88, 179, 160, 240, 20, 76, 154, 146, 199, 212, 41, 101, 135, 186, 111, 199, 16, 65, 255, 242, 19, 10, 3, 138, 0, 0, 0];
let merkle = vec![120, 226, 89, 180, 144, 207, 200, 168, 229, 14, 25, 51, 175, 222, 63, 119, 122, 71, 189, 172, 139, 97, 213, 4, 165, 27, 104, 222, 222, 42, 193, 129];
ogabrielides marked this conversation as resolved.
Show resolved Hide resolved

let work_bytes: [u8; 32] =
hex!("000000000000000000000000000000000000000000000000050ec30af44bf25e")
hex!("0000000000000000000000000000000000000000000000000000000000f7b6f1")
.try_into()
.unwrap();
let work = Work::from_be_bytes(work_bytes);
Expand All @@ -493,16 +493,16 @@ mod tests {
assert_eq!(serialize(&real_decode.header.prev_blockhash), prevhash);
assert_eq!(real_decode.header.merkle_root, real_decode.compute_merkle_root().unwrap());
assert_eq!(serialize(&real_decode.header.merkle_root), merkle);
assert_eq!(real_decode.header.time, 1685447065);
assert_eq!(real_decode.header.bits, CompactTarget::from_consensus(422747587));
assert_eq!(real_decode.header.nonce, 2456102546);
assert_eq!(real_decode.header.time, 1730283725);
assert_eq!(real_decode.header.bits, CompactTarget::from_consensus(503384208));
assert_eq!(real_decode.header.nonce, 394542);
assert_eq!(real_decode.header.work(), work);
assert_eq!(
real_decode.header.validate_pow(real_decode.header.target()).unwrap(),
real_decode.block_hash()
);
assert_eq!(real_decode.header.difficulty(), 84852220);
assert_eq!(real_decode.header.difficulty_float(), 84852220.19239795);
assert_eq!(real_decode.header.difficulty(), 0);
assert_eq!(real_decode.header.difficulty_float(), 0.0037797675075301206);
// [test] TODO: check the transaction data

assert_eq!(real_decode.size(), some_block.len());
Expand Down
23 changes: 10 additions & 13 deletions dash/src/blockdata/transaction/special_transaction/coinbase.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ use crate::hash_types::{MerkleRootMasternodeList, MerkleRootQuorums};
use crate::io::{Error, ErrorKind};
use crate::{VarInt, io};
use crate::bls_sig_utils::BLSSignature;
use crate::consensus::encode::{compact_size_len, read_compact_size, write_compact_size};

/// A Coinbase payload. This is contained as the payload of a coinbase special transaction.
/// The Coinbase payload is described in DIP4.
Expand All @@ -43,15 +44,16 @@ pub struct CoinbasePayload {
impl CoinbasePayload {
/// The size of the payload in bytes.
/// version(2) + height(4) + merkle_root_masternode_list(32) + merkle_root_quorums(32)
/// in addition to the above, if version >= 3: asset_locked_amount(8) + best_cl_height(4) +
/// best_cl_signature(VarInt(len) + len)
/// in addition to the above, if version >= 3: asset_locked_amount(8) + best_cl_height(compact_size) +
/// best_cl_signature(96)
pub fn size(&self) -> usize {
let mut size: usize = 2 + 4 + 32 + 32;
if self.version >= 3 {
size += 4 + 8;
if let Some(sig) = &self.best_cl_signature {
size += VarInt(sig.len() as u64).len() + sig.len()
size += 96;
if let Some(best_cl_height) = self.best_cl_height {
size += compact_size_len(best_cl_height);
}
size += 8;
}
size
}
Expand All @@ -66,7 +68,7 @@ impl Encodable for CoinbasePayload {
len += self.merkle_root_quorums.consensus_encode(w)?;
if self.version >= 3 {
if let Some(best_cl_height) = self.best_cl_height {
len += best_cl_height.consensus_encode(w)?;
len += write_compact_size(w, best_cl_height)?;
} else {
return Err(Error::new(ErrorKind::InvalidInput, "best_cl_height is not set"));
}
Expand Down Expand Up @@ -94,12 +96,7 @@ impl Decodable for CoinbasePayload {
let merkle_root_masternode_list = MerkleRootMasternodeList::consensus_decode(r)?;
let merkle_root_quorums = MerkleRootQuorums::consensus_decode(r)?;
let best_cl_height = if version >= 3 {
let value = u8::consensus_decode(r)?;
match value {
253 => Some(u16::consensus_decode(r)? as u32),
254 => Some(u32::consensus_decode(r)?),
_ => Some(value as u32)
}
Some(read_compact_size(r)?)
} else { None };
let best_cl_signature =
if version >= 3 { Some(BLSSignature::consensus_decode(r)?) } else { None };
Expand All @@ -126,7 +123,7 @@ mod tests {

#[test]
fn size() {
let test_cases: &[(usize, u16)] = &[(70, 2), (179, 3)];
let test_cases: &[(usize, u16)] = &[(70, 2), (177, 3)];
for (want, version) in test_cases.iter() {
let payload = CoinbasePayload {
height: 1000,
Expand Down
135 changes: 57 additions & 78 deletions dash/src/blockdata/transaction/special_transaction/quorum_commitment.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ use crate::consensus::{Decodable, Encodable, encode};
use crate::hash_types::{QuorumHash, QuorumVVecHash};
use crate::prelude::*;
use crate::{VarInt, io};
use crate::consensus::encode::{compact_size_len, fixed_bitset_len, read_compact_size, read_fixed_bitset, write_compact_size, write_fixed_bitset};

/// A Quorum Finalization Commitment. It is described in the finalization section of DIP6:
/// [dip-0006.md#6-finalization-phase](https://github.com/dashpay/dips/blob/master/dip-0006.md#6-finalization-phase)
Expand All @@ -35,8 +36,8 @@ pub struct QuorumFinalizationCommitment {
pub llmq_type: u8,
pub quorum_hash: QuorumHash,
pub quorum_index: Option<i16>,
pub signers: Vec<u8>,
pub valid_members: Vec<u8>,
pub signers: Vec<bool>,
pub valid_members: Vec<bool>,
Comment on lines +39 to +40
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Potential issues with Vec<bool> usage

Using Vec<bool> can lead to unexpected behaviors due to its internal bit-packing optimization. Consider using the bitvec crate's BitVec type for more robust and explicit bitset handling, or ensure that all operations account for the specifics of Vec<bool>.

pub quorum_public_key: BLSPublicKey,
pub quorum_vvec_hash: QuorumVVecHash,
pub quorum_sig: BLSSignature,
Expand All @@ -47,8 +48,10 @@ impl QuorumFinalizationCommitment {
/// The size of the payload in bytes.
pub fn size(&self) -> usize {
let mut size = 2 + 1 + 32 + 48 + 32 + 96 + 96;
size += VarInt(self.signers.len() as u64).len() + self.signers.len();
size += VarInt(self.valid_members.len() as u64).len() + self.valid_members.len();
size += compact_size_len(self.signers.len() as u32);
size += fixed_bitset_len(self.signers.as_slice(), self.signers.len());
size += compact_size_len(self.valid_members.len() as u32);
size += fixed_bitset_len(self.valid_members.as_slice(), self.signers.len());
ogabrielides marked this conversation as resolved.
Show resolved Hide resolved
if self.version == 2 || self.version == 4 {
size += 2;
}
Expand All @@ -67,8 +70,10 @@ impl Encodable for QuorumFinalizationCommitment {
len += q_index.consensus_encode(w)?;
}
}
len += self.signers.consensus_encode(w)?;
len += self.valid_members.consensus_encode(w)?;
len += write_compact_size(w, self.signers.len() as u32)?;
len += write_fixed_bitset(w, self.signers.as_slice(), self.signers.iter().len())?;
len += write_compact_size(w, self.valid_members.len() as u32)?;
len += write_fixed_bitset(w, self.valid_members.as_slice(), self.valid_members.iter().len())?;
len += self.quorum_public_key.consensus_encode(w)?;
len += self.quorum_vvec_hash.consensus_encode(w)?;
len += self.quorum_sig.consensus_encode(w)?;
Expand Down Expand Up @@ -96,8 +101,8 @@ impl Decodable for QuorumFinalizationCommitment {
llmq_type,
quorum_hash,
quorum_index,
signers: signers.iter().map(|&b| b as u8).collect(),
valid_members: valid_members.iter().map(|&b| b as u8).collect(),
signers,
valid_members,
quorum_public_key,
quorum_vvec_hash,
quorum_sig,
Expand Down Expand Up @@ -144,86 +149,60 @@ impl Decodable for QuorumCommitmentPayload {
}
}

fn read_compact_size<R: Read + ?Sized>(r: &mut R) -> io::Result<u64> {
let mut marker = [0u8; 1];
r.read_exact(&mut marker)?;
match marker[0] {
0xFD => {
// Read the next 2 bytes as a little-endian u16
let mut buf = [0u8; 2];
r.read_exact(&mut buf)?;
Ok(u16::from_le_bytes(buf) as u64)
}
0xFE => {
// Read the next 4 bytes as a little-endian u32
let mut buf = [0u8; 4];
r.read_exact(&mut buf)?;
Ok(u32::from_le_bytes(buf) as u64)
}
0xFF => {
// Read the next 8 bytes as a little-endian u64
let mut buf = [0u8; 8];
r.read_exact(&mut buf)?;
Ok(u64::from_le_bytes(buf))
}
value => {
// For values less than 253, the value is stored directly in the marker byte
Ok(value as u64)
}
}
}

fn read_fixed_bitset<R: Read + ?Sized>(r: &mut R, size: usize) -> std::io::Result<Vec<bool>> {
// Calculate the number of bytes needed
let num_bytes = (size + 7) / 8;
let mut bytes = vec![0u8; num_bytes];

// Read bytes from the reader
r.read_exact(&mut bytes)?;

// Unpack bits into a vector of bools
let mut bits = Vec::with_capacity(size);
for p in 0..size {
let byte = bytes[p / 8];
let bit = (byte >> (p % 8)) & 1;
bits.push(bit != 0);
}

Ok(bits)
}

#[cfg(test)]
mod tests {
use hashes::Hash;

use crate::bls_sig_utils::{BLSPublicKey, BLSSignature};
use crate::consensus::Encodable;
use crate::hash_types::{QuorumHash, QuorumVVecHash};
use crate::transaction::special_transaction::quorum_commitment::{
QuorumCommitmentPayload, QuorumFinalizationCommitment,
};
use crate::transaction::special_transaction::quorum_commitment::{QuorumCommitmentPayload, QuorumFinalizationCommitment};

#[test]
fn size() {
let want = 325;
let payload = QuorumCommitmentPayload {
version: 0,
height: 0,
finalization_commitment: QuorumFinalizationCommitment {
{
let want = 317;
let payload = QuorumCommitmentPayload {
version: 0,
height: 0,
finalization_commitment: QuorumFinalizationCommitment {
version: 1,
llmq_type: 0,
quorum_hash: QuorumHash::all_zeros(),
quorum_index: None,
signers: vec![true, false, true, true, false],
valid_members: vec![false, true, false, true],
quorum_public_key: BLSPublicKey::from([0; 48]),
quorum_vvec_hash: QuorumVVecHash::all_zeros(),
quorum_sig: BLSSignature::from([0; 96]),
sig: BLSSignature::from([0; 96]),
},
};
let actual = payload.consensus_encode(&mut Vec::new()).unwrap();
assert_eq!(payload.size(), want);
assert_eq!(actual, want);
}
{
let want = 319;
let payload = QuorumCommitmentPayload {
version: 0,
llmq_type: 0,
quorum_hash: QuorumHash::all_zeros(),
quorum_index: None,
signers: vec![1, 2, 3, 4, 5],
valid_members: vec![6, 7, 8, 9, 0],
quorum_public_key: BLSPublicKey::from([0; 48]),
quorum_vvec_hash: QuorumVVecHash::all_zeros(),
quorum_sig: BLSSignature::from([0; 96]),
sig: BLSSignature::from([0; 96]),
},
};
let actual = payload.consensus_encode(&mut Vec::new()).unwrap();
assert_eq!(payload.size(), want);
assert_eq!(actual, want);
height: 0,
finalization_commitment: QuorumFinalizationCommitment {
version: 2,
llmq_type: 0,
quorum_hash: QuorumHash::all_zeros(),
quorum_index: Some(1),
signers: vec![true, false, true, true, false, true, false],
valid_members: vec![false, true, false, true, false, true],
quorum_public_key: BLSPublicKey::from([0; 48]),
quorum_vvec_hash: QuorumVVecHash::all_zeros(),
quorum_sig: BLSSignature::from([0; 96]),
sig: BLSSignature::from([0; 96]),
},
};
let actual = payload.consensus_encode(&mut Vec::new()).unwrap();
assert_eq!(payload.size(), want);
assert_eq!(actual, want);
}
}
}
Loading
Loading