README
¶
Hyperledger Burrow
| Branch | Linux |
|---|---|
| Master |  |
| Develop |  |
Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node. It executes Ethereum EVM smart contract code (usually written in Solidity) on a permissioned virtual machine. Burrow provides transaction finality and high transaction throughput on a proof-of-stake Tendermint consensus engine.
What is Burrow
Hyperledger Burrow is a permissioned blockchain node that executes smart contract code following the Ethereum specification. Burrow is built for a multi-chain universe with application specific optimization in mind. Burrow as a node is constructed out of three main components: the consensus engine, the permissioned Ethereum virtual machine and the rpc gateway. More specifically Burrow consists of the following:
- Consensus Engine: Transactions are ordered and finalised with the Byzantine fault-tolerant Tendermint protocol. The Tendermint protocol provides high transaction throughput over a set of known validators and prevents the blockchain from forking.
- Application Blockchain Interface (ABCI): The smart contract application interfaces with the consensus engine over the ABCI. The ABCI allows for the consensus engine to remain agnostic from the smart contract application.
- Smart Contract Application: Transactions are validated and applied to the application state in the order that the consensus engine has finalised them. The application state consists of all accounts, the validator set and the name registry. Accounts in Burrow have permissions and either contain smart contract code or correspond to a public-private key pair. A transaction that calls on the smart contract code in a given account will activate the execution of that account’s code in a permissioned virtual machine.
- Permissioned Ethereum Virtual Machine: This virtual machine is built to observe the Ethereum operation code specification and additionally asserts the correct permissions have been granted. Permissioning is enforced through secure native functions and underlies all smart contract code. An arbitrary but finite amount of gas is handed out for every execution to ensure a finite execution duration - “You don’t need money to play, when you have permission to play”.
- Application Binary Interface (ABI): Transactions need to be formulated in a binary format that can be processed by the blockchain node. Current tooling provides functionality to compile, deploy and link solidity smart contracts and formulate transactions to call smart contracts on the chain.
- API Gateway: Burrow exposes REST and JSON-RPC endpoints to interact with the blockchain network and the application state through broadcasting transactions, or querying the current state of the application. Websockets allow subscribing to events, which is particularly valuable as the consensus engine and smart contract application can give unambiguously finalised results to transactions within one blocktime of about one second.
Project Roadmap
Project information generally updated on a quarterly basis can be found on the Hyperledger Burrow Wiki.
Minimum requirements
| Requirement | Notes |
|---|---|
| Go version | Go1.10 or higher |
Installation
See the install instructions.
Quick Start
- Single full node - start your first chain
- Send transactions - how to communicate with your Burrow chain
- Deploy contracts - interact with the Ethereum Virtual Machine
- Multiple validators - advanced consensus setup
- Seed nodes - add new node dynamically
- Kubernetes - bootstraps a burrow network on a Kubernetes cluster
Project documentation
Burrow getting started documentation is available in the docs directory and in GoDocs.
Contribute
We welcome any and all contributions. Read the contributing file for more information on making your first Pull Request to Burrow!
You can find us on:
Future work
For some (slightly outdated) ideas on future work, see the proposals document.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
The acm package contains code relating to accounts and account state the abbreviation probably derives from 'ACcount Management'
|
The acm package contains code relating to accounts and account state the abbreviation probably derives from 'ACcount Management' |
|
cmd
|
|
|
Package consensus contains the logic maintaining and connecting to our Tendermint consensus network.
|
Package consensus contains the logic maintaining and connecting to our Tendermint consensus network. |
|
pubsub
This package was extracted from Tendermint Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).
|
This package was extracted from Tendermint Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients). |
|
query
Package query provides a parser for a custom query format: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar.
|
Package query provides a parser for a custom query format: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar. |
|
The governance package contains functionality for altering permissions, token distribution, consensus parameters, validators, and network forks.
|
The governance package contains functionality for altering permissions, token distribution, consensus parameters, validators, and network forks. |
|
lib/server
Commons for HTTP handling
|
Commons for HTTP handling |