Fix paths

skalenetwork · Sep 20, 2024 · 0d9acf1 · 0d9acf1
1 parent 8680fa2
commit 0d9acf1
Show file tree

Hide file tree

Showing 76 changed files with 827 additions and 9,259 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -11,6 +11,8 @@ module.exports = {
 
     },
     ignorePatterns: [
-
+        "coverage/**",
+        "typechain-types/**",
+        "**/venv/**"
     ]
   };
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,9 +1,11 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/proxy"
-  schedule:
-    interval: "weekly"
-    day: "saturday"
-  allow: 
-    - dependency-type: "production"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/scripts/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,5 +1,7 @@
 name: publish
 
+# cspell:words PYPI_TOKEN ncipollo
+
 on:
   pull_request:
     types: [closed]
@@ -103,17 +105,17 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: data
-        path: proxy/data
+        path: data
 
     - name: Create Release
       uses: ncipollo/release-action@v1
       with:
         tag: ${{ env.VERSION }}
         prerelease: ${{ env.PRERELEASE }}
-        artifacts: "proxy/predeployed/dist/*,\
-                    proxy/predeployed/data/*,\
-                    proxy/data/ima-schain-*-manifest.json,\
-                    proxy/data/*-abi.json"
+        artifacts: "predeployed/dist/*,\
+                    predeployed/data/*,\
+                    data/ima-schain-*-manifest.json,\
+                    data/*-abi.json"
 
     - name: Build and publish image
       env:

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "dictionary"]
+	path = dictionary
+	url = https://github.com/skalenetwork/dictionary.git
diff --git a/CODEOWNERS b/CODEOWNERS
diff --git a/Dockerfile b/Dockerfile
@@ -3,7 +3,7 @@ FROM node:18
 RUN mkdir /app
 
 COPY VERSION /app
-COPY proxy /app
+COPY ./ /app
 
 WORKDIR /app
 

diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,22 @@
+{
+    "version": "0.2",
+    "language": "en",
+    "ignorePaths": [
+        ".gitignore",
+        "artifacts/**",
+        "cache/**",
+        "coverage/**",
+        "coverage.json",
+        "data/**",
+        "typechain-types/**",
+        "**/venv/**"
+    ],
+    "dictionaries": ["domain-terms", "libraries", "names", "skale-terms", "solidity"],
+    "dictionaryDefinitions": [
+        { "name": "skale-terms", "path": "dictionary/skale-terms.txt"},
+        { "name": "libraries", "path": "dictionary/libraries.txt"},
+        { "name": "domain-terms", "path": "dictionary/domain-terms.txt"},
+        { "name": "names", "path": "dictionary/names.txt"},
+        { "name": "solidity", "path": "dictionary/solidity.txt"}
+    ]
+}
diff --git a/deployer/README.md b/deployer/README.md
@@ -1,16 +1,17 @@
 <!-- SPDX-License-Identifier: (AGPL-3.0-only OR CC-BY-4.0) -->
+<!-- cspell:words creds -->
 
 # SKALE IMA Deployer
 
 These helper scripts will deploy `IMA` on a SKALE chain.
 
 ## Usage
 
-1)  Place credentials files for each SKALE chain into the `creds` directory
-2)  Run `python deployer.py`
+1) Place credentials files for each SKALE chain into the `creds` directory
+2) Run `python deployer.py`
 
 ## Requirements
 
--   python 3.6+
--   scp
--   all dependencies for truffle deployment (see `proxy` folder)
+- python 3.6+
+- scp
+- all dependencies for truffle deployment (see root folder)
diff --git a/dictionary b/dictionary
diff --git a/docs/deployment.md b/docs/deployment.md
@@ -1,4 +1,5 @@
 <!-- SPDX-License-Identifier: (AGPL-3.0-only OR CC-BY-4.0) -->
+<!-- cspell:words npms privateKey_skalechain ipcpath ipcx -->
 
 # IMA Deployment and Initialization
 
@@ -18,7 +19,7 @@ Deploy process includes:
 
 2)  `SKALE Chain` network with known HTTP(S) URL of **Web3** interface.
 
-3)  Preliminary deployed **Skale Manager** software with known address of **ContractManager** smart contract saved into the `proxy/data/skaleManagerComponents.json` file like shown in the following example:
+3)  Preliminary deployed **Skale Manager** software with known address of **ContractManager** smart contract saved into the `data/skaleManagerComponents.json` file like shown in the following example:
 
 ```json
 {
@@ -39,7 +40,7 @@ Deploy process includes:
 6)  Node modules should be initialized in the following folders:
     ```shell
     export IMA_ROOT=.....
-    cd $IMA_ROOT/proxy; npm install
+    cd $IMA_ROOT; npm install
     cd $IMA_ROOT/npms/skale-owasp; npm install
     cd $IMA_ROOT/npms/skale-ima; npm install
     cd $IMA_ROOT/agent; npm install
@@ -49,10 +50,10 @@ Deploy process includes:
 
 ### Configure Truffle
 
-Edit the `$IMA_ROOT/proxy/truffle-config.js` and specify needed networks (`Mainnet` and `SKALE Chain`) and account addresses which will own contracts on these blockchains:
+Edit the `$IMA_ROOT/truffle-config.js` and specify needed networks (`Mainnet` and `SKALE Chain`) and account addresses which will own contracts on these blockchains:
 
 ```shell
-cd $IMA_ROOT/proxy
+cd $IMA_ROOT
 nano ./truffle-config.js
 ```
 
@@ -83,7 +84,7 @@ Initialize required environment variables. Example of `.env` file can be found i
 Build all the contracts once to ensure everything initialized OK:
 
 ```shell
-cd $IMA_ROOT/proxy
+cd $IMA_ROOT
 mkdir -p data || true
 rm -rf ./build
 rm -rf ./data/proxy*
@@ -94,7 +95,7 @@ ls -1 ./data/
 ### Smart contract Deployment for Main Net
 
 ```shell
-cd $IMA_ROOT/proxy
+cd $IMA_ROOT
 npm run deploy-to-mainnet
 ls -1 ./data/
 ```
@@ -104,7 +105,7 @@ You should see **proxyMainnet.json** file listed.
 #### Smart contract Deployment for S-Chain
 
 ```shell
-cd $IMA_ROOT/proxy
+cd $IMA_ROOT
 npm run deploy-to-schain
 ls -1 ./data/
 ```
@@ -126,8 +127,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -143,8 +144,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -162,8 +163,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -210,8 +211,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --address-s-chain=0x66c5a87f4a49dd75e970055a265e8dd5c3f8f852
 ```
@@ -232,8 +233,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --address-main-net=[ADDRESS] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -253,8 +254,8 @@ node ./main.js --verbose=9 \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
     --id-s-chain=Bob \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY]
 ```
 
@@ -273,8 +274,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY]
 ```
 
@@ -312,8 +313,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -331,8 +332,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -350,8 +351,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY]
 ```
@@ -399,8 +400,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --erc20-main-net=data-mn.json \
     --erc20-s-chain=data-sc.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
@@ -428,8 +429,8 @@ node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --erc20-main-net=data-mn.json \
     --erc20-s-chain=data-sc.json \
     --address-main-net=[ADDRESS] \
@@ -536,8 +537,8 @@ reset; node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY] \
     --sign-messages \
@@ -553,8 +554,8 @@ reset; node ./main.js --verbose=9 \
     --id-s-chain=Bob \
     --cid-main-net=-4 \
     --cid-s-chain=-4 \
-    --abi-main-net=../proxy/data/proxyMainnet.json \
-    --abi-s-chain=../proxy/data/proxySchain_Bob.json \
+    --abi-main-net=../data/proxyMainnet.json \
+    --abi-s-chain=../data/proxySchain_Bob.json \
     --key-main-net=[YOUR_ETH_PRIVATE_KEY] \
     --key-s-chain=[YOUR_PRIVATE_KEY] \
     --sign-messages \

diff --git a/package.json b/package.json
@@ -16,8 +16,8 @@
         "test": "yarn tsc && npx hardhat test",
         "tsc": "tsc --noEmit",
         "slither": "slither .",
-        "fullcheck": "yarn lint && yarn tsc && yarn eslint && yarn slither",
-        "hooks": "git config core.hooksPath proxy/.githooks",
+        "fullCheck": "yarn lint && yarn tsc && yarn eslint && yarn slither",
+        "hooks": "git config core.hooksPath .githooks",
         "no-hooks": "git config core.hooksPath .git/hooks"
     },
     "dependencies": {
@@ -50,6 +50,7 @@
         "chai": "^4.2.0",
         "chai-almost": "^1.0.1",
         "chai-as-promised": "^7.1.1",
+        "cspell": "^8.14.4",
         "eslint": "^8.46.0",
         "ethereum-waffle": "^4.0.10",
         "ganache": "7.9.2",