Merge pull request #30 from fioprotocol/eric/readme

Update Readme and wfio.json
fioprotocol · Oct 14, 2022 · 22afb2d · 22afb2d
2 parents 0a1d0e2 + 1f5a716
commit 22afb2d
Show file tree

Hide file tree

Showing 2 changed files with 5,781 additions and 18,345 deletions.
diff --git a/README.md b/README.md
@@ -6,3 +6,18 @@
 - Truffle v5.1.65 (core: 5.1.65)
 - Solidity - ^0.8.0 (solc-js)
 - @OpenZeppelin/contracts@4.3.0
+
+### Truffle deployment
+
+A .env file with following entries is needed for Truffle deployment:
+
+MNEMONIC=                  # Mnemonic phrase for local Ganache testing
+MNEMONIC_DEVNET=           # Mnemonic phrase for Devnet
+MNEMONIC_TESTNET=          # Mnemonic phrase for Testnet
+APP_ID=                    # Infura API key
+ETHERSCAN_API_KEY=         # Etherscan API key
+CUSTODIANS_DEVNET=         # Comma separated list of initial 10 custodians
+CUSTODIANS_TESTNET=        # Comma separated list of initial 10 custodians
+# Local testing only
+CUSTODIANS_LOCAL=          # Comma separated list of initial 10 custodians
+ORACLE=                    # Oracle public key used by reg-oracle.js