Skip to content

Commit

Permalink
docs(readme): add tables
Browse files Browse the repository at this point in the history
  • Loading branch information
nikola-bozin-txfusion committed Dec 20, 2023
1 parent 6d5ba0c commit 4a9d047
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 0 deletions.
1 change: 1 addition & 0 deletions packages/hardhat-zksync-chai-matchers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ expect(await contract.getAmount()).to.equal(100);
```

## 📝 Documentation

In addition to the [hardhat-zksync-chai-matchers](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-chai-matchers.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
17 changes: 17 additions & 0 deletions packages/hardhat-zksync-ethers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@ or

`yarn add -D @matterlabs/hardhat-zksync-ethers zksync-ethers ethers`

## Helpers

| 🙏 Helper | 📄 Description |
|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| provider | Retruns a zk.Provider automatically connected to the selected network. |
| getWallet | Returns zk.Wallet for the given private key or index. |
| getContractFactory variant1 | Returns a zk.ContractFactory for provided artifact name. |
| getContractFactory variant2 | Returns a zk.ContractFactory for provided artifact abi and bytecode. |
| getContractFactoryFromArtifact | Returns a zk.ContractFactory for provided artifact. |
| getContractAt | Returns zk.Contract for provided artifact name or abi and address of deployed contract. |
| getContractAtFromArtifact | Returns zk.ContractFactory for provided artifact and address of deployed contract |
| getImpersonatedSigner | Impersonates zk.Signer from address |
| extractFactoryDeps | Extracts factory deps from artifact |
| loadArtifact | Load ZkSyncArtifact from contract name |
| deployContract | Deploys contract |

## 📖 Example

After installing it, add the plugin to your Hardhat config:
Expand All @@ -35,6 +51,7 @@ Find deployed address:
`console.info(await myContract.getAddress());`

## 📝 Documentation

In addition to the [hardhat-zksync-ethers](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-ethers.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
27 changes: 27 additions & 0 deletions packages/hardhat-zksync-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,34 @@ or

`yarn add -D @matterlabs/hardhat-zksync-node`

## 🕹 Commands

`yarn hardhat node-zksync`

This command runs a local zkSync In-memory node by initiating a JSON-RPC server. It uses the provided or default configurations to set up and run the zkSync node, allowing for blockchain operations in a local environment. The command also handles tasks such as downloading the necessary JSON-RPC server binary if it's not already present.

| 🙏 Helper | 📄 Description |
|-------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| --port | Port on which the server should listen. Defaults to 8011. |
| --log | Log filter level. Accepted values are: error, warn, info, and debug. Defaults to info. |
| --log-file-path | Path to the file where logs should be written. Defaults to era_test_node.log |
| --cache | Type of cache to use. Accepted values are: none, disk, and memory. Defaults to disk. |
| --cache-dir | Directory location for the disk cache. Defaults to .cache |
| --reset-cache | Flag to reset the local disk cache. |
| --show-calls | Determines which call debug information to show. Accepted values are: none, user, system, and all. Defaults to none. |
| --show-storage-logs | Determines which storage logs to show. Accepted values are: none, read, write, and all. Defaults to none. |
| --show-vm-details | Specifies the level of Virtual Machine (VM) details to show. Accepted values are: none and all. Defaults to none. |
| --show-gas-details | Specifies the level of gas details to show. Accepted values are: none and all. Defaults to none. |
| --resolve-hashes | When enabled, it makes the debug log more readable but might decrease performance. |
| --dev-use-local-contracts | Flag to load locally compiled system contracts. Useful when making changes to system contracts or bootloader. |
| ---fork | Starts a local network that is a fork of another network. Accepted values are: testnet, mainnet, or a specific URL. |
| --fork-block-number | Specifies the block height at which to fork. |
| --replay-tx | Transaction hash to replay. |

**Restrictions**: The --replay-tx and --fork-block-number parameters cannot be specified simultaneously.

## 📝 Documentation

In addition to the [hardhat-zksync-node](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-node.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-zksync-solc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ or
`yarn add -D @matterlabs/hardhat-zksync-solc`

## 📝 Documentation

In addition to the [hardhat-zksync-solc](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-solc.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-zksync-toolbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ or
`yarn add -D @matterlabs/hardhat-zksync-toolbox ethers zksync-ethers`

## 📝 Documentation

In addition to the [hardhat-zksync-toolbox](https://era.zksync.io/docs/tools/hardhat/plugins.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-zksync-upgradable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ or
`yarn add -D @matterlabs/hardhat-zksync-upgradable @openzeppelin/contracts @openzeppelin/contracts-upgradeable`

## 📝 Documentation

In addition to the [hardhat-zksync-upgradable](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-upgradable.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-zksync-verify-vyper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ or
`yarn add -D @matterlabs/hardhat-zksync-verify-vyper`

## 📝 Documentation

In addition to the [hardhat-zksync-verify-vyper](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-verify-vyper.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-zksync-verify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ or
`yarn add -D @matterlabs/hardhat-zksync-verify @nomicfoundation/hardhat-verify`

## 📝 Documentation

In addition to the [hardhat-zksync-verify](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-verify.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-zksync-vyper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ or
`yarn add -D @matterlabs/hardhat-zksync-vyper @nomiclabs/hardhat-vyper`

## 📝 Documentation

In addition to the [hardhat-zksync-vyper](https://era.zksync.io/docs/tools/hardhat/hardhat-zksync-vyper.html), zkSync's Era [website](https://era.zksync.io/docs/) offers a variety of resources including:

[Guides to get started](https://era.zksync.io/docs/dev/building-on-zksync/hello-world.html): Learn how to start building on zkSync Era.\
Expand Down

0 comments on commit 4a9d047

Please sign in to comment.