Skip to main content

check_id

Function check_id 

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

Generates an check ledger entry ID for a given owner and sequence in the XRP Ledger.

Check ledger entry IDs are used to reference check entries in the XRP Ledger’s state data. This function uses the generic create_id_from_host_call helper to manage the FFI interaction.

§Arguments

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

§Returns

  • Result<LedgerEntryIdBytes> - On success, returns a 32-byte check ledger entry ID. On failure, returns an Error with the corresponding error code.

§Safety

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

§Example

use xrpl_common_stdlib::types::account_id::AccountID;
use xrpl_common_stdlib::ledger_entry_ids::check_id;
use xrpl_common_stdlib::host::trace::{ trace_hex, 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 check_id(&owner, sequence) {
    xrpl_common_stdlib::host::Result::Ok(id) => {
      trace_hex("Generated ledger entry ID", &id);
    }
    xrpl_common_stdlib::host::Result::Err(e) => {
      trace_num("Error assembling ledger entry ID", e.code() as i64);
    }
  }
  Ok(())
}