Skip to content

Latest commit

 

History

History
137 lines (94 loc) · 4.56 KB

README.md

File metadata and controls

137 lines (94 loc) · 4.56 KB


Rooch

Rooch is a VApp Container with Move language for Bitcoin ecosystem.


Check-Build-Test License

VApp stands for Verifiable Application. A Verifiable Application aims to ensure the verifiability of both computations and states within the application, thereby guaranteeing the transparency and reliability of its operations.

Developer Network Information

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

Developer Network Information

Please refer to Connect to 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 a local server

    rooch server start -n local
    • RUST_LOG=debug rooch server start for debugging information
    • You can directly use the devnet or testnet to skip this step.
    • If you want to program with Bitcoin UTXO or Inscription, please setup the local Bitcoin development env and start the server with:
    rooch server start -n local  --btc-rpc-url http://127.0.0.1:18443 --btc-rpc-username roochuser --btc-rpc-password roochpass --btc-sync-block-interval 1 
  6. Publishing the Move project

    rooch move publish -p my_move_project

Experience Rooch through examples.

Deep Dive into Rooch

Storage Abstraction

Storage Abstraction

State DB
  • Overview:

State DB

Transaction Flow

Components

  • MoveOS: MoveOS is a standalone Move runtime environment based on MoveVM. It provides Move execution environment for Rooch.

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.