BNB Studio is an integrated development environment (IDE), making developing BNB smart contracts faster and easier.
English | 简体中文
Download BNB Studio install-package in Github Release according to the computer system type (.dmg/.zip for macOS, .AppImage for Linux, .exe for Windows).
- macOS: Double click to open
BNB-Studio-x.x.x.dmgand dragBNB Studioto the application folder. - Linux: Double-click to open
BNB-Studio-x.x.x.AppImage, select Properties => Permissions => Execute, and tick the Allow executing file as progrom option. Close the properties window and double-click to open the application (different Linux distributions may have different installation methods). - Windows: Double click to run the
BNB-Studio-x.x.x.exe.
BNB Studio uses inotify by default on Linux to monitor directories for changes. You will need to increase the amount of inotify watchers to ensure the filetree is refreshed properly.
To increase inotify watchers at boot, execute the following command in Terminal:
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
When BNB Studio is properly installed and started for the first time, users will see a welcome page, where the dependencies for BNB are displayed, including Docker, BNB Node and BNB Truffle.
- Docker is used to to start the BNB Node and compile projects in BNB Studio. If Docker is not installed yet, users can click the Install Docker button to visit the official Docker website and download and install it.
- BNB Node in Docker is the BNB node image officially provided by BNB. BNB Studio uses the image to run the BNB node and compile projects.
- Truffle in Docker is a BNB version of truffle used to create and compile projects.
When all the dependencies are properly installed and run, the gray Skip button will change into a green Get Started button. Click the button to enter the main interface of BNB Studio.
After entering the main interface, users need to create some keypairs by opening the keypair manager by clicking the key icon at the bottom left on any interface of BNB Studio.
Users can create, import and manage keypairs in the keypair manager. When creating and editing a keypair, users can set an alias for the keypair to facilitate identification in later use. Besides storing and managing keypairs, the keypair manager will also provide a genesis address for the genesis block. When creating a new BNB node instance, all addresses in the keypair manager will be regarded as genesis addresses.
Before the following steps, users need to create some keypairs in the key manager as the genesis address for creating node instances.
After the node is started, click the Explorer tab at the top to switch the main interface to the block explorer. In the block explorer, users can query the information of a given address. This module is still under development, so users can only check the balance in the explorer currently.
Copy the address generated from the keypair manager, paste the address in the address bar and click Enter, then the balance of the address will be visible.
Click the transfer button on the right side of the address bar, the transfer window will open, enter the transfer amount and receiver address, and click Sign and Push to complete the transfer.
In the world of blockchain, people usually call the method of applying for test tokens as faucet. BNB Studio provides convenient faucet entrances for different test networks. Switch to a different network and click the faucet button next to the address bar to open the facuet page of the current test network in the browser.
Click the Project tab at the top to switch the main interface to the project manager. Click the New button in the upper right corner of the page to open the Create a New Project pop-up window, enter the project name and select an appropriate template. Currently BNB Studio provides two templates:
Coin：the coin smart contract provided by the BNB instance
After selecting the template, you can select the truffle version as needed.
After the project is created, the main interface will switch to the project editor. The project editor consists of several commonly used development modules, including a file browser, code editor, toolbar, log viewer, etc.
Click the compile button (hammer-shaped) on the toolbar, BNB Studio will compile the project, and you can view the compilation result through the log viewer below. After compilation, a json file will be generated in the build folder under the project directory.
Click the deploy button (boat-shaped) on the toolbar to open the Deploy modal. You can enter constructor parameters, signer, gas limit and gas price for the deployment.
Click the Deploy button, BNB Studio will deploy the project, and the deployment result will be displayed in a pop-up window.
After successfully deploying the smart contract, click the blue contract button in the pop-up window, the main interface will switch to the contract explorer, and BNB Studio will automatically open the smart contract just deployed.
The contract explorer interface includes two parts:
- On the left is the calling method of the contract. Click the blue button in the upper left of the left column, the drop-down box displays the methods defined by the current contract. Users can click the method name to select the calling method.
- On the right is the data reading of the contract. Click the blue button in the upper left of the right column, the drop-down box shows the data table of the current contract. Users can click the table name to view the data in different tables.
BNB Studio will automatically read the functions in the contract ABI and generate a parameter table for each function. Select the function to be called, enter the parameters, select the signer (the signer should be an existing address in the keypair manager; the read operation does not need to be selected), and click the run button to call the contract. The call result (success or failure) will be displayed in the result viewer below.
