Merge pull request #38 from VenusProtocol/develop

Release to main

Author: gleiser-oliveira

.github/prepare_slim_package.sh

@@ -0,0 +1,17 @@
+# Create a slim folder with the minium content we want, and remove unneeded files
+mkdir slim && cp -r artifacts* package.json README.md deployments slim && cd slim
+find deployments -mindepth 1 -depth -not -name "*_addresses.json*" -exec rm -r "{}" +
+find artifacts -mindepth 1 -depth -not -regex "artifacts/contracts.*" -exec rm -r "{}" +
+find artifacts-zk -mindepth 1 -depth -not -regex "artifacts-zk/contracts.*" -exec rm -r "{}" +
+find artifacts -mindepth 1 -depth -regex "artifacts/.*dbg\.json" -exec rm -r "{}" +
+
+# Add "-slim" to the version in the npm package, keeping the tag "-dev" if it exists
+jq '.version |= sub("^(?<core>[0-9]+\\.[0-9]+\\.[0-9]+)"; "\(.core)-slim")' package.json > package.tmp.json && mv package.tmp.json package.json 
+
+# Remove the "prepare" and "postinstall" scripts, they won't work for this slim version
+jq 'del(.scripts.prepare)' package.json > package.tmp.json && mv package.tmp.json package.json
+jq 'del(.scripts.postinstall)' package.json > package.tmp.json && mv package.tmp.json package.json
+
+# Empty devDependencies and dependencies
+jq '.dependencies = {}' package.json > package.tmp.json && mv package.tmp.json package.json
+jq '.devDependencies = {}' package.json > package.tmp.json && mv package.tmp.json package.json

.github/publish_slim_package.sh

@@ -0,0 +1,10 @@
+# Ensure npm 11.5.1 or later is installed
+npm install -g npm@latest
+
+cd slim
+
+# Extract to PRE_RELEASE_TAG the tag in the version field of the package json, or the empty string if it doesn't exist
+PRE_RELEASE_TAG=$(jq -r '.version | if test("-") then capture("^[0-9]+\\.[0-9]+\\.[0-9]+-(?<tag>[a-zA-Z-]+)") | .tag else "" end' package.json)
+
+# Publish the package to a custom tag for slim versions
+npm publish --access public --tag $PRE_RELEASE_TAG

.github/workflows/cd.yaml

@@ -6,6 +6,10 @@ on:
       - main
       - develop
 
+permissions:
+  id-token: write # Required for OIDC
+  contents: read
+
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -19,6 +23,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           cache: "yarn"
+          node-version: "22.14.0"
+          registry-url: "https://registry.npmjs.org"
 
       - name: Install dependencies
         run: yarn
@@ -29,9 +35,14 @@ jobs:
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.VENUS_TOOLS_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           GIT_AUTHOR_NAME: Venus Tools
           GIT_AUTHOR_EMAIL: tools@venus.io
           GIT_COMMITTER_NAME: Venus Tools
           GIT_COMMITTER_EMAIL: tools@venus.io
         run: yarn semantic-release
+
+      - name: Prepare slim package
+        run: bash .github/prepare_slim_package.sh
+
+      - name: Publish slim package
+        run: bash .github/publish_slim_package.sh

.github/workflows/ci.yaml

@@ -115,10 +115,6 @@ jobs:
             EXPORT=true yarn hardhat export --network ${NETWORK} --export ./deployments/${NETWORK}.json
             jq -M '{name, chainId, addresses: .contracts | map_values(.address)}' ./deployments/${NETWORK}.json > ./deployments/${NETWORK}_addresses.json
           done
-          for NETWORK in zksyncsepolia zksyncmainnet; do
-            EXPORT=true yarn hardhat export --network ${NETWORK} --export ./deployments/${NETWORK}.json --config hardhat.config.zksync.ts
-            jq -M '{name, chainId, addresses: .contracts | map_values(.address)}' ./deployments/${NETWORK}.json > ./deployments/${NETWORK}_addresses.json
-          done
           yarn prettier
 
       - uses: stefanzweifel/git-auto-commit-action@v5

.prettierignore

@@ -10,3 +10,4 @@ scenario
 typechain
 contracts/oracle
 CHANGELOG.md
+docs

.prettierrc

@@ -2,13 +2,30 @@
   "arrowParens": avoid,
   "bracketSpacing": true,
   "endOfLine": "auto",
-  "importOrder": ["module-alias/register", "<THIRD_PARTY_MODULES>", "^[./]"],
-  "importOrderParserPlugins": ["typescript"],
+  "importOrder": [
+    "module-alias/register",
+    "<THIRD_PARTY_MODULES>",
+    "^[./]"
+  ],
+  "importOrderParserPlugins": [
+    "typescript"
+  ],
   "importOrderSeparation": true,
   "importOrderSortSpecifiers": true,
   "printWidth": 120,
   "singleQuote": false,
   "tabWidth": 2,
   "trailingComma": all,
-  "overrides": [{ "files": "*.sol", "options": { "tabWidth": 4 } }],
-}
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "tabWidth": 4
+      }
+    }
+  ],
+  "plugins": [
+    "prettier-plugin-solidity",
+    "@trivago/prettier-plugin-sort-imports"
+  ]
+}

.solhint.json

@@ -4,12 +4,26 @@
     "code-complexity": ["error", 15],
     "compiler-version": ["error", ">=0.5.0"],
     "const-name-snakecase": "error",
+    "immutable-vars-naming": "off",
     "constructor-syntax": "error",
-    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "func-visibility": [
+      "error",
+      {
+        "ignoreConstructors": true
+      }
+    ],
+    "function-max-lines": ["warn", 60],
     "max-line-length": ["error", 175],
     "not-rely-on-time": "off",
     "no-global-import": "error",
-    "reason-string": ["warn", { "maxLength": 64 }],
-    "ordering": "error"
+    "reason-string": [
+      "warn",
+      {
+        "maxLength": 64
+      }
+    ],
+    "ordering": "warn",
+    "state-visibility": "off",
+    "avoid-low-level-calls": "off"
   }
 }