Relay

API Reference

SDK Reference

UI Kit

Try Relay

Support

Notify the backend in order to fetch the traces and detect any internal deposits

Transactions Index

The fastest and cheapest way to bridge & transact across chains

What is Relay?

Instant deposits and withdrawals using Relay

Instant Bridging

Execute cross-chain transactions via Relay

Cross-Chain Execution

Bridging

Swapping

How to implement Calling (executing crosschain transactions)

Calling

How to use just-in-time gas to execute cross-chain transactions

Just-In-Time Gas

Deep Linking

Relay Protocol

Reservoir's production grade relaying service

The Reservoir Relayer

How to make your contract compatible with Relay

Contract Compatibility

Fees

Refunds

Trade Types

Learn how Relay handles surpluses or shortages.

Surplus & Shortage

Supported Chains

Contract Addresses

Brand Assets

API Overview

Step Execution Overview

Handling Errors

This API returns all possible chains available.

Get Chains

This API returns solver capacity data & user data.

Get Config

This API returns current status of intent.

Get Execution Status

This API returns all the cross-chain transactions.

Get Requests

This API returns the price of a token on a specific chain.

Get Token Price

This api returns currency metadata from a curated list

Get Currencies

This API returns a lightweight quote without calldata or steps.

Get Price

This API returns an executable quote for swapping, bridging and calling

Get Quote

Pay for an action on one chain and perform one or more transactions on another chain.

Execute Call

Execute Bridge

Execute a swap on any currency pair on any supported chain.

Execute Swap

Getting Started

createClient

Method to get the relayer's solver capacity.

getSolverCapacity

Get a lightweight quote for a crosschain relay (bridge, swap, call, etc)

getPrice

Get a quote for a crosschain relay (bridge, swap, call, etc)

getQuote

Execute a quote and get updates on its progress

execute

Typescript API Typings Typescript Types that facilitate API interaction

Typescript API Typings

Overview

Installing and Configuring RelayKit Hooks

Fetch a lightweight quote to preview route pricing

usePrice

Fetch a quote and then execute it with this convenient hook

API Reference

Transactions Index

Body

Response