Skip to content

Commit

Permalink
use yarn instead of npm
Browse files Browse the repository at this point in the history
  • Loading branch information
@H34D
H34D committed May 27, 2021
1 parent bd1e071 commit ec5dd99
Show file tree
Hide file tree
Showing 7 changed files with 93 additions and 19,904 deletions.
4 changes: 2 additions & 2 deletions docs/Packages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ This package uses [Semantic Versioning](https://semver.org/), so if you are test
If you need to build a local version of the package you need to run the following commands:

```bash
npm install
npm run build
yarn
yarn build
```

If you need to release a new version of the library before tagging, you need to execute the following command:
Expand Down
31 changes: 15 additions & 16 deletions docs/ReleaseProcess.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ The steps to build a new version are the following:
- To bump the minor version: `./bumpversion.sh minor`
- To bump the major version: `./bumpversion.sh major`
- assuming we are on version `v0.2.4` and the desired version is `v0.2.5` `./bumpversion.sh patch` has to be run.
- run `npm i` to update the version in `package-lock.json`

## Interact with networks

Expand Down Expand Up @@ -46,8 +45,8 @@ One instance of the multi sig wallet, defined as `owner`. This wallet will be as

### Deploy & Upgrade

- run `npm run clean` to clean the work dir.
- run `npm run compile` to compile the contracts.
- run `yarn clean` to clean the work dir.
- run `yarn compile` to compile the contracts.

#### Rinkeby (Testnet)

Expand All @@ -57,19 +56,19 @@ One instance of the multi sig wallet, defined as `owner`. This wallet will be as

##### Deploy the whole application

- To deploy all contracts run `npm run deploy:rinkeby`
- To deploy all contracts run `yarn deploy:rinkeby`

##### Deploy a single contracts

- To deploy a single contract you need to specify the contracts to deploy as a parameter to the deploy script: ie. `npm run deploy:rinkeby -- NeverminedToken Dispenser`will deploy `NeverminedToken` and `Dispenser`.
- To deploy a single contract you need to specify the contracts to deploy as a parameter to the deploy script: ie. `yarn deploy:rinkeby -- NeverminedToken Dispenser`will deploy `NeverminedToken` and `Dispenser`.

##### Upgrade the whole application

- To upgrade all contracts run `npm run upgrade:rinkeby`
- To upgrade all contracts run `yarn upgrade:rinkeby`

##### Upgrade a single contract

- To upgrade a single contract run `npm run upgrade:rinkeby -- NeverminedToken`. For upgrading the `NeverminedToken` contract.
- To upgrade a single contract run `yarn upgrade:rinkeby -- NeverminedToken`. For upgrading the `NeverminedToken` contract.

##### Persist artifacts

Expand All @@ -83,19 +82,19 @@ One instance of the multi sig wallet, defined as `owner`. This wallet will be as

##### Deploy the whole application

- To deploy all contracts run `npm run deploy:mumbai`
- To deploy all contracts run `yarn deploy:mumbai`

##### Deploy a single contracts

- To deploy a single contract you need to specify the contracts to deploy as a parameter to the deploy script: ie. `npm run deploy:mumbai -- NeverminedToken Dispenser`will deploy `NeverminedToken` and `Dispenser`.
- To deploy a single contract you need to specify the contracts to deploy as a parameter to the deploy script: ie. `yarn deploy:mumbai -- NeverminedToken Dispenser`will deploy `NeverminedToken` and `Dispenser`.

##### Upgrade the whole application

- To upgrade all contracts run `npm run upgrade:mumbai`
- To upgrade all contracts run `yarn upgrade:mumbai`

##### Upgrade a single contract

- To upgrade a single contract run `npm run upgrade:mumbai -- NeverminedToken`. For upgrading the `NeverminedToken` contract.
- To upgrade a single contract run `yarn upgrade:mumbai -- NeverminedToken`. For upgrading the `NeverminedToken` contract.

##### Persist artifacts

Expand All @@ -110,19 +109,19 @@ One instance of the multi sig wallet, defined as `owner`. This wallet will be as

##### Deploy the whole application

- To deploy all the contracts run `npm run deploy:kovan`
- To deploy all the contracts run `yarn deploy:kovan`

##### Deploy a single contracts

- To deploy a single contracts you need to specify the contracts to deploy as a parameter to the deploy script: ie. `npm run deploy:kovan -- NeverminedToken Dispenser` will deploy `NeverminedToken` and `Dispenser`.
- To deploy a single contracts you need to specify the contracts to deploy as a parameter to the deploy script: ie. `yarn deploy:kovan -- NeverminedToken Dispenser` will deploy `NeverminedToken` and `Dispenser`.

##### Upgrade the whole application

- To upgrade all contracts run `npm run upgrade:kovan`
- To upgrade all contracts run `yarn upgrade:kovan`

##### Upgrade a single contract

- To upgrade a single contract run `npm run upgrade:kovan -- NeverminedToken`. For upgrading the `NeverminedToken` contract.
- To upgrade a single contract run `yarn upgrade:kovan -- NeverminedToken`. For upgrading the `NeverminedToken` contract.

##### Persist artifacts

Expand Down Expand Up @@ -200,7 +199,7 @@ changes about the new version (in the future, these will come from the changelog

## Audit

To check or document that all transactions have been approved in the multi sig wallet you can run `npm run audit:rinkeby`
To check or document that all transactions have been approved in the multi sig wallet you can run `yarn audit:rinkeby`
to get a list of all the current transactions and their current status.

```text
Expand Down
24 changes: 12 additions & 12 deletions docs/Upgrades.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ The following configuration should be an example for `wallets-<NETWORK_NAME>.jso

The following commands clean, install dependencies and compile the contracts:
```console
$ npm run clean #to clean the work dir
$ npm i #install dependencies
$ npm run compile #to compile the contracts
$ yarn clean #to clean the work dir
$ yarn #install dependencies
$ yarn compile #to compile the contracts
```

### 3. Deploy & Upgrade
Expand All @@ -103,20 +103,20 @@ The following steps shows how to perform contracts deployment and upgrade on `Ri

##### Deploy the whole application

- To deploy all contracts run `npm run deploy:rinkeby`
- To deploy all contracts run `yarn deploy:rinkeby`

##### Deploy a single contracts

- To deploy a single contract you need to specify the contracts to deploy as a parameter to the deploy script:
ie. `npm run deploy:rinkeby -- NeverminedToken Dispenser`will deploy `NeverminedToken` and `Dispenser`.
ie. `yarn deploy:rinkeby -- NeverminedToken Dispenser`will deploy `NeverminedToken` and `Dispenser`.

##### Upgrade the whole application

- To upgrade all contracts run `npm run upgrade:rinkeby`
- To upgrade all contracts run `yarn upgrade:rinkeby`

##### Upgrade a single contract

- To upgrade a single contract run `npm run upgrade:rinkeby -- NeverminedToken`. For upgrading the `NeverminedToken` contract.
- To upgrade a single contract run `yarn upgrade:rinkeby -- NeverminedToken`. For upgrading the `NeverminedToken` contract.

##### Persist artifacts

Expand All @@ -130,19 +130,19 @@ The following steps shows how to perform contracts deployment and upgrade on `Ri

##### Deploy the whole application

- To deploy all the contracts run `npm run deploy:kovan`
- To deploy all the contracts run `yarn deploy:kovan`

##### Deploy a single contracts

- To deploy a single contracts you need to specify the contracts to deploy as a parameter to the deploy script: ie. `npm run deploy:kovan -- NeverminedToken Dispenser` will deploy `NeverminedToken` and `Dispenser`.
- To deploy a single contracts you need to specify the contracts to deploy as a parameter to the deploy script: ie. `yarn deploy:kovan -- NeverminedToken Dispenser` will deploy `NeverminedToken` and `Dispenser`.

##### Upgrade the whole application

- To upgrade all contracts run `npm run upgrade:kovan`
- To upgrade all contracts run `yarn upgrade:kovan`

##### Upgrade a single contract

- To upgrade a single contract run `npm run upgrade:kovan -- NeverminedToken`. For upgrading the `NeverminedToken` contract.
- To upgrade a single contract run `yarn upgrade:kovan -- NeverminedToken`. For upgrading the `NeverminedToken` contract.

##### Persist artifacts

Expand All @@ -164,7 +164,7 @@ All upgrades of the contracts have to be approved by the `upgrader` wallet confi

### 5. Audit Contracts

To check or document that all transactions have been approved in the multi sig wallet you can run `npm run audit:rinkeby` to get a list of all the current transactions and their current status.
To check or document that all transactions have been approved in the multi sig wallet you can run `yarn audit:rinkeby` to get a list of all the current transactions and their current status.

```text
Wallet: 0x24EB26D4042a2AB576E7E39b87c3f33f276AeF92
Expand Down

0 comments on commit ec5dd99

Please sign in to comment.