Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryvo.network/llms.txt

Use this file to discover all available pages before exploring further.

This page is the fastest way to see the Ryvo protocol execute real settlements. It runs the committed devnet demo, which exercises every settlement path against the live deployment and produces the benchmark artifacts used throughout these docs. If you want the integration-level walkthrough instead, go to Your first payment.
1

Clone the protocol repository

git clone https://github.com/Ryvonetwork/ryvo-protocol.git
cd ryvo-protocol
npm install
2

Run the devnet demo

npm run demo:ryvo-protocol
This executes the committed end-to-end flow against the live devnet program:
  1. latest-commitment settlement
  2. bundle settlement
  3. single-payer cooperative clearing
  4. bilateral cooperative clearing
  5. the largest executable multilateral clearing round on devnet
The run writes a machine-readable manifest to config/ryvo-protocol-demo-last-run.json.
3

Generate benchmark artifacts (optional)

npm run benchmarks:generate
This combines the demo manifest with deterministic sizing scripts and refreshes the live and synthetic benchmark pages in this docs site.

​
Live devnet deployment

FieldValue
Program ID3UyUFeNsUYPpM6hMRf7H8wg3MKEXQ82rqnsXhZrUwgSD
Clusterdevnet
Message domaina58a109a38f14cc27ef174135176cab3
Gateway-channel settlement tokenOfficial devnet USDC, mint 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU; resolve token_id from TokenRegistry or RYVO_PROTOCOL_DEVNET_USDC_TOKEN_ID
The full reference is on the Deployment page.

​
Prerequisites

  • Node.js 18 or newer
  • Rust toolchain (only required if you want to rebuild the program)
  • Solana CLI
  • Anchor
If you only want to integrate against the live deployment, you do not need to rebuild the program. Build tools are only required when working inside the protocol repository itself.

​
Repository commands

From inside the protocol repo, these are the commands you will use most often: 
cargo fmt --check
cargo clippy --lib --features no-entrypoint -- -D warnings
anchor build
node ./node_modules/typescript/bin/tsc --noEmit
powershell -ExecutionPolicy Bypass -File scripts/test-local.ps1
The PowerShell script spins up a local validator, deploys the program, and runs the full Anchor test suite, useful on Windows + WSL developer machines.

​
Where to go next

Protocol overview

The on-chain objects, signed messages, and settlement paths.

Your first payment

Build the smallest useful Ryvo integration end-to-end.

Run the devnet demo

More detail on the demo script and what it produces.

Live benchmarks

See the compression ratios and explorer links this demo generates.

Agentic tools

Skills, CLI, MCP, and LLM text for agents integrating the protocol.