Skip to content

Commit

Permalink
Update documentation with latest changes on Tessera APIs (#906)
Browse files Browse the repository at this point in the history
  • Loading branch information
namtruong authored and jpmsam committed Dec 9, 2019
1 parent dd10cda commit 877f852
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/Privacy/Tessera/Usage/Interface & API.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

All interfaces can be set to run over HTTP, GRPC or HTTP-over-Unix-Sockets.

### gRPC (for inter-node communication)
### gRPC for inter-node communication (Deprecated)

We currently have an implementation of gRPC for peer node communication as experiment API. This is not enabled on Quorum yet, but between Tessera nodes they can be enabled by adding in a couple of properties in the configuration file as child elements of `serverConfig`.

Expand All @@ -12,6 +12,9 @@ We currently have an implementation of gRPC for peer node communication as exper

Please note that communication between Quorum and Tessera are still via unix socket. This communication flag provides additional options for Tessera peer-to-peer communication. If gRPC is the option specified, please ensure the peers urls are provided with the appropriate ports.

!!! info
gRPC as a protocol for peer-to-peer communication will be removed from Tessera version 0.10.2

---

### Tessera to Tessera - Public API
Expand Down Expand Up @@ -41,6 +44,8 @@ The following endpoints are advertised on this interface:
* `/version`
* `/upcheck`
* `/storeraw`
* `/keys`
* `/partyinfo/keys`

### Quorum to Tessera - Private API

Expand All @@ -49,6 +54,7 @@ Quorum uses this API to:
- Send and receive details of private transactions

The following endpoints are advertised on this interface:

- `/version`
- `/upcheck`
- `/sendraw`
Expand All @@ -60,12 +66,13 @@ The following endpoints are advertised on this interface:
### Admin API

Admins should use this API to:

- Access information about the Tessera node
- Make changes to the configuration of the Tessera node

The following endpoints are advertised on this API:

- `/peers` - Add to, and retrieve from, the Tessera node's peers list
- `/keypairs` - Retrieve all public keys or search for a particular public key in use by the Tessera node

## API Details

Expand Down

0 comments on commit 877f852

Please sign in to comment.