Skip to content

Commit

Permalink
more identation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ctindogaru
ctindogaru committed Feb 4, 2022
1 parent e74e226 commit 5301087
Showing 1 changed file with 63 additions and 51 deletions.
114 changes: 63 additions & 51 deletions release_process.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ There are two important concepts you need to know about Sputnik. There is a *mot
- 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
Expand Down Expand Up @@ -43,49 +45,51 @@ There are two important concepts you need to know about Sputnik. There is a *mot
- 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
### v3 Release Plan

[1. Upgrade the factory from v2 to v3 and then set up the default code for the DAO to be v2.](#upgrade-the-factory-from-v2-to-v3)
[2. After we get enough confidence using factory v3 and DAO v2, change the default code for the DAO from v2 to v3.](#change-dao-default-code-from-v2-to-v3)
[3. Existing DAOs will need to migrate from v2 to v3.](#migrate-dao-from-v2-to-v3)
[1 Upgrade the factory from v2 to v3 and then set up the default code for the DAO to be v2.](#1-upgrade-the-factory-from-v2-to-v3)
[2 After we get enough confidence using factory v3 and DAO v2, change the default code for the DAO from v2 to v3.](#2-change-dao-default-code-from-v2-to-v3)
[3 Existing DAOs will need to migrate from v2 to v3.](#3-migrate-dao-from-v2-to-v3)

---

### Upgrade the factory from v2 to v3
### 1 Upgrade the factory from v2 to v3

This should be done in the following order:
- [testnet - using a personal account](#using-personal-account-on-testnet)
- [testnet - using the official testnet factory account](#using-official-account-on-testnet)
- [mainnet - using the official mainnet factory account](#using-official-account-on-mainnet)
- [testnet - using a personal account](#1-1-using-personal-account-on-testnet)
- [testnet - using the official testnet factory account](#1-2-using-official-account-on-testnet)
- [mainnet - using the official mainnet factory account](#1-3-using-official-account-on-mainnet)

___

#### Using personal account on testnet
### 1 1 Using personal account on testnet

**1. Create a new NEAR account for the factory:**
***1. Create a new NEAR account for the factory:***

```bash
near create-account sputnik-factory.ctindogaru.testnet --masterAccount ctindogaru.testnet --initialBalance 50
```

**2. Deploy the factory code:**
***2. Deploy the factory code:***
```bash
./build.sh
```
```bash
near deploy sputnik-factory.ctindogaru.testnet sputnikdao-factory2/res/sputnikdao_factory2.wasm
```

**3. Init the factory:**
***3. Init the factory:***
```bash
near call sputnik-factory.ctindogaru.testnet new '{}' --accountId sputnik-factory.ctindogaru.testnet --gas 100000000000000
```

**4. Download the current `wasm` code used for creating new DAOs:**
***4. Download the current `wasm` code used for creating new DAOs:***

```bash
near view sputnikv2.testnet get_dao_list
Expand All @@ -98,26 +102,26 @@ params:='{"request_type":"view_code","finality":"final","account_id":"thegame.sp
| base64 --decode > dao-code-v2.wasm
```

**5. Use the code downloaded at the previous step and store it inside the factory as the default code used for creating new DAOs:**
***5. Use the code downloaded at the previous step and store it inside the factory as the default code used for creating new DAOs:***
```bash
BYTES='cat dao-code-v2.wasm | base64'
```
```bash
near call sputnik-factory.ctindogaru.testnet store $(eval "$BYTES") --base64 --accountId sputnik-factory.ctindogaru.testnet --gas 100000000000000 --amount 10
```

**6. Use the code hash returned from the previous step to store the metadata associated with the code:**
***6. Use the code hash returned from the previous step to store the metadata associated with the code:***
```bash
near call sputnik-factory.ctindogaru.testnet store_contract_metadata '{"code_hash": "ZGdM2TFdQpcXrxPxvq25514EViyi9xBSboetDiB3Uiq", "metadata": {"version": "v2", "commit_id": "c2cf1553b070d04eed8f659571440b27d398c588"}, "set_default": true}' --accountId sputnik-factory.ctindogaru.testnet
```

**7. See all the contract versions stored inside the factory:**
***7. See all the contract versions stored inside the factory:***
```bash
near view sputnik-factory.ctindogaru.testnet get_contracts_metadata
```
2 versions should be displayed. The one that got created on init and the one that you stored in the previous step.

**8. Try to create a new DAO from the factory - using NEAR CLI:**
***8. Try to create a new DAO from the factory - using NEAR CLI:***
```bash
export COUNCIL='["ctindogaru.testnet"]'
```
Expand All @@ -128,28 +132,30 @@ export ARGS=`echo '{"config": {"name": "ctindogaru-dao", "purpose": "ctindogaru
near call sputnik-factory.ctindogaru.testnet create "{\"name\": \"ctindogaru-dao\", \"args\": \"$ARGS\"}" --accountId sputnik-factory.ctindogaru.testnet --gas 150000000000000 --amount 10
```

**9. See all the DAOs created by the factory:**
***9. See all the DAOs created by the factory:***
```bash
near view sputnik-factory.ctindogaru.testnet get_dao_list
```
The DAO created in the previous step should be displayed here.

**10. Try to interact with the DAO and make sure everything works:**
***10. Try to interact with the DAO and make sure everything works:***
```bash
near view ctindogaru-dao.sputnik-factory.ctindogaru.testnet get_available_amount
```

#### Using official account on testnet
___

**1. Upgrade the factory code:**
### 1 2 Using official account on testnet

***1. Upgrade the factory code:***
```bash
./build.sh
```
```bash
near deploy sputnikv2.testnet sputnikdao-factory2/res/sputnikdao_factory2.wasm
```

**2. Download the current `wasm` code used for creating new DAOs:**
***2. Download the current `wasm` code used for creating new DAOs:***

```bash
near view sputnikv2.testnet get_dao_list
Expand All @@ -162,99 +168,105 @@ params:='{"request_type":"view_code","finality":"final","account_id":"thegame.sp
| base64 --decode > dao-code-v2.wasm
```

**3. Use the code downloaded at the previous step and store it inside the factory as the default code used for creating new DAOs:**
***3. Use the code downloaded at the previous step and store it inside the factory as the default code used for creating new DAOs:***
```bash
BYTES='cat dao-code-v2.wasm | base64'
```
```bash
near call sputnikv2.testnet store $(eval "$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:**
***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 '{"code_hash": "ZGdM2TFdQpcXrxPxvq25514EViyi9xBSboetDiB3Uiq", "metadata": {"version": "v2", "commit_id": "c2cf1553b070d04eed8f659571440b27d398c588"}, "set_default": true}' --accountId sputnikv2.testnet
```

**5. See all the contract versions stored inside the factory:**
***5. See all the contract versions stored inside the factory:***
```bash
near view sputnikv2.testnet get_contracts_metadata
```
Only the version stored in the previous step should be displayed.

**6. Try to create a new DAO using the new factory - using Astro DAO:**
***6. Try to create a new DAO using 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.

Please note that the DAO itself is still v2. The only difference is that the DAO gets created through the v3 version of the factory.

#### Using official account on mainnet
___

### 1 3 Using official account on mainnet

The process is very similar with 1.2.

---
___

### Change DAO default code from v2 to v3
### 2 Change DAO default code from v2 to v3

After a few weeks of running factory v3 + DAO v2, it's time to step up the game and upgrade the default DAO version to v3.

This should be done in the following order:
- 1. testnet, using the official testnet factory account
- 2. mainnet, using the official mainnet factory account
- [testnet - using the official testnet factory account](#2-1-using-official-account-on-testnet)
- [mainnet - using the official mainnet factory account](#2-2-using-official-account-on-mainnet)

Assumptions:
- the DAO v3 code will be a snapshot of the code from commit id 596f27a649c5df3310e945a37a41a957492c0322.

#### 2.1 Testnet - using official factory account
___

**1. Checkout to the right commit id**
### 2 1 Using official account on testnet

***1. Checkout to the right commit id***
```bash
git checkout 596f27a649c5df3310e945a37a41a957492c0322
```

**2. Build the DAO v3 code:**
***2. Build the DAO v3 code:***
```bash
./build.sh
```

**3. Use the code built at the previous step and store it inside the factory as the default code used for creating new DAOs:**
***3. Use the code built at the previous step and store it inside the factory as the default code used for creating new DAOs:***
```bash
BYTES='cat sputnikdao2/res/sputnikdao2.wasm | base64'
```
```bash
near call sputnikv2.testnet store $(eval "$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:**
***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 '{"code_hash": "GUMFKZP6kdLgy3NjKy1EAkn77AfZFLKkj96VAgjmHXeS", "metadata": {"version": "v3", "commit_id": "596f27a649c5df3310e945a37a41a957492c0322"}, "set_default": true}' --accountId sputnikv2.testnet
```

**5. See all the contract versions stored inside the factory:**
***5. See all the contract versions stored inside the factory:***
```bash
near view sputnikv2.testnet get_contracts_metadata
```
2 versions should be displayed:
- v2 with commit id `c2cf1553b070d04eed8f659571440b27d398c588` and hash `ZGdM2TFdQpcXrxPxvq25514EViyi9xBSboetDiB3Uiq`
- v3 with commit id `596f27a649c5df3310e945a37a41a957492c0322` and hash `GUMFKZP6kdLgy3NjKy1EAkn77AfZFLKkj96VAgjmHXeS`

**6. Try to create a DAO v3 - using Astro DAO:**
***6. Try to create a DAO v3 - using Astro DAO:***

Go to https://testnet.app.astrodao.com/all/daos and try to create a new DAO from the UI.
The DAO that gets created should be a brand new v3 DAO.

#### 2.2 Mainnet - using official factory account
___

### 2 2 Using official account on mainnet

The process is very similar with 2.1.

---
___

### Migrate DAO from v2 to v3
### 3 Migrate DAO from v2 to v3

Assumptions:
- we are the trying to upgrade `amber.sputnik-dao.near` from v2 to v3
- we have the account id `ctindogaru.near`

1. Open a bash terminal and login to your near account:
***1. Open a bash terminal and login to your near account:***

```bash
export NEAR_ENV=mainnet
Expand All @@ -264,7 +276,7 @@ export NEAR_ENV=mainnet
near login
```

2. Clone the sputnik repo and go to the v3 snapshot of the code.
***2. Clone the sputnik repo and go to the v3 snapshot of the code.***

```bash
git clone https://github.com/near-daos/sputnik-dao-contract && cd sputnik-dao-contract
Expand All @@ -274,7 +286,7 @@ git clone https://github.com/near-daos/sputnik-dao-contract && cd sputnik-dao-co
git checkout 596f27a649c5df3310e945a37a41a957492c0322
```

3. Store the DAO code in your DAO.
***3. Store the DAO code in your DAO.***

```bash
BYTES='cat sputnikdao2/res/sputnikdao2.wasm | base64'
Expand All @@ -286,23 +298,23 @@ near call amber.sputnik-dao.near store_blob $(eval "$BYTES") --base64 --accountI

After running the command from above, you should get the following code hash in return: `GUMFKZP6kdLgy3NjKy1EAkn77AfZFLKkj96VAgjmHXeS`. If your result differs from `GUMFKZP6kdLgy3NjKy1EAkn77AfZFLKkj96VAgjmHXeS`, do not proceed further as you could harm your DAO. Ask for help on the telegram group: `SputnikDAO v2.0`.

4. Create an upgrade proposal for your DAO.
***4. Create an upgrade proposal for your DAO.***

Run the following command:
```bash
near call amber.sputnik-dao.near add_proposal '{"proposal": {"description": "Upgrade DAO to v3 version", "kind": {"UpgradeSelf": {"hash": "GUMFKZP6kdLgy3NjKy1EAkn77AfZFLKkj96VAgjmHXeS"}}}}' --accountId ctindogaru.near --amount 1
```

5. Approve the proposal.
***5. Approve the proposal.***

Everyone from the DAO should go to `https://app.astrodao.com/dao/amber.sputnik-dao.near/proposals` and approve the proposal.

6. Once the proposal get approved, the upgrade will take place.
***6. Once the proposal get approved, the upgrade will take place.***

7. Now that the upgrade is complete, remove the code from your DAO.
***7. Now that the upgrade is complete, remove the code from your DAO.***

```bash
near call amber.sputnik-dao.near remove_blob '{"hash": "GUMFKZP6kdLgy3NjKy1EAkn77AfZFLKkj96VAgjmHXeS"}' --accountId ctindogaru.near --gas 100000000000000 --amount 10
```

7. Congrats! You're now using the DAO v3.
***8. Congrats! You're now using the DAO v3.***

0 comments on commit 5301087

Please sign in to comment.