Set Up the Client

Create the client

import { AltudeGasStation } from '@altude/gasstation'

const gasStation = new AltudeGasStation({
  apiKey: process.env.ALTUDE_API_KEY!,
})

The API key is the only required runtime value. The selected cluster comes from the API key’s Altude configuration, so callers should not supply devnet, testnet, or mainnet-beta manually.

Initialize runtime configuration

const config = await gasStation.init()

console.log(config.RpcEnvironment)
console.log(config.FeePayer)
console.log(config.TokenExpiration)

init() requests GET /api/transaction/config with your API key. The response supplies:

Field	Description
`RpcUrl`	RPC node selected for the API key
`Token`	Short-lived JWT used to authorize RPC calls
`TokenExpiration`	JWT expiration time
`FeePayer`	Altude account that sponsors transaction fees
`RpcEnvironment`	Cluster selected for the API key

The SDK caches valid configuration and refreshes it near token expiration.

The API response is authoritative. Do not replace RpcUrl, Token, or FeePayer with public endpoints or hard-coded values.

Provide a signer

Transaction-building methods accept a GaslessTransactionSigner. The signer exposes its Solana address and signs transaction message bytes locally:

import type { GaslessTransactionSigner } from '@altude/gasstation'

const signer: GaslessTransactionSigner = {
  address: wallet.publicKey,
  async signTransactionMessage(messageBytes) {
    return wallet.signTransactionMessage(messageBytes)
  },
}

Adapt the method body to your wallet library. Private key material should never be sent to Altude.

Custom API base URL

Use baseUrl only when Altude provides a non-default API environment:

const gasStation = new AltudeGasStation({
  apiKey: process.env.ALTUDE_API_KEY!,
  baseUrl: 'https://api.example.altude.so',
})

Mock mode

Constructing the client without an API key enables local mock responses for selected HTTP methods. Live RPC operations require an API key and reject with RPC_ERROR when configuration cannot be resolved.

Get Started

Wallet Integrations

Get Started by SDK

Set Up the Client

Create the client

Initialize runtime configuration

Provide a signer

Custom API base URL

Mock mode

​Create the client

​Initialize runtime configuration

​Provide a signer

​Custom API base URL

​Mock mode

Create the client

Initialize runtime configuration

Provide a signer

Custom API base URL

Mock mode