Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update to ZKsync #157

Merged
merged 2 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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!

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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://...`

Expand Down Expand Up @@ -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.
Expand All @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/contract-interaction.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```

Expand Down
4 changes: 2 additions & 2 deletions docs/transaction-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions src/commands/create/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/commands/dev/command.ts
Original file line number Diff line number Diff line change
@@ -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");
2 changes: 1 addition & 1 deletion src/commands/dev/restart.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
2 changes: 1 addition & 1 deletion src/commands/dev/start.ts
Original file line number Diff 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);
2 changes: 1 addition & 1 deletion src/commands/dev/stop.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
6 changes: 3 additions & 3 deletions src/data/chains.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand Down
Loading