ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-08-19 13:20:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: Hook up vault_id host function

Browse Source
This commit is contained in:
TimothyBanks
2026-08-10 21:49:46 -04:00
parent 7e7014c7ca
commit 98abdef208
11 changed files with 129 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
crates/xrpl-host-functions/src/lib.rs
View File

@@ -399,6 +399,13 @@ host_functions! {
#[wasm_name = "ticket_id"]
fn ticket_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult<usize>;
/// The 32-byte keylet of a `Vault`, 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 = "vault_id"]
fn vault_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult<usize>;
/// The XRPL `sha512Half` of `data`: the first [`HASH_LEN`] bytes of its SHA-512.
#[gas = 2000]
#[wasm_name = "sha512_half"]

15
crates/xrpl-host-functions/tests/generated_abi.rs
View File

@@ -376,6 +376,14 @@ impl HostFunctions for FakeHost {
put(out, &[account[0]; HASH_LEN])
}
/// The same account-and-sequence shape, for a `Vault`.
fn vault_keylet(&self, account: &[u8], _seq: i32, out: &mut [u8]) -> HostResult<usize> {
if account.is_empty() {
return Err(HostError::InvalidAccount);
}
put(out, &[account[0]; HASH_LEN])
}
fn sha512_half(&self, data: &[u8], out: &mut [u8]) -> HostResult<usize> {
let mut digest = [0; HASH_LEN];
digest[0] = data.len() as u8;
@@ -597,6 +605,12 @@ fn the_trait_is_implementable() {
host.ticket_keylet(&[], 5, &mut out),
Err(HostError::InvalidAccount)
);
assert_eq!(host.vault_keylet(&[7; 20], 5, &mut out), Ok(HASH_LEN));
assert_eq!(out[0], 7);
assert_eq!(
host.vault_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(()));
@@ -701,6 +715,7 @@ fn the_spec_table_matches_the_declarations() {
("permissioned_domain_id", 350),
("signers_id", 350),
("ticket_id", 350),
("vault_id", 350),
("sha512_half", 2000),
("trace", 500),
("trace_num", 500),

8
crates/xrpl-wasm-vm-ffi/src/lib.rs
View File

@@ -375,6 +375,10 @@ mod ffi {
#[cxx_name = "ticketKeylet"]
fn ticket_keylet(self: &HostContext, account: &[u8], seq: i32, out: &mut [u8]) -> i32;
#[namespace = "xrpl"]
#[cxx_name = "vaultKeylet"]
fn vault_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;
@@ -638,6 +642,10 @@ impl HostFunctions for CxxHost<'_> {
bytes_written(self.ctx.ticket_keylet(account, seq, out))
}
fn vault_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult<usize> {
bytes_written(self.ctx.vault_keylet(account, seq, out))
}
fn sha512_half(&self, data: &[u8], out: &mut [u8]) -> HostResult<usize> {
bytes_written(self.ctx.sha512_half(data, out))
}

3
crates/xrpl-wasm-vm/src/abi.rs
View File

@@ -372,6 +372,9 @@ mod tests {
fn ticket_keylet(&self, _account: &[u8], _seq: i32, _out: &mut [u8]) -> HostResult<usize> {
unreachable!("no unit test in this module calls the host")
}
fn vault_keylet(&self, _account: &[u8], _seq: i32, _out: &mut [u8]) -> HostResult<usize> {
unreachable!("no unit test in this module calls the host")
}
fn sha512_half(&self, _data: &[u8], _out: &mut [u8]) -> HostResult<usize> {
unreachable!("no unit test in this module calls the host")
}

19
crates/xrpl-wasm-vm/src/register.rs
View File

@@ -707,6 +707,25 @@ pub(crate) fn register_host_functions(
})
},
),
HostFunctionSpec::VaultKeylet => 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<i32, wasmi::Error> {
charged(&mut caller, HostFunctionSpec::VaultKeylet, |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.vault_keylet(account.read(data)?, seq, buf)
})
})
},
),
HostFunctionSpec::Sha512Half => linker.func_wrap(
HOST_MODULE,
op.wasm_name(),

5
crates/xrpl-wasm-vm/tests/budgets.rs
View File

@@ -234,6 +234,11 @@ fn call_for(op: HostFunctionSpec) -> Call {
"(call $ticket_id (i32.const 0) (i32.const 20) (i32.const 5) (i32.const 32) (i32.const 32))",
5,
),
HostFunctionSpec::VaultKeylet => (
import::VAULT_ID,
"(call $vault_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))",

15
crates/xrpl-wasm-vm/tests/host_calls.rs
View File

@@ -733,6 +733,21 @@ fn ticket_id_reads_the_account_and_seq() {
assert_eq!(*host.ticket_keylets_asked.borrow(), vec![(account, 5)]);
}
/// The last account-and-sequence keylet, with its own answer set, for a vault.
#[test]
fn vault_id_reads_the_account_and_seq() {
let account = vec![0u8; 20];
let host =
FakeHost::new().answering_vault_keylet(account.clone(), 5, support::Answer::filler(32));
let wat = module(
&[import::VAULT_ID, ONE_PAGE],
"(call $vault_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.vault_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() {

3
crates/xrpl-wasm-vm/tests/preflight.rs
View File

@@ -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; 40] = [
const ALL_IMPORTS: [&str; 41] = [
import::LDGR_INDEX,
import::PARENT_LDGR_TIME,
import::PARENT_LDGR_HASH,
@@ -136,6 +136,7 @@ const ALL_IMPORTS: [&str; 40] = [
import::PERMISSIONED_DOMAIN_ID,
import::SIGNERS_ID,
import::TICKET_ID,
import::VAULT_ID,
import::SHA512_HALF,
import::TRACE,
import::TRACE_NUM,

27
crates/xrpl-wasm-vm/tests/support/mod.rs
View File

@@ -269,6 +269,11 @@ pub struct FakeHost {
pub ticket_keylets: HashMap<(Vec<u8>, i32), Answer>,
/// Every (account, seq) `ticket_keylet` was asked for.
pub ticket_keylets_asked: RefCell<Vec<(Vec<u8>, i32)>>,
/// What `vault_keylet` answers, by (account bytes, seq). An unlisted key answers
/// `InvalidAccount`.
pub vault_keylets: HashMap<(Vec<u8>, i32), Answer>,
/// Every (account, seq) `vault_keylet` was asked for.
pub vault_keylets_asked: RefCell<Vec<(Vec<u8>, i32)>>,
/// What `sha512_half` answers, whatever it is given.
pub digest: Answer,
/// Every field selector `get_current_ledger_obj_field` was asked for.
@@ -359,6 +364,8 @@ impl Default for FakeHost {
signer_list_keylets_asked: RefCell::new(Vec::new()),
ticket_keylets: HashMap::new(),
ticket_keylets_asked: RefCell::new(Vec::new()),
vault_keylets: HashMap::new(),
vault_keylets_asked: RefCell::new(Vec::new()),
digest: Answer::filler(32),
fields_asked: RefCell::new(Vec::new()),
digested: RefCell::new(Vec::new()),
@@ -649,6 +656,16 @@ impl FakeHost {
self
}
pub fn answering_vault_keylet(
mut self,
account: Vec<u8>,
seq: i32,
answer: Answer,
) -> FakeHost {
self.vault_keylets.insert((account, seq), answer);
self
}
pub fn answering_digest(mut self, answer: Answer) -> FakeHost {
self.digest = answer;
self
@@ -1022,6 +1039,15 @@ impl HostFunctions for FakeHost {
}
}
fn vault_keylet(&self, account: &[u8], seq: i32, out: &mut [u8]) -> HostResult<usize> {
let key = (account.to_vec(), seq);
self.vault_keylets_asked.borrow_mut().push(key.clone());
match self.vault_keylets.get(&key) {
Some(answer) => answer.fill(out),
None => Err(HostError::InvalidAccount),
}
}
fn sha512_half(&self, data: &[u8], out: &mut [u8]) -> HostResult<usize> {
self.digested.borrow_mut().push(data.to_vec());
self.digest.fill(out)
@@ -1100,6 +1126,7 @@ pub mod import {
pub const PERMISSIONED_DOMAIN_ID: &str = r#"(import "host_lib" "permissioned_domain_id" (func $permissioned_domain_id (param i32 i32 i32 i32 i32) (result i32)))"#;
pub const SIGNERS_ID: &str = r#"(import "host_lib" "signers_id" (func $signers_id (param i32 i32 i32 i32) (result i32)))"#;
pub const TICKET_ID: &str = r#"(import "host_lib" "ticket_id" (func $ticket_id (param i32 i32 i32 i32 i32) (result i32)))"#;
pub const VAULT_ID: &str = r#"(import "host_lib" "vault_id" (func $vault_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)))"#;

8
include/xrpl/tx/wasm/HostContext.h
View File

@@ -256,6 +256,14 @@ public:
std::int32_t seq,
rust::Slice<std::uint8_t> 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
vaultKeylet(
rust::Slice<std::uint8_t const> account,
std::int32_t seq,
rust::Slice<std::uint8_t> out) const noexcept;
[[nodiscard]] std::int32_t
sha512Half(rust::Slice<std::uint8_t const> data, rust::Slice<std::uint8_t> out) const noexcept;

20
src/libxrpl/tx/wasm/HostContext.cpp
View File

@@ -803,6 +803,26 @@ HostContext::ticketKeylet(
});
}
std::int32_t
HostContext::vaultKeylet(
rust::Slice<std::uint8_t const> account,
std::int32_t seq,
rust::Slice<std::uint8_t> 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_.vaultKeylet(
AccountID::fromVoid(account.data()), static_cast<std::uint32_t>(seq));
if (!value)
return hfErrorToInt(value.error());
return answer(out, value->data(), value->size());
});
}
std::int32_t
HostContext::sha512Half(rust::Slice<std::uint8_t const> data, rust::Slice<std::uint8_t> out)
const noexcept