Configuration

DecibelConfig

network: Aptos network identifier
fullnodeUrl: Aptos fullnode HTTP endpoint
tradingHttpUrl: Decibel trading REST base URL
tradingWsUrl: Decibel trading WebSocket URL
gasStationUrl: Base URL override for the Gas Station API (only needed for custom networks)
gasStationApiKey: Geomi Gas Station API key for sponsored transactions
gasStationAddress: on-chain fee-payer address of that Gas Station; only required for encrypted submission
deployment: on-chain package and addresses (package, predepositPackage, campaignPackage, usdc, testc, perpEngineGlobal, dlpVault, dlpShare; fftCampaignAddr optional)
chainId: optional preconfigured chain id to accelerate build/sign

Custom config example

import { type DecibelConfig } from "@decibeltrade/sdk";
import { Network } from "@aptos-labs/ts-sdk";

const CUSTOM: DecibelConfig = {
  network: Network.CUSTOM,
  fullnodeUrl: "https://fullnode.example.com/v1",
  tradingHttpUrl: "https://api.example.com/decibel",
  tradingWsUrl: "wss://api.example.com/decibel/ws",
  gasStationUrl: "https://api.example.com/gs/v1", // optional: enables gas sponsorship
  gasStationApiKey: process.env.GAS_STATION_API_KEY, // optional: enables gas sponsorship
  deployment: {
    package: "0x...package",
    predepositPackage: "0x...predeposit",
    campaignPackage: "0x...campaign",
    usdc: "0x...usdc",
    testc: "0x...testc",
    perpEngineGlobal: "0x...global",
    dlpVault: "0x...dlpVault",
    dlpShare: "0x...dlpShare",
  },
  chainId: 204, // optional
};

Gas Station (Sponsored Transactions)

To sponsor gas fees for your users via Geomi Gas Station, add gasStationApiKey to your config:

const config = {
  ...TESTNET_CONFIG,
  gasStationApiKey: process.env.GAS_STATION_API_KEY!,
};

const write = new DecibelWriteDex(config, account);

When gasStationApiKey is set, the SDK automatically submits all transactions through the Gas Station for fee sponsorship. Users don’t need APT for gas. To disable sponsorship, simply omit gasStationApiKey from the config.

Encrypted submission

Pass defaultEncrypted: true to DecibelWriteDex to submit front-run-sensitive writes as encrypted pending transactions. The flag is exposed as a readonly property on the instance, and submission still downgrades to plaintext when the fullnode exposes no encryption key. An encrypted transaction bakes the literal fee-payer address into its payload at build time, so a Gas Station can only sponsor one when gasStationAddress is also set. Use configSupportsEncryptedSubmission(config) to check that before promising the user encryption:

import { configSupportsEncryptedSubmission } from "@decibeltrade/sdk";

const config = {
  ...TESTNET_CONFIG,
  gasStationApiKey: process.env.GAS_STATION_API_KEY!,
  gasStationAddress: process.env.GAS_STATION_ADDRESS!, // omit this and writes go out in plaintext
};

const write = new DecibelWriteDex(config, account, {
  defaultEncrypted: configSupportsEncryptedSubmission(config),
});

Node API keys

Pass nodeApiKey to DecibelReadDex or DecibelWriteDex for fullnode rate limits and performance.
Under the hood, the SDK sends it as Authorization: Bearer <YOUR_NODE_API_KEY> on outbound HTTP requests:

const read = new DecibelReadDex(TESTNET_CONFIG, {
  nodeApiKey: process.env.APTOS_NODE_API_KEY!, // Required
});
const write = new DecibelWriteDex(TESTNET_CONFIG, account, {
  nodeApiKey: process.env.APTOS_NODE_API_KEY!, // Required
});

Quick Start

Guides

TypeScript SDK

CLI

On-Chain: Reference

On-Chain: Account Management

On-Chain: Order Management

On-Chain: Position Management

On-Chain: Builder Fee

On-Chain: Vault Transactions

DecibelConfig

Custom config example

Gas Station (Sponsored Transactions)

Encrypted submission

Node API keys

​DecibelConfig

​Custom config example

​Gas Station (Sponsored Transactions)

​Encrypted submission

​Node API keys

DecibelConfig

Custom config example

Gas Station (Sponsored Transactions)

Encrypted submission

Node API keys