pub struct ErgoBox {
pub value: BoxValue,
pub ergo_tree: ErgoTree,
pub tokens: Vec<Token, Global>,
pub additional_registers: NonMandatoryRegisters,
pub creation_height: u32,
pub transaction_id: TxId,
pub index: u16,
/* private fields */
}Expand description
Box (aka coin, or an unspent output) is a basic concept of a UTXO-based cryptocurrency. In Bitcoin, such an object is associated with some monetary value (arbitrary, but with predefined precision, so we use integer arithmetic to work with the value), and also a guarding script (aka proposition) to protect the box from unauthorized opening.
In other way, a box is a state element locked by some proposition (ErgoTree).
In Ergo, box is just a collection of registers, some with mandatory types and semantics, others could be used by applications in any way. We add additional fields in addition to amount and proposition~(which stored in the registers R0 and R1). Namely, register R2 contains additional tokens (a sequence of pairs (token identifier, value)). Register R3 contains height specified by user (protocol checks if it was <= current height when transaction was accepted) and also transaction identifier and box index in the transaction outputs. Registers R4-R9 are free for arbitrary usage.
A transaction is unsealing a box. As a box can not be open twice, any further valid transaction can not be linked to the same box.
Fields
value: BoxValueamount of money associated with the box
ergo_tree: ErgoTreeguarding script, which should be evaluated to true in order to open this box
tokens: Vec<Token, Global>secondary tokens the box contains
additional_registers: NonMandatoryRegistersadditional registers the box can carry over
creation_height: u32height when a transaction containing the box was created. This height is declared by user and should not exceed height of the block, containing the transaction with this box.
transaction_id: TxIdid of transaction which created the box
index: u16number of box (from 0 to total number of boxes the transaction with transactionId created - 1)
Implementations
impl ErgoBox
impl ErgoBox
pub const MAX_TOKENS_COUNT: usize
pub const MAX_TOKENS_COUNT: usize
Maximum number of tokens in the box
Crate new box
pub fn box_id(&self) -> BoxId
pub fn box_id(&self) -> BoxId
Box id (Blake2b256 hash of serialized box)
pub fn from_box_candidate(
box_candidate: &ErgoBoxCandidate,
transaction_id: TxId,
index: u16
) -> Result<ErgoBox, SigmaSerializationError>
pub fn from_box_candidate(
box_candidate: &ErgoBoxCandidate,
transaction_id: TxId,
index: u16
) -> Result<ErgoBox, SigmaSerializationError>
Create ErgoBox from ErgoBoxCandidate by adding transaction id and index of the box in the transaction
pub fn get_register(&self, id: RegisterId) -> Option<Constant>
pub fn get_register(&self, id: RegisterId) -> Option<Constant>
Get register value
Returns tokens as tuple of byte array and amount as primitive types
pub fn script_bytes(&self) -> Result<Vec<i8, Global>, SigmaSerializationError>
pub fn script_bytes(&self) -> Result<Vec<i8, Global>, SigmaSerializationError>
Returns serialized ergo_tree guarding this box
Tuple of height when block got included into the blockchain and transaction identifier with box index in the transaction outputs serialized to the byte array.
pub fn bytes_without_ref(
&self
) -> Result<Vec<i8, Global>, SigmaSerializationError>
pub fn bytes_without_ref(
&self
) -> Result<Vec<i8, Global>, SigmaSerializationError>
Returns serialized ErgoBox without tx_id and index
Trait Implementations
impl<'de> Deserialize<'de> for ErgoBox
impl<'de> Deserialize<'de> for ErgoBox
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<ErgoBox, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<ErgoBox, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl SigmaSerializable for ErgoBox
impl SigmaSerializable for ErgoBox
pub fn sigma_serialize<W>(
&self,
w: &mut W
) -> Result<(), SigmaSerializationError> where
W: SigmaByteWrite,
pub fn sigma_serialize<W>(
&self,
w: &mut W
) -> Result<(), SigmaSerializationError> where
W: SigmaByteWrite,
Write self to the given writer.
This function has a sigma_ prefix to alert the reader that the
serialization in use is consensus-critical serialization Read more
pub fn sigma_parse<R>(r: &mut R) -> Result<ErgoBox, SigmaParsingError> where
R: SigmaByteRead,
pub fn sigma_parse<R>(r: &mut R) -> Result<ErgoBox, SigmaParsingError> where
R: SigmaByteRead,
Try to read self from the given reader.
sigma- prefix to alert the reader that the serialization in use
is consensus-critical Read more
fn sigma_serialize_bytes(
&self
) -> Result<Vec<u8, Global>, SigmaSerializationError>
fn sigma_serialize_bytes(
&self
) -> Result<Vec<u8, Global>, SigmaSerializationError>
Serialize any SigmaSerializable value into bytes
fn sigma_parse_bytes(bytes: &[u8]) -> Result<Self, SigmaParsingError>
fn sigma_parse_bytes(bytes: &[u8]) -> Result<Self, SigmaParsingError>
Parse self from the bytes
impl TryExtractFrom<Literal> for ErgoBox
impl TryExtractFrom<Literal> for ErgoBox
pub fn try_extract_from(c: Literal) -> Result<ErgoBox, TryExtractFromError>
pub fn try_extract_from(c: Literal) -> Result<ErgoBox, TryExtractFromError>
Extract the value or return an error if type does not match
impl StructuralEq for ErgoBox
impl StructuralPartialEq for ErgoBox
Auto Trait Implementations
impl RefUnwindSafe for ErgoBox
impl UnwindSafe for ErgoBox
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key and return true if they are equal.
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self to use its Display implementation when
Debug-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted.
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.borrow() into the pipe function. Read more
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self, then passes self.borrow_mut() into the pipe
function. Read more
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.as_ref() into the pipe function.
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self, then passes self.as_mut() into the pipe
function. Read more
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Borrows self, then passes self.deref() into the pipe function.
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B> of a value. Read more
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow() only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut() only in debug builds, and is erased in release
builds. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref() only in debug builds, and is erased in release
builds. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut() only in debug builds, and is erased in release
builds. Read more
impl<T> TryExtractFrom<Constant> for T where
T: TryExtractFrom<Literal>,
impl<T> TryExtractFrom<Constant> for T where
T: TryExtractFrom<Literal>,
pub fn try_extract_from(cv: Constant) -> Result<T, TryExtractFromError>
pub fn try_extract_from(cv: Constant) -> Result<T, TryExtractFromError>
Extract the value or return an error if type does not match
pub fn try_extract_into<T>(self) -> Result<T, TryExtractFromError> where
T: TryExtractFrom<F>,
pub fn try_extract_into<T>(self) -> Result<T, TryExtractFromError> where
T: TryExtractFrom<F>,
Extract value of the given type from any type (e.g. [‘Constant’], [super::value::Value])
on which [TryExtractFrom] is implemented Read more