Struct DynamicRecord 

pub struct DynamicRecord<N: Network> { /* private fields */ }

A dynamic record is a fixed-size representation of a record. Like static Records, a dynamic record contains an owner, nonce, and a version. However, instead of storing the full data, it only stores the Merkle root of the data. This ensures that all dynamic records have a constant size, regardless of the amount of data they contain.

Suppose we have the following record with two data entries:

record foo:
    owner as address.private;
    microcredits as u64.private;
    memo as [u8; 32u32].public;

The leaves of its Merkle tree are computed as follows:

L_0 := HashPSD8(ToField(name_0) || ToFields(entry_0))
L_1 := HashPSD8(ToField(name_1) || ToFields(entry_1))

where name_i is the field encoding of the entry identifier (e.g. "microcredits" → Field), and ToFields packs the entry’s mode tag bits (2 bits), plaintext bits, and a terminus 1 bit into field elements. The terminus bit ensures collision-resistance across entries of different lengths.

The tree has depth RECORD_DATA_TREE_DEPTH = 5 and is constructed with path hasher HashPSD2 and the padding scheme outlined in snarkVM’s MerkleTree.

Implementations

impl<N: Network> DynamicRecord<N>

pub fn find<A: Into<Access<N>> + Copy + Debug>( &self, path: &[A], ) -> Result<Value<N>>

Returns the entry from the given path.

impl<N: Network> DynamicRecord<N>

pub fn size_in_bits() -> Result<usize>

Returns the number of bits in a dynamic record.

pub fn size_in_bits_raw() -> Result<usize>

Returns the number of raw bits in a dynamic record.

impl<N: Network> DynamicRecord<N>

pub const fn new_unchecked( owner: Address<N>, root: Field<N>, nonce: Group<N>, version: U8<N>, data: Option<RecordData<N>>, ) -> Self

Initializes a dynamic record without checking that the root, tree, and data are consistent.

impl<N: Network> DynamicRecord<N>

pub const fn owner(&self) -> &Address<N>

Returns the owner of the record.

pub const fn root(&self) -> &Field<N>

Returns the Merkle root of the record data.

pub const fn nonce(&self) -> &Group<N>

Returns the nonce of the record.

pub const fn version(&self) -> &U8<N>

Returns the version of the record.

pub const fn data(&self) -> &Option<RecordData<N>>

Returns the optional record data.

pub fn is_hiding(&self) -> bool

Returns true if the dynamic record is a hiding variant.

impl<N: Network> DynamicRecord<N>

pub fn from_record(record: &Record<N, Plaintext<N>>) -> Result<Self>

Creates a dynamic record from a static record.

pub fn to_record( &self, owner_is_private: bool, ) -> Result<Record<N, Plaintext<N>>>

Creates a static record from this dynamic record.

pub fn merkleize_data( data: &IndexMap<Identifier<N>, Entry<N, Plaintext<N>>>, ) -> Result<RecordDataTree<N>>

Computes the Merkle tree containing the given (ordered) entries as leaves. More details on the structure of the tree can be found in DynamicRecord.

pub fn initialize_hashers() -> (&'static Poseidon8<N>, &'static Poseidon2<N>)

Returns the leaf and path hashers used to merkleize record entries.

Trait Implementations

impl<N: Clone + Network> Clone for DynamicRecord<N>

fn clone(&self) -> DynamicRecord<N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Network> Debug for DynamicRecord<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Prints the dynamic record as a string.

impl<N: Network> Display for DynamicRecord<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Prints the dynamic record as a string.

impl<N: Network> Equal for DynamicRecord<N>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

impl<N: Network> From<&DynamicRecord<N>> for Value<N>

fn from(dynamic_record: &DynamicRecord<N>) -> Self

Initializes the value from a dynamic record.

impl<N: Network> From<DynamicRecord<N>> for Value<N>

fn from(dynamic_record: DynamicRecord<N>) -> Self

Initializes the value from a dynamic record.

impl<N: Network> FromBytes for DynamicRecord<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the dynamic record from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N: Network> FromStr for DynamicRecord<N>

fn from_str(string: &str) -> Result<Self>

Returns a dynamic record from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Network> Parser for DynamicRecord<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string as a dynamic record: { owner: address, _root: field, _nonce: group, _version: u8 }.

impl<N: Network> PartialEq for DynamicRecord<N>

fn eq(&self, other: &Self) -> bool

Returns true if self and other are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Network> ToBits for DynamicRecord<N>

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the dynamic record as a list of little-endian bits.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the dynamic record as a list of big-endian bits.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N: Network> ToBytes for DynamicRecord<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the record to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Network> ToFields for DynamicRecord<N>

fn to_fields(&self) -> Result<Vec<Self::Field>>

Returns the dynamic record as a list of field elements.

type Field = Field<N>

impl<N: Network> Eq for DynamicRecord<N>