Relay

https://docs.relay.link/
Admin
Relay is a multichain payments network designed for fast and cheap cross-chain bridging, swapping,...
Tokens:342,232
Snippets:2,214
Trust Score:8.7
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Install Relay Docs MCP Server via CLI

Source: https://docs.relay.link/resources/developing-with-ai

Run this command to manually install the Relay docs MCP server. After installation, start the server with the npm start command.

```bash
npx @mintlify/mcp add docs.relay.link
```

```bash
npm --prefix ~/.mcp/docs.relay.link start
```

--------------------------------

### Install the Relay settlement SDK

Source: https://docs.relay.link/references/api/api_core_concepts/input-validation

Install the @relay-protocol/settlement-sdk package via npm. This is a prerequisite for the subsequent code examples.

```bash
npm install @relay-protocol/settlement-sdk
```

--------------------------------

### Fast Fill flow using Relay SDK

Source: https://docs.relay.link/features/fast-fill

Complete example of the fast fill flow: setup wallet, initialize Relay client, get a quote, execute the quote, and call fastFill immediately after transaction submission. Requires @relayprotocol/relay-sdk and viem. The fastFill call is made before waiting for confirmation, and a hold is placed on the app balance until the deposit is indexed.

```typescript
import { getClient, createClient } from "@relayprotocol/relay-sdk";
import { createWalletClient, createPublicClient, http } from "viem";
import { base } from "viem/chains";

// 1. Setup Wallet - Initialize your wallet using your preferred method
const account = {}; // Your wallet account (e.g., privateKeyToAccount, or injected wallet)
const wallet = createWalletClient({
  account,
  chain: base,
  transport: http(),
});

const publicClient = createPublicClient({
  chain: base,
  transport: http(),
});

// 2. Initialize the Relay client
createClient({
  baseApiUrl: "https://api.relay.link",
  source: "YOUR_APP_NAME",
});

// 3. Get a quote using the SDK
const quote = await getClient().actions.getQuote({
  chainId: 8453, // Base
  toChainId: 42161, // Arbitrum
  currency: "0x0000000000000000000000000000000000000000", // ETH
  toCurrency: "0x0000000000000000000000000000000000000000", // ETH
  amount: "100000000000000", // 0.0001 ETH
  tradeType: "EXACT_INPUT",
  wallet,
});

const requestId = quote.steps[0].requestId;
console.log(`Request ID: ${requestId}`);

// 4. Execute the quote and fast fill once the transaction is submitted
let txHash: string;

await getClient().actions.execute({
  quote,
  wallet,
  onProgress: async ({ currentStep, currentStepItem, txHashes }) => {
    // Once transaction is submitted, trigger fast fill immediately
    if (txHashes && txHashes.length > 0 && !txHash) {
      txHash = txHashes[0];
      console.log(`Transaction submitted: ${txHash}`);

      // 5. Call Fast Fill immediately after submitting (before waiting for confirmation)
      const fastFillResult = await getClient().actions.fastFill({
        requestId,
      });
      console.log("Fast fill initiated:", fastFillResult);
    }

    // Monitor progress
    if (currentStep && currentStepItem) {
      console.log(`Step: ${currentStep.action}, Status: ${currentStepItem.status}`);
    }
  },
});

console.log("Bridge completed successfully!");
```

--------------------------------

### Use adaptLighterWallet with viem wallet client

Source: https://docs.relay.link/references/relay-kit/sdk/adapters

Adapts an EVM wallet for Lighter deposits. Requires the user's connected EVM address and a signMessage callback. The example creates a viem wallet client, gets the address, adapts it, then gets a quote and executes.

```typescript
import { getClient, getQuote } from '@relayprotocol/relay-sdk'
import { adaptLighterWallet } from '@relayprotocol/relay-lighter-wallet-adapter'
import { createWalletClient, custom } from 'viem'
import { mainnet } from 'viem/chains'

// Lighter deposits are authorized by an L1 (EVM) signature, so the adapter
// only needs the user's connected EVM address and a signMessage callback.
const walletClient = createWalletClient({
  chain: mainnet,
  transport: custom(window.ethereum!)
})

const [address] = await walletClient.requestAddresses()

const adaptedWallet = adaptLighterWallet({
  l1Address: address,
  signL1Message: (message) =>
    walletClient.signMessage({ account: address, message })
})

const options = ... // define this based on getQuote options (destinationChainId: 3586256, recipient: <Lighter account index>)

const quote = await getClient().actions.getQuote(options)

getClient().actions.execute({
  quote,
  wallet: adaptedWallet,
  onProgress: ({ steps, fees, breakdown, currentStep, currentStepItem, txHashes, details }) => {
    // custom handling
  }
})
```

--------------------------------

### Install Relay SDK with bun

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and viem using bun.

```bash
bun add @relayprotocol/relay-sdk viem 
```

--------------------------------

### Install Relay SDK with npm

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and viem using npm.

```bash
npm install --save @relayprotocol/relay-sdk viem 
```

--------------------------------

### Example Get Quote V2 Response

Source: https://docs.relay.link/references/api/get-quote-v2

Example JSON response from the Get Quote V2 endpoint. Shows a transaction step with an incomplete status, including the transaction data, fee parameters, and a status check endpoint.

```json
[
  {
    "id": "deposit",
    "action": "Confirm transaction in your wallet",
    "description": "Depositing funds to the relayer to execute the swap for USDC",
    "kind": "transaction",
    "requestId": "0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
    "items": [
      {
        "status": "incomplete",
        "data": {
          "from": "0x0CccD55A5Ac261Ea29136831eeaA93bfE07f5Db6",
          "to": "0xf70da97812cb96acdf810712aa562db8dfa3dbef",
          "data": "0x00fad611",
          "value": "1000000000000000000",
          "maxFeePerGas": "12205661344",
          "maxPriorityFeePerGas": "2037863396",
          "chainId": 1
        },
        "check": {
          "endpoint": "/intents/status?requestId=0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
          "method": "GET"
        }
      }
    ]
  }
]
```

--------------------------------

### Install Relay SDK with yarn

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and viem using yarn.

```bash
yarn add @relayprotocol/relay-sdk viem 
```

--------------------------------

### cURL request to get swap sources

Source: https://docs.relay.link/references/api/get-swap-sources

Sends a GET request to the swap-sources endpoint using cURL. No authentication is required for this example.

```bash
curl --request GET \
  --url https://api.relay.link/swap-sources
```

--------------------------------

### Example: All Tokens Supported

Source: https://docs.relay.link/references/api/api_resources/supported-routes

Shows a JSON response where tokenSupport is 'All', indicating that routes involving this chain are supported for tokens where Solver or DEX liquidity is available. The example includes chain details and a list of ERC20 currencies with their properties.

```json
{
  "chains": [
        {
            "id": 10,
            "name": "optimism",
            "displayName": "Optimism",
            "tokenSupport": "All",
            "currency": {
                "id": "eth",
                "symbol": "ETH",
                "name": "Ether",
                "address": "0x0000000000000000000000000000000000000000",
                "decimals": 18,
                "supportsBridging": true
            },
            "erc20Currencies": [
                {
                    "id": "wbtc",
                    "symbol": "WBTC",
                    "name": "Wrapped BTC",
                    "address": "0x68f180fcce6836688e9084f035309e29bf0a2095",
                    "decimals": 8,
                    "supportsBridging": false,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                },
                {
                    "id": "usdt",
                    "symbol": "USDT",
                    "name": "Tether USD",
                    "address": "0x94b008aa00579c1307b0ef2c499ad98a8ce58e58",
                    "decimals": 6,
                    "supportsBridging": true,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                },
                {
                    "id": "dai",
                    "symbol": "DAI",
                    "name": "Dai Stablecoin",
                    "address": "0xda10009cbd5d07dd0cecc66161fc93d7c9000da1",
                    "decimals": 18,
                    "supportsBridging": false,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                },
                {
                    "id": "usdc",
                    "symbol": "USDC",
                    "name": "USD Coin",
                    "address": "0x0b2c639c533813f4aa9d7837caf62653d097ff85",
                    "decimals": 6,
                    "supportsBridging": true,
                    "supportsPermit": true,
                    "withdrawalFee": 0,
                    "depositFee": 0,
                    "surgeEnabled": false
                }
            ]
        }
  ]
}
```

--------------------------------

### Install Relay SDK with pnpm

Source: https://docs.relay.link/references/relay-kit/sdk/installation

Install the Relay SDK and viem using pnpm.

```bash
pnpm add @relayprotocol/relay-sdk viem 
```

--------------------------------

### Python requests GET /intents/status/v3

Source: https://docs.relay.link/references/api/get-intents-status-v3

Example Python code using the requests library to call the Get Status endpoint and print the response text.

```python
import requests

url = "https://api.relay.link/intents/status/v3"

response = requests.get(url)

print(response.text)
```

--------------------------------

### JavaScript fetch GET /intents/status/v3

Source: https://docs.relay.link/references/api/get-intents-status-v3

Example JavaScript code using fetch to call the Get Status endpoint. Logs the JSON response or error.

```javascript
const options = {method: 'GET'};

fetch('https://api.relay.link/intents/status/v3', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Install RelayKit UI with bun

Source: https://docs.relay.link/references/relay-kit/ui/installation

Install the required packages using bun: viem, wagmi, @tanstack/react-query, and @relayprotocol/relay-kit-ui.

```bash
bun add viem wagmi @tanstack/react-query @relayprotocol/relay-kit-ui 
```

--------------------------------

### 200 response example for GET /requests/v3

Source: https://docs.relay.link/references/api/get-requests

Example 200 response body showing the structure of the returned requests array. Fields are placeholders such as <string> and <unknown>.

```json
{
  "requests": [
    {
      "id": "<string>",
      "status": "refund",
      "user": "<string>",
      "recipient": "<string>",
      "sender": "<string>",
      "refundTo": "<string>",
      "supersededByRequestId": "<string>",
      "duplicateDeposits": {
        "parentRequestId": "<string>",
        "refundRequestIds": [
          "<string>"
        ]
      },
      "depositAddress": {
        "address": "<string>",
        "type": "strict",
        "depositor": "<string>",
        "depositTxHash": "<string>",
        "recoveryAddress": "<string>"
      },
      "data": {
        "claimStatus": "unclaimed",
        "slippageTolerance": "<string>",
        "failReason": "UNKNOWN",
        "refundFailReason": "AMOUNT_TOO_LOW_TO_REFUND",
        "failedTxHash": "<string>",
        "failedTxBlockNumber": 123,
        "failedCallData": {
          "from": "<string>",
          "to": "<string>",
          "data": "<string>",
          "value": "<string>"
        },
        "usesExternalLiquidity": true,
        "timeEstimate": 123,
        "triggeredByFastFill": true,
        "inTxs": [
          {
            "txHash": "<string>",
            "fee": "<string>",
            "feeUsd": "<string>",
            "block": 123,
            "type": "<string>",
            "chainId": 123,
            "timestamp": 123,
            "status": "success",
            "data": "<unknown>",
            "stateChanges": "<unknown>"
          }
        ],
        "outTxs": [
          {
            "txHash": "<string>",
            "fee": "<string>",
            "feeUsd": "<string>",
            "block": 123,
            "type": "<string>",
            "chainId": 123,
            "timestamp": 123,
            "status": "success",
            "data": "<unknown>",
            "stateChanges": "<unknown>"
          }
        ],
        "appFees": {
          "quoted": [
            {
              "recipient": "<string>",
              "bps": "<string>",
              "amount": "<string>",
              "amountFormatted": "<string>"
            }
          ],
          "actual": [
            {
              "recipient": "<string>",
              "bps": "<string>",
              "amount": "<string>",
              "amountFormatted": "<string>",
              "amountUsd": "<string>"
            }
          ],
          "currency": {
            "chainId": 123,
            "address": "<string>",
            "symbol": "<string>",
            "name": "<string>",
            "decimals": 123,
            "metadata": {
              "logoURI": "<string>",
              "verified": true,
              "isNative": true
            }
          }
        },
        "feeSponsorship": {
          "quoted": {
            "selectedComponents": [
              "execution"
            ],
            "capHit": true,
            "components": {
              "execution": {
                "selected": true,
                "total": {
                  "amount": "<string>",
                  "amountFormatted": "<string>",
                  "amountUsd": "<string>",
                  "minimumAmount": "<string>"
                },
                "sponsored": {
                  "amount": "<string>",
                  "amountFormatted": "<string>",
                  "amountUsd": "<string>",
                  "minimumAmount": "<string>"
                },
                "userPays": {
                  "amount": "<string>",
                  "amountFormatted": "<string>",
                  "amountUsd": "<string>",
                  "minimumAmount": "<string>"
                }
              },
              "swap": {
                "selected": true,
                "total": {
                  "amount": "<string>",
                  "amountFormatted": "<string>",
                  "amountUsd": "<string>",
                  "minimumAmount": "<string>"
                },
                "sponsored": {
                  "amount": "<string>",
                  "amountFormatted": "<string>",
                  "amountUsd": "<string>",
                  "minimumAmount": "<string>"
                },
                "userPays": {
                  "amount": "<string>",
                  "amountFormatted": "<string>",
                  "amountUsd": "<string>",
                  "minimumAmount": "<string>"
                }
              }
            }
          }
        }
      }
    }
  ]
}
```

--------------------------------

### Example: All Tokens Supported

Source: https://docs.relay.link/references/api/api_resources/supported-routes

Example response showing a chain with tokenSupport set to 'All', meaning routes involving this chain are supported for tokens where Solver or DEX liquidity is available.

```APIDOC
## Example: All Tokens Supported

### Description
Example response showing a chain with `tokenSupport` set to `"All"`, meaning routes involving this chain are supported for tokens where Solver or DEX liquidity is available.

### Response Example
```json
{
  "chains": [
    {
      "id": 10,
      "name": "optimism",
      "displayName": "Optimism",
      "tokenSupport": "All",
      "currency": {
        "id": "eth",
        "symbol": "ETH",
        "name": "Ether",
        "address": "0x0000000000000000000000000000000000000000",
        "decimals": 18,
        "supportsBridging": true
      },
      "erc20Currencies": [
        {
          "id": "wbtc",
          "symbol": "WBTC",
          "name": "Wrapped BTC",
          "address": "0x68f180fcce6836688e9084f035309e29bf0a2095",
          "decimals": 8,
          "supportsBridging": false,
          "withdrawalFee": 0,
          "depositFee": 0,
          "surgeEnabled": false
        },
        {
          "id": "usdt",
          "symbol": "USDT",
          "name": "Tether USD",
          "address": "0x94b008aa00579c1307b0ef2c499ad98a8ce58e58",
          "decimals": 6,
          "supportsBridging": true,
          "withdrawalFee": 0,
          "depositFee": 0,
          "surgeEnabled": false
        },
        {
          "id": "dai",
          "symbol": "DAI",
          "name": "Dai Stablecoin",
          "address": "0xda10009cbd5d07dd0cecc66161fc93d7c9000da1",
          "decimals": 18,
          "supportsBridging": false,
          "withdrawalFee": 0,
          "depositFee": 0,
          "surgeEnabled": false
        },
        {
          "id": "usdc",
          "symbol": "USDC",
          "name": "USD Coin",
          "address": "0x0b2c639c533813f4aa9d7837caf62653d097ff85",
          "decimals": 6,
          "supportsBridging": true,
          "supportsPermit": true,
          "withdrawalFee": 0,
          "depositFee": 0,
          "surgeEnabled": false
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Install Lighter SDK for Adapter Bootstrap

Source: https://docs.relay.link/references/api/api_guides/lighter-support

Install the Lighter SDK if you want the adapter to run its own bootstrap (fresh keygen, accountApiKey, or storage paths).

```bash
yarn add @relay-protocol/lighter-ts-sdk
```

--------------------------------

### cURL request to get usage metrics

Source: https://docs.relay.link/references/api/get-usage

Sends a GET request to the Relay Link usage metrics endpoint using cURL. No authentication headers are shown in this example.

```bash
curl --request GET \
  --url https://api.relay.link/metrics/usage
```

--------------------------------

### SDK Installation

Source: https://docs.relay.link/references/api/api_guides/lighter-support

Installation commands for the Relay SDK with the Lighter wallet adapter and optional Lighter SDK.

```APIDOC
## SDK Installation

### Description
Install the required packages to use the Relay SDK with Lighter.

### Command
```bash
yarn add @relayprotocol/relay-lighter-wallet-adapter @relayprotocol/relay-sdk viem
```

### Optional Lighter SDK
If you want the adapter to run its own bootstrap (fresh keygen, `accountApiKey`, or `storage` paths), you also need the Lighter SDK:

```bash
yarn add @relay-protocol/lighter-ts-sdk
```
```

--------------------------------

### cURL request to Get Price

Source: https://docs.relay.link/references/api/get-price

Example cURL command to call the Get Price endpoint. It sends a POST request to https://api.relay.link/price with a JSON body containing the required fields.

```bash
curl --request POST \
  --url https://api.relay.link/price \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "<string>",
  "originChainId": 123,
  "destinationChainId": 123,
  "originCurrency": "<string>",
  "destinationCurrency": "<string>",
  "amount": "<string>"
}
'
```

--------------------------------

### Install RelayKit UI with yarn

Source: https://docs.relay.link/references/relay-kit/ui/installation

Install the required packages using yarn: viem, wagmi, @tanstack/react-query, and @relayprotocol/relay-kit-ui.

```bash
yarn add viem wagmi @tanstack/react-query @relayprotocol/relay-kit-ui 
```

--------------------------------

### Install RelayKit UI with npm

Source: https://docs.relay.link/references/relay-kit/ui/installation

Install the required packages using npm: viem, wagmi, @tanstack/react-query, and @relayprotocol/relay-kit-ui.

```bash
npm install viem wagmi @tanstack/react-query @relayprotocol/relay-kit-ui 
```

--------------------------------

### Get App Fee Balances - JSON response

Source: https://docs.relay.link/features/fast-fill

Example response from the Get App Fee Balances API showing the balance details, including currency, amount, and minimum amount.

```json
{
  "currency": {
    "chainId": 8453,
    "address": "0x0000000000000000000000000000000000000000",
    "symbol": "USDC",
    "name": "USDC",
    "decimals": 6
  },
  "amount": "75021651210714015",
  "amountFormatted": "0.075021651210714015",
  "amountUsd": "116.235557",
  "minimumAmount": "75021651210714015"
}
```

--------------------------------

### Install ws package

Source: https://docs.relay.link/references/api/api_guides/websockets

Install the 'ws' WebSocket library for Node.js.

```bash
npm install ws
```

--------------------------------

### Python requests request to Get Price

Source: https://docs.relay.link/references/api/get-price

Example using the requests library in Python to call the Get Price endpoint. It sends a POST request with a JSON payload and prints the response text.

```python
import requests

url = "https://api.relay.link/price"

payload = {
    "user": "<string>",
    "originChainId": 123,
    "destinationChainId": 123,
    "originCurrency": "<string>",
    "destinationCurrency": "<string>",
    "amount": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

--------------------------------

### Install Relay Lighter Wallet Adapter and Dependencies

Source: https://docs.relay.link/references/api/api_guides/lighter-support

Install the required packages for using the Relay SDK with Lighter: the wallet adapter, the Relay SDK, and viem.

```bash
yarn add @relayprotocol/relay-lighter-wallet-adapter @relayprotocol/relay-sdk viem
```

--------------------------------

### JavaScript fetch request to Get Price

Source: https://docs.relay.link/references/api/get-price

Example using the fetch API in JavaScript to call the Get Price endpoint. It sends a POST request with a JSON body and logs the response or error.

```javascript
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    user: '<string>',
    originChainId: 123,
    destinationChainId: 123,
    originCurrency: '<string>',
    destinationCurrency: '<string>',
    amount: '<string>'
  })
};

fetch('https://api.relay.link/price', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Example 200 response for get withdrawal status

Source: https://docs.relay.link/references/api/get-withdrawal-status

Example JSON response returned by the endpoint. The status field indicates the withdrawal status, and transaction contains the transaction to broadcast when status is 'ready'.

```json
{
  "status": "<string>",
  "transaction": {},
  "withdrawal": {},
  "txHash": "<string>",
  "reason": "<string>"
}
```
Tokens:
Raw