mirror of
https://github.com/logos-blockchain/lez-programs.git
synced 2026-08-26 06:31:19 +00:00
feat(modules/amm): add sync-reserves module op
A permissionless keeper op that refreshes a pool's stored reserves to the live
vault balances (and its TWAP tick). Same lean pattern as the other plans, but
minimal: SyncReserves is a unit instruction — no quote, no user inputs (no
amounts/slippage/deadline/holdings), and nothing signs.
FFI (modules/amm/ffi):
- sync_reserves_plan: encodes SyncReserves over the fixed 6-account IDL order
(config, pool, vault_a, vault_b, current_tick, clock), all non-signing.
config/pool/current_tick/clock are order-independent PDAs from derive_pair;
the vaults come from the pool's stored ids in pool_data (read-only, but the
guest still asserts them — a non-canonically-stored pool would otherwise
mismatch). Fails closed: same_token_pair, config_unavailable, no_pool.
- Wired through mod.rs / ffi.rs (cbindgen header regenerated). Tests cover the
stored-vault + zero-signer + unit-instruction layout and the fail-closed
paths. amm_ffi: 43 tests pass, clippy clean. (lib.rs is a cargo fmt re-wrap.)
C++ module (modules/amm/src):
- syncReserves reads config + pool server-side, calls the plan, and submits.
request is just { tokenAId, tokenBId } — no holdings/amounts/deadline. Public
method → auto-exposed via the universal-module dispatch.
This commit is contained in:
@@ -23,6 +23,7 @@ use super::{
|
||||
quote::minimum_opening_pair,
|
||||
AddLiquidityPlanRequest, AddLiquidityQuoteRequest, CreatePoolPlanRequest,
|
||||
LiquidityQuoteRequest, RemoveLiquidityPlanRequest, RemoveLiquidityQuoteRequest,
|
||||
SyncReservesPlanRequest,
|
||||
};
|
||||
use crate::account::{account_id_from_hex, account_id_hex, parse_program_id};
|
||||
|
||||
@@ -574,6 +575,58 @@ pub(super) fn remove_liquidity_plan(request: RemoveLiquidityPlanRequest) -> Resu
|
||||
))
|
||||
}
|
||||
|
||||
/// Builds the `SyncReserves` submission — a permissionless keeper op that refreshes the pool's
|
||||
/// stored reserves to the live vault balances (and its TWAP tick). A unit instruction: no
|
||||
/// amounts, deadline, or holdings, and nothing signs. config / pool / current_tick / clock are
|
||||
/// order-independent PDAs from `derive_pair`; the vaults come from the pool's stored ids in
|
||||
/// `pool_data` (read-only, but the guest still asserts them). Fixed 6-account IDL order.
|
||||
/// Recoverable failures fail closed as `Err` (`same_token_pair`, `config_unavailable`,
|
||||
/// `no_pool`).
|
||||
pub(super) fn sync_reserves_plan(request: SyncReservesPlanRequest) -> Result<Value, String> {
|
||||
let amm_program = parse_program_id(&request.amm_program_id)?;
|
||||
let token_a = account_id_from_hex(&request.token_a_id, "token A id")?;
|
||||
let token_b = account_id_from_hex(&request.token_b_id, "token B id")?;
|
||||
if token_a == token_b {
|
||||
return Err(String::from("same_token_pair"));
|
||||
}
|
||||
|
||||
// config / pool / current_tick / clock are order-independent PDAs, so the token order does
|
||||
// not matter for derive_pair.
|
||||
let Ok(pair) = derive_pair(amm_program, token_a, token_b, &request.config) else {
|
||||
return Err(String::from("config_unavailable"));
|
||||
};
|
||||
|
||||
// The vaults are asserted against the pool's stored ids, so take them from pool_data (a pool
|
||||
// created outside the FFI can store a non-canonical order — see add/remove/swap plans).
|
||||
let Some(pool) = hex::decode(&request.pool_data)
|
||||
.ok()
|
||||
.and_then(|bytes| borsh::from_slice::<PoolDefinition>(&bytes).ok())
|
||||
else {
|
||||
return Err(String::from("no_pool"));
|
||||
};
|
||||
|
||||
let instruction = risc0_zkvm::serde::to_vec(&amm_core::Instruction::SyncReserves)
|
||||
.map_err(|error| format!("instruction serialization failed: {error}"))?;
|
||||
|
||||
// Fixed IDL account order for SyncReserves; nothing signs (permissionless keeper op).
|
||||
let account_ids = [
|
||||
pair.config,
|
||||
pair.pool,
|
||||
pool.vault_a_id,
|
||||
pool.vault_b_id,
|
||||
pair.current_tick,
|
||||
pair.clock,
|
||||
];
|
||||
let signing_requirements = [false, false, false, false, false, false];
|
||||
|
||||
Ok(plan_response(
|
||||
&request.amm_program_id,
|
||||
account_ids,
|
||||
&signing_requirements,
|
||||
instruction,
|
||||
))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use amm_core::{compute_config_pda, compute_pool_pda, compute_vault_pda, AmmConfig};
|
||||
@@ -1382,4 +1435,88 @@ mod tests {
|
||||
no_pool.config = valid_config(amm);
|
||||
assert_eq!(remove_liquidity_plan(no_pool), Err(String::from("no_pool")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sync_plan_emits_pool_stored_vaults_and_signs_nothing() {
|
||||
let program = "00".repeat(32);
|
||||
let amm = parse_program_id(&program).unwrap();
|
||||
let token_a = AccountId::new([0x11; 32]);
|
||||
let token_b = AccountId::new([0x22; 32]);
|
||||
let vault_a = AccountId::new([0xA1; 32]);
|
||||
let vault_b = AccountId::new([0xB1; 32]);
|
||||
let pool = PoolDefinition {
|
||||
definition_token_a_id: token_a,
|
||||
definition_token_b_id: token_b,
|
||||
vault_a_id: vault_a,
|
||||
vault_b_id: vault_b,
|
||||
liquidity_pool_id: AccountId::new([0xCC; 32]),
|
||||
liquidity_pool_supply: 1_000_000,
|
||||
reserve_a: 1_000_000,
|
||||
reserve_b: 2_000_000,
|
||||
fees: 30,
|
||||
};
|
||||
let value = sync_reserves_plan(SyncReservesPlanRequest {
|
||||
amm_program_id: program.clone(),
|
||||
config: valid_config(amm),
|
||||
token_a_id: account_id_hex(token_a),
|
||||
token_b_id: account_id_hex(token_b),
|
||||
pool_data: pool_hex(&pool),
|
||||
})
|
||||
.unwrap();
|
||||
|
||||
let ids = value["accountIds"]
|
||||
.as_array()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.map(|v| v.as_str().unwrap().to_string())
|
||||
.collect::<Vec<String>>();
|
||||
assert_eq!(ids.len(), 6);
|
||||
assert_eq!(ids[0], account_id_hex(compute_config_pda(amm)));
|
||||
assert_eq!(
|
||||
ids[1],
|
||||
account_id_hex(compute_pool_pda(amm, token_a, token_b))
|
||||
);
|
||||
assert_eq!(ids[2], account_id_hex(vault_a)); // pool's stored vaults
|
||||
assert_eq!(ids[3], account_id_hex(vault_b));
|
||||
// ids[4] current_tick, ids[5] clock — order-independent PDAs.
|
||||
assert_eq!(
|
||||
value["signingRequirements"],
|
||||
serde_json::json!([false, false, false, false, false, false])
|
||||
);
|
||||
let expected_instruction = {
|
||||
let words = risc0_zkvm::serde::to_vec(&amm_core::Instruction::SyncReserves).unwrap();
|
||||
serde_json::json!(words.iter().map(|w| u64::from(*w)).collect::<Vec<u64>>())
|
||||
};
|
||||
assert_eq!(value["instruction"], expected_instruction);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sync_plan_fails_closed() {
|
||||
let token = AccountId::new([0xAA; 32]);
|
||||
let other = AccountId::new([0xBB; 32]);
|
||||
let base =
|
||||
|token_a: AccountId, token_b: AccountId, pool_data: String| SyncReservesPlanRequest {
|
||||
amm_program_id: "00".repeat(32),
|
||||
config: read_failed(),
|
||||
token_a_id: account_id_hex(token_a),
|
||||
token_b_id: account_id_hex(token_b),
|
||||
pool_data,
|
||||
};
|
||||
|
||||
// Same token pair — rejected before any config/pool work.
|
||||
assert_eq!(
|
||||
sync_reserves_plan(base(token, token, String::new())),
|
||||
Err(String::from("same_token_pair"))
|
||||
);
|
||||
// Unavailable config (read_failed) surfaces before the pool decode.
|
||||
assert_eq!(
|
||||
sync_reserves_plan(base(token, other, String::new())),
|
||||
Err(String::from("config_unavailable"))
|
||||
);
|
||||
// Valid config but no pool data → no_pool (decode happens after derive_pair).
|
||||
let amm = parse_program_id(&"00".repeat(32)).unwrap();
|
||||
let mut no_pool = base(token, other, String::new());
|
||||
no_pool.config = valid_config(amm);
|
||||
assert_eq!(sync_reserves_plan(no_pool), Err(String::from("no_pool")));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,7 +21,8 @@ pub use request::{
|
||||
CreatePoolPlanRequest, LiquidityQuoteRequest, PairIdsRequest, PoolIdRequest, ProgramIdRequest,
|
||||
RemoveLiquidityPlanRequest, RemoveLiquidityQuoteRequest, ResolvePoolRequest,
|
||||
SwapExactInPlanRequest, SwapExactInQuoteRequest, SwapExactOutPlanRequest,
|
||||
SwapExactOutQuoteRequest, SwapPairRequest, TokenHoldingsRequest, TokenIdsRequest,
|
||||
SwapExactOutQuoteRequest, SwapPairRequest, SyncReservesPlanRequest, TokenHoldingsRequest,
|
||||
TokenIdsRequest,
|
||||
};
|
||||
use serde_json::Value;
|
||||
|
||||
@@ -142,6 +143,10 @@ pub fn remove_liquidity_plan(request: RemoveLiquidityPlanRequest) -> AmmResult {
|
||||
liquidity::remove_liquidity_plan(request).map_err(Into::into)
|
||||
}
|
||||
|
||||
pub fn sync_reserves_plan(request: SyncReservesPlanRequest) -> AmmResult {
|
||||
liquidity::sync_reserves_plan(request).map_err(Into::into)
|
||||
}
|
||||
|
||||
/// Lists the wallet's fungible token holdings for the account selector.
|
||||
pub fn token_holdings(request: TokenHoldingsRequest) -> AmmResult {
|
||||
token_holdings::token_holdings(request).map_err(Into::into)
|
||||
|
||||
@@ -254,6 +254,23 @@ pub struct RemoveLiquidityPlanRequest {
|
||||
pub pool_data: String,
|
||||
}
|
||||
|
||||
/// Builds the `SyncReserves` submission — a permissionless keeper op refreshing the pool's
|
||||
/// stored reserves to the live vault balances (and its TWAP tick). No amounts / deadline /
|
||||
/// holdings: it is a unit instruction over pool-derived accounts. `pool_data` supplies the
|
||||
/// stored vault ids the guest asserts against.
|
||||
#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct SyncReservesPlanRequest {
|
||||
/// Resolved by the module from `AMM_PROGRAM_BIN` (like every id-deriving op).
|
||||
pub amm_program_id: String,
|
||||
/// AMM config account read — decoded by `derive_pair` for the `twap_oracle_program_id`
|
||||
/// the `current_tick` PDA depends on (same as the swap / liquidity plan requests).
|
||||
pub config: AccountRead,
|
||||
pub token_a_id: String,
|
||||
pub token_b_id: String,
|
||||
pub pool_data: String,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct TokenHoldingsRequest {
|
||||
|
||||
Reference in New Issue
Block a user