pegasys-orchestrate/README.md

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

[![Website](https://img.shields.io/website?label=documentation&url=https%3A%2F%2Fdocs.orchestrate.pegasys.tech%2F)](https://docs.orchestrate.pegasys.tech/)
[![Website](https://img.shields.io/website?label=website&url=https%3A%2F%2Fpegasys.tech%2Forchestrate%2F)](https://pegasys.tech/orchestrate/)

[![npm](https://img.shields.io/npm/v/pegasys-orchestrate)](https://www.npmjs.com/package/pegasys-orchestrate)
[![npm](https://img.shields.io/npm/dw/pegasys-orchestrate)](https://www.npmjs.com/package/pegasys-orchestrate)

[![CircleCI](https://img.shields.io/circleci/build/gh/ConsenSys/orchestrate-node?token=b950a12c7c5f1ba8ae60273360c99d832301057a)](https://circleci.com/gh/ConsenSys/orchestrate-node)
[![codecov](https://codecov.io/gh/ConsenSys/orchestrate-node/branch/master/graph/badge.svg)](https://codecov.io/gh/ConsenSys/orchestrate-node)
[![Known Vulnerabilities](https://snyk.io/test/github/PegaSysEng/orchestrate-node/badge.svg?targetFile=package.json)](https://snyk.io/test/github/PegaSysEng/orchestrate-node?targetFile=package.json)

# Orchestrate Node.js Library

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

## Compatibility

| SDK versions        | Orchestrate versions           |
| ------------------- | ------------------------------ |
| master/HEAD         | Orchestrate main/HEAD          |
| SDK v6.2.x          | Orchestrate v21.12.5 or higher |
| SDK v6.1.x          | Orchestrate v21.12.1 or higher |
| SDK v6.0.x          | Orchestrate v21.12.0 or higher |
| ~~SDK v5.x.x~~      | Deprecated                     |
| SDK v4.1.x          | Orchestrate v21.1.5 or higher  |
| SDK v4.0.x          | Orchestrate v21.1.0 or higher  |
| SDK v3.1.1          | Orchestrate v2.4 or higher     |
| SDK v3.1.x          | Orchestrate v2.3 or higher     |
| SDK v3.0.x          | Orchestrate v2.3-rcX           |
| SDK v2.3.x          | Orchestrate v2.1 or higher     |
| SDK v2.2.x          | Orchestrate v2.1 or higher     |
| SDK v2.1.x          | Orchestrate v2.1 or higher     |
| SDK v2.0.x          | Orchestrate v2.0               |
| SDK v1.0.x or lower | Orchestrate v1.0 or lower      |

## Orchestrate documentation

For a global understanding of Orchestrate, not only this SDK, refer to the
[Orchestrate documentation.](https://docs.orchestrate.consensys.net/)

## Important requirement

**The Orchestrate SDK requires Orchestrate to be installed.**

> **Important:** Orchestrate is only available for Orchestrate customers and
> [ConsenSys partners](https://consensys.net/solutions/partnerships/).
>
> [Contact ConsenSys](https://codefi.consensys.net/orchestrate-get-in-touch) if you want to purchase Orchestrate
> or are interested in our [partner program](https://consensys.net/solutions/partnerships/).
>
> 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](mailto: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](https://github.com/PegaSysEng/quorum-dev-quickstart/tree/master/files/orchestrate).