BNB Smart Chain tooling

​

BNB Smart Chain client

1. Install BNB Smart Chain client.
2. Use geth attach command with the node endpoint.
   Shell

   Copy

   geth attach YOUR_CHAINSTACK_ENDPOINT
   

   where YOUR_CHAINSTACK_ENDPOINT — your node HTTPS or WSS endpoint protected either with the key or password. See node access details.
3. Invoke any methods from Web3 JavaScript API. Example below demonstrates how to get the balance of an address in wei value and convert it to ether value:
   Javascript

   Copy

   > web3.fromWei(web3.eth.getBalance("0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae"))
   642538.078574759898951277
   

​

GraphQL

​

UI

1. On Chainstack, navigate to your dedicated BNB Smart Chain node. See node access details.
2. Hover over GraphQL IDE URL and click Open.
3. In the graphical interface that opens, run a GraphQL query. Example to get the latest block number:

{ block { number } }

​

Node.js

const axios = require('axios');
const main = async () => {
  try {
    const result = await axios.post(
      'YOUR_CHAINSTACK_ENDPOINT',
      {
        query: `
          { block { number } }
        `
      }
    );
    console.log(result.data);
  } catch(error) {
    console.error(error);
  }
}
main();

• YOUR_CHAINSTACK_ENDPOINT — your node GraphQL endpoint protected either with the key or password. See node access details.
• query — your GraphQL query. In this case, to get the latest block number.

​

MetaMask

​

Hardhat

1. Install Hardhat and create a project.
2. Create a new environment in hardhat.config.js:
   Javascript

   Copy

   require("@nomiclabs/hardhat-waffle");
   ...
   module.exports = {
     solidity: "0.7.3",
     networks: {
       chainstack: {
           url: "YOUR_CHAINSTACK_ENDPOINT",
           accounts: ["YOUR_PRIVATE_KEY"]
       },
     }
   };
   

   where
   • YOUR_CHAINSTACK_ENDPOINT — your node HTTPS or WSS endpoint protected either with the key or password. See node access details.
   • YOUR_PRIVATE_KEY — the private key of the account that you use to deploy the contract
3. Run npx hardhat run scripts/deploy.js --network chainstack and Hardhat will deploy using Chainstack. See also Forking EVM-compatible mainnet with Hardhat.

​

Remix IDE

1. Get MetaMask and set it to interact through a Chainstack node. See Interacting through MetaMask.
2. In Remix IDE, navigate to the Deploy tab. Select Injected Provider - MetaMask in Environment. This will engage MetaMask and make Remix IDE interact with the network through a Chainstack node.

​

web3.js

1. Install web3.js.
2. Connect over HTTP or WebSocket.

​

HTTP

const Web3 = require('web3');

const web3 = new Web3(new Web3.providers.HttpProvider('YOUR_CHAINSTACK_ENDPOINT'));

web3.eth.getBlockNumber().then(console.log);

​

WebSocket

const Web3 = require('web3');

const web3 = new Web3(new Web3.providers.WebsocketProvider('YOUR_CHAINSTACK_ENDPOINT'));

web3.eth.getBlockNumber().then(console.log);

​

web3.py

1. Install web3.py.
2. Connect over HTTP or WebSocket. See also EVM node connection: HTTP vs WebSocket.

​

HTTP

from web3 import Web3

web3 = Web3(Web3.HTTPProvider('YOUR_CHAINSTACK_ENDPOINT'))
print(web3.eth.block_number)

• YOUR_CHAINSTACK_ENDPOINT — your node HTTPS endpoint protected either with the key or password
• HOSTNAME — your node HTTPS endpoint hostname
• USERNAME — your node access username (for password-protected endpoints)
• PASSWORD — your node access password (for password-protected endpoints)

​

WebSocket

from web3 import Web3

web3 = Web3(Web3.WebsocketProvider('YOUR_CHAINSTACK_ENDPOINT'))
print(web3.eth.block_number)

• YOUR_CHAINSTACK_ENDPOINT — your node WSS endpoint protected either with the key or password
• HOSTNAME — your node WSS endpoint hostname
• USERNAME — your node access username (for password-protected endpoints)
• PASSWORD — your node access password (for password-protected endpoints)

​

web3.php

1. Install web3.php.
2. Connect over HTTP:
   Php

   Copy

   <?php
   
   require_once "vendor/autoload.php";
   
   use Web3\Web3;
   use Web3\Providers\HttpProvider;
   use Web3\RequestManagers\HttpRequestManager;
   
   $web3 = new Web3(new HttpProvider(new HttpRequestManager("YOUR_CHAINSTACK_ENDPOINT", 5)));
   ?>
   

   where YOUR_CHAINSTACK_ENDPOINT is your node HTTPS endpoint protected either with the key or password
3. Use JSON-RPC methods to interact with the node. Example to get the latest block number:
   Key Protected

   Copy

   <?php
   
   require_once "vendor/autoload.php";
   
   use Web3\Web3;
   use Web3\Providers\HttpProvider;
   use Web3\RequestManagers\HttpRequestManager;
   
   $web3 = new Web3(new HttpProvider(new HttpRequestManager("YOUR_CHAINSTACK_ENDPOINT, 5)));
   
   $eth = $web3->eth;
   
   $eth->blockNumber(function ($err, $data) {
        print "$data \n";
   });
   ?>
   

​

web3j

package getLatestBlock;

import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.web3j.protocol.Web3j;
import org.web3j.protocol.core.DefaultBlockParameterName;
import org.web3j.protocol.core.methods.response.EthBlock;
import org.web3j.protocol.exceptions.ClientConnectionException;
import org.web3j.protocol.http.HttpService;

import okhttp3.Authenticator;
import okhttp3.Credentials;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.Route;

public final class App {

  private static final String USERNAME = "USERNAME";
  private static final String PASSWORD = "PASSWORD";
  private static final String ENDPOINT = "ENDPOINT";

  public static void main(String[] args) {
    try {

      OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder();
      clientBuilder.authenticator(new Authenticator() {
          @Override public Request authenticate(Route route, Response response) throws IOException {
              String credential = Credentials.basic(USERNAME, PASSWORD);
              return response.request().newBuilder().header("Authorization", credential).build();
          }
      });

      HttpService service = new HttpService(RPC_ENDPOINT, clientBuilder.build(), false);
      Web3j web3 = Web3j.build(service);

      EthBlock.Block latestBlock = web3.ethGetBlockByNumber(DefaultBlockParameterName.LATEST, false).send().getBlock();

      System.out.println("Latest Block: #" + latestBlock.getNumber());

    } catch (IOException | ClientConnectionException ex) {

      Logger.getLogger(App.class.getName()).log(Level.SEVERE, null, ex);
    }
  }

}

• ENDPOINT — your node HTTPS endpoint protected either with the key or password
• USERNAME — your node access username (for password-protected endpoints)
• PASSWORD — your node access password (for password-protected endpoints)

​

ethers.js

1. Install ethers.js.
2. Connect over HTTP or WebSocket. See also EVM node connection: HTTP vs WebSocket.

​

HTTP

const { ethers } = require("ethers");

var urlInfo = {
    url: 'YOUR_CHAINSTACK_ENDPOINT'
};
var provider = new ethers.providers.JsonRpcProvider(urlInfo, NETWORK_ID);

provider.getBlockNumber().then(console.log);

• YOUR_CHAINSTACK_ENDPOINT — your node HTTPS endpoint protected either with the key or password
• USERNAME — your node access username (for password-protected endpoints)
• PASSWORD — your node access password (for password-protected endpoints)
• NETWORK_ID — BNB Smart Chain network ID:
  • Mainnet: 56
  • Testnet: 97

​

WebSocket

const { ethers } = require("ethers");

const provider = new ethers.providers.WebSocketProvider('YOUR_CHAINSTACK_ENDPOINT', NETWORK_ID);

provider.getBlockNumber().then(console.log);

• YOUR_CHAINSTACK_ENDPOINT — your node WSS endpoint endpoint protected either with the key or password
• NETWORK_ID — BNB Smart Chain network ID:
  • Mainnet: 56
  • Testnet: 97

​

Brownie

1. Install Brownie.
2. Use the brownie networks add command with the node endpoint:
   Shell

   Copy

   brownie networks add "BNB Smart Chain" ID name="NETWORK_NAME" host=YOUR_CHAINSTACK_ENDPOINT chainid=NETWORK_ID
   

   where
   • ID — any name that you will use as the network tag to run a deployment. For example, bsc-mainnet.
   • NETWORK_NAME — any name that you want to identify the network by in the list of networks. For example, Mainnet (Chainstack).
   • YOUR_CHAINSTACK_ENDPOINT — your node HTTPS or WSS endpoint
   • NETWORK_ID — BNB Smart Chain network ID:
     • Mainnet: 56
     • Testnet: 97 Example to run the deployment script:

brownie run deploy.py --network chainstack-mainnet

​

Foundry

1. Install Foundry.
2. Use --rpc-url to run the operation through your Chainstack node.

​

Forge

forge create CONTRACT_NAME --contracts CONTRACT_PATH --private-key PRIVATE_KEY --rpc-url YOUR_CHAINSTACK_ENDPOINT

• CONTRACT_NAME — name of the contract in the Solidity source code
• CONTRACT_PATH — path to your smart contract
• PRIVATE_KEY — the private key to your funded account that you will use to deploy the contract
• YOUR_CHAINSTACK_ENDPOINT — your node HTTPS endpoint protected either with the key or password

​

Cast

cast block-number --rpc-url YOUR_CHAINSTACK_ENDPOINT