Installation - Gauntlet Docs

Install

pnpm add @gauntlet-xyz/sdk viem

npm install @gauntlet-xyz/sdk viem

yarn add @gauntlet-xyz/sdk viem

bun add @gauntlet-xyz/sdk viem

The SDK uses viem as a peer dependency. Install a compatible 2.x release in your application.

Requirements

Node.js 18+ or any modern JavaScript runtime (Bun, Deno)
TypeScript 5+ recommended
An RPC URL for each chain you want to interact with (e.g. Alchemy, Infura, or your own node)
A Gauntlet API key from the sign-up process
A Gauntlet builder code for attribution — request this alongside your API key from the Gauntlet partnerships team. Without it, deposits go through but volume is not attributed to your integration.

RPC URLs, PublicClient, and WalletClient are only needed for the transaction path. If you only read data through client.api, an API key is all the configuration required.

Peer Dependencies

The SDK communicates directly on-chain using your RPC URLs. It reads allowances, share prices, and vault state, then returns transaction objects you sign and submit through your own wallet infrastructure. You need a viem PublicClient and WalletClient in your application.

import { createPublicClient, createWalletClient, http } from 'viem'
import { base } from 'viem/chains'

const account = '0x0000000000000000000000000000000000000001' as const

const publicClient = createPublicClient({
  chain: base,
  transport: http(process.env.RPC_URL_BASE!),
})

const walletClient = createWalletClient({
  account,
  chain: base,
  transport: http(process.env.RPC_URL_BASE!),
})

All transaction and Aera quote APIs are available from either public entry point:

import {
  getAeraTokenModeSupport,
  getSyncWithdrawQuote,
  getWithdrawTx,
} from '@gauntlet-xyz/sdk'

// The same exports are also available from '@gauntlet-xyz/sdk/evm'.

Next Steps

Setup

Initialize the SDK and make your first deposit.

Reference

Full constructor, methods, result shape, and errors.