Official Golang implementation of the Sperax protocol, based off of the official golang implementation of the Ethereum protocol
Click here to find the documentation of Sperax blockchain.
Most functionalities of this client is similar to the Ethereum golang implementation. If you do not find your question answered by Sperax documentation, try searching the geth wiki.
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
make geth
or, to build the full suite of utilities:
make all
The Sperax blockchain client comes with several wrappers/executables found in the cmd
directory.
Command | Description |
---|---|
geth |
Our main Sperax blockchain client. It is the entry point into the Sperax network (test- for now and main- later), 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 Sperax network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. geth --help for command line options. |
abigen |
Source code generator to convert Sperax 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 Ethereum Native DApps wiki page for details. |
bootnode |
Stripped down version of our Sperax 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 SVM (Sperax Virtual Machine, now mostly EVM and will update to be very different from EVM in Sperax 2.0) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of SVM opcodes (e.g. evm --code 60ff60ff --debug run ). |
gethrpctest |
Developer utility tool to support our ethereum/rpc-test test suite which validates baseline conformity to the Ethereum JSON RPC specs. Please see the Ethereum test suite's readme for details. |
rlpdump |
Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Sperax 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 Sperax network. |
Going through all the possible command line flags is out of scope here (please consult our 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 Sperax client instance.
We are currently working on Sperax testnet
As an alternative to passing the numerous flags to the Sperax
binary, you can also pass a
configuration file via:
$ geth --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:
$ geth --your-favourite-flags dumpconfig
As a developer, sooner rather than later you'll want to start interacting with geth
and the
Sperax 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
and geth
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 geth
,
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 geth
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 Sperax 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!
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 the Sperax Golang implementation, please send your suggestions to [email protected].
Also, we are about to launch the Sperax forum for any technical discussion around Sperax design and implementation. Check out our update on our official website sperax.io.
The go-ethereum 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-ethereum binaries (i.e. all code inside of the cmd
directory) is licensed under the
GNU General Public License v3.0, also
included in our repository in the COPYING
file.