Getting Started

Installation

Install the Relay SDK and its peer dependency viem

yarn add @reservoir0x/relay-sdk viem

npm install --save @reservoir0x/relay-sdk viem

pnpm add @reservoir0x/relay-sdk viem

bun add @reservoir0x/relay-sdk viem

Environment Requirements:

node 18+ typescript ^5.0.4 (if using typescript)

Configuration

To configure the SDK we first need to create a global instance of it:

import { createClient, convertViemChainToRelayChain, MAINNET_RELAY_API, TESTNET_RELAY_API } from '@reservoir0x/relay-sdk'
import { mainnet } from 'viem/chains'

createClient({
  baseApiUrl: MAINNET_RELAY_API,
  source: "YOUR.SOURCE",
  chains: [convertViemChainToRelayChain(mainnet)]
});

You can replace the baseApiUrl with TESTNET_RELAY_API when testing with testnets. In the example above we also pass in an array of RelayChains converted from a viem chain, the sdk exports a function (convertViemChainToRelayChain) to easily do this. Learn more about the createClient options.

​Installation

​Environment Requirements:

​Configuration

Installation

Environment Requirements:

Configuration