rooch-network / rooch

Fully on-chain Application Container with Move Language
https://rooch.network
Apache License 2.0
125 stars 53 forks source link
bitcoin blockchain ethereum layer2 modular move rollup rust


Rooch

Rooch is a Modular Fully on-chain Application Container, with Move language.


Check-Build-Test License

Usage

Developer Network Information

Please refer to Connect to Developer Test Network for more information.

MoveStd & MoveosStd & RoochFramework documentation

Please refer to Rooch's built-in library for more information.

Getting Started

  1. Building from source:

    cargo build && cp target/debug/rooch ~/.cargo/bin/
  2. initialize Rooch config:

    rooch init
  3. Creating a new Move project:

    rooch move new my_move_project
  4. Building the Move project:

    cd my_move_project && rooch move build
  5. Starting the server

    rooch server start
    • RUST_LOG=debug rooch server start for debugging information
    • You can directly use the devnet and skip this step.
  6. Publishing the Move project

    rooch move publish -p my_move_project

Experience Rooch through examples.

Deep Dive into Rooch

Storage Abstraction - [Docs](https://rooch.network/learn/core-concepts/objects/storage-abstraction) - Overview: ![Storage Abstraction](./docs/website/public/docs/rooch-design-storage-abstraction.svg)
State DB - Overview: ![State DB](./docs/website/public/docs/rooch-design-statedb.svg)
Transaction Flow - [Docs](https://rooch.network/learn/core-concepts/transaction/transaction-flow) - Overview: ![Rooch Transaction Flow](./docs/website/public/docs/rooch-design-transaction-flow-functional-perspective.svg)

Components

Contributing

Rooch is an open source project, you can help with ideas, code, or documentation, we appreciate any efforts that help us to make the project better!

To get started with contributing:

The First Good Pull Request

Community

License

Current Rooch code is released under Apache 2.0.

When contributing to a Rooch feature, you can find the relevant license in the comments at the top of each file.