Configuration

Configuration options and settings for @tetherto/wdk-wallet-ton-gasless

Wallet Configuration

import WalletManagerTonGasless from '@tetherto/wdk-wallet-ton-gasless'

const config = {
  // Required: TON Center API client
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key' // Optional, for higher rate limits
  },
  // Required: TON API client (used for gasless transaction relay)
  tonApiClient: {
    url: 'https://tonapi.io/v2',
    secretKey: 'your-tonapi-key' // Optional but recommended
  },
  // Required: Paymaster token used to pay gas fees
  paymasterToken: {
    address: 'EQ...' // Paymaster Jetton master contract address
  },
  // Optional: Maximum fee for transfer operations (in paymaster token base units)
  transferMaxFee: 10000000
}

const wallet = new WalletManagerTonGasless(seedPhrase, config) // config is required

Account Configuration

import { WalletAccountTonGasless } from '@tetherto/wdk-wallet-ton-gasless'

const accountConfig = {
  // Required: TON Center API client
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key' // Optional
  },
  // Required: TON API client
  tonApiClient: {
    url: 'https://tonapi.io/v2',
    secretKey: 'your-tonapi-key' // Optional but recommended
  },
  // Required: Paymaster token
  paymasterToken: {
    address: 'EQ...' // Paymaster Jetton master contract address
  },
  // Optional: Maximum fee for transfer operations
  transferMaxFee: 10000000
}

const account = new WalletAccountTonGasless(seedPhrase, "0'/0/0", accountConfig) // config is required

Read-Only Account Configuration

import { WalletAccountReadOnlyTonGasless } from '@tetherto/wdk-wallet-ton-gasless'

const readOnlyConfig = {
  // Required: TON Center API client
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key' // Optional
  },
  // Required: TON API client
  tonApiClient: {
    url: 'https://tonapi.io/v2',
    secretKey: 'your-tonapi-key' // Optional but recommended
  },
  // Required: Paymaster token
  paymasterToken: {
    address: 'EQ...' // Paymaster Jetton master contract address
  }
  // Note: transferMaxFee is NOT available for read-only accounts
}

const readOnlyAccount = new WalletAccountReadOnlyTonGasless(publicKey, readOnlyConfig) // config is required

Configuration Options

tonClient

The tonClient option configures the TON Center API client for blockchain interactions. You can pass either a configuration object or an existing TonClient instance.

Type:

type TonClientOption = TonClientConfig | TonClient;

interface TonClientConfig {
  /**
   * TON Center API endpoint URL
   * @example 'https://toncenter.com/api/v3'
   */
  url: string;

  /**
   * Optional API key for TON Center
   * Required for higher rate limits
   */
  secretKey?: string;
}

Required: Yes

tonApiClient

The tonApiClient option configures the TON API client used for gasless transaction relay and fee estimation. You can pass either a configuration object or an existing TonApiClient instance.

Type:

type TonApiClientOption = TonApiClientConfig | TonApiClient;

interface TonApiClientConfig {
  /**
   * TON API endpoint URL
   * @example 'https://tonapi.io/v2'
   */
  url: string;

  /**
   * Optional API key for TON API
   */
  secretKey?: string;
}

Required: Yes

paymasterToken

The paymasterToken option specifies the Jetton token used to pay gas fees in gasless transactions.

Type:

interface PaymasterTokenConfig {
  /**
   * Paymaster Jetton master contract address
   * @example 'EQ...'
   */
  address: string;
}

Required: Yes

Example:

const config = {
  paymasterToken: {
    address: 'EQ...' // Paymaster Jetton master contract address
  }
}

transferMaxFee

The transferMaxFee option sets the maximum allowed fee for transfer operations, denominated in the paymaster token's base units. This helps prevent unexpectedly high transaction fees.

Type: number | bigint

Required: No

Example:

const config = {
  transferMaxFee: 10000000 // Maximum fee in paymaster token base units
}

Complete Configuration Example

Here's a complete configuration example with all options:

const config = {
  // TON Center API client (required)
  tonClient: {
    url: 'https://toncenter.com/api/v3',
    secretKey: 'your-api-key'
  },
  
  // TON API client for gasless relay (required)
  tonApiClient: {
    url: 'https://tonapi.io/v2',
    secretKey: 'your-tonapi-key'
  },
  
  // Paymaster token for gas fee payment (required)
  paymasterToken: {
    address: 'EQ...' // Paymaster Jetton master contract address
  },
  
  // Fee limits (optional)
  transferMaxFee: 10000000 // Maximum fee in paymaster token base units
}

Security Considerations

• Keep API keys and secrets secure and never expose them in client-side code

• Use environment variables for sensitive configuration values

• Always use HTTPS URLs for API endpoints

• Set appropriate transferMaxFee limits to prevent excessive fees

• Validate contract addresses before using them in configuration

Node.js Quickstart

Get started with WDK in a Node.js environment

React Native Quickstart

Build mobile wallets with React Native Expo

WDK TON Gasless Wallet Usage

Get started with WDK's TON Gasless Wallet Usage

WDK TON Gasless Wallet API

Get started with WDK's TON Gasless Wallet API

---

Need Help?

Discord Community

Connect with developers, ask questions, share your projects

Join Community

GitHub Issues

Report bugs, request features, and get technical help

Open an Issue

Email Contact

For sensitive or private matters, contact our team directly

Send an email