Merge branch 'main' into mde/sam-contract

Author: Maikol

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.gitattributes

@@ -17,4 +17,4 @@ runs:
       run: yarn --immutable
     - name: Build
       shell: bash
-      run: yarn build
+      run: yarn build || yarn build

.github/actions/setup/action.yml

@@ -1,4 +1,4 @@
-name: CI
+name: CI - packages/contracts
 
 env:
   CI: true
@@ -23,7 +23,9 @@ jobs:
       - name: Set up environment
         uses: ./.github/actions/setup
       - name: Run tests
-        run: yarn test:coverage
+        run: |
+          pushd packages/contracts
+          yarn test:coverage
       - name: Upload coverage report
         uses: codecov/codecov-action@v3
         with:

.github/workflows/ci.yml renamed to .github/workflows/ci-contracts.yml

@@ -0,0 +1,26 @@
+name: CI - packages/token-distribution
+
+env:
+  CI: true
+
+on:
+  push:
+    branches: "*"
+    paths:
+      - packages/token-distribution/**
+  pull_request:
+    branches: "*"
+    paths:
+      - packages/token-distribution/**
+  workflow_dispatch:
+
+jobs:
+  test-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Run tests
+        run: yarn test

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

@@ -1,4 +1,4 @@
-name: E2E
+name: E2E - packages/contracts
 
 env:
   CI: true
@@ -9,7 +9,7 @@ on:
     paths:
       - packages/contracts/contracts/**
       - packages/contracts/config/**
-      - packages/contracts/e2e/**
+      - packages/contracts/test/e2e/**
       - packages/contracts/tasks/**
       - packages/contracts/scripts/**
       - packages/contracts/hardhat.config.ts
@@ -18,7 +18,7 @@ on:
     paths:
       - packages/contracts/contracts/**
       - packages/contracts/config/**
-      - packages/contracts/e2e/**
+      - packages/contracts/test/e2e/**
       - packages/contracts/tasks/**
       - packages/contracts/scripts/**
       - packages/contracts/hardhat.config.ts
@@ -41,4 +41,5 @@ jobs:
           sed -i'' -e 's/^\(.*dev.period.*\)/# \1/' docker-compose.yaml
           ./test-node.bash --init --batchposters 0 --redundantsequencers 0 --detach
           popd
+          pushd packages/contracts
           L1_NETWORK=localnitrol1 L2_NETWORK=localnitrol2 yarn test:e2e

.github/workflows/e2e.yml renamed to .github/workflows/e2e-contracts.yml

@@ -36,8 +36,8 @@ jobs:
         with:
           name: contract-artifacts
           path: |
-            build
-            cache/*.json
+            packages/contracts/build
+            packages/contracts/cache/*.json
   
   verify:
     name: Verify deployments
@@ -54,7 +54,7 @@ jobs:
           name: contract-artifacts
 
       - name: Verify contracts on Defender
-        run: yarn hardhat --network ${{ inputs.network }} verify-defender ${{ inputs.contracts }}
+        run: cd packages/contracts && yarn hardhat --network ${{ inputs.network }} verify-defender ${{ inputs.contracts }}
         env:
           DEFENDER_API_KEY: "${{ secrets.DEFENDER_API_KEY }}"
           DEFENDER_API_SECRET: "${{ secrets.DEFENDER_API_SECRET }}"

.github/workflows/verifydeployed.yml

@@ -21,6 +21,7 @@ cached/
 # Build artifacts
 dist/
 build/
+deployments/hardhat/
 
 # Ignore solc bin output
 bin/
@@ -43,3 +44,9 @@ addresses-fork.json
 
 # Keys
 .keystore
+
+# Graph client
+.graphclient
+
+tx-builder-*.json
+!tx-builder-template.json

.gitignore

@@ -1 +1,2 @@
 nodeLinker: node-modules
+nmHoistingLimits: workspaces

.yarnrc.yml

@@ -37,7 +37,10 @@ This repository is a Yarn workspaces monorepo containing the following packages:
 | Package | Latest version | Description |
 | --- | --- | --- |
 | [contracts](./packages/contracts) | [![npm version](https://badge.fury.io/js/@graphprotocol%2Fcontracts.svg)](https://badge.fury.io/js/@graphprotocol%2Fcontracts) | Contracts enabling the open and permissionless decentralized network known as The Graph protocol. |
+| [eslint-graph-config](./packages/eslint-graph-config) | [![npm version]()]() | Shared linting and formatting rules for TypeScript projects. |
+| [token-distribution](./packages/token-distribution) | - | Contracts managing token locks for network participants |
 | [sdk](./packages/sdk) | [![npm version](https://badge.fury.io/js/@graphprotocol%2Fsdk.svg)](https://badge.fury.io/js/@graphprotocol%2Fsdk) | TypeScript based SDK to interact with the protocol contracts |
+| [solhint-graph-config](./packages/eslint-graph-config) | [![npm version]()]() | Shared linting and formatting rules for Solidity projects. |
 
 
 ## Development
@@ -65,21 +68,42 @@ $ yarn
 $ yarn build
 ```
 
-### Versioning a package 
+### Versioning and publishing packages
 
-To version a package, run the following command from the root of the repository:
+We use [changesets](https://github.com/changesets/changesets) to manage package versioning, this ensures that all packages are versioned together in a consistent manner and helps with generating changelogs.
+
+#### Step 1: Creating a changeset
+
+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
-# Change directory to the package you want to version
-$ cd packages/<package-name>
+$ yarn 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.
 
-# Bump the version
-$ yarn version <major|minor|patch>
+#### Step 2: Creating a package release
+
+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
+```
+
+### Step 3: Tagging the release
+
+__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
+$ git push --follow-tags
 ```
 
-__Note on cross referenced packages__: Bumping the version of a package that is cross referenced by another package will automatically bump the dependency version in the other package. For example, if you bump the version of `sdk` from `0.0.1` to `0.0.2`, the required version of `sdk` in the `contracts` package will automatically be bumped to `0.0.2`. Depending on the nature of the change you might need to bump (and publish) a new version of the `contracts` package as well.
+#### Step 4: Publishing a package release
 
-### Publishing a package
+__Note__: this step is meant to be run on the main branch.
 
 Packages are published and distributed via NPM. To publish a package, run the following command from the root of the repository: