Getting Started

Getting Started

Admin PortalAPI Reference

---

1. Obtain an API Key

To use the VoidAI Bridge SDK, you must first register as a Tenant.

1. Contact the VoidAI team to register your tenant contract. The team will validate your request and register your tenant with a Primary Wallet (Bittensor).

2. Log in to the VoidAI Admin Panel using your Primary Wallet at app.voidai.com.

3. Navigate to the API Keys section to retrieve your apiKey (Public) and secretKey (Private).

Tenant Portal Features

Once registered, the portal provides a full management dashboard:

Feature	Description
Performance	View API key performance, rate limits, and quota usage.
Transaction History	Track transactions per key with status visibility.
Fee Management	Set your tenant fee percentage for bridge, swap, and CCIP operations.
Rewards	View your accumulated fees and request manual payouts.

Claiming Fees

Manual Reward System

The current reward system is manual. There is no SDK or API for programmatic fee claiming.

• View your accumulated rewards in the Admin Portal.
• To claim, request a payout from the Admin.
• The Admin transfers funds manually to your registered wallet (Bittensor, EVM, or Solana).

---

2. Installation

npm

npm install @voidaisdk/bridge-sdk

yarn

yarn add @voidaisdk/bridge-sdk

If you plan to use wallet integrations, install the relevant peer dependencies:

# Bittensor / Polkadot
npm install @polkadot/api @polkadot/extension-dapp

# EVM
npm install ethers
# or
npm install viem wagmi

# Solana
npm install @solana/web3.js @solana/wallet-adapter-react

---

3. Initialization

The SDK supports two modes: Frontend (browser) and Backend (server). Choose based on your deployment context.

Frontend (Browser)

Use BridgeSDK for client-side applications. Only your apiKey is required.

Never expose your secretKey in frontend code.

The secretKey is for server-side use only. Exposing it in browser code is a critical security risk.

import { BridgeSDK } from '@voidaisdk/bridge-sdk';

const sdk = new BridgeSDK({
    apiKey: 'YOUR_PUBLIC_API_KEY',
    environment: 'mainnet', // 'devnet' | 'testnet' | 'mainnet'
});

// Wait for authentication (JWT exchange) to complete
await sdk.ready;

console.log('Bridge SDK is ready!');

Backend (Server)

Use BridgeSDKServer for server-side applications. Both apiKey and secretKey are required.

import { BridgeSDKServer } from '@voidaisdk/bridge-sdk';

const serverSdk = new BridgeSDKServer({
    apiKey: 'YOUR_PUBLIC_API_KEY',
    secretKey: 'YOUR_SECRET_KEY',
    environment: 'mainnet',
});

await serverSdk.ready;

See Server-Side Usage for the full server integration guide.

---

4. Configuration

Environments

Environment	Base URL	Bridge Contract (EVM)	Purpose
devnet	https://api-sdk-dev.voidai.envistudios.com/api	0x6266ce15aC4f32F096Ff91881dd887a0F4bBa569	Development & Testing
testnet	https://sdk-backend.voidai.com/sdk	0x4aA4396BfD6F268b427077079800F420dF947b63	Staging / Pre-Production
mainnet	https://sdk.voidai.com/sdk	0x604e8Ef901C0E69E79463D997ba7D0724A909b84	Production

TypeScript Support

The SDK ships with full TypeScript type definitions. Import types directly as needed:

import { BridgeSwapRequest, BridgeSwapResponse } from '@voidaisdk/bridge-sdk';

---

5. Security Best Practices

Frontend (Browser)

• Initialize the SDK with only your public apiKey.
• Configure Domain Whitelisting in the VoidAI Tenant Portal. The backend validates the Origin header — requests from non-whitelisted domains are rejected.
• Only whitelist domains you control (e.g. https://myapp.com, http://localhost:3000 for development).

Backend (Server)

• Use both apiKey and secretKey. The SDK exchanges these credentials for a JWT Access Token via POST /api/v1/auth/login.
• The JWT is automatically managed and refreshed by the SDK for all subsequent API calls.
• Always store keys in environment variables (e.g. .env files) — never hardcode them in source files or commit them to version control.

---

See Also

• Wallet Integration
• Bridge Operations
• Server-Side Usage
• API Reference