Getting started docs

README.md

@@ -1,23 +1,94 @@
 ![Secret Network](sn-logo.png)
 
-<p align="center">
-Secret Network secures the decentralized web
-</p>
+<div align="center">
+
+[![version](https://img.shields.io/badge/version-1.3.1-blue)](https://github.com/scrtlabs/SecretNetwork/releases/tag/v1.3.1)
+[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+<a href="https://twitter.com/intent/follow?screen_name=SecretNetwork">
+<img src="https://img.shields.io/twitter/follow/SecretNetwork?style=social&logo=twitter"
+alt="Follow"></a>
 
-Want to build a better internet? Solve for privacy.
+ </div>
 
-Secret Network is a blockchain-based, open-source protocol that lets anyone perform computations on encrypted data, bringing privacy to smart contracts and public blockchains. Our mission: improve the adoption and usability of decentralized technologies, for the benefit of all.
+Secret Network offers scalable permissionless smart contracts with a private by default design— bringing novel use cases to blockchain not feasible on public systems. Secret Network enables users to take back ownership over their private (financial) information and for them to share this information with whom they trust. Secret Network was the first protocol to provide private smart contracts on mainnet, live since September 2020. Secret Network is Built with the Cosmos Software Development Kit (SDK) bringing Interoperable privacy to the entire Cosmos ecosystem. Secret Network uses a combination of the Intel SGX (Software Guard Extension) Trusted Execution Environment technology, several encryption schemes and key management to bring privacy by default to blockchain users. Secret Contracts are an implementation of the Rust based smart contract compiling toolkit CosmWasm, adding private metadata possibilities. Secret Network is powered by the Native public coin SCRT which is used for fees, Proof Of Stake security and Governance. With more than 20+ Dapps, 100+ full time builders and a strong grassroots community Secret Network aims to bring privacy to the masses.
 
-Mainnet is out! Get the latest release at [https://github.com/scrtlabs/SecretNetwork/releases/latest](https://github.com/scrtlabs/SecretNetwork/releases/latest).
 
-[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+# Setting up Environment
+
+## Prebuilt Environment
 
-# Getting Started (gitpod)
+### Gitpod
 
 Click the button below to start a new development environment:
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/scrtlabs/SecretNetwork)
 
+### VSCode Docker Environment
+
+1. Install <vs code remote> extension
+
+2. Clone this repository into a new dev container
+
+### Docker Dev Environments
+
+1. From Docker Desktop, create a new Dev Environment from the prebuilt image - `ghcr.io/scrtlabs/secretnetwork-dev:latest`
+2. Connect with VSCode, or use the container directly
+3. Make sure the code is updated by using `get fetch` and `git pull`
+
+## Manual Set up
+
+### Clone Repo
+
+Clone this repo to your favorite working directory
+
+### Install Rust
+
+Install rust from [https://rustup.rs/](https://rustup.rs/). 
+
+Then, add the rust-src component. This will also install the version of rust that is defined by the workspace (in `rust-toolchain`) - `rustup component add rust-src`
+
+To run tests you'll need to add the wasm32 target - `rustup target add wasm32-unknown-unknown`
+
+### Install Go
+
+Install go from [https://go.dev/doc/install](https://go.dev/doc/install)
+
+### Install SGX
+
+To compile the code and run tests, you'll need to install the SGX SDK and PSW. To run in simulation (or software) modes of SGX you do _not_ need to install the SGX driver. 
+For a simple install, run the [install-sgx.sh](./scripts/install-sgx.sh) script in the following way:
+
+`sudo ./scripts/install-sgx.sh true true true false`
+
+# Build from Source
+
+Use `make build-linux` to build the entire codebase. This will build both the Rust (enclave & contract engine) and the Go (blockchain) code.
+
+To build just the rust code, you can use `make _build-linux`, while to build just the Go code, there is the aptly named `make build_local_no_rust`.
+
+
+Tip:
+```text
+For a production build the enclave must be copied from the most recent release. 
+
+This is due to non-reproducible builds, and the fact that enclaves must be signed with a specific key to be accepted on mainnet. 
+
+Still, the non-enclave code can be modified and ran on mainnet as long as there are no consensus-breaking changes
+```
+
+# Running Something
+
+## Run tests
+
+To build run all tests, use `make go-tests`
+
+## Start local network
+
+Run `./scripts/start-node.sh`
+
+# Documentation
+
+For the latest documentation, check out [https://docs.scrt.network](https://docs.scrt.network)
 
 # Community
 
@@ -30,31 +101,6 @@ Click the button below to start a new development environment:
 - Community Telegram Channel: [https://t.me/SCRTnetwork](https://t.me/SCRTnetwork)
 - Community Secret Nodes Telegram: [https://t.me/secretnodes](https://t.me/secretnodes)
 
-# Block Explorers
-
-Secret Network is secured by the SCRT coin (Secret), which is used for fees, staking, and governance. Transactions, validators, governance proposals, and more can be viewed using the following Secret Network block explorers:
-
-- [secretnodes](https://secretnodes.com)
-- [Mintscan](https://mintscan.io/secret)
-
-# Wallets
-
-- [Ledger Nano S and Ledger Nano X](docs/ledger-nano-s.md)
-- [Keplr](https://wallet.keplr.app)
-- [Math Wallet](https://mathwallet.org/secretnetwork-wallet/)
-- [Citadel.one](https://app.citadel.one)
-
-# Implementation Discussions
-
-- [An Update on the Encryption Protocol](https://forum.scrt.network/t/an-update-on-the-encryption-protocol/1641)
-- [Hard Forks and Network Upgrades](https://forum.scrt.network/t/hard-forks-and-network-upgrades/1670)
-- [Don’t trust, verify (an untrusted host)](https://forum.scrt.network/t/dont-trust-verify-an-untrusted-host/1669)
-- [Secret Contracts on Secret Network](https://forum.scrt.network/t/secret-contracts-on-enigma-blockchain/1284)
-- [Network key management/agreement](https://forum.scrt.network/t/network-key-management-agreement/1324)
-- [Input/Output/State Encryption/Decryption protocol](https://forum.scrt.network/t/input-output-state-encryption-decryption-protocol/1325)
-- [Why the Cosmos move doesn’t mean we’re leaving Ethereum](https://forum.scrt.network/t/why-the-cosmos-move-doesnt-mean-were-leaving-ethereum/1301)
-- [(Dev discussion/Issue) WASM implementation](https://forum.scrt.network/t/dev-discussion-issue-wasm-implementation/1303)
-
 # License
 
 SecretNetwork is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License](LICENSE) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The GNU Affero General Public License is based on the GNU GPL, but has an additional term to allow users who interact with the licensed software over a network to receive the source for that program.

scripts/install-sgx.sh

@@ -0,0 +1,120 @@
+#! /bin/bash
+
+set -e
+
+INSTALL_DEPS=${1:-"true"}
+INSTALL_SDK=${2:-"true"}
+INSTALL_PSW=${3:-"true"}
+INSTALL_DRIVER=${4:-"true"}
+UBUNTUVERSION=$(lsb_release -r -s | cut -d '.' -f 1)
+
+if [ "$(id -u)" -ne 0 ]; then
+    echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+    exit 1
+fi
+
+if (($UBUNTUVERSION < 16)); then
+	echo "Your version of Ubuntu is not supported. Must have Ubuntu 16.04 and up. Aborting installation script..."
+	exit 1
+elif (($UBUNTUVERSION < 18)); then
+	DISTRO='xenial'
+elif (($UBUNTUVERSION < 20)); then
+	DISTRO='bionic'
+	OS='ubuntu18.04-server'
+else
+	DISTRO='focal'
+	OS='ubuntu20.04-server'  
+fi
+
+deps() {
+    echo "\n\n#######################################"
+    echo "##### Installing missing packages #####"
+    echo "#######################################\n\n"
+
+    # Install needed packages for script
+    sudo apt install -y make wget
+}
+
+install_sdk(){
+   # Create a working directory to download and install the SDK inside
+   mkdir -p "$HOME/.sgxsdk"
+
+   # In a new sub-shell cd into our working directory so to no pollute the
+   # original shell's working directory
+   cd "$HOME/.sgxsdk"
+
+   wget -O https://download.01.org/intel-sgx/sgx-linux/2.13/distro/ubuntu20.04-server/sgx_linux_x64_sdk_2.13.100.4.bin
+
+   # Make the driver and SDK installers executable
+   chmod +x ./sgx_linux_*.bin
+}
+
+install_sgx_driver(){
+   echo "\n\n###############################################"
+   echo "##### Installing Intel SGX driver #####"
+   echo "###############################################\n\n"
+
+   wget -O https://download.01.org/intel-sgx/sgx-linux/2.13/distro/ubuntu20.04-server/sgx_linux_x64_driver_2.11.0_0373e2e.bin
+
+   # Install the driver
+   sudo ./sgx_linux_x64_driver_*.bin
+
+   # Remount /dev as exec, also at system startup
+   sudo tee /etc/systemd/system/remount-dev-exec.service >/dev/null <<EOF
+  [Unit]
+  Description=Remount /dev as exec to allow AESM service to boot and load enclaves into SGX
+
+  [Service]
+  Type=oneshot
+  ExecStart=/bin/mount -o remount,exec /dev
+  RemainAfterExit=true
+
+  [Install]
+  WantedBy=multi-user.target
+EOF
+
+   sudo systemctl enable remount-dev-exec
+   sudo systemctl start remount-dev-exec
+
+   # Install the SDK inside ./sgxsdk/ which is inside $HOME/.sgxsdk
+   echo yes | ./sgx_linux_x64_sdk_*.bin
+
+   # Setup the environment variables for every new shell
+   echo "source '$HOME/.sgxsdk/sgxsdk/environment'" |
+      tee -a "$HOME/.bashrc" "$HOME/.zshrc" > /dev/null
+
+}
+
+install_psw(){
+    echo "\n\n##############################################"
+    echo "##### Installing additional dependencies #####"
+    echo "##############################################\n\n"
+
+    # Add Intel's SGX PPA
+    echo "deb [arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu $DISTRO main" |
+    sudo tee /etc/apt/sources.list.d/intel-sgx.list
+    wget -qO - https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key |
+    sudo apt-key add -
+    sudo apt update
+
+    # Install all the additional necessary dependencies (besides the driver and the SDK)
+    # for building a rust enclave
+    wget -O /tmp/libprotobuf10_3.0.0-9_amd64.deb http://ftp.br.debian.org/debian/pool/main/p/protobuf/libprotobuf10_3.0.0-9_amd64.deb
+    (sleep 3 ; echo y) | sudo gdebi /tmp/libprotobuf10_3.0.0-9_amd64.deb
+
+    sudo apt install -y libsgx-enclave-common libsgx-enclave-common-dev libsgx-urts sgx-aesm-service libsgx-uae-service libsgx-launch libsgx-aesm-launch-plugin libsgx-ae-le autoconf libtool
+}
+
+deps
+
+if [ "${INSTALL_SDK}" = "true" ]; then
+   install_sdk
+fi
+
+if [ "${INSTALL_PSW}" = "true" ]; then
+   install_psw
+fi
+
+if [ "${INSTALL_DRIVER}" = "true" ]; then
+   install_sgx_driver
+fi

scripts/start-node.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+set -o errexit -o nounset
+
+CHAINID=$1
+GENACCT=$2
+
+if [ -z "$1" ]; then
+  echo "Need to input chain id..."
+  exit 1
+fi
+
+if [ -z "$2" ]; then
+  echo "Need to input genesis account address..."
+  exit 1
+fi
+
+# Build genesis file incl account for passed address
+coins="10000000000uscrt,100000000000stake"
+secretd init --chain-id $CHAINID $CHAINID
+secretd keys add validator --keyring-backend="test"
+secretd add-genesis-account $(secretd keys show validator -a --keyring-backend="test") $coins
+secretd add-genesis-account $GENACCT $coins
+secretd gentx validator 5000000000uscrt --keyring-backend="test" --chain-id $CHAINID
+secretd collect-gentxs
+
+# Set proper defaults and change ports
+sed -i 's#"tcp://127.0.0.1:26657"#"tcp://0.0.0.0:26657"#g' ~/.secretd/config/config.toml
+sed -i 's/timeout_commit = "5s"/timeout_commit = "1s"/g' ~/.secretd/config/config.toml
+sed -i 's/timeout_propose = "3s"/timeout_propose = "1s"/g' ~/.secretd/config/config.toml
+sed -i 's/index_all_keys = false/index_all_keys = true/g' ~/.secretd/config/config.toml
+
+# Start the secretd
+secretd start --pruning=nothing --bootstrap