The go-tcc from tcc-world

Go TCC

Official golang implementation of the Ethereum-based TCC protocol.

Binaries are published at https://github.com/tcc-world/go-tcc/releases.

Building the source

For prerequisites and detailed build instructions please stick to the official Go-Ethereum Installation Instructions.

Building TCC requires both a Go (version 1.7 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make tcc

or, to build the full suite of utilities:

make all

Executables

The Go-TCC project comes with several wrappers/executables found in the cmd directory.

Command	Description
`tcc`	Our main TCC CLI client. It is the entry point into the TCC 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 TCC network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. Check `tcc --help` and the official Go-Ethereum CLI Wiki page 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 with expanded functionality if the contract bytecode is also available. However it also accepts Solidity source files, making development much more streamlined. Please see the official Go-Ethereum Native DApps wiki page for details.
`bootnode`	Stripped down version of the TCC 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`).
`tccrpctest`	Developer utility tool to support the ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the test suite's readme for details.
`rlpdump`	Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Ethereum-based TCC protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`).
`swarm`	swarm daemon and tools. This is the entrypoint for the swarm network. `swarm --help` for command line options and subcommands. See https://swarm-guide.readthedocs.io for swarm documentation.
`puppeth`	a CLI wizard that aids in creating a new Ethereum-based network.

Running tcc

Going through all the possible command line flags is out of scope here (please consult the compatible Go-Ethereum CLI Wiki page), but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own TCC instance.

Full node on the main TCC network

By far the most common scenario is people wanting to simply interact with the TCC network: create accounts; transfer funds; deploy and interact with contracts. For this particular use-case the user doesn't care about years-old historical data, so we can fast-sync quickly to the current state of the network. To do so:

$ tcc --fast --cache=512 console

This command will:

Start TCC in fast sync mode (--fast), causing it to download more data in exchange for avoiding processing the entire history of the TCC network, which is very CPU intensive.
Bump the memory allowance of the database to 512MB (--cache=512), which can help significantly in sync times especially for HDD users. This flag is optional and you can set it as high or as low as you'd like, though we'd recommend the 512MB - 2GB range.
Start up TCC's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as TCC's own management APIs. This too is optional and if you leave it out you can always attach to an already running TCC instance with tcc attach.

Full node on the TCC test network

Transitioning towards developers, if you'd like to play around with creating TCC contracts, you almost certainly would like to do that without any real money involved until you get the hang of the entire system. In other words, instead of attaching to the main network, you want to join the test network with your node, which is fully equivalent to the main network, but with play-Ether only.

$ tcc --testnet --fast --cache=512 console

The --fast, --cache flags and console subcommand have 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 to here.

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

Instead of using the default data directory (~/.tcc on Linux for example), TCC will nest itself one level deeper into a testnet subfolder (~/.tcc/testnet on Linux). Note, on OSX and Linux this also means that attaching to a running testnet node requires the use of a custom endpoint since tcc attach will try to attach to a production node endpoint by default. E.g. tcc attach <datadir>/testnet/tcc.ipc. Windows users are not affected by this.
Instead of connecting the main TCC network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis states.

Note: Although there are some internal protective measures to prevent transactions from crossing over between the main network and test network, you should make sure to always use separate accounts for play-money and real-money. Unless you manually move accounts, TCC will by default correctly separate the two networks and will not make any accounts available between them.

Configuration

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

$ tcc --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:

$ tcc --your-favourite-flags dumpconfig

Programatically interfacing TCC nodes

As TCC coincides with the ethereum protocol in so many parts, sooner rather than later you'll want to start interacting with TCC and the TCC network via your own programs and not manually through the console. To aid this, TCC has built in support for a JSON-RPC based APIs (standard APIs and TCC specific APIs). These can be exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows).

The IPC interface is enabled by default and exposes all the APIs supported by TCC, whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect.

HTTP based JSON-RPC API options:

--rpc Enable the HTTP-RPC server
--rpcaddr HTTP-RPC server listening interface (default: "localhost")
--rpcport HTTP-RPC server listening port (default: 8545)
--rpcapi API's offered over the HTTP-RPC interface (default: "eth,net,web3")
--rpccorsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
--ws Enable the WS-RPC server
--wsaddr WS-RPC server listening interface (default: "localhost")
--wsport WS-RPC server listening port (default: 8546)
--wsapi API's offered over the WS-RPC interface (default: "eth,net,web3")
--wsorigins Origins from which to accept websockets requests
--ipcdisable Disable the IPC-RPC server
--ipcapi API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3")
--ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)

You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect via HTTP, WS or IPC to a TCC node configured with the above flags and you'll need to speak JSON-RPC on all transports. You can reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert TCC nodes with exposed APIs! Further, all browser tabs can access locally running webservers, so malicious webpages could try to subvert locally available APIs!

Note: You could also use a full fledged TCC node as a bootnode, but it's the less recommended way.

Starting up your member nodes

With the bootnode operational and externally reachable (you can try telnet <ip> <port> to ensure it's indeed reachable), start every subsequent TCC node pointed to the bootnode for peer discovery via the --bootnodes flag. It will probably also be desirable to keep the data directory of your private network separated, so do also specify a custom --datadir flag.

$ tcc --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above>

Note: Since your network will be completely cut off from the main and test networks, you'll also need to configure a miner to process transactions and create new blocks for you.

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to go-tcc, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
Code must be documented adhering to the official Go commentary guidelines.
Pull requests need to be based on and opened against the master branch.
Commit messages should be prefixed with the package(s) they modify.
- E.g. "eth, rpc: make trace configs optional"

Please see the Go-Ethereum Developers' Guide for more details on configuring your environment, managing project dependencies and testing procedures.

License

Go-TCC is a fork of the Go-Ethereum client and library. The go-tcc library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file. The go-tcc binaries (i.e. all code inside of the cmd directory) and/or some other specific files authored by TCC developers are is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.

tcc-world / go-tcc Goto Github PK

go-tcc's Introduction

Go TCC

Building the source

Executables

Running tcc

Full node on the main TCC network

Full node on the TCC test network

Configuration

Programatically interfacing TCC nodes

Starting up your member nodes

Contribution

License

go-tcc's People

Stargazers

Watchers

Forkers

go-tcc's Issues

Recommend Projects

Recommend Topics

Recommend Org