Struct redgold_schema::structs::StandardData

pub struct StandardData {

    pub amount: Option<CurrencyAmount>,
    pub generic_typed_value: Option<GenericTypedValue>,
    pub peer_data: Option<PeerMetadata>,
    pub node_metadata: Option<NodeMetadata>,
    pub dynamic_node_metadata: Option<DynamicNodeMetadata>,
    pub height: Option<i64>,
    pub data_hash: Option<Hash>,
    pub hash: Option<Hash>,
    pub observation: Option<Observation>,
    pub address: Option<Address>,
    pub state: Option<BytesData>,
    pub request: Option<BytesData>,
    pub standard_request: Option<StandardRequest>,
    pub liquidity_request: Option<LiquidityRequest>,
    pub portfolio_info: Option<PortfolioInfo>,
    pub schema_def: Option<SchemaDef>,
    pub data: Option<BytesData>,
    pub aggregate_state_hash: Option<Hash>,
    pub external_transaction_id: Option<ExternalTransactionId>,
}

Generic data structure designed to hold arbitrary data in a common format. This should be considered supplementary to using a regular schema, not a complete substitute.

Fields

amount: Option<CurrencyAmount>

Standard currency style field

generic_typed_value: Option<GenericTypedValue>

peer_data: Option<PeerMetadata>

Where a peer (representing a person controlling multiple nodes from a cold wallet,) updates it’s metadata within a transaction

node_metadata: Option<NodeMetadata>

Where an online or live node programmatically updates it’s own metadata using it’s live hot keys

dynamic_node_metadata: Option<DynamicNodeMetadata>

Latest value associated with the online / hot node – updated more frequently and not necessarily tracked in every transaction, but kept here for reference.

height: Option<i64>

Equivalent to ‘block height’, linear observation counter

data_hash: Option<Hash>

Reference to externally resolved data

hash: Option<Hash>

Pure hash reference, without necessarily being backed by any specific data.

observation: Option<Observation>

Used for node transactions related to their internal observation formation, equivalent to a ‘local’ block

address: Option<Address>

Used for referencing bitcoin address, kept here at top level for convenience

state: Option<BytesData>

Used to store state information directly following eUTXO conventions

request: Option<BytesData>

Contract style request, similar to Ethereum transaction for updating a smart contract, from an external user

standard_request: Option<StandardRequest>

Contract style response, similar to above, but specifically typed to correspond to a ‘default’ schema driven request common to all contracts and available automatically in the SDK.

liquidity_request: Option<LiquidityRequest>

Staking request, designed for use with the native AMM/Portfolio functions.

portfolio_info: Option<PortfolioInfo>

Portfolio information, used for updating the current ‘target’ state of a portfolio

schema_def: Option<SchemaDef>

Schema definition for the data, used for parsing and validation

data: Option<BytesData>

Generic bytes data, used for storing arbitrary data

aggregate_state_hash: Option<Hash>

For eUTXO style contracts, the hash of all state information aggregated from initial state origin. Can be re-calculated.

external_transaction_id: Option<ExternalTransactionId>

A bitcoin txid for example

Implementations

impl StandardData

pub fn height(&self) -> i64

Returns the value of height, or the default value if height is unset.

impl StandardData

pub fn observation(o: Observation) -> Self

pub fn empty() -> Self

pub fn peer_data(pd: PeerMetadata) -> Option<Self>

pub fn amount_data(amount: u64) -> Option<Self>

Trait Implementations

impl Clone for StandardData

fn clone(&self) -> StandardData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StandardData

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

Formats the value using the given formatter.

impl Default for StandardData

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StandardData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for StandardData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for StandardData

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for StandardData

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for StandardData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StandardData

impl StructuralEq for StandardData

impl StructuralPartialEq for StandardData