chore: merge develop into main

.env.example

@@ -0,0 +1,32 @@
+# GENERAL
+
+## The network used for testing purposes
+NETWORK_NAME="mainnet" #  ["mainnet", "sepolia", "polygon", "mumbai","baseMainnet", "baseGoerli", "baseSepolia", "arbitrum", "arbitrumSepolia"]
+
+# CONTRACTS
+
+## Hex encoded private keys separated by a comma `,`a
+PRIVATE_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" # Default hardhat account 0 private key. DON'T USE FOR DEPLOYMENTS
+
+## RPC alchemy credentials
+ALCHEMY_API_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+
+## Gas Reporting
+REPORT_GAS='true'
+COINMARKETCAP_API_KEY="zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz"
+
+## Block explorers
+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="alice-debug-1s"
+SUBGRAPH_NETWORK_NAME="goerli" #  ["mainnet", "goerli", "polygon", "polygonMumbai"]

.eslintrc.yml

@@ -0,0 +1,34 @@
+root: true
+
+extends:
+  - 'eslint:recommended'
+  - 'plugin:@typescript-eslint/eslint-recommended'
+  - 'plugin:@typescript-eslint/recommended'
+  - 'prettier'
+
+plugins:
+  - '@typescript-eslint'
+  - 'unused-imports'
+
+rules:
+  '@typescript-eslint/no-floating-promises':
+    - error
+    - ignoreIIFE: true
+      ignoreVoid: true
+  '@typescript-eslint/no-inferrable-types': 'off'
+  '@typescript-eslint/no-explicit-any': 'off'
+  '@typescript-eslint/no-unused-vars':
+    - error
+    - argsIgnorePattern: '_'
+      varsIgnorePattern: '_'
+
+  'unused-imports/no-unused-imports': 'error'
+
+ignorePatterns:
+  - '*.log'
+  - '*.env'
+  - '.env'
+  - '.DS_Store'
+  - .pnp.*
+  - 'node_modules'
+  - '*.config.js'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a bug report to help us
+title: 'Bug: <add-text-here>'
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+A short summary of what the bug is. Please be clear and concise.
+
+**To Reproduce (please complete the following information)**
+
+- Config and flags: [e.g. variable="xyz"]
+- Steps to reproduce the behavior:
+  1. node '...'
+  2. make request with '....'
+  3. '...'
+  4. See error
+
+**Current behavior**
+In depth explanation, if required, or a clear and concise description of what actually happens.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**System (please complete the following information):**
+
+- OS: [e.g. Fedora 35]
+- Software version [e.g. Docker 8, Node 14.19.1]
+- Commit hash [e.g. e84617d]
+
+**Additional context**
+Add any other context about the problem here.

.github/labeler.yml

@@ -0,0 +1,27 @@
+contracts:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'contracts/**/*'
+          - 'contracts/*'
+          - '.github/workflows/contracts-*.yml'
+
+sdk:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'sdk/**/*'
+          - 'sdk/*'
+          - '.github/workflows/sdk-*.yml'
+
+subgraph:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'subgraph/**/*'
+          - 'subgraph/*'
+          - '.github/workflows/subgraph-*.yml'
+
+configs:
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'configs/**/*'
+          - 'configs/*'
+          - '.github/workflows/configs-*.yml'

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## 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-?)
+
+<!--- Use the https://www.conventionalcommits.org to name this PR and its commits.-->
+<!--- Consider using https://commitizen.github.io/cz-cli/ for this purpose.-->
+
+## 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.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] My changes generate no new warnings.
+- [ ] Any dependent changes have been merged and published in downstream modules.
+- [ ] I created tasks to update dependent repositories (OSx, Plugins)
+- [ ] I ran all tests with success and extended them if necessary.
+- [ ] I have updated the `CHANGELOG.md` file in the root folder.

.github/scripts/generate_release_matrix.py

@@ -0,0 +1,58 @@
+import json
+import os
+
+#
+# // PULL_LABELS = toJson(github.event.pull_request.labels)
+# 
+# [
+# 	{
+# 		"color": "FFFFF7",
+# 		"default": false,
+# 		"description": "Issue describes change in the development process",
+# 		"id": 1786730933,
+# 		"name": "label_pqr-xyz-release",
+# 		"node_id": "MDU6TGFiZWwxNzg2NzMwOTMz",
+# 		"url": "https://api.github.com/repos/parzh/parzh.github.io/labels/Domain:%20dev"
+# 	},
+# 	{
+# 		"color": "cc062a",
+# 		"default": false,
+# 		"description": "Issue must be addressed right now",
+# 		"id": 1786706637,
+# 		"name": "label_abc-release",
+# 		"node_id": "MDU6TGFiZWwxNzg2NzA2NjM3",
+# 		"url": "https://api.github.com/repos/parzh/parzh.github.io/labels/Priority:%20top"
+# 	},
+# 	{
+# 		"color": "00727C",
+# 		"default": false,
+# 		"description": "Issue describes lack of a functionality or an open possibility of enhancement",
+# 		"id": 1786726751,
+# 		"name": "label_123-improvement",
+# 		"node_id": "MDU6TGFiZWwxNzg2NzI2NzUx",
+# 		"url": "https://api.github.com/repos/parzh/parzh.github.io/labels/Type:%20improvement"
+# 	}
+# ]
+#
+# Test:
+# PULL_LABELS=$(cat labels.json) python3 generate_release_matrix.py
+#
+
+try:
+    labels = json.loads(os.getenv('PULL_LABELS'))
+except:
+    labels = []
+
+trigger_substring = "-release"
+matrix = []
+hasLabels = False
+for label in labels:
+    label_name = str(label['name'])
+    trigger_substring_index = label_name.find(trigger_substring)
+    if trigger_substring_index != -1:
+        matrix.append({
+            'package': label_name[:trigger_substring_index],
+        })
+        hasLabels = True
+
+print(json.dumps({'include': matrix}))

.github/scripts/generate_release_notes.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+PACKAGE=$1
+
+echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
+echo "## All changes in $PACKAGE" >> $GITHUB_ENV
+echo "" >> $GITHUB_ENV
+
+PULL_REQUESTS=$(gh pr list --label $PACKAGE --state merged --json title,mergeCommit,number)
+
+# convert to base64 so we only have one line per pull request that we iterate over
+echo $PULL_REQUESTS | jq -r '.[] | @base64' | while read pull_request ; do
+    COMMIT=$(echo $pull_request | base64 -d | jq -r '.mergeCommit.oid')
+    NUMBER=$(echo $pull_request | base64 -d | jq -r '.number')
+    TITLE=$(echo $pull_request | base64 -d | jq -r '.title')
+
+    # if there is more than 1 tag, the pull request is already included in another release
+    if [ $(git tag --contain $COMMIT | grep -i $PACKAGE | wc -l) -le 1 ]; then
+        echo "- $TITLE in #$NUMBER" >> $GITHUB_ENV
+    fi
+done
+
+
+echo "EOF" >> $GITHUB_ENV

.github/workflows/configs-publish.yml

@@ -0,0 +1,21 @@
+name: Configs Publish
+
+on:
+  push:
+    tags:
+      - '*-configs'
+
+jobs:
+  check_tag:
+    uses: ./.github/workflows/reusable-check-tag.yml
+    with:
+      ref: ${{ github.ref }}
+
+  publish:
+    needs: [check_tag]
+    uses: ./.github/workflows/reusable-publish.yml
+    with:
+      package: ${{ needs.check_tag.outputs.package }}
+      version: ${{ needs.check_tag.outputs.version }}
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/configs-tests.yml

@@ -0,0 +1,40 @@
+name: Configs Tests
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    paths:
+      - 'configs/**'
+      - '.github/workflows/configs-*.yml'
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  formatting-linting:
+    uses: ./.github/workflows/formatting-linting.yml
+  tests:
+    runs-on: 'ubuntu-latest'
+    defaults:
+      run:
+        working-directory: configs
+    steps:
+      - name: 'Check out the repo'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Install Node.js'
+        uses: 'actions/setup-node@v3'
+        with:
+          cache: 'yarn'
+          node-version: 18
+
+      - name: 'Install the dependencies'
+        run: 'yarn install --frozen-lockfile'
+
+      - name: 'Build the configs'
+        run: 'yarn build'
+
+      - name: 'Test the configs'
+        run: 'yarn test >> $GITHUB_STEP_SUMMARY'

.github/workflows/contracts-publish.yml

@@ -0,0 +1,28 @@
+name: Contracts Publish
+
+on:
+  push:
+    tags:
+      - '*-contracts'
+
+jobs:
+  check_tag:
+    uses: ./.github/workflows/reusable-check-tag.yml
+    with:
+      ref: ${{ github.ref }}
+
+  tests:
+    needs: [check_tag]
+    if: ${{ needs.check_tag.outputs.package == 'contracts' }}
+    uses: ./.github/workflows/contracts-tests.yml
+    secrets:
+      ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+
+  publish:
+    needs: [check_tag, tests]
+    uses: ./.github/workflows/reusable-publish.yml
+    with:
+      package: ${{ needs.check_tag.outputs.package }}
+      version: ${{ needs.check_tag.outputs.version }}
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/contracts-tests.yml

@@ -0,0 +1,52 @@
+name: Contracts Tests
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    paths:
+      - 'contracts/**'
+      - '.github/workflows/contracts-*.yml'
+  workflow_dispatch:
+  workflow_call:
+    secrets:
+      ALCHEMY_API_KEY:
+        required: true
+
+jobs:
+  formatting-linting:
+    uses: ./.github/workflows/formatting-linting.yml
+  tests:
+    runs-on: 'ubuntu-latest'
+    defaults:
+      run:
+        working-directory: contracts
+    steps:
+      - name: 'Check out the repo'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Install Node.js'
+        uses: 'actions/setup-node@v3'
+        with:
+          cache: 'yarn'
+          node-version: 18
+
+      - name: 'Install the dependencies'
+        run: 'yarn install --frozen-lockfile'
+
+      - name: 'Build the contracts'
+        run: 'yarn build'
+        env:
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+
+      - name: 'Build the typechain'
+        run: 'yarn typechain'
+        env:
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+
+      - name: 'Test the contracts and generate the coverage report'
+        run: 'yarn coverage >> $GITHUB_STEP_SUMMARY'
+        env:
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}