Categorygithub.com/truechain/truechain-engineering-code
modulepackage
3.0.3+incompatible
Repository: https://github.com/truechain/truechain-engineering-code.git
Documentation: pkg.go.dev

# README

TrueChain Engineering Code

TrueChain is a truly fast, permissionless, secure and scalable public blockchain platform which is supported by hybrid consensus technology called Minerva and a global developer community.    TrueChain uses hybrid consensus combining PBFT and fPoW to solve the biggest problem confronting public blockchain: the contradiction between decentralization and efficiency.

TrueChain uses PBFT as fast-chain to process transactions, and leave the oversight and election of PBFT to the hands of PoW nodes. Besides, TrueChain integrates fruitchain technology into the traditional PoW protocol to become fPoW, to make the chain even more decentralized and fair.

TrueChain also creates a hybrid consensus incentive model and a stable gas fee mechanism to lower the cost for the developers and operators of DApps, and provide better infrastructure for decentralized eco-system. 

Building the source

Building getrue 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

make getrue

or, to build the full suite of utilities:

make all

The execuable command getrue will be found in the cmd directory.

Running getrue

Going through all the possible command line flags is out of scope here (please consult our CLI Wiki page), also you can quickly run your own getrue instance with a few common parameter combos.

Running on the Truechain main network

$ getrue console

This command will:

  • Start getrue with network ID 19330 in full node mode(default, can be changed with the --syncmode flag after version 1.1).
  • Start up Getrue's built-in interactive console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Geth's own management APIs. This too is optional and if you leave it out you can always attach to an already running Getrue instance with getrue attach.

Running on the Truechain test network

To test your contracts, you can join the test network with your node.

$ getrue --testnet console

The console subcommand has the exact same meaning as above and they are equally useful on the testnet too. Please see above for their explanations if you've skipped here.

Specifying the --testnet flag, however, will reconfigure your Geth instance a bit:

  • Test network uses different network ID 18928
  • Instead of connecting the main TrueChain network, the client will connect to the test network, which uses testnet P2P bootnodes, and genesis states.

Configuration

As an alternative to passing the numerous flags to the getrue binary, you can also pass a configuration file via:

$ getrue --config /path/to/your_config.toml

To get an idea how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ getrue --your-favourite-flags dumpconfig

Running on the Truechain singlenode(private) network

To start a getrue instance for single node, run it with these flags:

$ getrue --singlenode  console

Specifying the --singlenode flag, however, will reconfigure your Geth instance a bit:

  • singlenode network uses different network ID 400
  • Instead of connecting the main or test TrueChain network, the client has no peers, and generate fast block without committee.

Which will start sending transactions periodly to this node and mining fruits and snail blocks.

# Packages

Package accounts implements high level Ethereum account management.
No description provided by the author
Package common contains various helper functions.
Package consensus implements different Ethereum consensus engines.
No description provided by the author
No description provided by the author
Package core implements the Ethereum consensus protocol.
No description provided by the author
No description provided by the author
Package etrue implements the Truechain protocol.
Package etrueclient provides a client for the Ethereum RPC API.
No description provided by the author
Package etruestats implements the network stats reporting service.
Package event deals with subscriptions to real-time events.
Package les implements the Light Ethereum Subprotocol.
Package light implements on-demand retrieval capable state and chain objects for the Ethereum Light Client.
Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
Go port of Coda Hale's Metrics library <https://github.com/rcrowley/go-metrics> Coda Hale's original work: <https://github.com/codahale/metrics>.
Package miner implements Ethereum block creation and mining.
Package node sets up multi-protocol Ethereum nodes.
Package p2p implements the Truechain p2p network protocols.
No description provided by the author
Package rlp implements the RLP serialization format.
Package rpc provides access to the exported methods of an object across a network or other I/O connection.
No description provided by the author
No description provided by the author
Package tests implements execution of Ethereum JSON tests.
Package trie implements Merkle Patricia Tries.
No description provided by the author

# Variables

NotFound is returned by API methods if the requested item does not exist.

# Structs

CallMsg contains parameters for contract calls.
FilterQuery contains options for contract log filtering.
SyncProgress gives progress indications when the node is synchronising with the Truechain network.

# Interfaces

ChainReader provides access to the blockchain.
ChainStateReader wraps access to the state trie of the canonical blockchain.
ChainSyncReader wraps access to the node's current sync status.
A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain.
GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state.
GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.
LogFilterer provides access to contract log events using a one-off query or continuous event subscription.
PendingContractCaller can be used to perform calls against the pending state.
A PendingStateEventer provides access to real time notifications about changes to the pending state.
A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain.
Subscription represents an event subscription where events are delivered on a data channel.
TransactionReader provides access to past transactions and their receipts.
TransactionSender wraps transaction sending.