|
|
@@ -2,16 +2,14 @@
|
|
|
|
|
|
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.
|
|
|
|
|
|
-<<<<<<< HEAD
|
|
|
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”.
|
|
|
-=======
|
|
|
+
|
|
|
[](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
|
|
|
[](https://goreportcard.com/report/github.com/ethereum/go-ethereum)
|
|
|
[](https://travis-ci.com/ethereum/go-ethereum)
|
|
|
[](https://discord.gg/nthXNEv)
|
|
|
->>>>>>> 97d11b018
|
|
|
|
|
|
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.
|
|
|
|
|
|
@@ -61,13 +59,9 @@ BNB will be used to:
|
|
|
|
|
|
## Building the source
|
|
|
|
|
|
-<<<<<<< HEAD
|
|
|
Many of the below are the same as or similar to go-ethereum.
|
|
|
|
|
|
-For prerequisites and detailed build instructions please read the [Installation Instructions](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum) on the wiki.
|
|
|
-=======
|
|
|
For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/install-and-build/installing-geth).
|
|
|
->>>>>>> 97d11b018
|
|
|
|
|
|
Building `geth` requires both a Go (version 1.13 or later) and a C compiler. You can install
|
|
|
them using your favourite package manager. Once the dependencies are installed, run
|
|
|
@@ -89,29 +83,20 @@ directory.
|
|
|
|
|
|
| Command | Description |
|
|
|
| :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
|
-<<<<<<< HEAD
|
|
|
-| **`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 Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options) for command line options. |
|
|
|
-| `abigen`,`bootnode`,`evm`, `gethrpctest`,`rlpdump`,`puppeth` | **These binaries are exactly the same as the binaries built in go-ethereum repo.**|
|
|
|
-=======
|
|
|
-| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum 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 can be used by other processes as a gateway into the Ethereum 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. |
|
|
|
+| **`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. |
|
|
|
| `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. |
|
|
|
| `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. |
|
|
|
| `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`). |
|
|
|
| `gethrpctest` | Developer utility tool to support our [ethereum/rpc-test](https://github.com/ethereum/rpc-tests) test suite which validates baseline conformity to the [Ethereum JSON RPC](https://eth.wiki/json-rpc/API) specs. Please see the [test suite's readme](https://github.com/ethereum/rpc-tests/blob/master/README.md) for details. |
|
|
|
| `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`). |
|
|
|
| `puppeth` | a CLI wizard that aids in creating a new Ethereum network. |
|
|
|
->>>>>>> 97d11b018
|
|
|
|
|
|
## Running `geth`
|
|
|
|
|
|
Going through all the possible command line flags is out of scope here (please consult our
|
|
|
-<<<<<<< HEAD
|
|
|
-[CLI Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)).
|
|
|
-=======
|
|
|
[CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)),
|
|
|
but we've enumerated a few common parameter combos to get you up to speed quickly
|
|
|
on how you can run your own `geth` instance.
|
|
|
->>>>>>> 97d11b018
|
|
|
|
|
|
### Hardware Requirements
|
|
|
|
|
|
@@ -122,9 +107,6 @@ The hardware must meet certain requirements to run a full node.
|
|
|
- 4 cores of CPU and 8 gigabytes of memory (RAM) for testnet.
|
|
|
- A broadband Internet connection with upload/download speeds of at least 1 megabyte per second
|
|
|
|
|
|
-<<<<<<< HEAD
|
|
|
-### A Full node on the Rialto test network
|
|
|
-=======
|
|
|
```shell
|
|
|
$ geth console
|
|
|
```
|
|
|
@@ -139,8 +121,7 @@ This command will:
|
|
|
This tool is optional and if you leave it out you can always attach to an already running
|
|
|
`geth` instance with `geth attach`.
|
|
|
|
|
|
-### A Full node on the Görli test network
|
|
|
->>>>>>> 97d11b018
|
|
|
+### A Full node on the Rialto test network
|
|
|
|
|
|
Steps:
|
|
|
|
|
|
@@ -159,14 +140,6 @@ use separate accounts for play-money and real-money. Unless you manually move
|
|
|
accounts, `geth` will by default correctly separate the two networks and will not make any
|
|
|
accounts available between them.*
|
|
|
|
|
|
-<<<<<<< HEAD
|
|
|
-### Programmatically interfacing `geth` nodes
|
|
|
-
|
|
|
-As a developer, sooner rather than later you'll want to start interacting with `geth` and the
|
|
|
-Binance Smart Chain network via your own programs and not manually through the console. To aid
|
|
|
-this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC)
|
|
|
-and [`geth` specific APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs)).
|
|
|
-=======
|
|
|
### Full node on the Rinkeby test network
|
|
|
|
|
|
Go Ethereum also supports connecting to the older proof-of-authority based test network
|
|
|
@@ -233,7 +206,6 @@ As a developer, sooner rather than later you'll want to start interacting with `
|
|
|
Ethereum network via your own programs and not manually through the console. To aid
|
|
|
this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API)
|
|
|
and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)).
|
|
|
->>>>>>> 97d11b018
|
|
|
These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based
|
|
|
platforms, and named pipes on Windows).
|
|
|
|
|
|
@@ -269,8 +241,6 @@ BSC nodes with exposed APIs! Further, all browser tabs can access locally
|
|
|
running web servers, so malicious web pages could try to subvert locally available
|
|
|
APIs!**
|
|
|
|
|
|
-<<<<<<< HEAD
|
|
|
-=======
|
|
|
### Operating a private network
|
|
|
|
|
|
Maintaining your own private network is more involved as a lot of configurations taken for
|
|
|
@@ -412,7 +382,6 @@ Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/dev
|
|
|
for more details on configuring your environment, managing project dependencies, and
|
|
|
testing procedures.
|
|
|
|
|
|
->>>>>>> 97d11b018
|
|
|
## License
|
|
|
|
|
|
The bsc library (i.e. all code outside of the `cmd` directory) is licensed under the
|
yutianwu