On this page
API Overview
Welcome to the comprehensive Brixs Developer API reference.
Brixs provides a robust, highly-available JSON-RPC 2.0 API for interacting with the blockchain, querying state, subscribing to events, and submitting signed transactions.
Environment URLs
Local Development
http://localhost:8545
Public Testnet
https://testnet.brixs.space/v1
Current Status: Testnet
The Brixs network is currently running exclusively in a Testnet environment. The Mainnet RPC endpoints will be published closer to our official launch.
Authentication
Public endpoints are rate-limited to 100 requests per IP per minute. For production usage, please request a dedicated API key from the developer portal.
Connection Best Practices
Phase 1: Local Setup
To begin developing, we recommend starting a local Brixs node using our developer CLI. This will instantly spin up a custom JSON-RPC gateway mapped to port 8545.
# Initialize the local Brixs node
brixs deploy
Phase 2: Connecting via Ethers.js
Because Brixs uses a native EVM execution layer (@ethereumjs/vm), you can connect using standard Web3 libraries without any custom SDKs.
// Connect to the Testnet or Local RPC
const { ethers } = require("ethers");
const provider = new ethers.providers.JsonRpcProvider("http://localhost:8545");
async function checkStatus() {
const blockNumber = await provider.getBlockNumber();
console.log(`Connected to Brixs! Current Block: ${blockNumber}`);
}
checkStatus();
Phase 3: Transaction Submission
Once connected, you can sign and submit transactions exactly as you would on Ethereum. The transactions are picked up by our Encrypted Mempool and eventually proven by our ZK-SNARK Prover Engine.