README
¶
Hyperledger Burrow
Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node. It executes Ethereum EVM and WASM 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
Burrow is a fully fledged blockchain node and smart contract execution engine -- a distributed database that executes code. Burrow runs Ethereum Virtual Machine (EVM) and Web Assembly (WASM) smart contracts. Burrow networks are synchronised using the Tendermint consensus algorithm.
Highlights include:
- Tamper-resistant merkle state - a node can detect if its state is corrupted or if a validator is dishonestly executing the protocol.
- Proof-of-stake support - run a private or public permissioned network.
- On-chain governance primitives - stakeholders may vote for autonomous smart contract upgrades.
- Ethereum account world-view - state and code is organised into cryptographically-addressable accounts.
- Low-level permissioning - code execution permissions can be set on a per-account basis.
- Event streaming - application state is organised in an event stream and can drive external systems.
- SQL mapping layer - map smart contract event emissions to SQL tables using a projection specification.
- GRPC interfaces - all RPC calls can be accessed from any language with GRPC support. Protobuf is used extensively for core objects.
- Javascript client library - client library uses code generation to provide access to contracts via statically Typescript objects.
- Keys service - provides optional delegating signing at the server or via a local proxy
- Web3 RPC - provides compatibility for mainnet Ethereum tooling such as Truffle and Metamask
What it is not
- An Ethereum mainnet client - we do not speak devp2p and various implementation details are different. We are Ethereum-derived but exploit greater freedom than mainnet compatibility would allow.
- Just a virtual machine
- A research project - we run it in production
Further introduction
See Burrow - the Boring Blockchain for an introduction to Burrow and its motivating vision.
Watch the Boring into Burrow talk from the Hyperledger Global Forum 2020
JavaScript Client
There is a JavaScript API
Project Roadmap
Project information generally updated on a quarterly basis can be found on the Hyperledger Burrow Wiki.
Documentation
Burrow getting started documentation is available on the documentation site (source markdown files can be found in docs) and programmatic API 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:
License
Documentation
¶
There is no documentation for this package.
Source Files
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
|
|
|
burrow
command
|
|
|
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. |
|
cmd/changelog
command
|
|
|
cmd/notes
command
|
|
|
cmd/version
command
|
|
|
lib/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
web3
Code generated by go-openrpc.
|
Code generated by go-openrpc. |
|
logging/cmd
command
|
|
|
vent
|
|
|
sqlsol
This package defines our Solidity to SQL relational database mapping layer which aims to describe tables realised as a projection of all EVM Log events emitted by the chain.
|
This package defines our Solidity to SQL relational database mapping layer which aims to describe tables realised as a projection of all EVM Log events emitted by the chain. |