diff --git a/README.md b/README.md index d39de19c..fb8d19f8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![era-test-node](./.github/assets/era_test_node_banner_light.png#gh-light-mode-only) -![Webb Logo](./.github/assets/era_test_node_banner_dark.png#gh-dark-mode-only) +![era-test-node](./.github/assets/era_test_node_banner_dark.png#gh-dark-mode-only) @@ -11,8 +11,7 @@ This crate provides an in-memory node that supports forking the state from other networks. -The goal of this crate is to offer a fast solution for integration testing, bootloader and system contract testing, and -prototyping. +The goal of this crate is to offer a fast solution for integration testing, bootloader and system contract testing, and prototyping. 🔗 For a detailed walkthrough, refer to the [official documentation](https://era.zksync.io/docs/tools/testing/era-test-node.html). @@ -149,6 +148,26 @@ Call(Normal) 0x55362182242a4de20ea8a0ec055b2134bb24e23d executeTransac ``` +You can use the following options to get more granular information during transaction processing: + +- `--show-storage-logs `: Show storage log information. + [default: none] + [possible values: none, read, write, all] + +- `--show-vm-details `: Show VM details information. + [default: none] + [possible values: none, all] + +- `--show-gas-details `: Show Gas details information. + [default: none] + [possible values: none, all] + +Example: + +```bash +era_test_node --show-storage-logs=all --show-vm-details=all --show-gas-details=all run +``` + ## 💰 Using Rich Wallets For testing and development purposes, the `era-test-node` comes pre-configured with a set of 'rich' wallets. These wallets are loaded with test funds, allowing you to simulate transactions and interactions without the need for real assets. @@ -174,6 +193,35 @@ Feel free to use these wallets in your tests, but remember, they are for develop See our list of [Supported APIs here](SUPPORTED_APIS.md). +## 🤖 CI/CD Testing with GitHub Actions + +A GitHub Action is available for integrating `era-test-node` into your CI/CD environments. This action offers high configurability and streamlines the process of testing your applications in an automated way. + +You can find this GitHub Action in the marketplace [here](https://github.com/marketplace/actions/era-test-node-action). + +### 📝 Example Usage + +Below is an example `yaml` configuration to use the `era-test-node` GitHub Action in your workflow: + +```yml +name: Run Era Test Node Action + +on: + push: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Run Era Test Node + uses: dutterbutter/era-test-node-action@latest +``` + ## 🤝 Contributing We welcome contributions from the community! If you're interested in contributing to the zkSync Era In-Memory Node, please take a look at our [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for guidelines and details on the process.