fix: update to ZKsync (#157)

matter-labs · Jul 30, 2024 · 22bcf30 · 22bcf30
1 parent c5ba110
commit 22bcf30
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 27 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,8 +1,8 @@
-# Contributing to zkSync CLI
+# Contributing to zksync-cli
 
 ## Welcome! 🎉
 
-Hello, contributor! Thanks for thinking about helping with the zkSync CLI project. This guide will help you understand how to contribute to our CLI tool.
+Hello, contributor! Thanks for thinking about helping with the zksync-cli project. This guide will help you understand how to contribute to our CLI tool.
 
 ## Getting Started
 
@@ -57,7 +57,7 @@ npm run lint
 
 ## Questions?
 
-If you have questions, you can ask on our [zkSync Community Hub](https://github.com/zkSync-Community-Hub/zksync-developers/discussions). We're here to help!
+If you have questions, you can ask on our [ZKsync Community Hub](https://github.com/ZKsync-Community-Hub/zksync-developers/discussions). We're here to help!
 
 ## Thank You!
 

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-### 🐛 Bug Report for zkSync CLI
+### 🐛 Bug Report for zksync-cli
 #### 📝 Description
 
 Provide a clear and concise description of the bug.

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,8 @@
 blank_issues_enabled: true
 contact_links:
     - name: zksync-developers Discussion
-      url: https://github.com/zkSync-Community-Hub/zksync-developers/discussions
+      url: https://github.com/ZKsync-Community-Hub/zksync-developers/discussions
       about: Please provide feedback, and ask questions here.
-    - name: zkSync CLI documentation page
+    - name: zksync-cli documentation page
       url: https://docs.zksync.io/build/tooling/zksync-cli
       about: Please refer to the documentation for immediate answers.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <div align="center">
 
-# ‣ ZKsync CLI 
+# ‣ zksync-cli 
 
-![ZKsync CLI](./zksync-cli-banner.png)
+![zksync-cli](./zksync-cli-banner.png)
 
 This CLI tool simplifies the process of developing applications and interacting with ZKsync.
 
@@ -86,7 +86,7 @@ See full documentation and advanced examples [here](./docs/transaction-info.md).
 ### 🔗 Supported chains
 
 Note: currently you might face issues interacting with custom ZK Chains. Fix is in progress.
-By default ZKsync CLI bridge commands support ZKsync Sepolia Testnet and ZKsync Mainnet. You can also use other networks by using one the options below:
+By default zksync-cli bridge commands support ZKsync Sepolia Testnet and ZKsync Mainnet. You can also use other networks by using one the options below:
 - Adding custom chain using `npx zksync-cli config chains` command.
 - Overwriting L1 and L2 RPC URLs. For example: `npx zksync-cli deposit --rpc=http://... --l1-rpc=http://...`
 
@@ -125,14 +125,14 @@ This project is licensed under [MIT](./LICENSE-MIT).
 
 ## ❓ Troubleshooting
 
-Encountering issues with ZKsync CLI? Below are some common problems with step-by-step recommendations for resolving them:
+Encountering issues with zksync-cli? Below are some common problems with step-by-step recommendations for resolving them:
 
 <details>
 <summary><b>`unknown command` Error</b></summary>
 
 If you encounter an `unknown command` error, follow these steps:
 
-a. **Check the ZKsync CLI Version**
+a. **Check the zksync-cli Version**
    - Run `npx zksync-cli --version` to check your current version.
    - Compare it with the latest version available on [npm](https://www.npmjs.com/package/zksync-cli).
    - If your version is lower than the one on npm follow the steps bellow. If your version is up-to-date, it's possible that the command was moved or renamed. Use `npx zksync-cli help` for a list of current commands or refer to the documentation.
@@ -157,7 +157,7 @@ e. **Use the Latest Version**
 
 If `npx zksync-cli` is not running the latest version:
 
-- Refer to the guide above to check and update your ZKsync CLI version.
+- Refer to the guide above to check and update your zksync-cli version.
 </details>
 
 <details>

diff --git a/docs/contract-interaction.md b/docs/contract-interaction.md
@@ -1,5 +1,5 @@
 # Contract interaction
-The zksync-cli tool, now enhanced with `contract read`, `contract write` and `contract encode` commands, offers efficient ways for developers to interact with smart contracts on zkSync. These commands automate tasks such as method verification, ABI handling, output decoding, and proxy contract processing.
+The zksync-cli tool, now enhanced with `contract read`, `contract write` and `contract encode` commands, offers efficient ways for developers to interact with smart contracts on ZKsync. These commands automate tasks such as method verification, ABI handling, output decoding, and proxy contract processing.
 
 ### Table of contents
 - [Contract Read - Running read-only methods](#contract-read)
@@ -73,7 +73,7 @@ npx zksync-cli contract read
 ```
 You will be prompted to select a chain, contract address, and method.
 ```bash
-? Chain to use: zkSync Sepolia Testnet
+? Chain to use: ZKsync Sepolia Testnet
 ? Contract address: 0x45E6dC995113fd3d1A3b1964493105B9AA9a9A42
 ```
 
@@ -135,7 +135,7 @@ npx zksync-cli contract write
 ```
 You will be prompted to select a chain, contract address, and method.
 ```bash
-? Chain to use: zkSync Sepolia Testnet
+? Chain to use: ZKsync Sepolia Testnet
 ? Contract address: 0x45E6dC995113fd3d1A3b1964493105B9AA9a9A42
 ```
 

diff --git a/docs/transaction-info.md b/docs/transaction-info.md
@@ -43,7 +43,7 @@ npx zksync-cli transaction info
 
 You will be prompted to select a chain and transaction hash.
 ```bash
-? Chain to use: zkSync Sepolia Testnet
+? Chain to use: ZKsync Sepolia Testnet
 ? Transaction hash: 0x2547ce8219eb7ed5d73e68673b0e4ded83afc732a6c651d43d9dc49bb2f13d40
 ```
 
@@ -90,7 +90,7 @@ npx zksync-cli transaction info --full
 ```
 
 ### Displaying raw JSON response
-If you prefer to see the raw JSON response from the zkSync node, use the `--raw` option:
+If you prefer to see the raw JSON response from the ZKsync node, use the `--raw` option:
 
 ```bash
 npx zksync-cli transaction info --raw

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "zksync-cli",
   "type": "module",
   "version": "0.0.0-development",
-  "description": "CLI tool that simplifies the process of developing applications and interacting with the zkSync network",
+  "description": "CLI tool that simplifies the process of developing applications and interacting with the ZKsync network",
   "repository": {
     "type": "git",
     "url": "https://github.com/matter-labs/zksync-cli.git"

diff --git a/src/commands/create/index.ts b/src/commands/create/index.ts
@@ -100,7 +100,7 @@ export const handler = async (predefinedFolderName: string | undefined, options:
               value: "frontend",
             },
             {
-              name: `Scripting ${chalk.gray("- automated interactions and advanced zkSync operations")}`,
+              name: `Scripting ${chalk.gray("- automated interactions and advanced ZKsync operations")}`,
               short: "Scripting",
               value: "scripting",
             },
@@ -137,7 +137,7 @@ export const handler = async (predefinedFolderName: string | undefined, options:
 };
 
 Program.command("create")
-  .description("Scaffold new project for zkSync")
+  .description("Scaffold new project for ZKsync")
   .argument("[folder_name]", "Folder name to create project in")
   .addOption(templateOption)
   .addOption(projectTypeOption)

diff --git a/src/commands/dev/command.ts b/src/commands/dev/command.ts
@@ -1,3 +1,3 @@
 import Program from "../../program.js";
 
-export default Program.command("dev").description("Manage local zkSync development environment");
+export default Program.command("dev").description("Manage local ZKsync development environment");
diff --git a/src/commands/dev/restart.ts b/src/commands/dev/restart.ts
@@ -14,6 +14,6 @@ export const handler = async (modulePackageNames: string[]) => {
 };
 
 Program.command("restart")
-  .description("Restart local zkSync environment and modules")
+  .description("Restart local ZKsync environment and modules")
   .argument("[module...]", "NPM package names of the modules to restart")
   .action(handler);
diff --git a/src/commands/dev/start.ts b/src/commands/dev/start.ts
@@ -178,4 +178,4 @@ export const handler = async () => {
   }
 };
 
-Program.command("start").description("Start local zkSync environment and modules").action(handler);
+Program.command("start").description("Start local ZKsync environment and modules").action(handler);
diff --git a/src/commands/dev/stop.ts b/src/commands/dev/stop.ts
@@ -27,6 +27,6 @@ export const handler = async (modulePackageNames: string[]) => {
 };
 
 Program.command("stop")
-  .description("Stop local zkSync environment and modules")
+  .description("Stop local ZKsync environment and modules")
   .argument("[module...]", "NPM package names of the modules to stop")
   .action(handler);
diff --git a/src/data/chains.ts b/src/data/chains.ts
@@ -32,7 +32,7 @@ export type L2Chain = Chain & { l1Chain?: Chain; blockExplorerApiUrl?: string; v
 export const l2Chains: L2Chain[] = [
   {
     id: 300,
-    name: "zkSync Sepolia Testnet",
+    name: "ZKsync Sepolia Testnet",
     network: "zksync-sepolia",
     rpcUrl: "https://sepolia.era.zksync.dev",
     explorerUrl: "https://sepolia.explorer.zksync.io",
@@ -41,7 +41,7 @@ export const l2Chains: L2Chain[] = [
   },
   {
     id: 324,
-    name: "zkSync Mainnet",
+    name: "ZKsync Mainnet",
     network: "zksync-mainnet",
     rpcUrl: "https://mainnet.era.zksync.io",
     explorerUrl: "https://explorer.zksync.io",
@@ -51,7 +51,7 @@ export const l2Chains: L2Chain[] = [
   {
     // deprecated network
     id: 280,
-    name: "zkSync Goerli Testnet",
+    name: "ZKsync Goerli Testnet",
     network: "zksync-goerli",
     rpcUrl: "https://testnet.era.zksync.dev",
     explorerUrl: "https://goerli.explorer.zksync.io",
-Original file line number
+Diff line change
@@ Expand Up / @@ -178,4 +178,4 @@ export const handler = async () => { @@
       }
     };
-    Program.command("start").description("Start local zkSync environment and modules").action(handler);
+    Program.command("start").description("Start local ZKsync environment and modules").action(handler);