Merge pull request #104 from gnosisguild/sp/evm-release

fix publish env vars, better readme

.github/workflows/publish-evm.yml

@@ -5,8 +5,9 @@ on:
     types: [created]
 
 env:
-  HARDHAT_VAR_MNEMONIC: "test test test test test test test test test test test junk"
-  HARDHAT_VAR_INFURA_API_KEY: "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+  MNEMONIC: "test test test test test test test test test test test junk"
+  INFURA_API_KEY: "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+  ETHERSCAN_API_KEY: "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
 
 jobs:
   publish-npm:

packages/evm/README.md

@@ -1,5 +1,28 @@
 # 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
 
 ```
@@ -19,8 +42,27 @@ To add a ciphernode to the registry, run
 yarn ciphernode:add --network [network] --ciphernode-address [address]
 ```
 
-To remove a ciphernode, run
+To request a new committee, run
+
+```
+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 ciphernode:remove --network [network] --ciphernode-address [address]
+yarn run hardhat --network [network] e3:publishInput --e3-id [e3-id] --data [input data]
 ```