@gnosis-guild/enclave - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "@gnosis-guild/enclave",
   "description": "Enclave is an open-source protocol for Encrypted Execution Environments (E3).",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "LGPL-3.0-only",
@@ -6,0 +6,0 @@ "author": {

README.md

 # Enclave EVM
 
+## Importing the contracts, interfaces or types
+
+To install, run
+
+```
+yarn add @gnosis-guild/enclave
+```
+
+If writing a new E3 program, you can import the necessary interfaces by writing
+something similar to:
+
+```
+import {
+    IE3Program,
+    IInputValidator,
+    IDecryptionVerifier
+} from "../interfaces/IE3Program.sol";
+
+contract MockE3Program is IE3Program {...}
+```
+
+[Check out the E3 mock for an example](./contracts/test/MockE3Program.sol)
+
 ## To deploy
@@ -22,6 +45,25 @@
 
-To remove a ciphernode, run
+To request a new committee, run
 
 ```
-yarn ciphernode:remove --network [network] --ciphernode-address [address]
+yarn run hardhat committee:new --network [network] \
 ```
+
+To publish the public key of a committee, run
+
+```
+yarn run hardhat --network [network] committee:publish --e3-id [e3-id] --nodes [node address],
+[node address] --public-key [publickey] \
+```
+
+To activate an E3, run
+
+```
+yarn run hardhat --network [network] e3:activate --e3-id [e3-id] \
+```
+
+To publish an input for an active E3, run
+
+```
+yarn run hardhat --network [network] e3:publishInput --e3-id [e3-id] --data [input data]
+```

No alert changes

Improved metrics

Total package byte prevSize

56441

increased by1.55%

Number of lines in readme file

69

increased by155.56%

No dependency changes