Installation

Install the GammaSwap V2 TypeScript SDK from npm.

npm install @gammaswap/v2-exchange-sdk

Requirements

• Node.js 20 or later

• An EVM-compatible wallet for signed exchange actions

• An RPC provider for deposits and other on-chain operations

• A WebSocket implementation when the runtime does not provide one

The SDK uses the global fetch and WebSocket implementations when they are available. Custom implementations can be supplied through the client constructors.

Ethers

Signed exchange actions and on-chain deposits use an ethers wallet.

If ethers is not already installed in your application, install it alongside the SDK:

npm install ethers

Node WebSocket support

The WebSocket clients use globalThis.WebSocket when the runtime provides it. In Node.js environments without a global WebSocket implementation, the SDK can use the ws package.

npm install ws

You can also provide a custom WebSocket constructor through WebSocketCtor.

Environment variables

A typical server-side integration may use the following environment variables:

EXCHANGE_API_URL=https://exchange-api.gammaswap.com/api
MARKET_WS_URL=wss://exchange-api.gammaswap.com/ws/
ORACLE_WS_URL=wss://exchange-api.gammaswap.com/oracle-ws/

CHAIN_ID=84532
RPC_URL=https://your-rpc-provider.example
PRIVATE_KEY=0x...

Never expose a private key in client-side code, committed source files, logs, or public environment configuration.

Verify the installation

Create a read-only client and request asset metadata:

import { createInfoClient } from "@gammaswap/v2-exchange-sdk";

const info = createInfoClient({
  apiUrl: "https://exchange-api.gammaswap.com/api",
});

const asset = await info.getAsset(
  "261336857817713630688382311349658711122006440411137",
);

console.log(asset);

InfoClient does not require a wallet because its methods only read public exchange data.

Local SDK development

The SDK repository uses:

• Node.js 20 or later

• pnpm 10 or later

These requirements apply when developing the SDK itself. Applications consuming the published npm package do not need to use pnpm.