AgentSkillsCN

simulation-service-tests

在本仓库（tycho-simulation-server）中运行、测试、基准测试、升级并部署 Tycho 模拟服务器。当您需要启动或停止服务、等待 /status 准备就绪、验证 /simulate 在众多代币对/池/协议（包括 Curve/Balancer 等虚拟机池）上的表现、计算 p50/p90/p99 延迟、运行负载/压力测试，或验证升级与部署（cargo fmt/clippy/test、docker build、CDK synth/diff/deploy）时，可使用此工具。

SKILL.md
--- frontmatter
name: simulation-service-tests
description: Run, test, benchmark, upgrade, and deploy the Tycho simulation server in this repo (tycho-simulation-server). Use when starting/stopping the service, waiting for /status readiness, validating /simulate across many token pairs/pools/protocols (including VM pools like curve/balancer), computing p50/p90/p99 latencies, running load/stress tests, or verifying upgrades and deployments (cargo fmt/clippy/test, docker build, CDK synth/diff/deploy).
metadata:
  short-description: Tycho simulation service tests

Simulation Service Tests

Quick start

  1. •Confirm the repo root (expect Cargo.toml and src/).
  2. •Ensure .env exists and contains TYCHO_API_KEY (avoid logging it). For manual health checks, use Authorization: <TYCHO_API_KEY> (no Bearer prefix).
  3. •Start the server (keeps a PID file in the repo root):
    bash
    cd /path/to/tycho-simulation-server
scripts/start_server.sh --repo .
  4. •Wait for readiness:
    bash
    scripts/wait_ready.sh --url http://localhost:3000/status
    • •If it stays warming_up, wait longer (3–5+ minutes on a cold start, longer with VM pools) or re-run with a higher --timeout.

One-shot end-to-end suite

Run start → wait_ready → smoke → coverage → latency:

bash
cd /path/to/tycho-simulation-server
scripts/run_suite.sh --repo . --suite core --stop

To include Curve/Balancer pools (VM feeds):

bash
scripts/run_suite.sh --repo . --suite core --enable-vm-pools --stop

If you need to tolerate partial failures or empty-liquidity responses while still running the suite:

bash
scripts/run_suite.sh --repo . --suite core --allow-partial --allow-no-liquidity --stop

Smoke test /simulate

  • •Use the curated presets (supports many mainnet tokens + suites).
  • •Remember: /simulate returns 200 OK even on partial failure; use meta.status / meta.failures.

Examples:

bash
python3 scripts/simulate_smoke.py --suite smoke
python3 scripts/simulate_smoke.py --pair DAI:USDC --pair WETH:USDC
python3 scripts/simulate_smoke.py --list-tokens

For stricter checks (fail on empty data and validate pool entries):

bash
python3 scripts/simulate_smoke.py --suite smoke --require-data --validate-data

Allow partial responses explicitly:

bash
python3 scripts/simulate_smoke.py --suite smoke --allow-status ready,partial_failure --allow-failures

Smoke test /encode

  • •/encode follows the latest schema (singleSwap-only execution).
  • •The smoke test performs two /simulate calls to pick pools, then posts a 2-hop route.
  • •Default addresses can be overridden via .env (COW_SETTLEMENT_CONTRACT, TYCHO_ROUTER_ADDRESS).

Examples:

bash
python3 scripts/encode_smoke.py --encode-url http://localhost:3000/encode --simulate-url http://localhost:3000/simulate --repo .
bash
python3 scripts/encode_smoke.py --allow-status ready,partial_failure --allow-failures --verbose

Pool/protocol coverage sweeps

coverage_sweep.py runs a suite of pairs and reports which protocols/pools appear in responses:

bash
python3 scripts/coverage_sweep.py --suite core --out logs/coverage_sweep.json
python3 scripts/coverage_sweep.py --suite v4_candidates

If you need Curve/Balancer coverage, start the server with ENABLE_VM_POOLS=true (see references/protocols.md).

To assert specific protocol presence (derived from pool_name prefixes), use:

bash
python3 scripts/coverage_sweep.py --suite core --expect-protocols uniswap_v3,uniswap_v4

Allow no_liquidity responses with only no_pools failures:

bash
python3 scripts/coverage_sweep.py --suite core --allow-no-pools

Latency percentiles (p50/p90/p99)

latency_percentiles.py measures only “good” responses by default (meta.status=ready, no meta.failures):

bash
python3 scripts/latency_percentiles.py --suite core --requests 300 --concurrency 50

Load / stress testing

  • •Prefer the repo suite + percentile runner:
    • •scripts/run_suite.sh --repo . --suite core (smoke + coverage + p50/p90/p99)
    • •python3 scripts/latency_percentiles.py --requests 2000 --concurrency 50 --suite core (heavier load)
  • •See STRESS_TEST_README.md for defaults and knobs (LATENCY_REQUESTS, LATENCY_CONCURRENCY, LATENCY_CONCURRENCY_VM).

Maintenance checks

Run a CI-like pass:

bash
zsh skills/simulation-service-tests/scripts/run_checks.zsh --repo /path/to/tycho-simulation-server

Memory tracking (jemalloc)

  1. •Run the ignored harnesses and record the output lines in .codex/memory-task/service-memory-tracking.md:
    bash
    cargo test --test integration protocol_reset_memory::memory_spike_breakdown_harness -- --ignored --nocapture
cargo test --test integration protocol_reset_memory::shared_db_rebuild_stress_harness -- --ignored --nocapture
  2. •Append a diff table based on the latest memory_breakdown line:
    bash
    python3 skills/simulation-service-tests/scripts/memory_diff.py --repo /path/to/tycho-simulation-server

Upgrade workflow (typical)

  1. •Bump tycho-simulation tag/version (or other deps).
  2. •Run: cargo fmt, cargo clippy ..., cargo test, cargo build --release.
  3. •Run the end-to-end suite (run_suite.zsh) with and without VM pools.
  4. •If infra changes are involved: npm ci, npx cdk synth, npx cdk diff.

Deploy workflow (CDK + Docker)

See references/deploy.md.

Included scripts

  • •Repo (source of truth): scripts/start_server.sh, scripts/stop_server.sh, scripts/wait_ready.sh, scripts/run_suite.sh, plus the Python runners in scripts/.
  • •Skill utilities: scripts/run_checks.zsh (CI-like cargo fmt/clippy/test/build + optional cdk synth/docker build).

References

  • •references/project.md – repo commands, endpoints, and stress-test details.
  • •references/encode.md – /encode schema and smoke-testing notes.
  • •references/protocols.md – which exchanges/protocol feeds this server subscribes to (and how to test them).
  • •references/tycho-deps.md – Tycho/Propeller Heads context and docs.
  • •references/upgrade.md – checklist for dependency upgrades.
  • •references/deploy.md – CDK + Docker deployment notes.