Skip to content

Overview

Rust-focused documentation for the Circles protocol, mirroring the original TypeScript SDK docs. Code samples use the Rust crates (circles-types, circles-pathfinder, circles-rpc, circles-profiles, and helpers).

Status: alpha, but no longer read-only. Querying, pathfinding, event decoding, transfer planning, invitation/referral planning, and native runner-backed writes are available today. Full TypeScript parity is still in progress, especially around browser-hosted execution and some service/auth polish.

  • What is Circles? Personal and group currencies on a trust graph.
  • Crates: types, pathfinding, RPC/query helpers, profiles, transfers, SDK, and runners.
  • Ready today: pathfinding, querying, event decoding, type-safe data structures, direct and path-based transfer planning, replenish flows, group-token mint/redeem planning, invitation/referral helpers, and native EOA / Safe execution.

See /circles-sdk for SDK structure and /reference for API details.