github.com/fff-chain/go-fff@v0.0.0-20220726032732-1c84420b8a99/README.md (about) 1 ## Binance Smart Chain 2 3 The goal of Binance Smart Chain is to bring programmability and interoperability to Binance Chain. In order to embrace the existing popular community and advanced technology, it will bring huge benefits by staying compatible with all the existing smart contracts on Ethereum and Ethereum tooling. And to achieve that, the easiest solution is to develop based on go-ethereum fork, as we respect the great work of Ethereum very much. 4 5 Binance Smart Chain starts its development based on go-ethereum fork. So you may see many toolings, binaries and also docs are based on Ethereum ones, such as the name “geth”. 6 7 [](https://pkg.go.dev/github.com/fff-chain/go-fff?tab=doc) 10 [](https://discord.gg/z2VpC455eU) 11 12 But from that baseline of EVM compatible, Binance Smart Chain introduces a system of 21 validators with Proof of Staked Authority (PoSA) consensus that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. 13 14 Cross-chain transfer and other communication are possible due to native support of interoperability. Relayers and on-chain contracts are developed to support that. Binance DEX remains a liquid venue of the exchange of assets on both chains. This dual-chain architecture will be ideal for users to take advantage of the fast trading on one side and build their decentralized apps on the other side. **The Binance Smart Chain** will be: 15 16 - **A self-sovereign blockchain**: Provides security and safety with elected validators. 17 - **EVM-compatible**: Supports all the existing Ethereum tooling along with faster finality and cheaper transaction fees. 18 - **Interoperable**: Comes with efficient native dual chain communication; Optimized for scaling high-performance dApps that require fast and smooth user experience. 19 - **Distributed with on-chain governance**: Proof of Staked Authority brings in decentralization and community participants. As the native token, BNB will serve as both the gas of smart contract execution and tokens for staking. 20 21 More details in [White Paper](http://binance.org/en#smartChain). 22 23 ## Key features 24 25 ### Proof of Staked Authority 26 Although Proof-of-Work (PoW) has been approved as a practical mechanism to implement a decentralized network, it is not friendly to the environment and also requires a large size of participants to maintain the security. 27 28 Proof-of-Authority(PoA) provides some defense to 51% attack, with improved efficiency and tolerance to certain levels of Byzantine players (malicious or hacked). 29 Meanwhile, the PoA protocol is most criticized for being not as decentralized as PoW, as the validators, i.e. the nodes that take turns to produce blocks, have all the authorities and are prone to corruption and security attacks. 30 31 Other blockchains, such as EOS and Cosmos both, introduce different types of Deputy Proof of Stake (DPoS) to allow the token holders to vote and elect the validator set. It increases the decentralization and favors community governance. 32 33 To combine DPoS and PoA for consensus, Binance Smart Chain implement a novel consensus engine called Parlia that: 34 35 1. Blocks are produced by a limited set of validators. 36 2. Validators take turns to produce blocks in a PoA manner, similar to Ethereum's Clique consensus engine. 37 3. Validator set are elected in and out based on a staking based governance on Binance Chain. 38 4. The validator set change is relayed via a cross-chain communication mechanism. 39 5. Parlia consensus engine will interact with a set of [system contracts](https://github.com/binance-chain/docs-site/blob/add-bsc/docs/smart-chain/guides/concepts/system-contract.md) to achieve liveness slash, revenue distributing and validator set renewing func. 40 41 42 ### Light Client of Binance Chain 43 44 To achieve the cross-chain communication from Binance Chain to Binance Smart Chain, need introduce a on-chain light client verification algorithm. 45 It contains two parts: 46 47 1. [Stateless Precompiled contracts](https://github.com/binance-chain/bsc/blob/master/core/vm/contracts_lightclient.go) to do tendermint header verification and Merkle Proof verification. 48 2. [Stateful solidity contracts](https://github.com/binance-chain/bsc-genesis-contract/blob/master/contracts/TendermintLightClient.sol) to store validator set and trusted appHash. 49 50 ## Native Token 51 52 BNB will run on Binance Smart Chain in the same way as ETH runs on Ethereum so that it remains as `native token` for BSC. This means, 53 BNB will be used to: 54 55 1. pay `gas` to deploy or invoke Smart Contract on BSC 56 2. perform cross-chain operations, such as transfer token assets across Binance Smart Chain and Binance Chain. 57 58 ## Building the source 59 60 Many of the below are the same as or similar to go-ethereum. 61 62 For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/install-and-build/installing-geth). 63 64 Building `geth` requires both a Go (version 1.14 or later) and a C compiler. You can install 65 them using your favourite package manager. Once the dependencies are installed, run 66 67 ```shell 68 make geth 69 ``` 70 71 or, to build the full suite of utilities: 72 73 ```shell 74 make all 75 ``` 76 77 ## Executables 78 79 The bsc project comes with several wrappers/executables found in the `cmd` 80 directory. 81 82 | Command | Description | 83 | :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 84 | **`geth`** | Main Binance Smart Chain client binary. It is the entry point into the BSC network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It has the same and more RPC and other interface as go-ethereum and can be used by other processes as a gateway into the BSC network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options. | 85 | `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. | 86 | `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. | 87 | `abigen` | Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [Ethereum contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. | 88 | `bootnode` | Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks. | 89 | `evm` | Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. `evm --code 60ff60ff --debug run`). | 90 | `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://eth.wiki/en/fundamentals/rlp)) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | 91 92 ## Running `geth` 93 94 Going through all the possible command line flags is out of scope here (please consult our 95 [CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)), 96 but we've enumerated a few common parameter combos to get you up to speed quickly 97 on how you can run your own `geth` instance. 98 99 ### Hardware Requirements 100 101 The hardware must meet certain requirements to run a full node. 102 - VPS running recent versions of Mac OS X or Linux. 103 - 1T of SSD storage for mainnet, 500G of SSD storage for testnet. 104 - 8 cores of CPU and 32 gigabytes of memory (RAM) for mainnet. 105 - 4 cores of CPU and 8 gigabytes of memory (RAM) for testnet. 106 - A broadband Internet connection with upload/download speeds of at least 10 megabyte per second 107 108 ```shell 109 $ geth console 110 ``` 111 112 This command will: 113 * Start `geth` in fast sync mode (default, can be changed with the `--syncmode` flag), 114 causing it to download more data in exchange for avoiding processing the entire history 115 of the Binance Smart Chain network, which is very CPU intensive. 116 * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), 117 (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/) 118 (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), 119 as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). 120 This tool is optional and if you leave it out you can always attach to an already running 121 `geth` instance with `geth attach`. 122 123 ### A Full node on the Rialto test network 124 125 Steps: 126 127 1. Download the binary, config and genesis files from [release](https://github.com/binance-chain/bsc/releases/download/v1.0.0-alpha.0/binary.zip), or compile the binary by `make geth`. 128 2. Init genesis state: `./geth --datadir node init genesis.json`. 129 3. Start your fullnode: `./geth --config ./config.toml --datadir ./node`. 130 4. Or start a validator node: `./geth --config ./config.toml --datadir ./node -unlock ${validatorAddr} --mine --allow-insecure-unlock`. The ${validatorAddr} is the wallet account address of your running validator node. 131 132 *Note: The default p2p port is 30311 and the RPC port is 8575 which is different from Ethereum.* 133 134 More details about [running a node](https://docs.binance.org/smart-chain/developer/fullnode.html) and [becoming a validator](https://docs.binance.org/smart-chain/validator/candidate.html). 135 136 *Note: Although there are some internal protective measures to prevent transactions from 137 crossing over between the main network and test network, you should make sure to always 138 use separate accounts for play-money and real-money. Unless you manually move 139 accounts, `geth` will by default correctly separate the two networks and will not make any 140 accounts available between them.* 141 142 ### Configuration 143 144 As an alternative to passing the numerous flags to the `geth` binary, you can also pass a 145 configuration file via: 146 147 ```shell 148 $ geth --config /path/to/your_config.toml 149 ``` 150 151 To get an idea how the file should look like you can use the `dumpconfig` subcommand to 152 export your existing configuration: 153 154 ```shell 155 $ geth --your-favourite-flags dumpconfig 156 ``` 157 158 ### Programmatically interfacing `geth` nodes 159 160 As a developer, sooner rather than later you'll want to start interacting with `geth` and the 161 Binance Smart Chain network via your own programs and not manually through the console. To aid 162 this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API) 163 and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)). 164 These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based 165 platforms, and named pipes on Windows). 166 167 The IPC interface is enabled by default and exposes all the APIs supported by `geth`, 168 whereas the HTTP and WS interfaces need to manually be enabled and only expose a 169 subset of APIs due to security reasons. These can be turned on/off and configured as 170 you'd expect. 171 172 HTTP based JSON-RPC API options: 173 174 * `--http` Enable the HTTP-RPC server 175 * `--http.addr` HTTP-RPC server listening interface (default: `localhost`) 176 * `--http.port` HTTP-RPC server listening port (default: `8545`) 177 * `--http.api` API's offered over the HTTP-RPC interface (default: `eth,net,web3`) 178 * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 179 * `--ws` Enable the WS-RPC server 180 * `--ws.addr` WS-RPC server listening interface (default: `localhost`) 181 * `--ws.port` WS-RPC server listening port (default: `8546`) 182 * `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`) 183 * `--ws.origins` Origins from which to accept websockets requests 184 * `--ipcdisable` Disable the IPC-RPC server 185 * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,shh,txpool,web3`) 186 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 187 188 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to 189 connect via HTTP, WS or IPC to a `geth` node configured with the above flags and you'll 190 need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You 191 can reuse the same connection for multiple requests! 192 193 **Note: Please understand the security implications of opening up an HTTP/WS based 194 transport before doing so! Hackers on the internet are actively trying to subvert 195 BSC nodes with exposed APIs! Further, all browser tabs can access locally 196 running web servers, so malicious web pages could try to subvert locally available 197 APIs!** 198 199 ## Contribution 200 201 Thank you for considering to help out with the source code! We welcome contributions 202 from anyone on the internet, and are grateful for even the smallest of fixes! 203 204 If you'd like to contribute to bsc, please fork, fix, commit and send a pull request 205 for the maintainers to review and merge into the main code base. If you wish to submit 206 more complex changes though, please check up with the core devs first on [our discord channel](https://discord.gg/z2VpC455eU) 207 to ensure those changes are in line with the general philosophy of the project and/or get 208 some early feedback which can make both your efforts much lighter as well as our review 209 and merge procedures quick and simple. 210 211 Please make sure your contributions adhere to our coding guidelines: 212 213 * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) 214 guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). 215 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) 216 guidelines. 217 * Pull requests need to be based on and opened against the `master` branch. 218 * Commit messages should be prefixed with the package(s) they modify. 219 * E.g. "eth, rpc: make trace configs optional" 220 221 Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide) 222 for more details on configuring your environment, managing project dependencies, and 223 testing procedures. 224 225 ## License 226 227 The bsc library (i.e. all code outside of the `cmd` directory) is licensed under the 228 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 229 also included in our repository in the `COPYING.LESSER` file. 230 231 The bsc binaries (i.e. all code inside of the `cmd` directory) is licensed under the 232 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 233 included in our repository in the `COPYING` file.