Merge pull request #35 from aragon/feat/bump-versions

Feat: docs and bump versions

packages/contracts/.eslintrc.yml

@@ -16,3 +16,5 @@ ignorePatterns:
   - typechain
   # files
   - coverage.json
+  - docs/config.js
+  - scripts/gen-nav.js

packages/contracts/README.adoc

@@ -1,7 +1,5 @@
 = Admin API
 
-IMPORTANT: The contracts of build 2(use build 1) are currently being audited, DO NOT USE IN PRODUCTION.
-
 == Core
 
 {{Admin}}

packages/contracts/docs/antora.yml

@@ -1,7 +1,7 @@
-name: admin
-title: Admin
-version: 1.x
-prerelease: false
-nav:
-  - modules/ROOT/nav.adoc
-  - modules/api/nav.adoc
+name: admin
+title: Admin
+version: 1.x
+prerelease: false
+nav:
+  - modules/ROOT/nav.adoc
+  - modules/api/nav.adoc

packages/contracts/docs/config.js

@@ -1,13 +1,13 @@
 const path = require('path');
 const fs = require('fs');
 
-// const { version, repository } = require('../package.json');
+const {version, repository} = require('../package.json');
 
-// const helpers = require(path.resolve(__dirname, './templates/helpers'));
+const helpers = require(path.resolve(__dirname, './templates/helpers'));
 
-// // overwrite the functions.
-// helpers.version = () => `${version}/packages/contracts`;
-// helpers.githubURI = () => repository.url;
+// overwrite the functions.
+helpers.version = () => `${version}/packages/contracts`;
+helpers.githubURI = () => repository.url;
 
 /** @type import('solidity-docgen/dist/config').UserConfig */
 module.exports = {

packages/contracts/docs/modules/api/pages/Admin.adoc

@@ -19,8 +19,6 @@
 :xref-AdminSetup-EXECUTE_PERMISSION_ID-bytes32: xref:Admin.adoc#AdminSetup-EXECUTE_PERMISSION_ID-bytes32
 = Admin API
 
-IMPORTANT: The contracts of build 2(use build 1) are currently being audited, DO NOT USE IN PRODUCTION.
-
 == Core
 
 :ADMIN_INTERFACE_ID: pass:normal[xref:#Admin-ADMIN_INTERFACE_ID-bytes4[`++ADMIN_INTERFACE_ID++`]]
@@ -38,7 +36,7 @@ IMPORTANT: The contracts of build 2(use build 1) are currently being audited, DO
 
 [.contract]
 [[Admin]]
-=== `++Admin++` link:https://github.com/aragon/blob/v1.0/src/Admin.sol[{github-icon},role=heading-link]
+=== `++Admin++` link:https://github.com/aragon/admin-plugin/blob/v1.3.0/packages/contracts/src/Admin.sol[{github-icon},role=heading-link]
 
 v1.2 (Release 1, Build 2)
 
@@ -338,7 +336,7 @@ The [ERC-165](https://eips.ethereum.org/EIPS/eip-165) interface ID of the contra
 
 [.contract]
 [[AdminSetup]]
-=== `++AdminSetup++` link:https://github.com/aragon/blob/v1.0/src/AdminSetup.sol[{github-icon},role=heading-link]
+=== `++AdminSetup++` link:https://github.com/aragon/admin-plugin/blob/v1.3.0/packages/contracts/src/AdminSetup.sol[{github-icon},role=heading-link]
 
 v1.2 (Release 1, Build 2)
 

packages/contracts/hardhat-zksync.config.ts

@@ -38,8 +38,8 @@ function specifiedAccounts(): string[] {
   return process.env.PRIVATE_KEY ? process.env.PRIVATE_KEY.split(',') : [];
 }
 
-task('build-contracts').setAction(async (args, hre) => {
-  await hre.run('compile');
+task('compile').setAction(async (args, hre, runSuper) => {
+  await runSuper(args);
   if (isZkSync(hre.network.name)) {
     // Copy zkSync specific build artifacts and cache to the default directories.
     // This ensures that we don't need to change import paths for artifacts in the project.
@@ -65,8 +65,8 @@ task('deploy-contracts')
     });
   });
 
-task('test-contracts').setAction(async (args, hre) => {
-  await hre.run('build-contracts');
+task('test').setAction(async (args, hre, runSuper) => {
+  await hre.run('compile');
   const imp = await import('./test/test-utils/wrapper');
 
   const wrapper = await imp.Wrapper.create(
@@ -75,7 +75,7 @@ task('test-contracts').setAction(async (args, hre) => {
   );
   hre.wrapper = wrapper;
 
-  await hre.run('test');
+  await runSuper(args);
 });
 
 // Extend HardhatRuntimeEnvironment

packages/contracts/hardhat.config.ts

@@ -33,7 +33,9 @@ if (process.env.ALCHEMY_API_KEY) {
   throw new Error('ALCHEMY_API_KEY in .env not set');
 }
 
-task('test-contracts').setAction(async (args, hre) => {
+// Override the test task so it injects wrapper.
+// Note that this also gets injected when running it through coverage.
+task('test').setAction(async (args, hre, runSuper) => {
   await hre.run('compile');
   const imp = await import('./test/test-utils/wrapper');
 
@@ -43,7 +45,7 @@ task('test-contracts').setAction(async (args, hre) => {
   );
   hre.wrapper = wrapper;
 
-  await hre.run('test');
+  await runSuper(args);
 });
 
 // Fetch the accounts specified in the .env file

packages/contracts/package.json

@@ -1,32 +1,42 @@
 {
+  "name": "@aragon/admin-plugin",
+  "private": true,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aragon/admin-plugin"
+  },
+  "author": "Aragon",
   "license": "AGPL-3.0-or-later",
+  "files": [
+    "/src"
+  ],
   "scripts": {
     "build": "cross-env TS_NODE_TRANSPILE_ONLY=true hardhat compile",
-    "build:zksync": "hardhat build-contracts --config hardhat-zksync.config.ts && yarn typechain",
+    "build:zksync": "hardhat compile --config hardhat-zksync.config.ts && yarn typechain",
     "coverage": "hardhat coverage --solcoverjs ./.solcover.js --temp artifacts --testfiles \"test/**/*.ts\" && yarn typechain",
     "deploy": "hardhat deploy",
     "deploy:zksync": "hardhat deploy-contracts --config hardhat-zksync.config.ts",
     "lint": "yarn lint:sol && yarn lint:ts",
     "lint:sol": "cd ../../ && yarn run lint:contracts:sol",
     "lint:ts": "cd ../../ && yarn run lint:contracts:ts",
-    "test": "hardhat test-contracts",
-    "test:zksync": "hardhat test-contracts --config hardhat-zksync.config.ts",
+    "test": "hardhat test",
+    "test:zksync": "hardhat test --config hardhat-zksync.config.ts",
     "docgen": "hardhat docgen",
     "typechain": "cross-env TS_NODE_TRANSPILE_ONLY=true hardhat typechain",
     "clean": "rimraf ./artifacts ./cache ./coverage ./typechain ./coverage.json && yarn typechain",
     "docs": "DOCS=true scripts/prepare-docs.sh"
   },
   "dependencies": {
-    "@aragon/osx-commons-contracts": "1.4.0-alpha.5",
+    "@aragon/osx-commons-contracts": "^1.4.0",
     "@openzeppelin/contracts": "^4.9.6",
     "@openzeppelin/contracts-upgradeable": "^4.9.6"
   },
   "devDependencies": {
-    "@aragon/osx": "1.3.0",
+    "@aragon/osx": "^1.4.0",
     "@aragon/osx-v1.3.0": "npm:@aragon/[email protected]",
-    "@aragon/osx-commons-configs": "0.4.0",
-    "@aragon/osx-commons-sdk": "0.0.1-alpha.11",
-    "@aragon/osx-ethers": "1.4.0-alpha.0",
+    "@aragon/osx-commons-configs": "^0.8.0",
+    "@aragon/osx-ethers": "^1.4.0",
+    "@aragon/osx-commons-sdk": "^0.1.0",
     "@matterlabs/hardhat-zksync-deploy": "0.8",
     "@matterlabs/hardhat-zksync-node": "0.1.0",
     "@matterlabs/hardhat-zksync-solc": "1.2.5",
@@ -67,11 +77,5 @@
     "ts-node": "^10.9.1",
     "typechain": "^8.3.2",
     "typescript": "^5.2.2"
-  },
-  "files": [
-    "/src"
-  ],
-  "publishConfig": {
-    "access": "public"
   }
 }

packages/contracts/yarn.lock

@@ -2,25 +2,32 @@
 # yarn lockfile v1
 
 
-"@aragon/osx-commons-configs@0.4.0", "@aragon/osx-commons-configs@^0.4.0":
+"@aragon/osx-commons-configs@^0.4.0":
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/@aragon/osx-commons-configs/-/osx-commons-configs-0.4.0.tgz#5b6ae025de1ccf7f9a135bfbcb0aa822c774acf9"
   integrity sha512-/2wIQCbv/spMRdOjRXK0RrXG1TK5aMcbD73RvMgMwQwSrKcA1dCntUuSxmTm2W8eEtOzs8E1VPjqZk0cXL4SSQ==
   dependencies:
     tslib "^2.6.2"
 
-"@aragon/[email protected]":
-  version "1.4.0-alpha.5"
-  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-contracts/-/osx-commons-contracts-1.4.0-alpha.5.tgz#37a28085677c21216628ba0a05f5fe09489eb71c"
-  integrity sha512-F2JWWxmUNmiJsaXcTDyd6F2GUIgnc313vvWTp/cSmSVkccT2pfMleWqxIi4LIodX3ueFUYfE02rLj8Gjp1jljA==
+"@aragon/osx-commons-configs@^0.8.0":
+  version "0.8.0"
+  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-configs/-/osx-commons-configs-0.8.0.tgz#71e27c7063c3ca7a26a2c5ae12594063800bd9db"
+  integrity sha512-O8CIKxm+jCN4sq8DBAISlo+Y75VKY03uMqGVP1bUxshqW3ax42r2vlYtTRE/0dJgS9Yh5ElO1tVfDutsGoYWoA==
+  dependencies:
+    tslib "^2.6.2"
+
+"@aragon/[email protected]", "@aragon/osx-commons-contracts@^1.4.0":
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-contracts/-/osx-commons-contracts-1.4.0.tgz#61eda9fbfa19ab76cd7e33c688a2269c5e9f937b"
+  integrity sha512-EufkwHD9BfktIQcaLmvLfY0RXJ/ztbVtB0UtQTVyWZpWALbfUVtHtIC8D9/8JoYVbe8FyDi+btpbBQj79Iwrkg==
   dependencies:
     "@openzeppelin/contracts" "4.9.6"
     "@openzeppelin/contracts-upgradeable" "4.9.6"
 
-"@aragon/osx-commons-sdk@0.0.1-alpha.11":
-  version "0.0.1-alpha.11"
-  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-sdk/-/osx-commons-sdk-0.0.1-alpha.11.tgz#1e3e39aac3351b6649921a5e373a5146b86b2c92"
-  integrity sha512-/FgTLnS73QY0JxZYQlHwpd2ZuMPkPKdIlci9T4jgH9E4Eyyxh6GX7fJK+HekCcf6oMS5tTZ/Cb3sVyyzoO95iw==
+"@aragon/osx-commons-sdk@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-sdk/-/osx-commons-sdk-0.1.0.tgz#ec027744e2d9275d1c5535e356fc3607339c44c9"
+  integrity sha512-T7svAQsfMIpADvAKLnicS7bNV54EE9q8vFUOZy1hh5oF9N/07qD2eeXqXZ9W0uWEKfgpbIyZKV6k+X5kt2kklQ==
   dependencies:
     "@aragon/osx-commons-configs" "^0.4.0"
     "@ethersproject/address" "5.7.0"
@@ -29,12 +36,13 @@
     "@ethersproject/hash" "5.7.0"
     "@ethersproject/logger" "5.7.0"
     "@ethersproject/providers" "5.7.2"
-    ipfs-http-client "^51.0.0"
+    dotenv "^16.4.5"
+    undici "^6.21.0"
 
-"@aragon/[email protected].0-alpha.0":
-  version "1.4.0-alpha.0"
-  resolved "https://registry.yarnpkg.com/@aragon/osx-ethers/-/osx-ethers-1.4.0-alpha.0.tgz#329f1ac27660b486fa0b296dddeb004ce352001c"
-  integrity sha512-fFsrG/XMIjZe3MxVQdf87gqAC4q0Z/eBp72QUuzXJQ0gMSTSj/4TvveFn1N8toLN6KsJolMEkaTamyCGYR+5iA==
+"@aragon/osx-ethers@^1.4.0":
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/@aragon/osx-ethers/-/osx-ethers-1.4.0.tgz#b36b61973ef50798706c2645056a4ff6dc357f4a"
+  integrity sha512-7DoidZNuFHkps9oYuU+da/NJ+ItPXpfu9wja5vHtS0ExFMcU8ZbCDJGBaDMc0m/Q0kNeFIinCeQS6e1lUDx7VA==
   dependencies:
     ethers "^5.6.2"
 
@@ -47,14 +55,15 @@
     "@openzeppelin/contracts" "4.8.1"
     "@openzeppelin/contracts-upgradeable" "4.8.1"
 
-"@aragon/osx@1.3.0":
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/@aragon/osx/-/osx-1.3.0.tgz#eee59963546016bb3b41b7c7a9b7c41d33b37de2"
-  integrity sha512-ziLmnhWEoFS/uthxAYfI9tSylesMLTDe69XggKP9LK/tIOKAhyYjfAJ2mbhWZcH558c9o0gzAEErkDhqh/wdog==
+"@aragon/osx@^1.4.0":
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/@aragon/osx/-/osx-1.4.0.tgz#36ff0671e214ff331625cbcc67cd7f80ce276153"
+  integrity sha512-FY9GizdhRXCLOuy/pADbLD3BsFZ9c+4JmvGC4DB7mauyck8yY2Itf4RhFG3X/afzVihex0bNths4wIf90ZaaUA==
   dependencies:
+    "@aragon/osx-commons-contracts" "1.4.0"
     "@ensdomains/ens-contracts" "0.0.11"
-    "@openzeppelin/contracts" "4.8.1"
-    "@openzeppelin/contracts-upgradeable" "4.8.1"
+    "@openzeppelin/contracts" "4.9.6"
+    "@openzeppelin/contracts-upgradeable" "4.9.6"
 
 "@aws-crypto/[email protected]":
   version "1.2.2"
@@ -3371,6 +3380,11 @@ dotenv@^16.3.1:
   resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.3.1.tgz#369034de7d7e5b120972693352a3bf112172cc3e"
   integrity sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==
 
+dotenv@^16.4.5:
+  version "16.4.7"
+  resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.4.7.tgz#0e20c5b82950140aa99be360a8a5f52335f53c26"
+  integrity sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==
+
 dunder-proto@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/dunder-proto/-/dunder-proto-1.0.1.tgz#d7ae667e1dc83482f8b70fd0f6eefc50da30f58a"
@@ -8485,7 +8499,7 @@ undici@^5.14.0:
   dependencies:
     "@fastify/busboy" "^2.0.0"
 
-undici@^6.18.2, undici@^6.19.5:
+undici@^6.18.2, undici@^6.19.5, undici@^6.21.0:
   version "6.21.1"
   resolved "https://registry.yarnpkg.com/undici/-/undici-6.21.1.tgz#336025a14162e6837e44ad7b819b35b6c6af0e05"
   integrity sha512-q/1rj5D0/zayJB2FraXdaWxbhWiNKDvu8naDT2dl1yTlvJp4BLtOcp2a5BvgGNQpYYJzau7tf1WgKv3b+7mqpQ==

yarn.lock

@@ -7,13 +7,6 @@
   resolved "https://registry.yarnpkg.com/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz#bd9154aec9983f77b3a034ecaa015c2e4201f6cf"
   integrity sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==
 
-"@aragon/osx-commons-configs@^0.7.0-alpha.1":
-  version "0.7.0-alpha.1"
-  resolved "https://registry.yarnpkg.com/@aragon/osx-commons-configs/-/osx-commons-configs-0.7.0-alpha.1.tgz#564c0d449311981a65deeddf650ac5ac6287df77"
-  integrity sha512-ZWUj/XhRZYrbcCk1449CeohetggPwlB4SUjy5w/QmDS+2qJzoC50+vZ5GYg3vC3r7G0KSdJeLPzs1Ec8ez75MA==
-  dependencies:
-    tslib "^2.6.2"
-
 "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.22.13":
   version "7.23.4"
   resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.23.4.tgz#03ae5af150be94392cb5c7ccd97db5a19a5da6aa"
@@ -1325,11 +1318,6 @@ ts-api-utils@^1.0.1:
   resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-1.0.3.tgz#f12c1c781d04427313dbac808f453f050e54a331"
   integrity sha512-wNMeqtMz5NtwpT/UZGY5alT+VoKdSsOOP/kqHFcUW1P/VRhH2wJ48+DN2WwUliNbQ976ETwDL0Ifd2VVvgonvg==
 
-tslib@^2.6.2:
-  version "2.8.1"
-  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f"
-  integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==
-
 type-check@^0.4.0, type-check@~0.4.0:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.4.0.tgz#07b8203bfa7056c0657050e3ccd2c37730bab8f1"