Struct Encumbrance 

pub struct Encumbrance {

    pub encumbrance_id: EncumbranceId,
    pub asset_id: AssetId,
    pub encumbrance_type: EncumbranceType,
    pub encumbrance_commitment: [u8; 32],
    pub holder_ref: PartyRef,
    pub obligor_ref: Option<PartyRef>,
    pub priority: PriorityPosition,
    pub amount_commitment: Option<[u8; 32]>,
    pub effective_from: Timestamp,
    pub expiry: Option<Timestamp>,
    pub issuer_address: Address,
    pub issuer_class: PropertyIssuerClass,
    pub policy_id: PolicyId,
    pub revocation_ref: Option<[u8; 32]>,
    pub status: EncumbranceStatus,
    pub created_at: Timestamp,
    pub updated_at: Timestamp,
    pub recorded_at_height: BlockHeight,
    pub agreement_id: Option<[u8; 32]>,
    pub attachments: Vec<AttachmentRef>,
}

SRC-863 Encumbrance

Fields

encumbrance_id: EncumbranceId

Unique encumbrance identifier

asset_id: AssetId

Asset being encumbered

encumbrance_type: EncumbranceType

Encumbrance type

encumbrance_commitment: [u8; 32]

BLAKE3 commitment of encumbrance details

holder_ref: PartyRef

Holder of the encumbrance (lender, lienor, lessor)

obligor_ref: Option<PartyRef>

Obligor (borrower, debtor, lessee)

priority: PriorityPosition

Priority position

amount_commitment: Option<[u8; 32]>

Amount commitment (for monetary encumbrances)

effective_from: Timestamp

Effective date

expiry: Option<Timestamp>

Expiry/maturity date

issuer_address: Address

Issuer address

issuer_class: PropertyIssuerClass

Issuer class

policy_id: PolicyId

Policy ID

revocation_ref: Option<[u8; 32]>

Revocation reference (SRC-805 compatible)

status: EncumbranceStatus

Status

created_at: Timestamp

Creation timestamp

updated_at: Timestamp

Last update timestamp

recorded_at_height: BlockHeight

Block height when recorded

agreement_id: Option<[u8; 32]>

Related agreement ID (SRC-841)

attachments: Vec<AttachmentRef>

Attachments

Implementations

impl Encumbrance

pub fn generate_id( asset_id: &AssetId, encumbrance_type: EncumbranceType, holder_ref: &PartyRef, nonce: &[u8; 32], ) -> EncumbranceId

Generate encumbrance ID

pub fn generate_commitment( terms_hash: &[u8; 32], amount_commitment: Option<&[u8; 32]>, parties_commitment: &[u8; 32], ) -> [u8; 32]

Generate encumbrance commitment

pub fn is_active(&self, current_time: Timestamp) -> bool

Check if encumbrance is currently active

Trait Implementations

impl Clone for Encumbrance

fn clone(&self) -> Encumbrance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Encumbrance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Encumbrance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Encumbrance

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

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 Encumbrance

impl StructuralPartialEq for Encumbrance