Struct rgb::prelude::Disclosure

pub struct Disclosure { /* fields omitted */ }

Disclosure purpose is to expose a set of stash data related to number of RGB contracts to some external entity – or store them outside of the stash to be merged lately upon a certain event (for instance, withness transaction being mined or receiving a signature for the updated channel state from an LN channel counterparty).

MB: We are limited by 16-bit integer size for the number of anchors and extensions to disclose, but this is fine since we can produce multiple disclosures when needed

Implementations

impl Disclosure

pub fn version(&self) -> &u16

Since these are not consensus-critical data structure (we never commit

pub fn transitions(
    &self
) -> &BTreeMap<AnchorId, (Anchor, BTreeMap<ContractId, Transition>)>

State transitions organized by anchor and then RGB contract

pub fn extensions(&self) -> &BTreeMap<ContractId, Vec<Extension>>

State extensions organized by RGB contract

pub fn comment(&self) -> &Option<String>

Optional human-readable comment on the nature of the disclosed data

pub fn signatures(&self) -> &BTreeMap<PublicKey, Signature>

Signatures over all fields (apart from the signature itself) which may

impl Disclosure

pub fn insert_anchored_transitions(
    &mut self,
    anchor: Anchor,
    transitions: BTreeMap<ContractId, Transition>
)

pub fn insert_extensions(
    &mut self,
    contract_id: ContractId,
    extensions: Vec<Extension>
)

pub fn change_comment(&mut self, comment: String) -> bool

pub fn remove_comment(&mut self) -> bool

pub fn sig_hash(&self) -> SigHash

pub fn add_signature(
    &mut self,
    pubkey: PublicKey,
    signature: Signature
) -> Option<Signature>

pub fn remove_signature(&mut self, pubkey: PublicKey) -> Option<Signature>

pub fn empty_signatures(&mut self) -> usize

Trait Implementations

impl Clone for Disclosure

fn clone(&self) -> Disclosure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommitEncode for Disclosure

fn commit_encode<E: Write>(&self, e: E) -> usize

fn commit_serialize(&self) -> Vec<u8, Global>

impl ConcealAnchors for Disclosure

fn conceal_anchors_except(&mut self, protocols: &Vec<ContractId>) -> usize

fn conceal_anchors(&mut self) -> usize

impl ConcealSeals for Disclosure

fn conceal_seals(&mut self, seals: &Vec<Confidential>) -> usize

impl ConcealState for Disclosure

fn conceal_state_except(&mut self, seals: &Vec<Confidential>) -> usize

fn conceal_state(&mut self) -> usize

impl ConsensusCommit for Disclosure

type Commitment = DisclosureId

fn consensus_commit(&self) -> Self::Commitment

fn consensus_verify(&self, commitment: &Self::Commitment) -> bool

impl Debug for Disclosure

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

Formats the value using the given formatter.

impl Default for Disclosure

fn default() -> Disclosure

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Disclosure

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

Deserialize this value from the given Serde deserializer.

impl Display for Disclosure

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

Formats the value using the given formatter.

impl From<Disclosure> for Bech32

fn from(v: Disclosure) -> Self

Performs the conversion.

impl FromStr for Disclosure

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Disclosure> for Disclosure

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

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

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

This method tests for !=.

impl Serialize for Disclosure

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

Serialize this value into the given Serde serializer.

impl StrictDecode for Disclosure

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for Disclosure

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

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

Serializes data as a byte array using [strict_encode()] function

impl TryFrom<Bech32> for Disclosure

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bech32: Bech32) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Disclosure