From 78c8128c98501502abfb3f58477f65a5e0c9b437 Mon Sep 17 00:00:00 2001 From: TimothyBanks Date: Mon, 10 Aug 2026 20:56:18 -0400 Subject: [PATCH] feat: Hook up escrow_id host function --- crates/xrpl-host-functions/src/lib.rs | 7 +++++ .../tests/generated_abi.rs | 15 +++++++++++ crates/xrpl-wasm-vm-ffi/src/lib.rs | 8 ++++++ crates/xrpl-wasm-vm/src/abi.rs | 3 +++ crates/xrpl-wasm-vm/src/register.rs | 19 +++++++++++++ crates/xrpl-wasm-vm/tests/budgets.rs | 5 ++++ crates/xrpl-wasm-vm/tests/host_calls.rs | 15 +++++++++++ crates/xrpl-wasm-vm/tests/preflight.rs | 3 ++- crates/xrpl-wasm-vm/tests/support/mod.rs | 27 +++++++++++++++++++ include/xrpl/tx/wasm/HostContext.h | 8 ++++++ src/libxrpl/tx/wasm/HostContext.cpp | 20 ++++++++++++++ 11 files changed, 129 insertions(+), 1 deletion(-) diff --git a/crates/xrpl-host-functions/src/lib.rs b/crates/xrpl-host-functions/src/lib.rs index b5fc0e7a00..8f3874e6f2 100644 --- a/crates/xrpl-host-functions/src/lib.rs +++ b/crates/xrpl-host-functions/src/lib.rs @@ -296,6 +296,13 @@ host_functions! { #[wasm_name = "did_id"] fn did_keylet(&self, account: &[u8], out: &mut [u8]) -> HostResult; + /// The 32-byte keylet of an `Escrow`, computed from the 20-byte owner account and + /// its sequence number. `seq` is the guest's `u32` carried as its `i32` bit + /// pattern. Reads the account region and writes the keylet. + #[gas = 350] + #[wasm_name = "escrow_id"] + fn escrow_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult; + /// The XRPL `sha512Half` of `data`: the first [`HASH_LEN`] bytes of its SHA-512. #[gas = 2000] #[wasm_name = "sha512_half"] diff --git a/crates/xrpl-host-functions/tests/generated_abi.rs b/crates/xrpl-host-functions/tests/generated_abi.rs index 06bd8bccdc..074392872c 100644 --- a/crates/xrpl-host-functions/tests/generated_abi.rs +++ b/crates/xrpl-host-functions/tests/generated_abi.rs @@ -257,6 +257,14 @@ impl HostFunctions for FakeHost { put(out, &[account[0]; HASH_LEN]) } + /// The account-and-sequence shape, for an `Escrow`. + fn escrow_keylet(&self, account: &[u8], _seq: i32, out: &mut [u8]) -> HostResult { + if account.is_empty() { + return Err(HostError::InvalidAccount); + } + put(out, &[account[0]; HASH_LEN]) + } + fn sha512_half(&self, data: &[u8], out: &mut [u8]) -> HostResult { let mut digest = [0; HASH_LEN]; digest[0] = data.len() as u8; @@ -394,6 +402,12 @@ fn the_trait_is_implementable() { host.did_keylet(&[], &mut out), Err(HostError::InvalidAccount) ); + assert_eq!(host.escrow_keylet(&[7; 20], 5, &mut out), Ok(HASH_LEN)); + assert_eq!(out[0], 7); + assert_eq!( + host.escrow_keylet(&[], 5, &mut out), + Err(HostError::InvalidAccount) + ); assert_eq!(host.sha512_half(b"abc", &mut out), Ok(HASH_LEN)); assert_eq!(out[0], 3); assert_eq!(host.trace("hello", b"xy", true), Ok(())); @@ -487,6 +501,7 @@ fn the_spec_table_matches_the_declarations() { ("delegate_id", 350), ("deposit_preauth_id", 350), ("did_id", 350), + ("escrow_id", 350), ("sha512_half", 2000), ("trace", 500), ("trace_num", 500), diff --git a/crates/xrpl-wasm-vm-ffi/src/lib.rs b/crates/xrpl-wasm-vm-ffi/src/lib.rs index 34b4ad199e..997e81890a 100644 --- a/crates/xrpl-wasm-vm-ffi/src/lib.rs +++ b/crates/xrpl-wasm-vm-ffi/src/lib.rs @@ -304,6 +304,10 @@ mod ffi { #[cxx_name = "didKeylet"] fn did_keylet(self: &HostContext, account: &[u8], out: &mut [u8]) -> i32; + #[namespace = "xrpl"] + #[cxx_name = "escrowKeylet"] + fn escrow_keylet(self: &HostContext, account: &[u8], seq: i32, out: &mut [u8]) -> i32; + #[namespace = "xrpl"] #[cxx_name = "sha512Half"] fn sha512_half(self: &HostContext, data: &[u8], out: &mut [u8]) -> i32; @@ -498,6 +502,10 @@ impl HostFunctions for CxxHost<'_> { bytes_written(self.ctx.did_keylet(account, out)) } + fn escrow_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult { + bytes_written(self.ctx.escrow_keylet(account, seq, out)) + } + fn sha512_half(&self, data: &[u8], out: &mut [u8]) -> HostResult { bytes_written(self.ctx.sha512_half(data, out)) } diff --git a/crates/xrpl-wasm-vm/src/abi.rs b/crates/xrpl-wasm-vm/src/abi.rs index b0336de410..935786061a 100644 --- a/crates/xrpl-wasm-vm/src/abi.rs +++ b/crates/xrpl-wasm-vm/src/abi.rs @@ -302,6 +302,9 @@ mod tests { fn did_keylet(&self, _account: &[u8], _out: &mut [u8]) -> HostResult { unreachable!("no unit test in this module calls the host") } + fn escrow_keylet(&self, _account: &[u8], _seq: i32, _out: &mut [u8]) -> HostResult { + unreachable!("no unit test in this module calls the host") + } fn sha512_half(&self, _data: &[u8], _out: &mut [u8]) -> HostResult { unreachable!("no unit test in this module calls the host") } diff --git a/crates/xrpl-wasm-vm/src/register.rs b/crates/xrpl-wasm-vm/src/register.rs index 480913a75e..52ade0c04d 100644 --- a/crates/xrpl-wasm-vm/src/register.rs +++ b/crates/xrpl-wasm-vm/src/register.rs @@ -475,6 +475,25 @@ pub(crate) fn register_host_functions( }) }, ), + HostFunctionSpec::EscrowKeylet => linker.func_wrap( + HOST_MODULE, + op.wasm_name(), + |mut caller: Caller<'_, VmState<'_>>, + acc_ptr: i32, + acc_len: i32, + seq: i32, + out_ptr: i32, + out_len: i32| + -> Result { + charged(&mut caller, HostFunctionSpec::EscrowKeylet, |c| { + let out = Region::new(out_ptr, out_len); + let account = Region::new(acc_ptr, acc_len); + write_buffered(c, out, |host, data, buf| { + host.escrow_keylet(account.read(data)?, seq, buf) + }) + }) + }, + ), HostFunctionSpec::Sha512Half => linker.func_wrap( HOST_MODULE, op.wasm_name(), diff --git a/crates/xrpl-wasm-vm/tests/budgets.rs b/crates/xrpl-wasm-vm/tests/budgets.rs index f3d62bbb4a..036dc14980 100644 --- a/crates/xrpl-wasm-vm/tests/budgets.rs +++ b/crates/xrpl-wasm-vm/tests/budgets.rs @@ -179,6 +179,11 @@ fn call_for(op: HostFunctionSpec) -> Call { "(call $did_id (i32.const 0) (i32.const 20) (i32.const 32) (i32.const 32))", 4, ), + HostFunctionSpec::EscrowKeylet => ( + import::ESCROW_ID, + "(call $escrow_id (i32.const 0) (i32.const 20) (i32.const 5) (i32.const 32) (i32.const 32))", + 5, + ), HostFunctionSpec::Sha512Half => ( import::SHA512_HALF, "(call $sha512_half (i32.const 0) (i32.const 4) (i32.const 0) (i32.const 32))", diff --git a/crates/xrpl-wasm-vm/tests/host_calls.rs b/crates/xrpl-wasm-vm/tests/host_calls.rs index a462f8feaf..0feab266b3 100644 --- a/crates/xrpl-wasm-vm/tests/host_calls.rs +++ b/crates/xrpl-wasm-vm/tests/host_calls.rs @@ -527,6 +527,21 @@ fn did_id_reads_the_account_and_writes_the_keylet() { assert_eq!(*host.did_keylets_asked.borrow(), vec![account]); } +/// The account-and-sequence keylet shape (like check), with its own answer set. +#[test] +fn escrow_id_reads_the_account_and_seq_and_writes_the_keylet() { + let account = vec![0u8; 20]; + let host = + FakeHost::new().answering_escrow_keylet(account.clone(), 5, support::Answer::filler(32)); + + let wat = module( + &[import::ESCROW_ID, ONE_PAGE], + "(call $escrow_id (i32.const 0) (i32.const 20) (i32.const 5) (i32.const 64) (i32.const 64))", + ); + assert_eq!(status(&wat, &host), 32, "the 32-byte keylet length"); + assert_eq!(*host.escrow_keylets_asked.borrow(), vec![(account, 5)]); +} + /// A leading scalar parameter reaches the host as declared. #[test] fn home_le_field_passes_the_field_selector_through() { diff --git a/crates/xrpl-wasm-vm/tests/preflight.rs b/crates/xrpl-wasm-vm/tests/preflight.rs index dea1571b2c..7113f09ed1 100644 --- a/crates/xrpl-wasm-vm/tests/preflight.rs +++ b/crates/xrpl-wasm-vm/tests/preflight.rs @@ -98,7 +98,7 @@ fn a_disabled_feature_does_not_pass() { /// Every host function the ABI declares, spelled as a guest imports it. The count /// is asserted against the ABI so a function added to it cannot be left out here. -const ALL_IMPORTS: [&str; 29] = [ +const ALL_IMPORTS: [&str; 30] = [ import::LDGR_INDEX, import::PARENT_LDGR_TIME, import::PARENT_LDGR_HASH, @@ -125,6 +125,7 @@ const ALL_IMPORTS: [&str; 29] = [ import::DELEGATE_ID, import::DEPOSIT_PREAUTH_ID, import::DID_ID, + import::ESCROW_ID, import::SHA512_HALF, import::TRACE, import::TRACE_NUM, diff --git a/crates/xrpl-wasm-vm/tests/support/mod.rs b/crates/xrpl-wasm-vm/tests/support/mod.rs index 6eb69db451..e44c27334f 100644 --- a/crates/xrpl-wasm-vm/tests/support/mod.rs +++ b/crates/xrpl-wasm-vm/tests/support/mod.rs @@ -214,6 +214,11 @@ pub struct FakeHost { pub did_keylets: HashMap, Answer>, /// Every account `did_keylet` was asked for. pub did_keylets_asked: RefCell>>, + /// What `escrow_keylet` answers, by (account bytes, seq). An unlisted key answers + /// `InvalidAccount`. + pub escrow_keylets: HashMap<(Vec, i32), Answer>, + /// Every (account, seq) `escrow_keylet` was asked for. + pub escrow_keylets_asked: RefCell, i32)>>, /// What `sha512_half` answers, whatever it is given. pub digest: Answer, /// Every field selector `get_current_ledger_obj_field` was asked for. @@ -282,6 +287,8 @@ impl Default for FakeHost { deposit_preauth_keylets_asked: RefCell::new(Vec::new()), did_keylets: HashMap::new(), did_keylets_asked: RefCell::new(Vec::new()), + escrow_keylets: HashMap::new(), + escrow_keylets_asked: RefCell::new(Vec::new()), digest: Answer::filler(32), fields_asked: RefCell::new(Vec::new()), digested: RefCell::new(Vec::new()), @@ -463,6 +470,16 @@ impl FakeHost { self } + pub fn answering_escrow_keylet( + mut self, + account: Vec, + seq: i32, + answer: Answer, + ) -> FakeHost { + self.escrow_keylets.insert((account, seq), answer); + self + } + pub fn answering_digest(mut self, answer: Answer) -> FakeHost { self.digest = answer; self @@ -712,6 +729,15 @@ impl HostFunctions for FakeHost { } } + fn escrow_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult { + let key = (account.to_vec(), seq); + self.escrow_keylets_asked.borrow_mut().push(key.clone()); + match self.escrow_keylets.get(&key) { + Some(answer) => answer.fill(out), + None => Err(HostError::InvalidAccount), + } + } + fn sha512_half(&self, data: &[u8], out: &mut [u8]) -> HostResult { self.digested.borrow_mut().push(data.to_vec()); self.digest.fill(out) @@ -779,6 +805,7 @@ pub mod import { pub const DEPOSIT_PREAUTH_ID: &str = r#"(import "host_lib" "deposit_preauth_id" (func $deposit_preauth_id (param i32 i32 i32 i32 i32 i32) (result i32)))"#; pub const DID_ID: &str = r#"(import "host_lib" "did_id" (func $did_id (param i32 i32 i32 i32) (result i32)))"#; + pub const ESCROW_ID: &str = r#"(import "host_lib" "escrow_id" (func $escrow_id (param i32 i32 i32 i32 i32) (result i32)))"#; pub const SHA512_HALF: &str = r#"(import "host_lib" "sha512_half" (func $sha512_half (param i32 i32 i32 i32) (result i32)))"#; pub const TRACE: &str = r#"(import "host_lib" "trace" (func $trace (param i32 i32 i32 i32 i32) (result i32)))"#; diff --git a/include/xrpl/tx/wasm/HostContext.h b/include/xrpl/tx/wasm/HostContext.h index 41f424dd28..f74e91ac66 100644 --- a/include/xrpl/tx/wasm/HostContext.h +++ b/include/xrpl/tx/wasm/HostContext.h @@ -169,6 +169,14 @@ public: didKeylet(rust::Slice account, rust::Slice out) const noexcept; + // The account id must be 20 bytes, else `InvalidParams`. `seq` carries the guest's + // u32 as its i32 bit pattern. Writes the 32-byte keylet. + [[nodiscard]] std::int32_t + escrowKeylet( + rust::Slice account, + std::int32_t seq, + rust::Slice out) const noexcept; + [[nodiscard]] std::int32_t sha512Half(rust::Slice data, rust::Slice out) const noexcept; diff --git a/src/libxrpl/tx/wasm/HostContext.cpp b/src/libxrpl/tx/wasm/HostContext.cpp index 1290462771..9f85d06a3b 100644 --- a/src/libxrpl/tx/wasm/HostContext.cpp +++ b/src/libxrpl/tx/wasm/HostContext.cpp @@ -581,6 +581,26 @@ HostContext::didKeylet(rust::Slice account, rust::Slice account, + std::int32_t seq, + rust::Slice out) const noexcept +{ + return guarded(hostFunctions_.getJournal(), kHostInternal, [&] { + if (account.size() != AccountID::size()) + return hfErrorToInt(HostFunctionError::InvalidParams); + + // The guest's u32 seq arrives as its i32 bit pattern; recover it. + auto const value = hostFunctions_.escrowKeylet( + AccountID::fromVoid(account.data()), static_cast(seq)); + if (!value) + return hfErrorToInt(value.error()); + + return answer(out, value->data(), value->size()); + }); +} + std::int32_t HostContext::sha512Half(rust::Slice data, rust::Slice out) const noexcept