Struct Id

pub struct Id(pub Fq);

An identifier for an IBC asset type.

This is similar to, but different from, the design in ADR001. As in ADR001, a denomination trace is hashed to a fixed-size identifier, but unlike ADR001, we hash to a field element rather than a byte string.

A denomination trace looks like

• denom (native chain A asset)
• transfer/channelToA/denom (chain B representation of chain A asset)
• transfer/channelToB/transfer/channelToA/denom (chain C representation of chain B representation of chain A asset)

ADR001 defines the IBC asset ID as the SHA-256 hash of the denomination trace. Instead, Penumbra hashes to a field element, so that asset IDs can be more easily used inside of a circuit.

Tuple Fields

0: Fq

Implementations

impl Id

pub fn value_generator(&self) -> Element

Compute the value generator for this asset, used for computing balance commitments.

pub fn to_bytes(&self) -> [u8; 32]

Convert the asset ID to bytes.

pub fn value(&self, amount: Amount) -> Value

Create a value of this denomination.

pub fn to_base64(&self) -> String

Returns the base64 encoded string of the inner bytes.

Trait Implementations

impl AllocVar<Id, Fq> for AssetIdVar

fn new_variable<T: Borrow<Id>>( cs: impl Into<Namespace<Fq>>, f: impl FnOnce() -> Result<T, SynthesisError>, mode: AllocationMode, ) -> Result<Self, SynthesisError>

Allocates a new variable of type Self in the ConstraintSystem cs. The mode of allocation is decided by mode.

fn new_constant( cs: impl Into<Namespace<F>>, t: impl Borrow<V>, ) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new private witness of type Self in the ConstraintSystem cs.

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl DomainType for Id

type Proto = AssetId

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl From<Id> for AssetId

fn from(id: Id) -> Self

Converts to this type from the input type.

impl From<Metadata> for Id

fn from(base: Metadata) -> Id

Converts to this type from the input type.

impl FromStr for Id

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 Hash for Id

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

fn cmp(&self, other: &Id) -> 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 Id

fn eq(&self, other: &Id) -> 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 Id

fn partial_cmp(&self, other: &Id) -> 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 Id

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToConstraintField<Fq> for Id

fn to_field_elements(&self) -> Option<Vec<Fq>>

impl TryFrom<&[u8]> for Id

type Error = Error

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Id, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 32]> for Id

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: [u8; 32]) -> Result<Id, Self::Error>

Performs the conversion.

impl TryFrom<AssetId> for Id

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AssetId) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Id

impl Eq for Id

impl StructuralPartialEq for Id