|
|
@@ -1,13 +1,13 @@
|
|
|
## Core chain
|
|
|
|
|
|
-Core is an evolution of the Geth codebase. We leveraged the improvements made by the BSC team to add greater throughput and cheaper transactions by way of hard fork. Nevertheless, we differ from BSC in many ways. One preeminent difference is that Core is based on Satoshi Plus Consensus which relies on Proof of Work (PoW) alongside Delegated Proof of Stake (DPoS). With these modifications, we’re able to remain decentralized without the perrformance tradeoffs seen in traditional PoW consensus systems. Additionally, with our hybrid score based off of both delegated Bitcoin hash power and delegated stake, we’ve created a fluid market for validators and rewards that anyone can participate in.
|
|
|
+Core is an evolution of the Geth codebase. We leveraged the improvements made by the BSC team to add greater throughput and cheaper transactions by way of hard fork. Nevertheless, we differ from BSC in many ways. One preeminent difference is that Core is based on Satoshi Plus Consensus which relies on Proof of Work (PoW) alongside Delegated Proof of Stake (DPoS). With these modifications, we’re able to remain decentralized without the performance tradeoffs seen in traditional PoW consensus systems. Additionally, with our hybrid score based off of both delegated Bitcoin hash power and delegated stake, we’ve created a fluid market for validators and rewards that anyone can participate in.
|
|
|
|
|
|
[](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
|
|
|
[](https://discord.gg/coredao)
|
|
|
|
|
|
-More details in [White Paper](https://docs.coredao.org/core-white-paper-v1.0.5/).
|
|
|
+More details in [White Paper](https://docs.coredao.org/).
|
|
|
|
|
|
## Key features
|
|
|
|
|
|
@@ -27,7 +27,7 @@ To achieve the cross-chain communication from Bitcoin Network to Core chain, we
|
|
|
|
|
|
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://geth.ethereum.org/docs/install-and-build/installing-geth).
|
|
|
+For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth).
|
|
|
|
|
|
Building `geth` requires both a Go (version 1.14 or later) and a C compiler. You can install
|
|
|
them using your favourite package manager. Once the dependencies are installed, run
|
|
|
@@ -49,30 +49,24 @@ directory.
|
|
|
|
|
|
| Command | Description |
|
|
|
| :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
|
-| **`geth`** | Core chain client binary. It is the entry point into the Core chain 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 Core chain 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`** | Core chain client binary. It is the entry point into the Core chain 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 Core chain 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/fundamentals/command-line-options) for command line options. |
|
|
|
| `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. |
|
|
|
| `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. |
|
|
|
-| `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. |
|
|
|
+| `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/developers/dapp-developer/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`). |
|
|
|
-| `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`). |
|
|
|
+| `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/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`). |
|
|
|
|
|
|
## Running `geth`
|
|
|
|
|
|
Going through all the possible command line flags is out of scope here (please consult our
|
|
|
-[CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)),
|
|
|
+[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/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.
|
|
|
|
|
|
### Hardware Requirements
|
|
|
|
|
|
-The hardware must meet certain requirements to run a full node.
|
|
|
-
|
|
|
-- VPS running recent versions of Mac OS X or Linux.
|
|
|
-- 1T of SSD storage for mainnet, 500G of SSD storage for testnet.
|
|
|
-- 8 cores of CPU and 32 gigabytes of memory (RAM) for mainnet.
|
|
|
-- 4 cores of CPU and 8 gigabytes of memory (RAM) for testnet.
|
|
|
-- A broadband Internet connection with upload/download speeds of at least 10 megabyte per second
|
|
|
+The hardware must meet certain requirements to run a full node. Please check [How to run a core fullnode](https://docs.coredao.org/developer/node-and-validator/how-to-run-a-core-fullnode).
|
|
|
|
|
|
```shell
|
|
|
$ geth console
|
|
|
@@ -83,10 +77,10 @@ This command will:
|
|
|
* Start `geth` in fast sync mode (default, can be changed with the `--syncmode` flag),
|
|
|
causing it to download more data in exchange for avoiding processing the entire history
|
|
|
of the Core chain network, which is very CPU intensive.
|
|
|
- * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console),
|
|
|
- (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/)
|
|
|
+ * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console),
|
|
|
+ (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://web3js.readthedocs.io/en/latest/)
|
|
|
(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),
|
|
|
- as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server).
|
|
|
+ as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc).
|
|
|
This tool is optional and if you leave it out you can always attach to an already running
|
|
|
`geth` instance with `geth attach`.
|
|
|
|
|
|
@@ -94,7 +88,7 @@ This command will:
|
|
|
|
|
|
Steps:
|
|
|
|
|
|
-1. Download the binary, config and genesis files from [binaries](https://github.com/coredao-org/binaries), or compile the binary by `make geth`.
|
|
|
+1. Download the binary, config and genesis files from [latest release](https://github.com/coredao-org/core-chain/releases/tag/v1.0.1), or compile the binary by `make geth`.
|
|
|
2. Init genesis state: `./geth --datadir node init genesis.json`.
|
|
|
3. Start your fullnode: `./geth --config ./config.toml --datadir ./node`.
|
|
|
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.
|
|
|
@@ -130,7 +124,7 @@ $ geth --your-favourite-flags dumpconfig
|
|
|
As a developer, sooner rather than later you'll want to start interacting with `geth` and the
|
|
|
Core 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://eth.wiki/json-rpc/API)
|
|
|
-and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)).
|
|
|
+and [`geth` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)).
|
|
|
These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based
|
|
|
platforms, and named pipes on Windows).
|
|
|
|
|
|
@@ -188,7 +182,7 @@ Please make sure your contributions adhere to our coding guidelines:
|
|
|
* Commit messages should be prefixed with the package(s) they modify.
|
|
|
* E.g. "eth, rpc: make trace configs optional"
|
|
|
|
|
|
-Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide)
|
|
|
+Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers)
|
|
|
for more details on configuring your environment, managing project dependencies, and
|
|
|
testing procedures.
|
|
|
|
jackcrypto9527