Orchestrate Node.js Library

The Orchestrate library provides convenient access to the Orchestrate API from applications written in server-side JavaScript

Compatibility

Orchestrate documentation

For a global understanding of Orchestrate, not only this SDK, refer to the Orchestrate documentation.

Important requirement

The Orchestrate SDK requires Orchestrate to be installed.

Important: Orchestrate is only available for Orchestrate customers and ConsenSys partners.

Contact ConsenSys if you want to purchase Orchestrate or are interested in our partner program.

If you are already a partner or customer but we did not provide the credentials to access the Docker registry, send an email from your company email to orchestrate@consensys.net.

You can use this Quickstart only if you have received these credentials from ConsenSys to connect to the registry.

You cannot continue without the registry credentials.

Tip Try a free trial of Orchestrate with the Quorum Dev Quickstart.

CHANGELOG

All notable changes to this project will be documented in this file.

7.0.0 (WIP)

⚠ BREAKING CHANGES

• Reformatted job notification message

6.2.1 (2022-08-01)

🛠 Bug fixes

• Fixed inconsistent types on UpdateAccount and GetTransaction responses

6.2.0 (2022-06-07)

🛠 Bug fixes

• Fixed protobuf incompatibility.

6.1.2 (2022-06-07)

🛠 Bug fixes

• Fixed invalid type for gas.

6.1.1 (2022-02-24)

🛠 Bug fixes

• Add retryPolicy to raw transactions

6.1.0 (2022-01-13)

🆕 Features

• Support for Orchestrate v21.12.1 by adding the contractTag and contractName field to the ISendTransactionRequest object.

6.0.2 (2022-01-03)

🛠 Bug fixes

• Added missing storeID parameter to account request types

6.0.1 (2021-12-20)

🛠 Bug fixes

• Typo on auto generated documentation

6.0.0 (2021-12-20)

🆕 Features

• Support for new transaction pricing mechanism (eip-1559)
• Support for go-quorum privacy privacy enhancements: privacyFlags, mandatoryFor
• Support for go-quorum private transaction with optional privateFrom.
• Support for contract name and tag in transaction receipts

⚠ BREAKING CHANGES

• Removed /accounts/{address}/sign and /accounts/{address}/verify-signature in favor of /accounts/{address}/sign-message and /accounts/verify-message accordingly to EIP-191 standards

5.0.0 (DEPRECATED)

Deprecated version

4.2.1 (2021-10-06)

🛠 Bug fixes

• Fix return value of delete chain
• Security issues with package updates

4.2.0 (2021-06-3)

🆕 Features

• Adds new headers parameter to every method enabling users to pass complex headers such as X-Tenant-ID.

4.1.1 (2021-07-02)

🛠 Bug fixes

• Added support for delete chain

4.1.0 (2021-06-3)

🆕 Features

• Support for chain's metadata

4.0.0 (2021-01-25)

🆕 Features

• New Identity Management API to enable fine-grained management of Ethereum accounts
• Support for remote transaction signing, random payload signing and signature verify
• New unified API client, OrchestrateClient`

⚠ BREAKING CHANGES

• Remove support for account generation using the kafka. Removes AccountGenerator class and usages
• Remove support for contract-registry GRPC
• Remove account generation using CLI
• Remove client API classes TransactionClient, FaucetRegistry, ContractRegistry and ChainRegistry
• Renamed client API methods:
  • send(...) -> sendTransaction(...)
  • search() -> searchTransactions(...)
  • register(...) -> registerContract(...)
  • getCatalog(...) -> getContractsCatalog(...)
  • getTags(...) -> getContractTags(...)

3.1.2 (2020-10-12)

🛠 Bug fixes

• Fixes a bug where the consumer crashes when a raw transaction fails in the topic tx-recover

3.1.1 (2020-09-29)

🆕 Features

• Adding interfaces to create transactions with a gas price retry policy with an increment, limit and interval
• Adds job UUID to the transaction response

3.1.0 (2020-09-02)

🛠 Bug fixes

• Fixes a search of transactions by idempotency key issue
• Adapt transaction request interfaces to include gasPricePolicy

3.0.1 (2020-07-31)

🛠 Bug fixes

• Fixes a security issue by upgrading ethers to version 5

3.0.0 (2020-07-29)

🆕 Features

• Adapt SDK to be compatible with Orchestrate v2.3.0-rcX

2.3.0 (2020-07-08)

🆕 Features

• Manage your chains using a new HTTP wrapper chainRegistry
• Manage your faucets using a new HTTP wrapper faucetRegistry

2.2.0 (2020-06-08)

🛠 Bug fixes

• Update AccountGenerator constructor to be able to pass configurations for the producer and consumer, including the consumer group id.

Breaking changes

• chainName field was replaced by chain in TxRequest and TxResponse interfaces

2.1.0 (2020-06-02)

🆕 Features

• Support private transaction with Besu/Orion and Quorum/Tessera
• Support revert reason in transaction receipt
• Adds chain information to the transaction response

2.0.1 (2020-03-24)

🛠 Bug fixes

• Fixes a bug where the status of a receipt is always true when the transaction reverted

2.0.0 (2020-02-03)

Complete rewrite of the SDK in pure TypeScript and redefinition of the interfaces

🆕 Features

• Support version 2.0+ of Orchestrate
• Complete rewrite of the SDK in TypeScript
• Usage of kafkajs instead of kafka-node
• Usage of grpc-js instead of grpc
• Switch from an auto-commit mode to a manual commit which prevents to inadvertently commit non-processed messages and lose them.
• Consumer, Producer, ContractRegistry and AccountGenerator exposed as standalone classes
• Producer:
  • Accepts Options to increase flexibility of usage with Kafka
  • Specific functions for specific actions such as sendTransaction, sendRawTransaction and generateAccount.
  • Functions default to correct topics
• Consumer:
  • Accepts Options to increase flexibility of usage with Kafka
  • Implements a commit function to commit the message offsets manually
  • Returns output messages of the type ResponseMessage
• Rename Wallet into Account

1.0.0 (Unreleased)

Version 1.0.0 not released as the SDK has been rewritten completely as version 2.0.0

1.0.0-rc1 to 1.0.0-rc3 (2020-01-24)

🆕 Features

• Add the GetContract gRPC function call
• Add the nonce field
• Export the marshal and unmarshal methods in the consumer and producer

🛠 Bug fixes

• Rename geNetworks in getNetworks
• Correct typo to make ConsumerGroup extending from the correct class
• Add types in the package.json

0.5.0 (2019-10-30)

🆕 Features

• Make cli installable
• Support for TLS gRPC servers
• Rename to PegaSys Orchestrate

0.4.0 to 0.4.8 (2019-09-24)

🆕 Features

• Update ProducerOutput type with 'id' field as a string
• Update Readme - redirect to documentation website
• Update web3 to v1.2.0
• Update pkg to v0.7.0
• Update docstring

🛠 Bug fixes

• Update type definition file - add class attributes
• Update types for methods with Promises
• Update types options for producer, consumer, consumerGroup
• Update type definition path in package.json
• Use webpack instead of babel to build
• Use regenerator-runtime in main file

0.3.0 to 0.3.1 (2019-07-11)

🆕 Features

• Add typescript definitions
• Clean code and naming
• Update pkg to v0.6.1
• Check signature, input arguments, arguments

0.2.0 to 0.2.1 (2019-06-28)

🆕 Features

• Update pkg to v0.5.7
• Create wallet asynchronously
• Add web3 wrapper

0.1.0 to 0.1.8

🆕 Features

• Unmarshal extra metadata into Object instead of Array
• Unmarshal DecodedData into an Object instead of an Array
• Update README
• Update protobuf messages (v0.2.0-alpha.8 of pkg) including Quorum
• Handling error message type
• Create Producer, Consumer, ConsumerGroup
• Marshal message in protobuf