Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.relayer.fi/llms.txt

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

This changelog covers API and platform changes from v1.0 onward. Changes are grouped by milestone. Breaking changes are marked with a warning.

​
v2.8 — Curated Widget Kit, Agent Kit GA, Exchange Kit removed

Released: 2026-05-15 The platform consolidates around four Kits — Signing, Agent, Payout, Widget — and ships Agent Kit as a first-class product.

​
Added

  • Agent Kit (/v1/agents/*) — Budget-enforced AI agents with USDC wallets on Solana and x402 payments. SDK: @relayerfi/agent-sdk.
  • Payout: On-ramp (/v1/payout/onramp/*) and Off-ramp (/v1/payout/offramp/*) — directional fiat ↔ stablecoin flows, formerly bundled in Accounts.
  • Payout: Orders (/v1/orders) — unified order tracking across all rails (list, get, cancel).
  • Signing - Passkeys and Signing - Recovery — explicit endpoints for WebAuthn registration and email-based recovery.
  • AI-ready docs — the documentation site exposes an MCP server at /mcp, an llms.txt index, and contextual deeplinks to ChatGPT / Claude / Cursor / VS Code.

​
Changed (breaking)

The Exchange Kit (/v1/exchange/*) has been removed entirely. Operators who used OTC quotes/trades should migrate to direct stablecoin → fiat flows via the Payout Kit.
Widget creation is now curated — the POST /v1/action, PATCH /v1/action/{id}, and POST /v1/action/widgets/swap endpoints are no longer publicly accessible. Use the four canonical builders (/v1/action/builders/{swap,transfer-native,crosschain-transfer,crosschain-bridge}) instead.
  • The legacy POST /v1/transactions/sign/transfer/{native,token} endpoints were removed. Use POST /v1/transactions/prepare + POST /v1/transactions/confirm (passkey-stamped) instead.
  • Workspace-management endpoints (/v1/integrators/*) are now INTERNAL scope — accessible from the dashboard only.

​
v2.0 — Routes, Roles, Modules & Permissions

Released: 2026-03-25 Role-based access control, dynamic sidebar, and team management. Introduced workspace-scoped permissions and multi-team support.

​
Added

  • RBAC guard — API endpoints are now protected by role-based access control. Requests require an API key with sufficient permissions for the target resource.
  • Dynamic sidebar — The dashboard sidebar is built from the workspace’s active modules and role permissions, not a static list.
  • Team management — Workspace owners can invite team members, assign roles (Admin, Manager, Viewer), and control module access per team.
  • Module permissions — Each Kit module can be enabled or disabled per workspace.
  • Route restructuring — All API routes are now under /v1/{kit}/{resource} with consistent naming across Kits.

​
Changed

  • Auth guard applied globally — previously some endpoints were unprotected.
  • Signing wallet endpoints moved from /v1/wallets to /v1/signing/wallets.

​
v1.2 — Platform Rename

Released: 2026-03-25 The platform was renamed from Sherry to Relayer. Repository, package, and API references updated.

​
Changed

  • sherry-api → relayer-api
  • sherry-dashboard → relayer-dashboard
  • Base production URL changed from https://api.sherry.fi to https://api.relayer.fi
  • npm packages renamed to @relayer/* namespace
If you were using https://api.sherry.fi, update your base URL to https://api.relayer.fi. Old URLs are not redirected.

​
v1.1 — Cleanup & Module Mapping

Released: 2026-03-25 Internal module paths cleaned up. No breaking changes to the external API.

​
Changed

  • Internal module structure reorganized: common/ → api/, shared/ → blockchain/
  • Action Kit split: GTM (go-to-market) logic separated from core Action Kit
  • Rewards endpoint moved to Action Kit from a standalone module

​
v1.0 — Kit Architecture

Released: 2026-03-21 Initial Kit-based architecture. The Relayer API is organized into purpose-built Kits, each covering a distinct domain.

​
Added

  • Signing Kit (/v1/signing/*, /v1/transactions/*) — Self-custodial wallets, transaction prepare/confirm, passkey-based signing
  • Payout Kit (/v1/payout/*, /v1/orders) — Fiat on/off-ramp rails, recipient management, settlement tracking
  • Agent Kit (/v1/agents/*) — Budget-enforced AI agents with USDC wallets and x402 payments
  • Widget Kit — Embeddable React components for canonical protocols (swap, transfer, crosschain)
  • Consistent API response envelope: { success, message, data, statusCode, timestamp, path }
  • API key authentication via Authorization: ApiKey <key> header