BNB Chain Toolkit Guide

A modular TypeScript toolkit for building, deploying, and interacting with smart contracts on BNB Chain. Created by the Sperax team for the BNB Chain Hackathon.

Modules

Quick Start

# Install
npm install @nirholas/bnb-chain-toolkit

# Or use with MCP
npx @nirholas/bnb-chain-toolkit mcp

Token Module

Deploy a BEP-20 Token

import { TokenModule } from '@nirholas/bnb-chain-toolkit';

const token = new TokenModule(provider);
const result = await token.deploy({
  name: 'My Token',
  symbol: 'MTK',
  totalSupply: '1000000',
  decimals: 18
});
console.log(`Token deployed at: ${result.address}`);

Token Operations

// Get token info
const info = await token.getInfo('0x...');
// { name, symbol, decimals, totalSupply, owner }

// Transfer tokens
await token.transfer('0xRecipient', '1000', '0xTokenAddress');

// Approve spending
await token.approve('0xSpender', '1000', '0xTokenAddress');

// Check allowance
const allowance = await token.allowance('0xOwner', '0xSpender', '0xToken');

DeFi Module

PancakeSwap Integration

import { DeFiModule } from '@nirholas/bnb-chain-toolkit';

const defi = new DeFiModule(provider);

// Get swap quote
const quote = await defi.getSwapQuote({
  tokenIn: 'BNB',
  tokenOut: 'USDT',
  amountIn: '1'
});

// Execute swap
await defi.swap({
  tokenIn: 'BNB',
  tokenOut: 'USDT',
  amountIn: '1',
  slippage: 0.5
});

Venus Lending

// Supply collateral
await defi.supply({ protocol: 'venus', token: 'USDT', amount: '1000' });

// Borrow
await defi.borrow({ protocol: 'venus', token: 'BNB', amount: '0.5' });

Wallet Module

import { WalletModule } from '@nirholas/bnb-chain-toolkit';

const wallet = new WalletModule();

// Create new wallet
const newWallet = wallet.create();

// Import from mnemonic
const imported = wallet.fromMnemonic('word1 word2 ...');

// Get BNB balance
const balance = await wallet.getBalance('0x...');

// Batch transfer
await wallet.batchTransfer([
  { to: '0xAddr1', amount: '1', token: 'BNB' },
  { to: '0xAddr2', amount: '100', token: 'USDT' }
]);

Bridge Module

import { BridgeModule } from '@nirholas/bnb-chain-toolkit';

const bridge = new BridgeModule(provider);

// Bridge BNB to Ethereum
await bridge.transfer({
  from: 'bsc',
  to: 'ethereum',
  token: 'BNB',
  amount: '1'
});

// Bridge USDT to Arbitrum
await bridge.transfer({
  from: 'bsc',
  to: 'arbitrum',
  token: 'USDT',
  amount: '1000'
});

MCP Integration

The entire toolkit is available as MCP tools:

{
  "mcpServers": {
    "bnb-toolkit": {
      "command": "npx",
      "args": ["@nirholas/bnb-chain-toolkit", "mcp"],
      "env": {
        "BSC_RPC_URL": "https://bsc-dataseed.binance.org",
        "PRIVATE_KEY": "your-key"
      }
    }
  }
}

Sperax on BNB Chain

The toolkit includes Sperax-specific integrations:

• SPA token operations on BSC
• Plutus vault interactions (plvHEDGE, plvLOOP, plvDOLO)
• Cross-chain bridge to/from Arbitrum for USDs

Links

• GitHub: https://github.com/nirholas/bnb-chain-toolkit
• BNB Chain: https://www.bnbchain.org
• Sperax: https://app.sperax.io