Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PandaRR007 committed Nov 22, 2022
1 parent c2ac463 commit 23890bc
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@

A tool for multisig member to add "upgrade MCS contract" request and confirm it.

## Table of Contents

- [Pre-requisite](#pre-requisite)
- [How to Build](#how-to-build)
- [Usage](#usage)


## Pre-requisite

**Go (version 1.18 or later)**

Go are available at the [Go installation page](https://go.dev/doc/install) and necessary bundles can be downloaded from the [Go download page](https://go.dev/dl/).


## Build
## How to Build
```shell
git clone https://github.com/PandaRR007/mcs-upgrade-tool.git
cd mcs-upgrade-tool
Expand All @@ -23,14 +30,21 @@ You can see a binary **mcs-upgrade-tool** is generated.
1. Configure upgrade.json
```json
{
"nearRpcUrl": "https://archival-rpc.testnet.near.org", // near rpc url
"sender": "member1.map002.testnet", // multisig member account to add the request
"senderPrivateKey": "ed25519:...", // private key of the multisig member
"multisigAccount": "multisig.mfac.map004.testnet", // multisig contract account
"mcsAccount": "mos2.mfac.map004.testnet", // MCS contract account to be upgraded
"mcsWasmFile": "/path/to/mcs.wasm" // MCS contract wasm file to upgrade the MCS contract
"nearRpcUrl": "https://archival-rpc.testnet.near.org",
"sender": "member1.map002.testnet",
"senderPrivateKey": "ed25519:...",
"multisigAccount": "multisig.mfac.map004.testnet",
"mcsAccount": "mos2.mfac.map004.testnet",
"mcsWasmFile": "/path/to/mcs.wasm"
}
```
* **nearRpcUrl**: near rpc url
* **sender**: multisig member account to add the request
* **senderPrivateKey**: private key of the multisig member
* **multisigAccount**: multisig contract account
* **mcsAccount**: MCS contract account to be upgraded
* **mcsWasmFile**: MCS contract wasm file to upgrade the MCS contract


2. Execute upgrade command

Expand Down

0 comments on commit 23890bc

Please sign in to comment.