Skip to main content

Escrow

Type Alias Escrow 

Source
pub type Escrow = Lock;
Expand description

Backward-compatible alias for the renamed Lock message.

Aliased Type§

pub struct Escrow {
    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>,
}

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.