2016-11-01 07:21:55 -07:00
# Quorum
2015-02-05 12:34:47 -08:00
2016-11-17 11:14:48 -08:00
Quorum is an Ethereum-based distributed ledger protocol with transaction/contract privacy and a new consensus mechanism.
2016-11-14 16:23:29 -08:00
2016-11-16 13:18:19 -08:00
Key enhancements:
2016-11-14 16:23:29 -08:00
* __QuorumChain__ - a new consensus model based on majority voting
* __Constellation__ - a peer-to-peer encrypted message exchange
2016-11-16 13:18:19 -08:00
* __Peer Security__ - node/peer permissioning using smart contracts
2016-11-14 16:23:29 -08:00
## Architecture
2016-11-17 13:07:02 -08:00
< a href = "https://github.com/jpmorganchase/quorum/wiki/Transaction-Processing#private-transaction-process-flow" > ![Quorum privacy architecture](https://github.com/jpmorganchase/quorum-docs/raw/master/images/QuorumTransactionProcessing.JPG)< / a >
2016-11-14 16:23:29 -08:00
2016-11-16 13:18:19 -08:00
The above diagram is a high-level overview of the privacy architecture used by Quorum. For more in-depth discussion of the components, refer to the [wiki ](https://github.com/jpmorganchase/quorum/wiki/ ) pages.
2016-11-14 16:23:29 -08:00
## Quickstart
2016-11-16 13:18:19 -08:00
The quickest way to get started with Quorum is using [VirtualBox ](https://www.virtualbox.org/wiki/Downloads ) and [Vagrant ](https://www.vagrantup.com/downloads.html ):
2016-11-14 16:23:29 -08:00
```sh
git clone https://github.com/jpmorganchase/quorum-examples
2016-11-18 08:52:54 -08:00
cd quorum-examples
2016-11-14 16:23:29 -08:00
vagrant up
# (should take 5 or so minutes)
vagrant ssh
```
Now that you have a fully-functioning Quorum environment set up, let's run the 7-node cluster example. This will spin up several nodes with a mix of voters, block makers, and unprivileged nodes.
2016-11-17 13:00:39 -08:00
```sh
2016-11-14 16:23:29 -08:00
# (from within vagrant env, use `vagrant ssh` to enter)
2016-11-23 14:39:30 -08:00
ubuntu@ubuntu-xenial:~$ cd quorum-examples/examples/7nodes
2016-11-14 16:23:29 -08:00
$ ./init.sh
# (output condensed for clarity)
[*] Cleaning up temporary data directories
[*] Configuring node 1
[*] Configuring node 2 as block maker and voter
[*] Configuring node 3
[*] Configuring node 4 as voter
[*] Configuring node 5 as voter
[*] Configuring node 6
[*] Configuring node 7
$ ./start.sh
[*] Starting Constellation nodes
2016-11-17 13:00:39 -08:00
[*] Starting bootnode... waiting... done
2016-11-14 16:23:29 -08:00
[*] Starting node 1
[*] Starting node 2
[*] Starting node 3
[*] Starting node 4
[*] Starting node 5
[*] Starting node 6
[*] Starting node 7
[*] Unlocking account and sending first transaction
2016-11-17 13:00:39 -08:00
Contract transaction send: TransactionHash: 0xbfb7bfb97ba9bacbf768e67ac8ef05e4ac6960fc1eeb6ab38247db91448b8ec6 waiting to be mined...
2016-11-14 16:23:29 -08:00
true
2016-07-12 02:51:31 -07:00
```
2016-11-22 00:21:10 -08:00
We now have a 7-node Quorum cluster with a [private smart contract ](https://github.com/jpmorganchase/quorum-examples/blob/master/examples/7nodes/script1.js ) (SimpleStorage) sent from `node 1` "for" `node 7` (denoted by the public key passed via `privateFor: ["ROAZBWtSacxXQrOe3FGAqJDyJjFePR5ce4TSIzmJ0Bc="]` in the `sendTransaction` call).
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
Connect to any of the nodes and inspect them using the following commands:
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
```sh
2016-11-14 16:26:48 -08:00
$ geth attach ipc:qdata/dd1/geth.ipc
$ geth attach ipc:qdata/dd2/geth.ipc
2016-11-14 16:23:29 -08:00
...
2016-11-14 16:26:48 -08:00
$ geth attach ipc:qdata/dd7/geth.ipc
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
# e.g.
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
$ geth attach ipc:qdata/dd2/geth.ipc
Welcome to the Geth JavaScript console!
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
instance: Geth/v1.5.0-unstable/linux/go1.7.3
coinbase: 0xca843569e3427144cead5e4d5999a3d0ccf92b8e
at block: 679 (Tue, 15 Nov 2016 00:01:05 UTC)
datadir: /home/ubuntu/quorum-examples/7nodes/qdata/dd2
modules: admin:1.0 debug:1.0 eth:1.0 net:1.0 personal:1.0 quorum:1.0 rpc:1.0 txpool:1.0 web3:1.0
2016-07-12 02:51:31 -07:00
2016-11-01 07:21:55 -07:00
> quorum.nodeInfo
{
2016-11-14 16:23:29 -08:00
blockMakerAccount: "0xca843569e3427144cead5e4d5999a3d0ccf92b8e",
2016-11-01 07:21:55 -07:00
blockmakestrategy: {
2016-11-14 16:23:29 -08:00
maxblocktime: 10,
2016-11-01 07:21:55 -07:00
minblocktime: 3,
status: "active",
type: "deadline"
},
canCreateBlocks: true,
canVote: true,
2016-11-14 16:23:29 -08:00
voteAccount: "0x0fbdc686b912d7722dc86510934589e0aaf3b55a"
2016-11-01 07:21:55 -07:00
}
2016-11-14 16:26:48 -08:00
# let's look at the private txn created earlier:
2016-11-17 13:00:39 -08:00
> eth.getTransaction("0xbfb7bfb97ba9bacbf768e67ac8ef05e4ac6960fc1eeb6ab38247db91448b8ec6")
2016-11-14 16:26:48 -08:00
{
2016-11-17 13:00:39 -08:00
blockHash: "0xb6aec633ef1f79daddc071bec8a56b7099ab08ac9ff2dc2764ffb34d5a8d15f8",
2016-11-14 16:26:48 -08:00
blockNumber: 1,
from: "0xed9d02e382b34818e88b88a309c7fe71e65f419d",
gas: 300000,
2016-11-17 13:00:39 -08:00
gasPrice: 0,
hash: "0xbfb7bfb97ba9bacbf768e67ac8ef05e4ac6960fc1eeb6ab38247db91448b8ec6",
input: "0x9820c1a5869713757565daede6fcec57f3a6b45d659e59e72c98c531dcba9ed206fd0012c75ce72dc8b48cd079ac08536d3214b1a4043da8cea85be858b39c1d",
2016-11-14 16:26:48 -08:00
nonce: 0,
2016-11-17 13:00:39 -08:00
r: "0x226615349dc143a26852d91d2dff1e57b4259b576f675b06173e9972850089e7",
s: "0x45d74765c5400c5c280dd6285a84032bdcb1de85a846e87b57e9e0cedad6c427",
2016-11-14 16:26:48 -08:00
to: null,
2016-11-17 13:00:39 -08:00
transactionIndex: 1,
v: "0x25",
2016-11-14 16:26:48 -08:00
value: 0
}
2016-07-12 02:51:31 -07:00
```
2016-11-15 13:55:10 -08:00
Note in particular the `v` field of "0x25" (37 in decimal) which marks this transaction as having a private payload (input).
2016-11-20 18:35:01 -08:00
## Demonstrating Privacy
2016-11-21 06:30:23 -08:00
Documentation detailing steps to demonstrate the privacy features of Quorum can be found in [quorum-examples/7nodes/README ](https://github.com/jpmorganchase/quorum-examples/tree/master/examples/7nodes/README.md ).
2016-11-20 18:35:01 -08:00
2016-11-14 16:23:29 -08:00
## Further Reading
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
Further documentation can be found in the [docs ](docs/ ) folder and on the [wiki ](https://github.com/jpmorganchase/quorum/wiki/ ).
2016-07-12 02:51:31 -07:00
2016-11-14 16:23:29 -08:00
## See also
2013-12-26 04:29:45 -08:00
2016-11-14 16:23:29 -08:00
* Quorum - https://github.com/jpmorganchase/quorum (this repository)
* Constellation - https://github.com/jpmorganchase/constellation
* quorum-examples - https://github.com/jpmorganchase/quorum-examples
* Quorum Wiki - https://github.com/jpmorganchase/quorum/wiki
2015-03-02 10:44:29 -08:00
2016-11-14 16:23:29 -08:00
## Contributing
2015-03-02 10:44:29 -08:00
2016-11-14 16:23:29 -08:00
Thank you for your interest in contributing to Quorum!
2014-02-08 13:16:11 -08:00
2016-11-17 19:35:18 -08:00
Quorum is built on open source and we fully intend to accept public contributions in the near future. Until then, feel free to file issues and open pull requests, but note that we won't be merging them until the necessary processes are in place.
2016-04-29 07:40:19 -07:00
## License
2014-01-11 06:27:08 -08:00
2016-04-29 07:40:19 -07:00
The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the
2016-09-26 23:48:55 -07:00
[GNU Lesser General Public License v3.0 ](https://www.gnu.org/licenses/lgpl-3.0.en.html ), also
2016-04-29 07:40:19 -07:00
included in our repository in the `COPYING.LESSER` file.
2014-02-15 02:49:29 -08:00
2016-04-29 07:40:19 -07:00
The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the
2016-09-26 23:48:55 -07:00
[GNU General Public License v3.0 ](https://www.gnu.org/licenses/gpl-3.0.en.html ), also included
2016-04-29 07:40:19 -07:00
in our repository in the `COPYING` file.