feat(contracts): use the latest token-plugin-template

Author: NicoSerranoP

.env.example

@@ -1,7 +1,10 @@
 # GENERAL
 
 ## The network used for testing purposes
-NETWORK_NAME="sepolia" #  ["mainnet", "sepolia", "polygon", "baseMainnet", "arbitrum"]
+NETWORK_NAME="mainnet" #  ["mainnet", "sepolia", "polygon"]
+
+## To upload the metadata for deployed contracts
+PUB_PINATA_JWT=
 
 # CONTRACTS
 
@@ -20,13 +23,24 @@ ETHERSCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
 POLYGONSCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
 BASESCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
 ARBISCAN_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
-
-# SUBGRAPH
-
-## The Graph credentials
-GRAPH_KEY="zzzzzzzzzzzz"
-
-## Subgraph
-SUBGRAPH_NAME="osx"
-SUBGRAPH_VERSION="v1.0.0"
-SUBGRAPH_NETWORK_NAME="mainnet" #  ["mainnet", "sepolia", "polygon", "base", "arbitrum"]
+PEAQ_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+
+## Deployment addresses
+# Note that addresses will be also used for testing so ensure they are valid on the network you are running the forking tests on.
+
+# Optional: if not provided will get it from the latest deployment on the network or from the ens registrar 
+#     defined in the framework if it supports it. In case it is not found will create a new one. 
+# For example for mainnet:
+# 0xb7401cD221ceAFC54093168B814Cc3d42579287f
+PLUGIN_REPO_ADDRESS=0x0000000000000000000000000000000000000000
+# not optional, if not provided will not be able to deploy the plugin or run the forking tests. 
+# For example for mainnet:
+# 0xaac9E9cdb8C1eb42d881ADd59Ee9c53847a3a4f3
+PLUGIN_REPO_FACTORY_ADDRESS=0x0000000000000000000000000000000000000000
+# optional, only needed when a latest versions of the plugin are going to be deploy on a new network.
+PLACEHOLDER_SETUP=0x0000000000000000000000000000000000000000
+# not optional, if not provided will not be able to transfer the ownership of the plugin when deploying
+#     the plugin or running the forking tests, or when the plugin is going to be installed on the management dao.
+#  for example for mainnet:
+# 0xf2d594F3C93C19D7B1a6F15B5489FFcE4B01f7dA
+MANAGEMENT_DAO_ADDRESS=0x0000000000000000000000000000000000000000

.github/labeler.yml

@@ -4,7 +4,3 @@
 contracts:
   - ./packages/contracts/**/*
   - ./packages/contracts/*
-
-subgraph:
-  - ./packages/subgraph/**/*
-  - ./packages/subgraph/*

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+## Description
+
+Please include a summary of the change and be sure you follow the contributions rules we do provide [here](../CONTRIBUTIONS.md)
+
+Task ID: [OS-?](https://aragonassociation.atlassian.net/browse/OS-?)
+
+## Type of change
+
+See the framework lifecylce in `packages/contracts/docs/framework-lifecycle` to decide what kind of change this pull request is.
+
+<!--- Please delete options that are not relevant. -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist:
+
+- [ ] I have selected the correct base branch.
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] My changes generate no new warnings.
+- [ ] Any dependent changes have been merged and published in downstream modules.
+- [ ] I ran all tests with success and extended them if necessary.
+- [ ] I have updated the `CHANGELOG.md` file in the root folder.
+- [ ] I have updated the `DEPLOYMENT_CHECKLIST` file in the root folder.
+- [ ] I have updated the `UPDATE_CHECKLIST` file in the root folder.

.github/workflows/artifacts-publish.yml

@@ -0,0 +1,63 @@
+name: Publish Artifacts
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-artifacts-to-npm:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Configure NPM for Scoped Package
+        run: |
+          cd packages/artifacts
+          SCOPE=$(jq -r '.name' package.json | cut -d'/' -f1)
+          echo "$SCOPE:registry=https://registry.npmjs.org/" > ~/.npmrc
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> ~/.npmrc
+
+      - name: Get Version from package.json
+        id: get_version
+        run: |
+          cd packages/artifacts
+          VERSION=$(jq -r '.version' package.json)
+          TAG_VERSION="v$VERSION"
+          echo "VERSION=$TAG_VERSION" >> $GITHUB_ENV
+
+      - name: Create Git Tag
+        run: |
+          git config --global user.name "github-actions"
+          git config --global user.email "github-actions@github.com"
+          git tag $VERSION
+          git push origin $VERSION
+
+      - name: Install Dependencies
+        run: |
+          cd packages/artifacts
+          yarn install --frozen-lockfile --ignore-scripts
+
+      - name: Build Package
+        env:
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+        run: |
+          cd packages/artifacts
+          yarn build
+
+      - name: Publish to NPM
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          cd packages/artifacts
+          if [[ "$VERSION" == *"-alpha"* ]]; then
+            npm publish --tag alpha --access public
+          else
+            npm publish --tag latest --access public
+          fi

.github/workflows/contracts-tests.yml

@@ -26,7 +26,7 @@ jobs:
           node-version: 18
 
       - name: 'Install the dependencies'
-        run: 'yarn install --frozen-lockfile'
+        run: 'yarn install --frozen-lockfile --ignore-scripts'
 
       - name: 'Build the contracts'
         run: 'yarn build'
@@ -37,4 +37,6 @@ jobs:
         run: 'yarn coverage'
         env:
           NETWORK_NAME: ${{ vars.NETWORK_NAME }}
+          PLUGIN_REPO_FACTORY_ADDRESS: ${{ vars.PLUGIN_REPO_FACTORY_ADDRESS }}
+          MANAGEMENT_DAO_ADDRESS: ${{ vars.MANAGEMENT_DAO_ADDRESS }}
           ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}

.github/workflows/formatting-linting.yml

@@ -19,7 +19,7 @@ jobs:
           node-version: 18
 
       - name: 'Install the dependencies'
-        run: 'yarn install --frozen-lockfile'
+        run: 'yarn install --frozen-lockfile --ignore-scripts'
 
       - name: 'Check code formatting'
         run: 'yarn prettier:check'
@@ -29,6 +29,3 @@ jobs:
 
       - name: 'Lint contracts ts and js'
         run: 'yarn lint:contracts:ts'
-
-      - name: 'Lint subgraph ts and js'
-        run: 'yarn lint:subgraph:ts'

.github/workflows/subgraph-tests.yml

@@ -2,17 +2,22 @@
 .coverage_artifacts
 .coverage_cache
 .coverage_contracts
-artifacts
 build
 cache
 coverage
 dist
 node_modules
 typechain
 
-packages/subgraph/imported
-packages/subgraph/generated
-packages/subgraph/tests/.bin
+packages/contracts/deployments
+packages/contracts/.upgradable/
+packages/contracts/createVersionProposalData*.json
+
+packages/contracts/artifacts
+
+packages/artifacts/src/abi.ts
+
+docs
 
 # files
 *.env
@@ -21,7 +26,6 @@ packages/subgraph/tests/.bin
 .pnp.*
 coverage.json
 
-packages/subgraph/deploy-output.txt
-packages/subgraph/subgraph.yaml
-packages/subgraph/tests/.latest.json
-packages/subgraph/tests/helpers/extended-schema.ts
+artifacts-zk
+cache-zk
+deployments-zk

.gitignore

@@ -15,6 +15,9 @@ imported
 generated
 */js-client/test/integration/*.test.ts
 
+packages/contracts/docs/templates/contract.hbs
+packages/contracts/docs/templates/page.hbs
+
 # files
 *.env
 *.log

.prettierignore

@@ -2,7 +2,7 @@
   "extends": "solhint:recommended",
   "plugins": ["prettier"],
   "rules": {
-    "code-complexity": ["error", 8],
+    "code-complexity": ["error", 10],
     "compiler-version": ["error", ">=0.8.4"],
     "func-visibility": ["error", {"ignoreConstructors": true}],
     "max-line-length": ["error", 120],