Struct Lock 

pub struct Lock {
    pub asset: Option<String>,
    pub currency: Option<String>,
    pub amount: String,
    pub originator: Party,
    pub beneficiary: Party,
    pub expiry: String,
    pub agreement: Option<String>,
    pub agents: Vec<Agent>,
    pub metadata: HashMap<String, Value>,
}

Lock message for holding assets on behalf of parties (TAIP-17).

A Lock allows one agent to request another agent to hold a specified amount of currency or asset from a party in escrow on behalf of another party.

Fields

asset: Option<String>

Cryptocurrency asset to be held in escrow (CAIP-19 identifier). Either asset OR currency MUST be present.

currency: Option<String>

ISO 4217 currency code (e.g. “USD”, “EUR”) for fiat-denominated locks. Either asset OR currency MUST be present.

amount: String

Amount to be held in escrow (decimal string).

originator: Party

Party whose assets will be placed in escrow.

beneficiary: Party

Party who will receive the assets when released.

expiry: String

Timestamp after which the lock automatically expires and funds are released back to the originator.

agreement: Option<String>

URL or URI referencing the terms and conditions of the lock.

agents: Vec<Agent>

Agents involved in the lock. Exactly one agent MUST have role “EscrowAgent”.

metadata: HashMap<String, Value>

Additional metadata.

Implementations

impl Lock

pub fn new_with_asset( asset: String, amount: String, originator: Party, beneficiary: Party, expiry: String, agents: Vec<Agent>, ) -> Self

Create a new Lock for cryptocurrency assets.

pub fn new_with_currency( currency: String, amount: String, originator: Party, beneficiary: Party, expiry: String, agents: Vec<Agent>, ) -> Self

Create a new Lock for fiat currency.

pub fn with_agreement(self, agreement: String) -> Self

Set the agreement URL.

pub fn with_metadata(self, key: String, value: Value) -> Self

Add metadata.

pub fn escrow_agent(&self) -> Option<&Agent>

Find the escrow agent (the agent with role == "EscrowAgent") in the agents list.

pub fn authorizing_agents(&self) -> Vec<&Agent>

Find agents that can authorise release (agents acting for the beneficiary).

Trait Implementations

impl Clone for Lock

fn clone(&self) -> Lock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Lock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Lock

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessageBody for Lock

fn message_type() -> &'static str

Get the message type string for this body type.

fn validate(&self) -> Result<()>

Validate the message body.

fn to_didcomm(&self, from: &str) -> Result<PlainMessage>

Convert this body to a DIDComm message.

fn to_didcomm_with_route<'a, I>( &self, from: &str, to: I, ) -> Result<PlainMessage>

where I: IntoIterator<Item = &'a str>,

Convert this body to a DIDComm message with a custom routing path.

fn from_didcomm(message: &PlainMessage) -> Result<Self>

where Self: Sized,

Extract this body type from a DIDComm message.

impl StructuralPartialEq for Lock