document the release process for upgrading contract code for the DAOs

release_process.md

@@ -0,0 +1,99 @@
+# Upgrading Smart Contracts in Sputnik - step-by-step walkthrough
+
+## Background
+
+Sometimes, the code inside a smart contract can change as a result of adding new features or improve existing functionality. When that happens, to take advantage of the new contract code, we must re-deploy the smart contract to the mainnet. This should be done in a very responsible manner, especially in Sputnik, since it contains sensitive information and it has more than $1M Total Value Locked inside the smart contracts.
+
+There are two important concepts you need to know about Sputnik. There is a *mother* called the factory and her *children* called the DAOs.
+- the factory aka *the mother*: it is considered to be the mother of all the DAOs, since it's responsible for creating them. A new child (DAO) is born when calling the `create` method on the mother (factory) contract (check `sputnikdao-factory2/src/lib.rs` for the factory code).
+- the DAOs aka *the children*: once created, they become independent from their mother and they have their own set of rules and policies that help them with self-governance (check `sputnikdao2/src/lib.rs` for the DAO code).
+
+## History of Sputnik - Searching through the archives:
+
+### Sputnik V1 smart contracts
+**Factory**: 
+- the factory code can be found inside `sputnikdao-factory/src`
+- the factory code is deployed on mainnet on `sputnikdao.near` account
+- the factory code was deployed on mainnet for the first time on [January 11, 2021 at 2:29:30pm](https://explorer.mainnet.near.org/transactions/Cxx9pPfrc12N79W8oREPYA2b1CwU6JKitXwAem9C4jHB) and the second time on [January 20, 2021 at 1:31:05pm
+](https://explorer.mainnet.near.org/transactions/653FzhtCKrhsxR5nmzHcuP3AnL5eLQYFyhU6tU4qMydg)
+- the factory code is deployed on testnet on `sputnik-v1.testnet` account
+
+**DAOs**:
+- the DAOs code can be found inside `sputnikdao/src`
+- the DAO code is deployed to several accounts that have the following format: `<dao_name>.sputnikdao.near` for mainnet and `<dao_name>.sputnik-v1.testnet` for testnet
+- see all the DAOs that live on mainnet by calling `near view sputnikdao.near get_dao_list`
+- see all the DAOs that live on testnet by calling `near view sputnik-v1.testnet get_dao_list`
+
+### Sputnik V2 smart contracts
+**Factory**: 
+- the factory code can be found inside `sputnikdao-factory2/src`
+- the factory code is deployed on mainnet on `sputnik-dao.near` account
+- the factory code was deployed only once on mainnet on [June 01, 2021 at 6:17:46pm](https://explorer.mainnet.near.org/transactions/HZZpqMjbhCPWF8n5DXLMq5WtpmASfXuDLtYF6vNsiD9U)
+- the factory code is deployed on testnet on `sputnikv2.testnet` account
+
+**DAOs**:
+- the DAOs code can be found inside `sputnikdao2/src`
+- the DAO code is deployed to several accounts that have the following format: `<dao_name>.sputnik-dao.near` for mainnet and `<dao_name>.sputnikv2.testnet` for testnet
+- see all the DAOs that live on mainnet by calling `near view sputnik-dao.near get_dao_list`
+- see all the DAOs that live on testnet by calling `near view sputnik-v1.testnet get_dao_list`
+
+### UI DApps built on top of the Sputnik smart contracts (from newest to oldest)
+- https://old.sputnik.fund/ -> it uses V1 smart contracts
+- https://www.sputnik.fund/ -> it uses V1 smart contracts
+- https://v2.sputnik.fund/ -> it uses V2 smart contracts
+- https://astrodao.com/ -> it uses V2 smart contracts
+
+## Introducing Sputnik V3 smart contracts
+
+The biggest advantage of V3 smart contracts is introducing an easy way for the DAO to upgrade to a new version of the code so it can take full advantage of the new features/performance improvements/bug fixes.  
+
+Since this is the first time that the factory and the DAO are being upgraded and upgrading smart contracts is a very sensitive topic, everything must be done with due diligence.
+
+## V3 Release Plan
+
+1. Download the current `wasm` code used for creating new DAOs.
+
+```bash
+near view sputnikv2.testnet get_dao_list
+# pick any dao from the returned list and use it to download the wasm code
+http --json post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare method=query \
+params:='{"request_type":"view_code","finality":"final","account_id":"thegame.sputnikv2.testnet"}' \  
+| jq -r .result.code_base64 \
+| base64 --decode > thegame.sputnikv2.testnet.wasm
+```
+
+2. Upgrade the testnet factory:
+```bash
+./build.sh
+near deploy sputnikv2.testnet sputnikdao-factory2/res/sputnikdao_factory2.wasm
+```
+
+3. Use the code downloaded at step 1 to store it inside the factory and use it as a default version for the DAOs
+```bash
+BYTES=$(cat thegame.sputnikv2.testnet.wasm | base64)
+near call sputnikv2.testnet store $BYTES --base64 --accountId sputnikv2.testnet --gas 100000000000000 --amount 10
+```
+
+4. Use the code hash returned from the previous step to store the metadata associated with the code
+```bash
+near call sputnikv2.testnet store_contract_metadata '{"metadata": {"code_hash": "TBD", "version": "V2", "commit_id": "c2cf1553b070d04eed8f659571440b27d398c588", "readme": "unavailable"}, "set_default": "true"}' --accountId sputnikv2.testnet
+```
+
+5. Try to create a new DAO from the new factory - using NEAR CLI
+```bash
+export COUNCIL='["council-member.testnet", "ctindogaru.testnet"]'
+export ARGS=`echo '{"config": {"name": "ctindogaru-dao", "purpose": "ctindogaru DAO", "metadata":""}, "policy": '$COUNCIL'}' | base64`
+near call sputnikv2.testnet create "{\"name\": \"ctindogaru-dao\", \"args\": \"$ARGS\"}" --accountId sputnikv2.testnet --amount 10 --gas 150000000000000
+```
+
+6. Try to create a new DAO from the new factory - using Astro DAO
+
+Go to https://testnet.app.astrodao.com/all/daos and try to create a new DAO from the UI. It should use the new version of the factory code.
+
+7. The main goal is for everything to work just as before and for users to not notice any difference, since they are still creating V2 DAOs. The only difference is that the factory is now upgraded and it can handle multiple DAO versions simultaneously. Let the new version of the factory rest on testnet for 1-2 weeks and make sure it didn't cause any issues.
+
+TBD:
+- steps for storing the V3 code for the DAOs and use it to create new DAOs
+- steps for upgrading V2 DAOs from the factory, but also from the DAO itself
+
+Last step. If nothing burned so far, repeat steps, but for mainnet.