Introduction @ consensys/quorum

Directory Structure
Entrypoints
API
CLI
UI
Schemas
Build
Test
Security
Bookmarks

.github
- ISSUE_TEMPLATE
- workflows
- CODEOWNERS
- CONTRIBUTING.md
- no-response.yml
- stale.yml
accounts
- abi
- external
- keystore
- pluggable
- scwallet
- usbwallet
- accounts.go
- accounts_test.go
- errors.go
- hd.go
- hd_test.go
- manager.go
- sort.go
- url.go
- url_test.go
build
- deb
- checksums.txt
- ci-notes.md
- ci.go
- goimports.sh
- mvn.pom
- mvn.settings
- nsis.envvarupdate.nsh
- nsis.geth.nsi
- nsis.install.nsh
- nsis.pathupdate.nsh
- nsis.simplefc.dll
- nsis.simplefc.source.zip
- nsis.uninstall.nsh
- pod.podspec
- run-peeps.sh
- update-license.go
cmd
- abidump
- abigen
- bootnode
- checkpoint-admin
- clef
- devp2p
- ethkey
- evm
- faucet
- geth
- p2psim
- puppeth
- rlpdump
- utils
common
- bitutil
- compiler
- fdlimit
- hexutil
- http
- math
- mclock
- prque
- big.go
- bytes.go
- bytes_test.go
- debug.go
- format.go
- path.go
- quorum.go
- size.go
- size_test.go
- slice.go
- slice_test.go
- test_utils.go
- types.go
- types_test.go
consensus
- clique
- ethash
- istanbul
- misc
- consensus.go
- errors.go
- protocol.go
console
- prompt
- testdata
- bridge.go
- bridge_test.go
- console.go
- console_test.go
containers
- docker
- vagrant
contracts
- checkpointoracle
core
- asm
- bloombits
- constellation-test-keys
- forkid
- mps
- privatecache
- rawdb
- state
- types
- vm
- .gitignore
- bench_test.go
- block_validator.go
- block_validator_test.go
- blockchain.go
- blockchain_cache_provider_mps_test.go
- blockchain_cache_provider_test.go
- blockchain_insert.go
- blockchain_repair_test.go
- blockchain_sethead_test.go
- blockchain_snapshot_test.go
- blockchain_test.go
- blocks.go
- bloom_indexer.go
- call_helper.go
- chain_indexer.go
- chain_indexer_test.go
- chain_makers.go
- chain_makers_test.go
- config.go
- dao_test.go
- default_psm.go
- default_psm_test.go
- dual_state_test.go
- error.go
- events.go
- evm.go
- gaspool.go
- gen_genesis.go
- gen_genesis_account.go
- genesis.go
- genesis_alloc.go
- genesis_test.go
- headerchain.go
- headerchain_test.go
- mkalloc.go
- multiple_psm.go
- multiple_psm_test.go
- private_state_manager.go
- private_state_test.go
- rlp_test.go
- state_prefetcher.go
- state_prefetcher_private_test.go
- state_processor.go
- state_processor_test.go
- state_transition.go
- state_transition_pmh.go
- state_transition_pmh_test.go
- state_transition_test.go
- tx_cacher.go
- tx_journal.go
- tx_list.go
- tx_list_test.go
- tx_noncer.go
- tx_pool.go
- tx_pool_test.go
- types.go
- upgrade_db_test.go
crypto
- blake2b
- bls12381
- bn256
- ecies
- secp256k1
- signify
- crypto.go
- crypto_test.go
- signature_cgo.go
- signature_nocgo.go
- signature_test.go
docs
- Consensus
- audits
- images
- theme
- Quorum Design.png
- Quorum Whitepaper v0.2.pdf
- conf.py
eth
- catalyst
- downloader
- ethconfig
- fetcher
- filters
- gasprice
- protocols
- tracers
- api.go
- api_backend.go
- api_backend_test.go
- api_test.go
- backend.go
- bloombits.go
- config_test.go
- handler.go
- handler_eth.go
- handler_eth_test.go
- handler_qlight_client.go
- handler_qlight_server.go
- handler_snap.go
- handler_test.go
- peer.go
- peerset.go
- quorum_protocol.go
- state_accessor.go
- sync.go
- sync_test.go
ethclient
- ethclient.go
- ethclient_test.go
- privateTransactionManagerClient.go
- privateTransactionManagerClient_test.go
- signer.go
ethdb
- dbtest
- leveldb
- memorydb
- batch.go
- database.go
- iterator.go
ethstats
- ethstats.go
event
- event.go
- event_test.go
- example_feed_test.go
- example_scope_test.go
- example_subscription_test.go
- example_test.go
- feed.go
- feed_test.go
- subscription.go
- subscription_test.go
extension
- extensionContracts
- privacyExtension
- api.go
- backend.go
- backend_test.go
- client.go
- contract_facade.go
- data_handler.go
- data_handler_test.go
- extension_utilities.go
- proxy_api.go
- services_factory.go
- state_fetcher.go
- state_fetcher_test.go
- subscriptions.go
- types.go
graphql
- graphiql.go
- graphiql_test.go
- graphql.go
- graphql_test.go
- schema.go
- service.go
internal
- build
- cmdtest
- debug
- ethapi
- flags
- guide
- jsre
- plugin
- testlog
- utesting
- web3ext
les
- checkpointoracle
- flowcontrol
- utils
- vflux
- api.go
- api_backend.go
- api_test.go
- benchmark.go
- bloombits.go
- client.go
- client_handler.go
- commons.go
- costtracker.go
- distributor.go
- distributor_test.go
- enr_entry.go
- fetcher.go
- fetcher_test.go
- handler_test.go
- metrics.go
- odr.go
- odr_requests.go
- odr_test.go
- peer.go
- peer_test.go
- protocol.go
- pruner.go
- pruner_test.go
- request_test.go
- retrieve.go
- server.go
- server_handler.go
- server_requests.go
- servingqueue.go
- state_accessor.go
- sync.go
- sync_test.go
- test_helper.go
- txrelay.go
- ulc.go
- ulc_test.go
light
- lightchain.go
- lightchain_test.go
- nodeset.go
- odr.go
- odr_test.go
- odr_util.go
- postprocess.go
- trie.go
- trie_test.go
- txpool.go
- txpool_test.go
log
- CONTRIBUTORS
- LICENSE
- README.md
- README_ETHEREUM.md
- doc.go
- emit_checkpoint.go
- format.go
- format_test.go
- handler.go
- handler_glog.go
- handler_go13.go
- handler_go14.go
- logger.go
- root.go
- syslog.go
metrics
- exp
- influxdb
- librato
- prometheus
- FORK.md
- LICENSE
- README.md
- config.go
- counter.go
- counter_test.go
- cpu.go
- cpu_disabled.go
- cpu_enabled.go
- cpu_syscall.go
- cpu_windows.go
- debug.go
- debug_test.go
- disk.go
- disk_linux.go
- disk_nop.go
- doc.go
- ewma.go
- ewma_test.go
- gauge.go
- gauge_float64.go
- gauge_float64_test.go
- gauge_test.go
- graphite.go
- graphite_test.go
- healthcheck.go
- histogram.go
- histogram_test.go
- init_test.go
- json.go
- json_test.go
- log.go
- memory.md
- meter.go
- meter_test.go
- metrics.go
- metrics_test.go
- opentsdb.go
- opentsdb_test.go
- registry.go
- registry_test.go
- resetting_sample.go
- resetting_timer.go
- resetting_timer_test.go
- runtime.go
- runtime_cgo.go
- runtime_gccpufraction.go
- runtime_no_cgo.go
- runtime_no_gccpufraction.go
- runtime_test.go
- sample.go
- sample_test.go
- syslog.go
- timer.go
- timer_test.go
- validate.sh
- writer.go
- writer_test.go
miner
- miner.go
- miner_test.go
- stress_clique.go
- stress_ethash.go
- unconfirmed.go
- unconfirmed_test.go
- worker.go
- worker_test.go
mobile
- accounts.go
- android_test.go
- big.go
- bind.go
- common.go
- context.go
- discover.go
- doc.go
- ethclient.go
- ethereum.go
- geth.go
- geth_android.go
- geth_ios.go
- geth_other.go
- init.go
- interface.go
- interface_test.go
- logger.go
- p2p.go
- params.go
- primitives.go
- types.go
- vm.go
multitenancy
- authorization.go
- authorization_test.go
- docs.go
- types.go
node
- api.go
- api_test.go
- config.go
- config_test.go
- defaults.go
- doc.go
- endpoints.go
- errors.go
- lifecycle.go
- node.go
- node_example_test.go
- node_test.go
- rpcstack.go
- rpcstack_test.go
- utils_test.go
p2p
- discover
- dnsdisc
- enode
- enr
- nat
- netutil
- nodestate
- rlpx
- simulations
- tracker
- dial.go
- dial_test.go
- message.go
- message_test.go
- metrics.go
- peer.go
- peer_error.go
- peer_test.go
- protocol.go
- qlight_transport.go
- server.go
- server_test.go
- transport.go
- transport_test.go
- util.go
- util_test.go
params
- bootnodes.go
- config.go
- config_test.go
- dao.go
- denomination.go
- errors.go
- network_params.go
- network_params_test.go
- protocol_params.go
- protocol_params_test.go
- quorum.go
- version.go
permission
- core
- v1
- v2
- api.go
- backend.go
- connection.go
- permission.go
- permission_test.go
plugin
- account
- gen
- helloworld
- initializer
- qlight
- security
- api.go
- base.go
- central.go
- central_test.go
- downloader.go
- downloader_test.go
- local_verifier.go
- local_verifier_test.go
- online_verifier.go
- plugin_manager_mockery.go
- plugin_templates.go
- plugin_templates_mockery.go
- service.go
- service_test.go
- settings.go
- settings_test.go
- utils.go
- utils_test.go
- verifier.go
- verifier_test.go
private
- cache
- engine
- mock_private
- mock_private.go
- private.go
- private_test.go
qlight
- test
- api.go
- client_cache.go
- config.go
- server.go
- token_holder.go
- token_holder_test.go
- types.go
raft
- api.go
- backend.go
- backend_test.go
- constants.go
- events.go
- handler.go
- handler_test.go
- listener.go
- minter.go
- minter_test.go
- peer.go
- persistence.go
- snapshot.go
- speculative_chain.go
- util.go
- wal.go
rlp
- decode.go
- decode_tail_test.go
- decode_test.go
- doc.go
- encode.go
- encode_test.go
- encoder_example_test.go
- iterator.go
- iterator_test.go
- raw.go
- raw_test.go
- typecache.go
rpc
- testdata
- client.go
- client_example_test.go
- client_test.go
- constants_unix.go
- constants_unix_nocgo.go
- context.go
- doc.go
- endpoints.go
- errors.go
- handler.go
- http.go
- http_test.go
- inproc.go
- ipc.go
- ipc_js.go
- ipc_unix.go
- ipc_windows.go
- json.go
- metrics.go
- security.go
- security_test.go
- server.go
- server_test.go
- service.go
- stdio.go
- subscription.go
- subscription_test.go
- testservice_test.go
- types.go
- types_test.go
- websocket.go
- websocket_test.go
signer
- core
- fourbyte
- rules
- storage
swarm
- README.md
tests
- fuzzers
- solidity
- testdata
- block_test.go
- block_test_util.go
- difficulty_test.go
- difficulty_test_util.go
- gen_btheader.go
- gen_difficultytest.go
- gen_stenv.go
- gen_sttransaction.go
- gen_vmexec.go
- init.go
- init_test.go
- rlp_test.go
- rlp_test_util.go
- state_test.go
- state_test_util.go
- transaction_test.go
- transaction_test_util.go
- vm_test.go
- vm_test_util.go
trie
- committer.go
- database.go
- database_test.go
- encoding.go
- encoding_test.go
- errors.go
- hasher.go
- iterator.go
- iterator_test.go
- node.go
- node_test.go
- proof.go
- proof_test.go
- secure_trie.go
- secure_trie_test.go
- stacktrie.go
- stacktrie_test.go
- sync.go
- sync_bloom.go
- sync_test.go
- trie.go
- trie_test.go
.bintray.json
.dockerignore
.gitattributes
.gitignore
.gitmodules
.golangci.yml
.mailmap
.travis.yml
AUTHORS
BUILDING.md
COPYING
COPYING.LESSER
Dockerfile
Dockerfile.alltools
Makefile
NOTES.md
README.md
SECURITY.md
appveyor.yml
circle.yml
go.mod
go.sum
interfaces.go
logo.png
mkdocs.yml
oss-fuzz.sh

Introduction

This document aims to provide a brief overview of the Introduction section of the GoQuorum codebase and its importance.

What is Introduction?

The Introduction section of the GoQuorum codebase serves as the entry point for understanding the core concepts and architecture of the project. It provides a high-level overview of GoQuorum’s features, purpose, and how it relates to Ethereum and go-ethereum.

Why is Introduction important?

The Introduction is crucial for several reasons:

Understanding the project’s scope: It provides a clear understanding of what GoQuorum is, its purpose, and its key features.
Contextualization: It establishes the relationship between GoQuorum and its parent project, go-ethereum, highlighting the key enhancements and modifications implemented.
Starting Point: It acts as a starting point for developers and users who are new to GoQuorum, providing a foundational understanding of the project’s architecture and its key components.
Guidance for further exploration: The Introduction guides users to relevant resources and documentation for a more in-depth understanding of specific features and functionalities.

Architecture

The Introduction section typically provides a high-level overview of the architectural components of GoQuorum, such as:

Tessera: A component that enables private transactions and contracts through public/private state separation and peer-to-peer encrypted message exchanges.
Consensus Mechanisms: GoQuorum offers several consensus mechanisms tailored for permissioned networks, including QBFT, Istanbul BFT, Clique POA, and Raft-based Consensus.
Pluggable Architecture: This feature allows GoQuorum to be extended with additional functionalities through plugins, providing flexibility and isolation.
Performance: GoQuorum aims to provide higher performance throughput compared to public geth.

Quickstart

The Introduction often includes information about quickstart guides and tools that make it easier for users to get started with GoQuorum.

GoQuorum Projects

This section provides a list of related GoQuorum projects, such as:

quorum-remix-plugin: A plugin for Ethereum’s Remix IDE that supports private contracts on a GoQuorum network.
Cakeshop: An integrated development environment and SDK for GoQuorum.
quorum-examples: A collection of GoQuorum demonstration examples.
Quorum-Kubernetes: A tool for deploying GoQuorum on Kubernetes.
we3js-quorum: An extension to web3.js that supports GoQuorum and Hyperledger Besu APIs.
Zero Knowledge on GoQuorum: This section may highlight projects related to zero-knowledge proofs on GoQuorum, including ZSL and Anonymous Zether.

Docker Containers

The Introduction may mention the availability of official Docker containers for GoQuorum, which can be found on Docker Hub.

Third Party Tools and Libraries

This section often lists third-party tools and libraries that enhance GoQuorum’s functionality, such as:

Chainlens Blockchain Explorer: A Blockchain Explorer for GoQuorum that supports viewing private transactions.
Quorum-Genesis: A CL utility for GoQuorum that helps populate the genesis file.
Quorum Maker: A utility for creating GoQuorum nodes.
ERC20 REST service: A GoQuorum-supported RESTful service for managing ERC-20 tokens.
Nethereum Quorum: A .NET GoQuorum adapter.
web3j-quorum: An extension to the web3j Java library that supports GoQuorum APIs.
Apache Camel: An Apache Camel component that provides support for the GoQuorum API using the web3j library.

Contributing

The Introduction may include information about how to contribute to GoQuorum, including guidelines for contributing code and submitting security bugs.

License

This section provides details about the licensing information for GoQuorum’s codebase, often referencing the GNU Lesser General Public License and the GNU General Public License.