View source for BinanceSmartChain RPC endpoint

[[File:BinanceSmartChainLogo.png|left|thumb]]

==  This is a general guide on deploying an Binance Smart Chain RPC endpoint for your Chainlink Node(s). ==
[https://github.com/bnb-chain/bsc#readme Official Binance Smart Chain Docs are available here]
{{:Box-round|title=NOTE|This document assumes base operating system is Debian 10}}


== Binance Smart Chain RPC Endpoints: ==

* Websocket
** <code>ws://<your_ip_address>:8546</code>
* HTTP
** <code>http://<your_ip_address>:8545</code>


== Install Dependencies ==
Before we can get our Binance Smart Chain node running, we need to install some necessary software.

we'll install some packages that we'll need or will at least be handy to have.

<code>sudo apt install -y git curl wget jq node-ws telnet traceroute</code>

=== Install Go ===
Navigate to the official Go download page at go.dev/doc/install, and copy the link address for the download button.

Once you have the link, we'll use wget to download it.

''Please remember that the below examples have <version> in lieu of the release that was applicable at the time of writing''

<code>wget <nowiki>https://go.dev/dl/go</nowiki><version>.linux-amd64.tar.gz</code>


This will download the tarball, which we will see is named go<version>.linux-amd64.tar.gz.

To start, we'll want to extract the tarball

<code>tar xvf go<version>.linux-amd64.tar.gz</code>


Now that the packages has been extracted, we should have a new directory named, go

We'll adjust permissions on the directory, then relocate it to out /usr/local/ directory.

<code>sudo chown -R root:root ./go</code>

<code>sudo mv go /usr/local/</code>


And then, we'll modify our ~/.profile file and then force a reload of it.

<code>nano ~/.profile</code>


We'll want to add the following to the bottom of the ~/.profile file
<pre style="white-space:pre-wrap; width:100%; border:1px solid lightgrey; background:black; color:white;">export GOPATH=$HOME/go
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin</pre>


Once those lines have been added to our profile, we need to force our TTY session to load it.

<code>source ~/.profile</code>


We'll know all is well when we check to see the path to the command and check to see what version of Go we have installed

<code>which go</code>

You should get /usr/local/go/bin/go as the path to the command


<code>go version</code>

We should see the newly installed verison, go version go<version> linux/amd64


== Download & Install Binance Smart Chain Node Software ==
First we'll need to clone the bnb-chain repository

<code>git clone <nowiki>https://github.com/bnb-chain/bsc.git</nowiki></code>


Once cloned, we'll change directories into the newly downloaded bnb-chain directory

<code>cd bnb-chain</code>


Then, we'll compile the necessary binaries, just like we would with geth

<code>make all</code>

Once it's finished compiling the binaries, we will be able to find them in the build directory, ~/bnb-chain/build/bin/geth.


we can check to confirm the operation of the binary by checking the verison

<code>./build/bin/geth --version</code>


== Create Binance Smart Chain Node Service ==
Create a new service file for your binance smart chain node.

<code>sudo nano /etc/systemd/system/binance-node.service</code>


Copy and paste the below into the new file, modifying the necessary values

We'll want to update the <username> to your correct value.
<pre style="white-space:pre-wrap; width:100%; border:1px solid lightgrey; background:black; color:white;">[Unit]
 Description=Binance Smart Chain RPC Node
 After=network.target auditd.service
 Wants=network.target
 
 [Service]
 Type=simple
 User=<username>
 WorkingDirectory=/home/<username>/.binancesmartchain/
 TimeoutStartSec=0
 TimeoutStopSec=120
 ExecStart=/home/<username>/bnb-chain/build/bin/geth \
 --mainnet \
 --cache 8192 \
 --log.json \
 --verbosity 2 \
 --metrics \
 --http \
 --http.addr 0.0.0.0 \
 --http.vhosts '*' \
 --ws \
 --ws.addr 0.0.0.0 \
 --ws.origins 0.0.0.0 \
 --datadir /home/<username>/.binancesmartchain/
 Restart=always
 RestartSec=10s
 
 [Install]
 WantedBy=multi-user.target
 RequiredBy=swarm.service
 Alias=binance-node.service</pre>


== Start Binance Smart Chain Node Service ==
Once we have the service file created, we can start it with a simple command, but first, we'll reload our daemons to be sure that it detects the newly created service file.

<code>sudo systemctl daemon-reload</code>

Then,

<code>sudo systemctl start binance-node.service</code>


== Check Status of Binance Smart Chain Node Service ==
We can check the status of the service itself by checking the system logs for the specific service

<code>sudo journalctl -u binance-node.service</code>


If we want to check the status/state of the endpoints sync, we can simply query the RPC endpoint to see what the block height is, and compare that against the explorer.

Here's a simple bash script that does exactly that.

''be sure to add your api key in place of <api_key>''
<pre style="white-space:pre-wrap; width:100%; border:1px solid lightgrey; background:black; color:white;">#!/bin/bash
 
 # blue foreground
 blue_fg=$(tput setaf 6)
 # reset to default
 reset=$(tput sgr0)
 
 # SET VARS
 BLOCK_HEIGHT=$(curl -s -H "Content-Type: application/json" <nowiki>http://localhost:8545</nowiki> -d '{"jsonrpc": "2.0", "id": 123, "method": "eth_blockNumber"}' | jq -r .result)
 BSCSCAN_BLOCK_HEIGHT=$(curl -s -d "action=eth_blockNumber&apikey=<api_key>&module=proxy" -X POST <nowiki>https://api.bscscan.com/api</nowiki> | jq -r .result)
 PEER_COUNT=$(curl -s -H "Content-Type: application/json" <nowiki>http://localhost:8545</nowiki> -d '{"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":74}' | jq -r .result)
 IS_SYNCING=$(curl -s -H "Content-Type: application/json" <nowiki>http://localhost:8545</nowiki> -d '{"jsonrpc": "2.0", "id": 123, "method": "eth_syncing"}' | jq .)
 
 echo "----------------------"
 echo "RPC Node block height: ${blue_fg}$((BLOCK_HEIGHT))${reset}"
 echo "BSCScan block height: ${blue_fg}$((BSCSCAN_BLOCK_HEIGHT))${reset}"
 echo "Current peer count:    ${blue_fg}$((PEER_COUNT))${reset}"
 
 VAR1=$(curl -s -H "Content-Type: application/json" <nowiki>http://localhost:8545</nowiki> -d '{"jsonrpc": "2.0", "id": 123, "method": "eth_syncing"}' | jq .result)
 VAR2="false"
 if [ "$VAR1" = "$VAR2" ]; then
     echo "Sync Status:           ${blue_fg}Node is synced.${reset}"
 else
     echo "${blue_fg}Node is ${yellow_fg}NOT${blue_fg} synced.${reset}"
 fi</pre>