Getting Started

Experience the power of the Topos zkEVM on your local environment with an all-in-one Command-Line Interface (CLI) to run your own demo scenario.

System Requirements

Hardware

• Memory: 16GB or more

Software

• Linux, MacOS
• Docker version 17.06.0 or greater
• Docker Compose version 2.0.0 or greater
• NodeJS version 16.0.0 or greater
• Rust recent nightly (2024)
• Git

Install / Run the CLI

Depending on your NodeJS environment and preferences, there are several ways to install Topos zkEVM Demo.

To install the topos zkevm demo globally, using npm, run the following command:

$ npm install -g @topos-protocol/topos-zkevm-demo

To install the topos zkevm demo globally, using yarn, run the following command:

$ yarn global add @topos-protocol/topos-zkevm-demo

Alternatively, you can install and run via npx:

$ npx @topos-protocol/topos-zkevm-demo

Run the demo

Navigate to (soon) to run the demo scenario!

Development

To build the project locally, run:

$ npm run build

Then, test the newly built CLI:

$ node dist/main <command>

Discussion

For community help or discussion, you can join the Topos Discord server:

https://discord.gg/zMCqqCbGMV

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.