consensys/orchestrate repository overview

⁠Orchestrate

Orchestrate is a blockchain Transaction Orchestration system that can operate multiple chains simultaneously. It provides production grade and agnostic mechanisms for transaction crafting, nonce management, transaction signing, transaction receipt listening, transaction receipt decoding, faucet and more.

Orchestrate is a microservices architecture composed of APIs & Workers. Workers communicate following publish-subscribe pattern using Apache Kafka as message broker.

Orchestrate is Plug & Play, a user only needs to send a business protobuf message to Orchestrate input topic, Orchestrate then manages the full lifecycle of the transaction from crafting the transaction to decoding event logs data.

⁠Useful links

• User Documentation⁠
• Orchestrate OpenAPI⁠
• GitHub Project⁠
• issues⁠
• Changelog⁠
• Quorum Key Manager⁠
• Helm Charts⁠
• Kubernetes deployment example⁠

⁠Run Orchestrate

Now launch Orchestrate service using docker-compose with the following command:

docker-compose up -d api tx-sender tx-listener

Orchestrate is connected to Quorum Key Manager(QKM)⁠ to perform every wallet action (creation, importing, signing, etc...). In this case for QKM setup, we are connecting to a local Hashicorp Vault Server which is enhanced with Quorum Hashicorp Vault Pluging⁠ to support private keys under hashicorp storage.

⁠Build from source

⁠Prerequisites

To build binary locally requires Go (version 1.16 or later) and C compiler.

⁠Build

After downloading dependencies (ie go mod download) you can run the following command to compile the binary

go build -o ./build/bin/orchestrate

Binary will be located in `./build/bin/orchestrate

⁠License

Orchestrate is licensed under the BSL 1.1.

Please refer to the LICENSE file⁠ for a detailed description of the license.

Please contact [email protected]⁠ if you need to purchase a license for a production use-case.