TONX.js

TONX.js SDK (@tonx/core) makes onboarding to the TON blockchain seamless with TON API tools, leveraging the power of TONX API to help you launch your dApp quickly.

Whether you're new to the TON ecosystem or an experienced developer, TONX.js simplifies the process and gets you started effortlessly.

For detailed usage instructions and a quickstart guide, visit the https://docs.tonxapi.com/docs/welcome-to-ton-api. To explore the full range of TON API endpoints provided by tonxapi.com, refer to the TON APIs Reference Overview.

Features

• JSON-RPC method powered by the TONX Supernode with 99.99% uptime, precise indexing, and ultra-low latency
• Full integration with TONX API endpoints

In addition, the TONX.js Adapter (@tonx/adapter) allows for an easy transition from popular TON client libraries like @ton/ton, TonWeb, and TonClient4. With just a few code changes, you can seamlessly integrate with TONX API.

Install

npm install @tonx/core

To access the full features of TONX API, including advanced tools, register here for a free TON API key.

Examples

Initialize TONX client and use its features:

import { TONXJsonRpcProvider } from "@tonx/core";

const client = new TONXJsonRpcProvider({
  network: "mainnet",
  apiKey: "YOUR_API_KEY",
});

// Get consensus block
const consensusBlock = await client.getConsensusBlock();
console.log(consensusBlock);

// Get tgBTC Jetton Wallet address by owner
const tgBTCWallet = await client.getTgBTCWalletAddressByOwner({
  owner_address: "YOUR_OWNER_ADDRESS"
});
console.log(tgBTCWallet)

// Get tgBTC transfers
const transfers = await client.getTgBTCTransfers({address: "YOUR_ADDRESS"});

// Create payload for use with TonConnect tgBTC transfers
const tgBTCTransferPayload = await client.getTgBTCTransferPayload({
  amount: 1000, // tgBTC Amount
  destination: "DESTINATION_ADDRESS",
  source: "YOUR_OWNER_ADDRESS",
});

// Using in TonConnect
await tonConnectUI.sendTransaction({
  validUntil: Math.floor(Date.now() / 1000) + 360,
  messages: [{ ...tgBTCTransferPayload }],
});

Documentation & Resources

• TONX API
• API Documentation
• TON APIs Reference Overview
• Quickstart Guide
• Dashboard Overview

License

MIT