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.

Relayer ships five public packages on npm. Pick the ones that match what you’re building.

​
At a glance

PackageUse it whenDetail
@relayerfi/widget-kit-reactYou’re building a React app and want the prebuilt swap / transfer / bridge UIReact component library
@relayerfi/widget-kit-nativeSame, but for React NativeNative components
@relayerfi/widget-kit-coreYou’re building a custom widget for a framework that isn’t ReactFramework-agnostic core logic
@relayerfi/action-kitYou’re generating widget action metadata server-side or want to validate metadata schemasMetadata builder + validator
@relayerfi/agent-sdkYou’re running an AI agent that needs budget enforcement and x402 paymentsAgent runtime SDK

​
Widget Kit (React)

The prebuilt React widget for end-user swap, transfer, and bridge flows. Renders the UI, manages wagmi connectivity, and orchestrates signing in both Metadata Mode (user’s own wallet) and Passkey Signing Mode. 
npm install @relayerfi/widget-kit-react wagmi viem @tanstack/react-query framer-motion
See Widget Kit → Installation and Widget Kit → Integration for setup.

​
Widget Kit (Native)

The same UI patterns as Widget Kit (React) but for React Native — drop into your mobile app. 
npm install @relayerfi/widget-kit-native

​
Widget Kit (Core)

Framework-agnostic core logic shared by widget-kit-react and widget-kit-native. Use directly if you’re building a custom widget for Vue, Svelte, or any other framework that isn’t covered. 
npm install @relayerfi/widget-kit-core

​
Action Kit

TypeScript library for building and validating widget action metadata. Defines the action schema, validates payloads before submission, and provides template helpers for common parameter types (token amounts, chain selectors, recipient addresses). 
npm install @relayerfi/action-kit viem
See Widget Kit → SDK reference for the full API.

​
Agent SDK

The runtime SDK for AI agents you operate via Relayer. Handles three-layer budget enforcement (infra / tokens / payments), x402 payment execution, kill-switch polling, and event reporting. Mastra-compatible. 
npm install @relayerfi/agent-sdk
See Agent Kit → Getting Started and Agent Kit → SDK reference.

​
Source code

All packages are open source under the relayerfi GitHub organization:

Widget Kit packages

Mono-repo for @relayerfi/widget-kit-react, widget-kit-core, widget-kit-native, and action-kit.

Agent SDK

Source for @relayerfi/agent-sdk lives in packages/ of the Relayer monorepo.