From 1d59f90486c7e2962e86bb1e8635b0d55b7af347 Mon Sep 17 00:00:00 2001 From: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Date: Mon, 29 Jul 2019 15:08:48 +1000 Subject: [PATCH] [PAN-2936] Add section on EEA compliant privacy (#1769) Signed-off-by: Adrian Sutton --- docs/Privacy/How-To/EEA-Compliant.md | 39 ++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 40 insertions(+) create mode 100644 docs/Privacy/How-To/EEA-Compliant.md diff --git a/docs/Privacy/How-To/EEA-Compliant.md b/docs/Privacy/How-To/EEA-Compliant.md new file mode 100644 index 0000000000..6e6141d930 --- /dev/null +++ b/docs/Privacy/How-To/EEA-Compliant.md @@ -0,0 +1,39 @@ +description: JSON-RPC methods to use for EEA-compliant privacy + + +# Using EEA-compliant Privacy + +When using [EEA-compliant privacy](../Explanation/Privacy-Groups.md), the group of nodes specified by `privateFrom`and `privateFor` form a privacy group and are given a unique +privacy group ID by Orion. + +Enable the [`EEA` API methods](../../Reference/Pantheon-API-Methods.md#eea-methods) using the [`--rpc-http-api`](../../Reference/Pantheon-CLI-Syntax.md#rpc-http-api) +or [`--rpc-ws-api`](../../Reference/Pantheon-CLI-Syntax.md#rpc-ws-api) command line options. + +Specify `privateFor` when creating the signed transaction passed as an input parameter to [`eea_sendRawTransaction`](../../Reference/Pantheon-API-Methods.md#eea_sendrawtransaction) +to create an EEA-compliant private transaction. + +## Privacy Group Type + +Privacy groups created when specifying `privateFrom` and `privateFor` are identified as type `LEGACY` +when returned by [`priv_findPrivacyGroup`](../../Reference/Pantheon-API-Methods.md#priv_findprivacygroup). + +!!! example + ```json + { + "jsonrpc": "2.0", + "id": 1, + "result": [ + { + "privacyGroupId": "68/Cq0mVjB8FbXDLE1tbDRAvD/srluIok137uFOaClM=", + "name": "legacy", + "description": "Privacy groups to support the creation of groups by privateFor and privateFrom", + "type": "LEGACY", + "members": [ + "g59BmTeJIn7HIcnq8VQWgyh/pDbvbt2eyP0Ii60aDDw=", + "negmDcN2P4ODpqn/6WkJ02zT/0w0bjhGpkZ8UP6vARk=" + ] + } + ] + } + ``` + diff --git a/mkdocs.yml b/mkdocs.yml index 5dfb25aeb2..165dde8ac4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -105,6 +105,7 @@ nav: - Using web3.js-eea Multinode Example: Privacy/Tutorials/eeajs-Multinode-example.md - How To: - Create and Send Private Transactions: Privacy/How-To/Creating-Sending-Private-Transactions.md + - Use EEA-compliant Privacy: Privacy/How-To/EEA-Compliant.md - Use the web3.js-eea Client Library: Privacy/How-To/eeajs.md - Explanation: - Privacy Overview: Privacy/Explanation/Privacy-Overview.md