Merge pull request #1137 from graphprotocol/tmigone/pnpm

Author: tmigone

.github/actions/setup/action.yml

@@ -6,14 +6,17 @@ runs:
   steps:
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@v1
-    - name: Enable corepack for modern yarn
+    - name: Enable Corepack
       shell: bash
       run: corepack enable
     - name: Install Node.js
       uses: actions/setup-node@v4
       with:
         node-version: 18
-        cache: 'yarn'
+        cache: 'pnpm'
+    - name: Set up pnpm via Corepack
+      shell: bash
+      run: corepack prepare [email protected] --activate
     - name: Install dependencies
       shell: bash
-      run: yarn --immutable
+      run: pnpm install --frozen-lockfile

.github/workflows/build.yml

@@ -22,4 +22,4 @@ jobs:
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Build
-        run: yarn build || yarn build
+        run: pnpm build || pnpm build

.github/workflows/ci-contracts.yml

@@ -27,11 +27,11 @@ jobs:
       - name: Build
         run: |
           pushd packages/contracts
-          yarn build || yarn build
+          pnpm build || pnpm build
       - name: Run tests
         run: |
           pushd packages/contracts
-          yarn test:coverage
+          pnpm test:coverage
       - name: Upload coverage report
         uses: codecov/codecov-action@v3
         with:

.github/workflows/ci-data-edge.yml

@@ -25,6 +25,6 @@ jobs:
       - name: Build
         run: |
           pushd packages/data-edge
-          yarn build
+          pnpm build
       - name: Run tests
-        run: yarn test
+        run: pnpm test

.github/workflows/ci-horizon.yml

@@ -27,24 +27,24 @@ jobs:
       - name: Build contracts
         run: |
           pushd packages/contracts
-          yarn build
+          pnpm build
           popd
       - name: Build horizon
         run: |
           pushd packages/horizon
-          yarn build
+          pnpm build
           popd
       - name: Build subgraph service
         run: |
           pushd packages/subgraph-service
-          yarn build
+          pnpm build
           popd
       - name: Build hardhat-graph-protocol
         run: |
           pushd packages/hardhat-graph-protocol
-          yarn build
+          pnpm build
           popd
       - name: Run tests
         run: |
           pushd packages/horizon
-          yarn test
+          pnpm test

.github/workflows/ci-subgraph-service.yml

@@ -27,24 +27,24 @@ jobs:
       - name: Build contracts
         run: |
           pushd packages/contracts
-          yarn build
+          pnpm build
           popd
       - name: Build horizon
         run: |
           pushd packages/horizon
-          yarn build
+          pnpm build
           popd
       - name: Build subgraph service
         run: |
           pushd packages/subgraph-service
-          yarn build
+          pnpm build
           popd
       - name: Build hardhat-graph-protocol
         run: |
           pushd packages/hardhat-graph-protocol
-          yarn build
+          pnpm build
           popd
       - name: Run tests
         run: |
           pushd packages/subgraph-service
-          yarn test
+          pnpm test

.github/workflows/ci-token-dist.yml

@@ -28,8 +28,8 @@ jobs:
       - name: Build
         run: |
           pushd packages/token-distribution
-          yarn build
+          pnpm build
       - name: Run tests
         run: |
           pushd packages/token-distribution
-          yarn test
+          pnpm test

.github/workflows/publish.yml

@@ -8,8 +8,8 @@ on:
         required: true
         type: choice
         options:
-        - contracts
-        - sdk
+          - contracts
+          - sdk
       tag:
         description: 'Tag to publish'
         required: true
@@ -27,10 +27,10 @@ jobs:
           submodules: recursive
       - name: Set up environment
         uses: ./.github/actions/setup
+      - name: Set npm token for publishing
+        run: pnpm config set //registry.npmjs.org/:_authToken ${{ secrets.GRAPHPROTOCOL_NPM_TOKEN }}
       - name: Publish 🚀
         shell: bash
         run: |
           pushd packages/${{ inputs.package }}
-          yarn npm publish --tag ${{ inputs.tag }} --access public
-        env:
-          YARN_NPM_AUTH_TOKEN: ${{ secrets.GRAPHPROTOCOL_NPM_TOKEN }}
+          pnpm publish --tag ${{ inputs.tag }} --access public --no-git-checks

.github/workflows/verifydeployed.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Build
         run: |
           pushd packages/contracts
-          yarn build || yarn build
+          pnpm build || pnpm build
 
       - name: Save build artifacts
         uses: actions/upload-artifact@v3
@@ -55,14 +55,14 @@ jobs:
       - name: Build
         run: |
           pushd packages/contracts
-          yarn build || yarn build
+          pnpm build || pnpm build
       - name: Get build artifacts
         uses: actions/download-artifact@v3
         with:
           name: contract-artifacts
 
       - name: Verify contracts on Defender
-        run: cd packages/contracts && yarn hardhat --network ${{ inputs.network }} verify-defender ${{ inputs.contracts }}
+        run: cd packages/contracts && pnpm hardhat --network ${{ inputs.network }} verify-defender ${{ inputs.contracts }}
         env:
           DEFENDER_API_KEY: "${{ secrets.DEFENDER_API_KEY }}"
           DEFENDER_API_SECRET: "${{ secrets.DEFENDER_API_SECRET }}"

.yarnrc.yml

@@ -29,7 +29,7 @@
 
 ## Packages
 
-This repository is a Yarn workspaces monorepo containing the following packages:
+This repository is a pnpm workspaces monorepo containing the following packages:
 
 | Package | Latest version | Description |
 | --- | --- | --- |
@@ -46,26 +46,22 @@ This repository is a Yarn workspaces monorepo containing the following packages:
 ## Development
 
 ### Setup
-To set up this project you'll need [git](https://git-scm.com) and [yarn](https://yarnpkg.com/) installed. Note that Yarn v4 is required to install the dependencies and build the project. 
+To set up this project you'll need [git](https://git-scm.com) and [pnpm](https://pnpm.io/) installed.
 
 From your command line:
 
 ```bash
-# Enable Yarn v4
-corepack enable
-yarn set version stable
-
 # Clone this repository
 $ git clone https://github.com/graphprotocol/contracts
 
 # Go into the repository
 $ cd contracts
 
 # Install dependencies
-$ yarn
+$ pnpm install
 
 # Build projects
-$ yarn build
+$ pnpm build
 ```
 
 ### Versioning and publishing packages
@@ -77,7 +73,7 @@ We use [changesets](https://github.com/changesets/changesets) to manage package
 A changeset is a file that describes the changes that have been made to the packages in the repository. To create a changeset, run the following command from the root of the repository:
 
 ```bash
-$ yarn changeset
+$ pnpm changeset
 ```
 
 Changeset files are stored in the `.changeset` directory until they are packaged into a release. You can commit these files and even merge them into your main branch without publishing a release.
@@ -87,7 +83,7 @@ Changeset files are stored in the `.changeset` directory until they are packaged
 When you are ready to create a new package release, run the following command to package all changesets, this will also bump package versions and dependencies:
 
 ```bash
-$ yarn changeset version
+$ pnpm changeset version
 ```
 
 ### Step 3: Tagging the release
@@ -97,7 +93,7 @@ __Note__: this step is meant to be run on the main branch.
 After creating a package release, you will need to tag the release commit with the version number. To do this, run the following command from the root of the repository:
 
 ```bash
-$ yarn changeset tag
+$ pnpm changeset tag
 $ git push --follow-tags
 ```
 
@@ -109,7 +105,7 @@ Packages are published and distributed via NPM. To publish a package, run the fo
 
 ```bash
 # Publish the package
-$ yarn npm publish --access public --tag <tag>
+$ pnpm npm publish --access public --tag <tag>
 ```
 
 Alternatively, there is a GitHub action that can be manually triggered to publish a package.

README.md

@@ -5,26 +5,12 @@
   "license": "GPL-2.0-or-later",
   "repository": "[email protected]:graphprotocol/contracts.git",
   "author": "The Graph team",
-  "packageManager": "[email protected]",
-  "workspaces": [
-    "packages/contracts",
-    "packages/data-edge",
-    "packages/eslint-graph-config",
-    "packages/hardhat-graph-protocol",
-    "packages/horizon",
-    "packages/sdk",
-    "packages/solhint-graph-config",
-    "packages/solhint-plugin-graph",
-    "packages/subgraph-service",
-    "packages/token-distribution"
-  ],
+  "packageManager": "[email protected]+sha1.648f6014eb363abb36618f2ba59282a9eeb3e879",
   "scripts": {
     "postinstall": "husky install",
-    "clean": "yarn workspaces foreach --all --parallel --verbose run clean",
-    "clean:all": "yarn clean && rm -rf node_modules packages/*/node_modules",
-    "build": "chmod +x ./scripts/build && ./scripts/build",
-    "lint": "yarn workspaces foreach --all --parallel --verbose run lint",
-    "test": "yarn workspaces foreach --all --parallel --verbose --interlaced run test"
+    "clean": "pnpm -r --parallel --reporter=append-only run clean",
+    "clean:all": "pnpm clean && rm -rf node_modules packages/*/node_modules",
+    "build": "chmod +x ./scripts/build && ./scripts/build"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.1",

package.json

@@ -11,7 +11,7 @@ cli/cli.ts --help
 For convenience, the script can also be used as a hardhat command with `hardhat migrate` and it can be also run with:
 
 ```
-yarn deploy
+pnpm deploy
 ```
 
 The **migrate** command will:
@@ -25,22 +25,22 @@ The **migrate** command will:
 The script accepts multiple parameters that allow to override default values, print the available options with:
 
 ```
-yarn deploy -- --help
+pnpm deploy -- --help
 ```
 
-NOTE: Please run `yarn build` at least once before running migrate as this command relies on artifacts produced in the compilation process.
+NOTE: Please run `pnpm build` at least once before running migrate as this command relies on artifacts produced in the compilation process.
 
 ### Networks
 
-By default, `yarn deploy` will deploy the contracts to a localhost instance of a development network.
+By default, `pnpm deploy` will deploy the contracts to a localhost instance of a development network.
 
 To deploy to a different network execute:
 
 ```
-yarn deploy -- --network {networkName}
+pnpm deploy -- --network {networkName}
 
 # Example
-yarn deploy -- --network goerli
+pnpm deploy -- --network goerli
 ```
 
 The network must be configured in the `hardhat.config.ts` as explained in https://hardhat.org/config.
@@ -54,7 +54,7 @@ A configuration file called `graph.<networkName>.yml` located in the `config` fo
 You can use a different set of configuration options by specifying the file location in the command line:
 
 ```
-yarn deploy -- --graph-config another-graph.mainnet.yml
+pnpm deploy -- --graph-config another-graph.mainnet.yml
 ```
 
 Rules:
@@ -100,7 +100,7 @@ Some contracts require the address from previously deployed contracts. For that
 ### Deploying a new testnet
 
 1. Make sure contracts are up to date as you please.
-2. `yarn deploy-goerli` to deploy to Goerli. This will create new contracts with new addresses in `addresses.json`.
+2. `pnpm deploy-goerli` to deploy to Goerli. This will create new contracts with new addresses in `addresses.json`.
 3. Update the `package.json` and `package-lock.json` files with the new package version and publish a new npm package with `npm publish`. You can dry-run the files to be uploaded by running `npm publish --dry-run`.
 4. Merge this update into master, branch off and save for whatever version of the testnet is going on, and then tag this on the github repo, pointing to your branch (ex. at `testnet-phase-1` branch). This way we can always get the contract code for testnet, while continuing to do work on mainnet.
 5. Pull the updated package into the subgraph, and other apps that depend on the package.json.

packages/contracts/DEPLOYMENT.md

@@ -56,7 +56,7 @@ The contracts are upgradable, following the [Open Zeppelin Proxy Upgrade Pattern
 The [NPM package](https://www.npmjs.com/package/@graphprotocol/contracts) contains contract interfaces and addresses for the testnet and mainnet. It also contains [typechain](https://github.com/ethereum-ts/TypeChain) generated objects to easily interact with the contracts. This allows for anyone to install the package in their repository and interact with the protocol. It is updated and released whenever a change to the contracts occurs.
 
 ```
-yarn add @graphprotocol/contracts
+pnpm add @graphprotocol/contracts
 ```
 
 # Contract Addresses
@@ -68,8 +68,8 @@ The testnet runs on Goerli, while mainnet is on Ethereum Mainnet. The addresses
 To setup the contracts locally, checkout the `dev` branch, then run:
 
 ```bash
-yarn
-yarn build
+pnpm
+pnpm build
 ```
 
 # Testing

packages/contracts/README.md

@@ -8,7 +8,7 @@ Testing is done with the following stack:
 
 ## Unit testing
 
-To test all the smart contracts, use `yarn test`.
+To test all the smart contracts, use `pnpm test`.
 To test a single file run: `npx hardhat test test/<FILE_NAME>.ts`
 
 ## E2E Testing
@@ -37,7 +37,7 @@ There are several types of e2e tests which can be run separately:
 It can be useful to run E2E tests against a fresh protocol deployment on L1, this can be done with the following:
 
 ```bash
-L1_NETWORK=localhost yarn test:e2e
+L1_NETWORK=localhost pnpm test:e2e
 ```
 
 The command will:
@@ -51,7 +51,7 @@ The command will:
 If you want to test the protocol on an L1/L2 setup, you can run:
 
 ```bash
-L1_NETWORK=localnitrol1 L2_NETWORK=localnitrol2 yarn test:e2e
+L1_NETWORK=localnitrol1 L2_NETWORK=localnitrol2 pnpm test:e2e
 ```
 
 In this case the command will: