chore: sync with osx-plugin-template-hardhat (#15)

* chore: merge `develop` into `main` (aragon#64)

* feat: copied files from the simple-storage-example-plugin repo into package/contracts

* set monorepo package.json

* fix: CI/CD

* init subgraph

* fix: CI/CD

* feat: CI/CD improvements

* feat: cleaned devDependencies

* feat: improve CI step description

* subgraph bare bone (WIP)

* feat: add subpackages and cleaned dependencies

* feat: temporary readme

* feat: move packages

* fix: wrong path

* add post install

* plugin repo only

* switch to osx-ethers

* fix missing dir issue

* make it build

* build 1

* chore: cleaning

* feat: deleted contracts-versions

* feat: refactoring

* feat: refactoring

* feat: improvements

* feat: refactoring

* fix: linting and prettier

* feat: print more infos, remove unused function

* fix: print more info

* More infos

* Renaming

* More info

* fix: test failing because of wrong default test network

* feature: add subgraph workflow

* fix: rename flows

* fix: adapt triggers

* fix: install packages first

* fix: triggers

* feat: one .env file

* fix: .env paths

* fix: remove redundant checkout

* debug: print info

* debug: attempt fix

* fix: missing env variable

* fix: triggers

* Removed summaries

* WIP

* improvements

* fix: path

* fix: empty json handling

* fix: lint warnings

* add psp and pluginRepos related mapping WIP

* refactor PSP handlers (WIP)

* refactor PSP handlers (WIP)

* refactor PSP handlers (WIP)

* refactor PSP handlers (WIP)

* clean up

* create common id functions

* clean up

* Feature: Add js client (#2)

* add dummy js-client

* update yarn.lock

* update package.json

* fix formatting

* fix comments and add js-client github actions

* update js-client test workflow

* fix test workflow

* fix lint

* update workflow

* wip

* fix comments and add implementation

* update yarn lock and remove docs workflow

* Update packages/contracts-ethers/package.json

Co-authored-by: Jør∂¡ <[email protected]>

* Update packages/js-client/src/context.ts

Co-authored-by: Jør∂¡ <[email protected]>

* Update packages/js-client/test/unit/context.test.ts

Co-authored-by: Jør∂¡ <[email protected]>

* add tests

* fix comments

* fix comments

* update client-common version

* fix lint command

* Update packages/js-client/src/internal/modules/methods.ts

Co-authored-by: Jør∂¡ <[email protected]>

* update size limit

* update gh actions

* update gh actions

* fix gh actions

* add build command

* update gh actions

* fix gh action

* fix lint

* fix lint

* ignore js-client tests

* minor fixes

---------

Co-authored-by: Jør∂¡ <[email protected]>

* fix subgraph build

* fix lint

* map 1 event

* chore: bump package versions

* feat: added event, tests, and improved signer, renamed plugin

* fix: linting and formatting errors

* feature: support base goerli network

* Add missing migration import for setup processing

* feat: added sepolia and base support and fix IPFS returning empty strings (#10)

* feat: added sepolia and base support

* fix: replaced outdated IPFS server url

* fix: empty return value

* OS-593: refactors repo for linting and linting during workflows (#11)

* chore(OS-593): Removes .editorconfig from project root

Prettier uses its .prettierrc as a first priority to configure the
formatter

* chore(OS-593): Updates node to v18 in gitpod

* chore(OS-593): same network for subgraph and contracts

Use the same network for subgraph and contracts in the .env.example file

* chore(OS-593): configure vscode editor correctly

configures vscode to use fixed a tabsize of 4 and adds commitizen
extentions into recommendations

* chore(OS-593): reconfigures linting system to start from the root

all linting commands have to be run from the root, then eslint merges
the configs per package and lints those

* build(OS-593): refactors package.json and dependency handling

moves all linting commands to the root of the repo for proper config
merging

* chore(OS-593): adds solidity visual developer as recommmended

we recommend to use the solidity visual auditor extension for
development

* style(OS-593): fixes linting issues

fixes some linting issues in contracts and js-client

* ci(OS-593): refactor workflows and include linting

refactors workflows to be easier and includes formatting and linting in
all workflows

* style(OS-593): apply prettier formatting

* ci(OS-593): lint all packages indiviually

lints the packages individually and adds step summaries for important
steps

* ci(OS-593): remove prettier output from summary

prettiers output isn't really working with step summary

* ci(OS-593): uses now node 18 in workflows

* chore(OS-593): fix typo in formatting-linting.yml

* docs: added readme (#13)

* docs: added readme

* docs: fix typos

* Os 782 remove the contracts ethers and do rollup in mini sdk (#12)

* refactor(OS-782): removes contracts-ethers package

Removes a now unecessary contracts-ethers package. js-client creates its
own typechain now

BREAKING CHANGE: Removal of contracts-ethers

* refactor(OS-782): js-client generates typescript

js-client doesn't depend on contracts-ethers anymore and creates the
typechain typings during its own build

* test(OS-782): ganache replacment, optimizations, use native jest

replaces depricated ganache setup with hardhat for testing, removes
contract interactions where they aren't necessary, upgrades jest by not
using tsdx for testing

* ci(OS-782): fixes js-client publish and tests workflows

corrects reusable worfklow in js-client publishing workflow, adapts
js-client-tests to use the new typechain integration properly

* build(OS-782): removes contracts-ethers linting command

* chore(OS-782): applies prettier formatting

* refactor: renamed and refactored files

* refactor: skip repo creation if ENS name is already taken

* docs: added usage guide and improved comments

* ci: fix workflow by removing outdated lint

* ci: formatting & linting on every push

* docs: improve migration file comment

* ci: fix linting workflow

* build: use the same typescript version everywhere

* docs: improve usage guide

* docs: improved usage guide

* OS-754 : re-organize entity relations & add testing (#15)

* re organize entity relations

* add testing for OSx & Plugin

* remove extra files

* Update Satsuma deploy node url

* Clean up

* fix lint

* fix subgraph scripts

* fix subgraph test flow

* ci: fixed linting work flow

* add comment

* OSx: Remove redundant code

* flow: build contracts for subgraph testing

* flow: build root for subgraph testing

* flow: remove comments

* subgraph: update test constants and comments

* subgraph: refactor & add comments

* ci: skip js-client linting

* docs: fix typo

---------

Co-authored-by: Michael Heuer <[email protected]>

* fix(js-client): exclude dist from tsconfig.json (#20)

* fix(js-client): exclude dist from tsconfig.json

not excluding dist would result in an error trying to run tests after
the client has been built

* ci(js-client): fix missing env in build

* chore: added arbitrum and arbitrumGoerli (#18)

* chore: added arbitrum and arbitrumGoerli

* ci: fix ci pipeline by adding typescript dev dependency

* ci: fix pipeline by removing leftover contracts-ethers lint

* ci: do a global lint on every push

* fix: etherscan arbitrum name

* ci: skip js-client linting

* build: add cross-env to fix subgraph ci

* refactor: add event explicitly

* build(js-client): replaces tsdx with dts-cli (#21)

* build(js-client): replace tsdx with dts-cli
deps(js-client): update to typescript 5.2.2
deps(root): update eslint packages

* lint(js-client): fixes linting errors

* test(js-client): fixes jest-environment import

* style: apply prettier changes

* chore: bump OZ dependency (#22)

* docs: add readme and usage guide

* OS-888 fix: Import Repo address from plugin-info (#26)

* fix: Import repo address from plugin-info

* fix: fix typo

* update plugin-info.json location

* update script

* update gitignore

* update osx-ethers to version 1.3.0

* Update .gitignore

Co-authored-by: Michael Heuer <[email protected]>

* fix import

* remove alias import

---------

Co-authored-by: Jose Manuel Mariñas Bascoy <[email protected]>
Co-authored-by: josemarinas <[email protected]>
Co-authored-by: Michael Heuer <[email protected]>

* build: clean-up of dependecy and commands  (#19)

* build: remove docker-related commands

* build: remove local subgraphs commands

* chore: bump dependencies

* build: bump OZ version and fix unmet dependencies

* Feature: Add Subgraph step-by-step guide (#25)

* add step-by-step guide

* fiux lintint

* fix comments

* fix lint

* fix: Remove individual usage

* fix: update .env.example to include Sepolia

* docs: Improve usage guide

* fix: replace arbitrumGoerli and baseGoerli with the sepolia replacements

* fix: improve usage format

* Apply suggestions from code review

Co-authored-by: Michael Heuer <[email protected]>

* feat: improve usage guide file structure & address comments

* fix: remove redundant titles

* fix: link dependencies in the usage guide

* fix: fix typo

* Apply suggestions from code review

Co-authored-by: Michael Heuer <[email protected]>

---------

Co-authored-by: Rekard0 <[email protected]>
Co-authored-by: Michael Heuer <[email protected]>

* feat: use `osx-commons-contracts` and `osx-commons-configs` (aragon#28)

* build: use ts 5.2.2

* refactor: use osx-commons

* refactor: use osx-commons

* build: use osx-commons-sdk

* build: use osx-commons-sdk

* refactor: contract improvements

* build: print coverage report

* chore: bump osx-commons-sdk version

* feat: use the latest osx-commons-contracts

* refactor: use osx-commons-configs and deploy script refactor

* build: subgraph fix

* docs: improve .env example

* style: fix prettier

* build: use osx-commons

* chore: bump subgraph osx-ethers dependency

* chore: remove todo

* test: remove redundant expect

* fix: use unknown instead of any

* fix: imports

* fix: wrong type

* fix: import

* fix: import

* feat: use typechain binding

* refactor: deploy script simplification

* refactor: findPluginRepo and domain

* refactor: improve code, comments, and tests

* refactor: improved helpers

* style: fix linting issues

* chore: remove todos

* revert: deletion of hashHelpers

* feat: catch errors properly

* refactor: folder structure

* refactor: help gh to track files

* refactor: help gh to track files

* refactor: improve folder structure (aragon#30)

* build: remove js client (aragon#31)

* ci: clean GH flows and remove gitpod (aragon#32)

* ci: improve flows

* style: remove unused commitizen config file

* build: update yarn.lock

* docs: update README.md (aragon#33)

* docs: update README.md

* doc: improve README and USAGE_GUIDE

* doc: minor improvement

* feat: use commons subgraph (aragon#29)

* use commons subgraph

* update events folder structure

* fix comments

* fix tests

* build: update yarn.lock

---------

Co-authored-by: Michael Heuer <[email protected]>

* build: improve  package.json files (aragon#34)

* feat: improvements surfaced from the admin plugin (aragon#36)

* feat: various improvements that surfaced from the admin plugin

* build: remove duplicated dependency

* ci: use network name env var

* style: throw errors for unsupported networks or missing deployments

* feat: update the env examples to change the infura api key for the alchemy one

* feat: update the hardhat contracts file to use the new commons networks config

* feat: update the hardhat config to use the new addRpcUrlToNetwork function from the config commons package

* feat: update the config commons dependency version

* ci: update the readme to add the new alchemy api key needed

* feat: add new commons config version

* ci: typo

* Update .env.example

Co-authored-by: Michael Heuer <[email protected]>

* Update README.md

Co-authored-by: Michael Heuer <[email protected]>

* feat: update the api key in the workflows

* ci: update readme

* feat: bump commons config version on subgraph

* feat: update the actions to run over the PR changes  instead of the commit changes

* ci: comment to check the pipeline

* ci: undo the last comment added on the readme

* feature: improvements (aragon#44)

* doc: added missing comment

* build: remove redundant dependency

* feat: add a function to generate a random ens, set the ens to the plugin settings

* feat: bump commons config version in subgraph

* feat: add random name function

* refactor: settings

---------

Co-authored-by: Claudia <[email protected]>

* feat: add manifest with psp address for missing networks and add the Plugin address to the json

* feat: update the script for getting the repo address

* feat: update the readme

* feat: update the deployment script to avoid deploying if the plugin address is not set

* ci update comment

* feat: change the manifest data json struct

* feat: change the script to get the correct params from the manifest data

* featL change to ens name

* feat: remove the ens domain due to it is not used

* feat: update deploy script to get the correct repo address

* feat: added IAction to template

* feat: bump matchstick version

* fix: remove deprecated networks

* fix: update the repository in the placeholder

* fix: local deploy script problem with `generateRandomName`  (aragon#53)

* fix: error on local deployment

* refactor: move generateName to avoid circular dependency

* refactor: split upgrade repo script into two (aragon#60)

* refactor: renamed file

* refactor: extract skip function

* refactor: renaming and commenting

* style: satisfy linter

* chore: maintained guide

* refactor: don't alias

* fix: wrong import

* fix: change the execution order so that reinitialization happens by default

* refactor: common steps

* refactor: remove IAction (aragon#61)

* f: removed IAction from template as is opinonated solution

* style: add empty line at EOF

---------

Co-authored-by: Michael Heuer <[email protected]>

* chore: refactor helpers (aragon#57)

* refactor: delete hashHelpers

* style: fix linter

* fix: import

* build: bump OZ dependency

* chore: bump osx-commons-sdk dependency

* chore: bumped commons-contracts

* chore: bump osx-commons-sdk version (aragon#62)

* chore: sync with `osx-commons` (aragon#63)

* chore: bump osx-commons-sdk version

* chore: bump osx-commons

* fix: yarn lock

* chore: removed networks (aragon#65)

---------

Co-authored-by: Rekard0 <[email protected]>
Co-authored-by: josemarinas <[email protected]>
Co-authored-by: Jør∂¡ <[email protected]>
Co-authored-by: Jør∂¡ <[email protected]>
Co-authored-by: Mathias Scherer <[email protected]>
Co-authored-by: Aaron Abu Usama <[email protected]>
Co-authored-by: Jose Manuel Mariñas Bascoy <[email protected]>
Co-authored-by: Claudia <[email protected]>
Co-authored-by: jordaniza <[email protected]>
Co-authored-by: Jordan <[email protected]>

* ci: remove not needed code (aragon#66)

* ci: remove the module name and version (aragon#67)

---------

Co-authored-by: Michael Heuer <[email protected]>
Co-authored-by: Rekard0 <[email protected]>
Co-authored-by: josemarinas <[email protected]>
Co-authored-by: Jør∂¡ <[email protected]>
Co-authored-by: Jør∂¡ <[email protected]>
Co-authored-by: Mathias Scherer <[email protected]>
Co-authored-by: Aaron Abu Usama <[email protected]>
Co-authored-by: Jose Manuel Mariñas Bascoy <[email protected]>
Co-authored-by: jordaniza <[email protected]>
Co-authored-by: Jordan <[email protected]>

.env.example

@@ -1,7 +1,7 @@
 # GENERAL
 
 ## The network used for testing purposes
-NETWORK_NAME="sepolia" #  ["mainnet", "sepolia", "polygon", "mumbai","baseMainnet", "baseGoerli", "baseSepolia", "arbitrum", "arbitrumSepolia"]
+NETWORK_NAME="sepolia" #  ["mainnet", "sepolia", "polygon", "baseMainnet", "arbitrum"]
 
 # CONTRACTS
 
@@ -29,4 +29,4 @@ GRAPH_KEY="zzzzzzzzzzzz"
 ## Subgraph
 SUBGRAPH_NAME="osx"
 SUBGRAPH_VERSION="v1.0.0"
-SUBGRAPH_NETWORK_NAME="mainnet" #  ["mainnet", "goerli", "sepolia", "polygon", "polygonMumbai", "base", "baseSepolia", "arbitrum", "arbitrumSepolia"]
+SUBGRAPH_NETWORK_NAME="mainnet" #  ["mainnet", "sepolia", "polygon", "base", "arbitrum"]

packages/contracts/hardhat.config.ts

@@ -115,14 +115,10 @@ const config: HardhatUserConfig = {
   etherscan: {
     apiKey: {
       mainnet: process.env.ETHERSCAN_API_KEY || '',
-      goerli: process.env.ETHERSCAN_API_KEY || '',
       sepolia: process.env.ETHERSCAN_API_KEY || '',
       polygon: process.env.POLYGONSCAN_API_KEY || '',
-      polygonMumbai: process.env.POLYGONSCAN_API_KEY || '',
       base: process.env.BASESCAN_API_KEY || '',
-      baseGoerli: process.env.BASESCAN_API_KEY || '',
       arbitrumOne: process.env.ARBISCAN_API_KEY || '',
-      arbitrumGoerli: process.env.ARBISCAN_API_KEY || '',
     },
     customChains: [
       {
@@ -141,14 +137,6 @@ const config: HardhatUserConfig = {
           browserURL: 'https://basescan.org',
         },
       },
-      {
-        network: 'baseGoerli',
-        chainId: 84531,
-        urls: {
-          apiURL: 'https://api-goerli.basescan.org/api',
-          browserURL: 'https://goerli.basescan.org',
-        },
-      },
     ],
   },
 

packages/contracts/package.json

@@ -1,6 +1,4 @@
 {
-  "name": "@aragon/admin-plugin-contracts",
-  "version": "1.0.0",
   "license": "AGPL-3.0-or-later",
   "scripts": {
     "build": "cross-env TS_NODE_TRANSPILE_ONLY=true hardhat compile",

packages/contracts/test/20_integration-testing/21_deployment.ts

@@ -67,11 +67,6 @@ describe(`Deployment on network '${productionNetworkName}'`, function () {
     it('registers the setup', async () => {
       const {pluginRepo} = await loadFixture(fixture);
 
-      await pluginRepo['getVersion((uint8,uint16))']({
-        release: VERSION.release,
-        build: VERSION.build,
-      });
-
       const results = await pluginRepo['getVersion((uint8,uint16))']({
         release: VERSION.release,
         build: VERSION.build,

packages/subgraph/scripts/deploy-subgraph.sh

@@ -26,7 +26,7 @@ echo '> Building subgraph'
 
 if [ "$SUBGRAPH_NETWORK_NAME" == 'localhost' ]
 then
-  SUBGRAPH_NETWORK_NAME='goerli'
+  SUBGRAPH_NETWORK_NAME='sepolia'
 fi
 
 # Prepare subgraph name