Struct AuthToken

pub struct AuthToken(/* private fields */);

Authorization token used for controlling the destructible memory cell access.

Authorization token is defined together with a destructible memory cell, as a part of the operation output.

When the destructible cell is being accessed by another operation as a part of its input, the token value is put into the virtual machine register E1. Then, it can be used by the codex validating a script alongside the witness value, which is a part of the operation input data.

Examples of use

One possible simplified scenario for the use of authorization token is the fact that the token provides a hash of a certain value; and the operation destroying the memory cell provides a preimage of the hash as a part of the input witness; and the validation script checks the preimage against the hash.

More complex scenarios involve single-use seals; the authorization token in this case represents a hash of (a commitment to) a single-use seal definition, and during the memory cell access the operation destroying that cell (“spending operation”) needs to prove that it has properly closed that single-use seal over the commitment to the spending operation. This scenario is implemented in the RGB smart contract system.

Implementations

impl AuthToken

pub const fn to_fe256(&self) -> fe256

Get a representation of a authorization token as a 256-bit field element.

pub fn from_byte_array(bytes: [u8; 30]) -> AuthToken

Construct the token out of 30 bytes of raw data.

pub fn to_byte_array(&self) -> [u8; 30]

Convert the token to 30 bytes of raw data.

pub fn to_bytes30(&self) -> Array<u8, 30>

Convert the token to 30 bytes blob.

Trait Implementations

impl Clone for AuthToken

fn clone(&self) -> AuthToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthToken

fn deserialize<D>( deserializer: D, ) -> Result<AuthToken, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthToken

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

Formats the value using the given formatter.

impl DisplayBaid64<30> for AuthToken

const HRI: &'static str = "at"

const CHUNKING: bool = true

const CHUNK_FIRST: usize = 8usize

const CHUNK_LEN: usize = 8usize

const PREFIX: bool = true

const EMBED_CHECKSUM: bool = true

const MNEMONIC: bool = false

fn to_baid64_payload(&self) -> [u8; 30]

fn to_baid64_string(&self) -> String

fn to_baid64_mnemonic(&self) -> String

fn display_baid64(&self) -> Baid64Display<LEN>

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

impl From<[u8; 30]> for AuthToken

fn from(value: [u8; 30]) -> AuthToken

Converts to this type from the input type.

impl From<Array<u8, 30>> for AuthToken

fn from(value: Array<u8, 30>) -> AuthToken

Converts to this type from the input type.

impl From<fe256> for AuthToken

fn from(v: fe256) -> AuthToken

Converts to this type from the input type.

impl FromBaid64Str<30> for AuthToken

fn from_baid64_str(s: &str) -> Result<Self, Baid64ParseError>

impl FromStr for AuthToken

type Err = Baid64ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AuthToken, <AuthToken as FromStr>::Err>

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

impl Hash for AuthToken

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

where __H: Hasher,

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 Ord for AuthToken

fn cmp(&self, other: &AuthToken) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AuthToken

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

Tests for self and other values to be equal, and is used by ==.

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 PartialOrd for AuthToken

fn partial_cmp(&self, other: &AuthToken) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AuthToken

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.

impl StrictDecode for AuthToken

fn strict_decode(reader: &mut impl TypedRead) -> Result<AuthToken, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for AuthToken

fn strict_dumb() -> AuthToken

impl StrictEncode for AuthToken

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for AuthToken

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for AuthToken

const STRICT_LIB_NAME: &'static str = LIB_NAME_ULTRASONIC

fn strict_name() -> Option<TypeName>

impl Copy for AuthToken

impl Eq for AuthToken

impl StrictProduct for AuthToken

impl StructuralPartialEq for AuthToken