Add docs for 1.15->1.16 upgrade

iKapitonau · iKapitonau · commit 564722dc5a66 · 2025-03-05T15:44:57.000+04:00
diff --git a/docs/upgrades/1.16/cleanup.sh b/docs/upgrades/1.16/cleanup.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+set -o xtrace
+
+sudo rm -fr /tmp/secretd
+sudo rm -fr /tmp/secretcli
+mkdir /tmp/secretd
+mkdir /tmp/secretcli
diff --git a/docs/upgrades/1.16/contract.wasm b/docs/upgrades/1.16/contract.wasm
diff --git a/docs/upgrades/1.16/docker-compose-115.yml b/docs/upgrades/1.16/docker-compose-115.yml
@@ -0,0 +1,58 @@
+# docker compose file that sets up a network for beta testing
+
+version: "3"
+
+services:
+  bootstrap:
+    image: ghcr.io/scrtlabs/localsecret:v1.15.1
+    container_name: bootstrap
+    volumes:
+      - /tmp/secretd:/root/.secretd
+      - /tmp/secretcli:/root/.secretcli
+    stdin_open: true
+    tty: true
+    environment:
+      - http_proxy
+      - https_proxy
+      - SECRET_NODE_TYPE=BOOTSTRAP
+      - LOG_LEVEL=trace
+      - CHAINID=secretdev-1
+      - SGX_MODE=SW
+    expose:
+      - 26656
+      - 26657
+    ports:
+      - "5000:5000"
+    entrypoint: /bin/bash
+
+  node:
+    image: ghcr.io/scrtlabs/localsecret:v1.15.1
+    container_name: node
+    depends_on:
+      - bootstrap
+    volumes:
+      - /tmp/secretd:/tmp/.secretd
+      - /tmp/secretcli:/root/.secretcli
+    stdin_open: true
+    tty: true
+    ports:
+      - "1317:1317"
+      - "9091:9091"
+    environment:
+      - http_proxy
+      - https_proxy
+      - SECRET_NODE_TYPE=node
+      - LOG_LEVEL=trace
+      - CHAINID=secretdev-1
+      - RPC_URL=bootstrap:26657
+      - PERSISTENT_PEERS=115aa0a629f5d70dd1d464bc7e42799e00f4edae@bootstrap:26656
+      - FAUCET_URL=bootstrap:5000
+      - SCRT_SGX_STORAGE=/root
+      - SGX_MODE=SW
+    entrypoint: /bin/bash
+    deploy:
+      restart_policy:
+        condition: on-failure
+        delay: 10s
+        max_attempts: 10
+        window: 123s
diff --git a/docs/upgrades/1.16/init_proposal.sh b/docs/upgrades/1.16/init_proposal.sh
@@ -0,0 +1,13 @@
+#!/bin/bash
+set -ox xtrace
+
+UPGRADE_BLOCK="$(docker exec node bash -c 'secretd status | jq "(.sync_info.latest_block_height | tonumber) + 30"')"
+# Propose upgrade
+TX_HASH="$(docker exec node bash -c "secretd tx upgrade software-upgrade v1.16 --upgrade-height $UPGRADE_BLOCK --title blabla --summary yolo --deposit 1000000000uscrt --no-verify --from a -y | jq '.txhash'")"
+sleep 10
+PROPOSAL_ID="$(docker exec node bash -c "secretd q tx $TX_HASH | jq '.events[] | select(.type == \"submit_proposal\") | .attributes[] | select(.key == \"proposal_id\") | .value | tonumber'")"
+# Vote yes (voting period is 90 seconds)
+docker exec node bash -c "secretd tx gov vote ${PROPOSAL_ID} yes --from validator -y"
+
+echo "PROPOSAL_ID   = ${PROPOSAL_ID}"
+echo "UPGRADE_BLOCK = ${UPGRADE_BLOCK}"
diff --git a/docs/upgrades/1.16/node_init.sh b/docs/upgrades/1.16/node_init.sh
@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+
+set -euvox pipefail
+
+# init the node
+# rm -rf ~/.secret*
+#secretd config chain-id enigma-testnet
+#secretd config indent true
+#secretd config trust-node true
+#secretd config keyring-backend test
+# rm -rf ~/.secretd
+
+mkdir -p /root/.secretd/.node
+secretd config set client chain-id secretdev-1
+secretd config set client keyring-backend test
+secretd config set client node http://bootstrap:26657
+secretd config set client output json
+
+mkdir -p /root/.secretd/.node
+
+secretd init "$(hostname)" --chain-id secretdev-1 || true
+
+PERSISTENT_PEERS=115aa0a629f5d70dd1d464bc7e42799e00f4edae@bootstrap:26656
+
+sed -i 's/persistent_peers = ""/persistent_peers = "'$PERSISTENT_PEERS'"/g' ~/.secretd/config/config.toml
+sed -i 's/trust_period = "168h0m0s"/trust_period = "168h"/g' ~/.secretd/config/config.toml
+echo "Set persistent_peers: $PERSISTENT_PEERS"
+
+echo "Waiting for bootstrap to start..."
+sleep 10
+
+secretd q block --type=height 1
+
+cp /tmp/.secretd/keyring-test /root/.secretd/ -r
+
+# MASTER_KEY="$(secretd q register secret-network-params 2> /dev/null | cut -c 3- )"
+
+#echo "Master key: $MASTER_KEY"
+
+SGX_MODE=SW  secretd init-enclave --reset
+
+PUBLIC_KEY=$(SGX_MODE=SW secretd parse /root/attestation_cert.der | cut -c 3- )
+
+echo "Public key: $PUBLIC_KEY"
+
+SGX_MODE=SW secretd parse /root/attestation_cert.der
+cat /root/attestation_cert.der
+#tx_hash="$(SGX_MODE=SW secretd tx register auth /root/attestation_cert.der -y --from a --gas-prices 0.25uscrt | jq -r '.txhash')"
+SGX_MODE=SW secretd tx register auth /root/attestation_combined.bin -y --from a --gas-prices 0.25uscrt --gas 5000000
+
+#secretd q tx "$tx_hash"
+sleep 10
+# SGX_MODE=SW secretd q tx "$tx_hash"
+
+SEED="$(SGX_MODE=SW secretd q register seed "$PUBLIC_KEY" | cut -c 3-)"
+echo "SEED: $SEED"
+#exit
+
+SGX_MODE=SW secretd q register secret-network-params
+
+SGX_MODE=SW secretd configure-secret node-master-key.txt "$SEED"
+
+cp /tmp/.secretd/config/genesis.json /root/.secretd/config/genesis.json
+
+SGX_MODE=SW secretd genesis validate
+
+RUST_BACKTRACE=1 SGX_MODE=SW secretd start --rpc.laddr tcp://0.0.0.0:26657
+
+# ./wasmi-sgx-test.sh
diff --git a/docs/upgrades/1.16/test-v1.16-upgrade-handler.md b/docs/upgrades/1.16/test-v1.16-upgrade-handler.md
@@ -0,0 +1,134 @@
+# How to test the v1.16 upgrade with LocalSecret
+
+__NOTE__: Always work in docs/upgrades/1.16 directory
+
+## Step 1
+
+Start a v1.15 chain.
+
+```bash
+docker compose -f docker-compose-115.yml up -d
+```
+We use modified node_init.sh script to start a regular node.
+Let's copy this script over into the node container
+```bash
+ docker cp node_init.sh node:/root/
+```
+
+(For convenience) Open a new terminal window:
+
+```bash
+docker exec -it bootstrap bash
+```
+
+, and start a bootstrap instance:
+```bash
+./bootstrap_init.sh
+```
+
+__Note__: If for whatever reason, bootstrap_init.sh fails to start reporting an illigal instraction,
+most likely cause is /tmp/secretd left from the previous run. Try to remove and recreate this directory
+if the script fails to run, restart the compose.
+
+Open yet another terminal window where you will start a regular node:
+
+```bash
+docker exec -it node bash
+```
+
+To start a node instance
+```bash
+chmod 0777 node_init.sh
+./node_init.sh
+```
+
+## Step 2 (Test basic contract)
+
+Copy a contract to node container:
+```bash
+docker cp ./contract.wasm node:/root/
+```
+
+Shell into the node container:
+```bash
+docker exec -it node bash
+```
+
+Store, instantiate, and execute the contract:
+```bash
+secretd config node http://0.0.0.0:26657
+secretd tx compute store contract.wasm --from a --gas 5000000 -y
+sleep 5
+INIT='{"counter":{"counter":10, "expires":100000}}'
+secretd tx compute instantiate 1 "$INIT" --from a --label "c" -y
+sleep 5
+ADDR=`secretd q compute list-contract-by-code 1 | jq -r '.[0].contract_address'`
+
+secretd tx compute execute $ADDR '{"increment":{"addition": 13}}' --from a -y
+sleep 5
+secretd query compute query $ADDR '{"get": {}}'
+```
+
+Expected result should be:
+```json
+{"get":{"count":23}}
+```
+
+## Step 3
+
+Propose a software upgrade on the v1.15 chain:
+We request an upgrade to take place at +30blocks (@10block/min)
+```bash
+./init_proposal.sh
+```
+
+## Step 4
+
+Perform the upgrade:
+At the upgrade block height you will see `ERR CONSENSUS FAILURE!!! err="UPGRADE \"v1.15\" NEEDED at height` for both containers: bootstrap and node.
+
+At this point, the chain is waiting for the upgrade to be performed
+
+__Special note__: If you run Ubuntu 22.04 or higher, you should consider building a localsecret target, which will produce a docker image for your active branch. We assume that you are on branch with tag v1.15.0 or cosmos-sdk-0.50.x-merged as of this writing.
+
+Option A: Either build locally, if you are on Ubuntu 20.04
+```bash
+FEATURES="light-client-validation,random" SGX_MODE=SW make build-linux
+```
+Option B: build a docker image if you are on Ubuntu 22.04 or higher
+```bash
+make localsecret
+```
+
+After the build is done, assemble the binary artefacts.
+You will need the following binaries:
+* secretd
+* librust_cosmwasm_enclave.signed.so
+* libgo_cosmwasm.so
+* librandom_api.so
+* tendermint_enclave.signed.so
+
+If you chose option B, you can access the binaries in the container and copy them to a host dir,
+e.g. SecretNetwork/docs/upgrades/1.15/bin by running update_binaries.sh:
+```bash
+./update_binaries.sh
+```
+
+Restart node:
+```bash
+source /opt/sgxsdk/environment && RUST_BACKTRACE=1 LOG_LEVEL="trace" secretd start --rpc.laddr tcp://0.0.0.0:26657
+```
+
+The log file will print out `INF applying upgrade "v1.15" at height` 
+
+If the upgrade process was successful, the blockchain will resume generating new blocks after the height at which the upgrade was requested.
+
+Chck that the previously deployed contract is still present
+Query the value of the counter:
+```bash
+secretd query compute query $ADDR '{"get": {}}'
+```
+Expected result should be:
+```json
+{"get":{"count":23}}
+```
diff --git a/docs/upgrades/1.16/update_binaries.sh b/docs/upgrades/1.16/update_binaries.sh
@@ -0,0 +1,34 @@
+#!/bin/bash
+set -o xtrace
+
+docker exec bootstrap bash -c 'rm -rf /tmp/upgrade-bin && mkdir -p /tmp/upgrade-bin'
+docker exec node bash -c 'rm -rf /tmp/upgrade-bin && mkdir -p /tmp/upgrade-bin'
+mkdir -p ./bin/
+docker cp localsecret:/usr/bin/secretd                               ./bin/
+docker cp localsecret:/usr/lib/librust_cosmwasm_enclave.signed.so    ./bin/
+docker cp localsecret:/usr/lib/libgo_cosmwasm.so                     ./bin/
+docker cp localsecret:/usr/lib/librandom_api.so                      ./bin/
+docker cp localsecret:/usr/lib/tendermint_enclave.signed.so          ./bin/
+# update bootstrap
+docker cp ./bin/secretd                               bootstrap:/tmp/upgrade-bin
+docker cp ./bin/librust_cosmwasm_enclave.signed.so    bootstrap:/tmp/upgrade-bin
+docker cp ./bin/libgo_cosmwasm.so                     bootstrap:/tmp/upgrade-bin
+# update node
+docker cp ./bin/secretd                               node:/tmp/upgrade-bin
+docker cp ./bin/librust_cosmwasm_enclave.signed.so    node:/tmp/upgrade-bin
+docker cp ./bin/libgo_cosmwasm.so                     node:/tmp/upgrade-bin
+docker cp ./bin/librandom_api.so                      node:/tmp/upgrade-bin
+docker cp ./bin/tendermint_enclave.signed.so          node:/tmp/upgrade-bin
+# stop node's secretd
+docker exec node bash -c 'pkill -9 secretd'
+# copy over updated binaries
+docker exec bootstrap bash -c 'cp /tmp/upgrade-bin/librust_cosmwasm_enclave.signed.so /usr/lib/'
+docker exec bootstrap bash -c 'cp /tmp/upgrade-bin/libgo_cosmwasm.so /usr/lib/'
+docker exec node bash -c 'cp /tmp/upgrade-bin/secretd /usr/bin/'
+docker exec node bash -c 'cp /tmp/upgrade-bin/librust_cosmwasm_enclave.signed.so /usr/lib/'
+docker exec node bash -c 'cp /tmp/upgrade-bin/libgo_cosmwasm.so /usr/lib/'
+
+# prepare a tmp dir to store validator's private key
+rm -rf /tmp/upgrade-bin && mkdir -p /tmp/upgrade-bin
+docker cp bootstrap:/root/.secretd/config/priv_validator_key.json /tmp/upgrade-bin/.
+docker cp /tmp/upgrade-bin/priv_validator_key.json node:/root/.secretd/config/priv_validator_key.json
