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.

The Relayer SDK (@relayerfi/action-kit) is the TypeScript library for building blockchain action metadata. It defines the action schema, validates metadata before submission, and provides template helpers for common parameter types. Use it to create the metadata object that powers a Relayer Trigger.
The Relayer SDK metadata layer is mode-agnostic. Whether your integration uses Passkey Signing (passkey) or Metadata Mode (bring your own wallet), the metadata schema and validation are identical. The SDK defines what action to perform — the integration mode determines how signing happens.

​
Install

npm install @relayerfi/action-kit viem
viem is a required peer dependency.

​
Core Concepts

  • Blockchain action metadata is a typed Metadata object with url, icon, title, description, and an actions array.
  • Each action in the array is one of: transfer, blockchain, http, dynamic, or a nested flow.
  • Call createMetadata(metadata) to validate and process the metadata. It throws if the input is invalid.
  • Call validateMetadata(metadata) for non-throwing validation that returns a detailed result object with an errors array.

​
Action Types

TypePurposeKey Fields
transferSend native tokens to an addressto, amount, chains
blockchainCall a smart contract functionaddress, abi, functionName, params
httpPOST to a REST endpoint for server-side logicpath, params
dynamicAdvanced server-side processing with external servicesurl, params
flowMulti-step interactive experience with conditional branchingsteps, decisions

​
Quick Start — Transfer Action

import { createMetadata, type Metadata } from '@relayerfi/action-kit';

const metadata: Metadata = {
  url: 'https://myapp.example',
  icon: 'https://example.com/icon.png',
  title: 'Send AVAX',
  description: 'Transfer 0.1 AVAX instantly',
  actions: [
    {
      type: 'transfer',
      label: 'Send 0.1 AVAX',
      description: 'Transfer 0.1 AVAX to recipient',
      to: '0x1234567890123456789012345678901234567890',
      amount: 0.1,
      chains: { source: 43114 }, // Avalanche C-Chain
    },
  ],
};

const validatedMetadata = createMetadata(metadata);

​
Quick Start — Blockchain Action

import { createMetadata, type Metadata } from '@relayerfi/action-kit';

const metadata: Metadata = {
  url: 'https://myapp.example',
  icon: 'https://example.com/icon.png',
  title: 'Approve USDC',
  description: 'Approve contract to spend USDC',
  actions: [
    {
      type: 'blockchain',
      label: 'Approve',
      address: '0xA0b86a33E6417C8D7648D5b1D6fF0F6dB6c15b2a',
      abi: [/* contract ABI */],
      functionName: 'approve',
      chains: { source: 1 }, // Ethereum Mainnet
      params: [
        { name: 'spender', type: 'address', value: '0xSpenderAddress', fixed: true },
        { name: 'amount', type: 'number', label: 'Amount', required: true },
      ],
    },
  ],
};

const validatedMetadata = createMetadata(metadata);

​
Validation

Use validateMetadata for non-throwing validation with detailed error reporting: 
import { validateMetadata } from '@relayerfi/action-kit';

const result = validateMetadata(metadata);

if (result.isValid) {
  console.log('Valid:', result.type);
} else {
  console.error('Errors:', result.errors);
}

​
Parameter Templates

PARAM_TEMPLATES provides predefined parameter shapes (email, token select, etc.) so you do not have to hand-craft common parameter structures: 
import { createParameter, PARAM_TEMPLATES } from '@relayerfi/action-kit';

const tokenParam = createParameter(PARAM_TEMPLATES.TOKEN_SELECT, {
  name: 'token',
  label: 'Select Token',
  options: [
    { label: 'USDC', value: 'usdc' },
    { label: 'DAI', value: 'dai' },
  ],
});

​
Supported Chains

ChainChain ID
Ethereum Mainnet1
Ethereum Sepolia11155111
Avalanche C-Chain43114
Avalanche Fuji43113
Celo Mainnet42220
Base Mainnet8453
Base Sepolia84532
Mantle Mainnet5000

​
API Reference

ExportTypePurpose
createMetadata(metadata)functionValidate and process metadata; throws on error
validateMetadata(input)functionNon-throwing validation with errors array
isBlockchainActionMetadata(action)type guardNarrow action type to blockchain
isTransferAction(action)type guardNarrow action type to transfer
isHttpAction(action)type guardNarrow action type to http
isActionFlow(obj)type guardNarrow to nested flow
PARAM_TEMPLATESconstantLibrary of predefined parameter shapes
createParameter(template, overrides)functionCreate a parameter from a template

​
Debug Your Trigger

Use the Relayer Debugger to test and preview blockchain action metadata before embedding. Paste your metadata JSON or URL and see the rendered Trigger in real time.

​
Next Steps

Integration Guide

Embed the Trigger component in your app.

Action Kit

Register and publish blockchain actions via the Relayer API.