Skip to main content

escrow_keylet

Function escrow_keylet 

Source
pub fn escrow_keylet(owner: &AccountID, seq: u32) -> Result<KeyletBytes>
Expand description

Generates an escrow keylet for a given owner and sequence in the XRP Ledger.

Escrow keylets are used to reference escrow entries in the XRP Ledger’s state data. This function uses the generic create_keylet_from_host_call helper to manage the FFI interaction.

§Arguments

  • owner - Reference to an AccountID representing the escrow owner’s account
  • seq - The account sequence associated with the escrow entry

§Returns

  • Result<KeyletBytes> - On success, returns a 32-byte escrow keylet. On failure, returns an Error with the corresponding error code.

§Safety

This function makes unsafe FFI calls to the host environment through the host::escrow_keylet function, though the unsafe code is contained within the closure passed to create_keylet_from_host_call.

§Example

use xrpl_wasm_stdlib::core::types::account_id::AccountID;
use xrpl_wasm_stdlib::core::keylets::escrow_keylet;
use xrpl_wasm_stdlib::host::trace::{DataRepr, trace_data, trace_num};

fn main() -> Result<(), Box<dyn std::error::Error>> {
  let owner: AccountID =
      AccountID::from(*b"\xd5\xb9\x84VP\x9f \xb5'\x9d\x1eJ.\xe8\xb2\xaa\x82\xaec\xe3");
  let sequence = 12345;
  match escrow_keylet(&owner, sequence) {
    xrpl_wasm_stdlib::host::Result::Ok(keylet) => {
      let _ = trace_data("Generated keylet", &keylet, DataRepr::AsHex);
    }
    xrpl_wasm_stdlib::host::Result::Err(e) => {
      let _ = trace_num("Error assembling keylet", e.code() as i64);
    }
  }
  Ok(())
}