From 877f85208e1db88e25398553a8a65c894032771c Mon Sep 17 00:00:00 2001 From: Nam Truong Date: Mon, 9 Dec 2019 17:43:04 +0000 Subject: [PATCH] Update documentation with latest changes on Tessera APIs (#906) --- docs/Privacy/Tessera/Usage/Interface & API.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/Privacy/Tessera/Usage/Interface & API.md b/docs/Privacy/Tessera/Usage/Interface & API.md index adf286a55..bfb68597d 100644 --- a/docs/Privacy/Tessera/Usage/Interface & API.md +++ b/docs/Privacy/Tessera/Usage/Interface & API.md @@ -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`. @@ -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 @@ -41,6 +44,8 @@ The following endpoints are advertised on this interface: * `/version` * `/upcheck` * `/storeraw` +* `/keys` +* `/partyinfo/keys` ### Quorum to Tessera - Private API @@ -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` @@ -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