forked from rooch-network/rooch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge commit 'e619c845f9b532430c65858ba2e0d2ff1c4b9e86'
* commit 'e619c845f9b532430c65858ba2e0d2ff1c4b9e86': [VM] Refactor view_function result, return the VMStatus to caller (rooch-network#646) add `rooch server clean` to rooch cli (rooch-network#634) fix const typo => `EFunctionCallBeyondSessionScope` (rooch-network#645) [rooch-networkgh-641] unify coin id to u64 and refactor blockchain scheme. (rooch-network#642) [SessionKey] Check the transaction va session scope (rooch-network#640) implement accumulator store and proof verification (rooch-network#605) refine README.md (rooch-network#639) [rooch-networkgh-621] refactor algorithms and validators. (rooch-network#636) update `rooch-cli.zh-CN.mdx` and translate it (rooch-network#637) [CLI] Support session key in CLI (rooch-network#629) Auto test for module publishing in Move (rooch-network#632) typescript sdk part of issues/585 (rooch-network#597) [types] Migrate module bindings from rooch-framework to rooch-types (rooch-network#623) add weekly 2023-08-14 (rooch-network#624) Detecting global storage instructions during module publishing. (rooch-network#619) [rooch-networkgh-609] refactor validators for other schemes. (rooch-network#610) Verify and publish modules in Move (rooch-network#392) Feature owen opt client code gen (rooch-network#600) Use generic parameter placeholders. (rooch-network#614)
- Loading branch information
Showing
234 changed files
with
11,265 additions
and
5,455 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,107 @@ | ||
# Rooch | ||
|
||
[Rooch](https://rooch.network) is a modular DApp container with the [Move language](https://github.com/move-language/move). | ||
|
||
<div align="center"> | ||
<br /> | ||
<br /> | ||
<a href="https://rooch.network"><img alt="Rooch" src="https://rooch.network/logo/rooch_black_combine.svg" width=384></a> | ||
<br /> | ||
<h3><a href="https://rooch.network">Rooch</a> is Modular DApp Container, with <a href="https://github.com/move-language/move)">Move.</a></h3> | ||
<br /> | ||
</div> | ||
|
||
[![Check-Build-Test](https://github.com/rooch-network/rooch/actions/workflows/check_build_test.yml/badge.svg)](https://github.com/rooch-network/rooch/actions/workflows/check_build_test.yml) | ||
[![License](https://img.shields.io/badge/license-Apache-green.svg)](LICENSE) | ||
[![LoC](https://tokei.rs/b1/github/rooch-network/rooch?category=lines)](https://github.com/rooch-network/rooch) | ||
|
||
## Usage | ||
|
||
1. Rooch Ethereum Layer2: Rooch(Execution) + Layer1s(Settlement) + Ethereum(Arbitration) + DA | ||
2. XChain Modular DApp: Rooch(Execution) + XChain(Settlement + Arbitration) + DA | ||
3. Rooch Layer3 Modular DApp: Rooch(Execution) + Rooch Layer2(Settlement + Arbitration) + DA | ||
4. Sovereign Rollup: Rooch + DA | ||
* **Multi-Chain Layer2**: Rooch(Execution) + Multi-Chain(Settlement) + Ethereum(Arbitration) + DA | ||
* **X-Chain Modular DApp**: Rooch(Execution) + X-Chain(Settlement + Arbitration) + DA | ||
* **Layer3 Modular DApp**: Rooch(Execution) + Rooch Layer2(Settlement + Arbitration) + DA | ||
* **Sovereign Rollup**: Rooch + DA | ||
|
||
## Getting Started | ||
|
||
1. Build from source | ||
1. Building from source: | ||
```bash | ||
cargo build && cp target/debug/rooch ~/.cargo/bin/ | ||
``` | ||
2. Create a new Move project | ||
|
||
2. initialize Rooch config: | ||
```bash | ||
rooch move new my_move_project | ||
rooch init | ||
``` | ||
3. Init Rooch config | ||
|
||
3. Creating a new Move project: | ||
```bash | ||
rooch init | ||
rooch move new my_move_project | ||
``` | ||
4. Build the Move project | ||
4. Building the Move project: | ||
```bash | ||
cd my_move_project && rooch move build | ||
``` | ||
5. Start the server | ||
|
||
5. Starting the server | ||
```bash | ||
rooch server start | ||
``` | ||
> If you want a more detailed log for debugging, you can use `RUST_LOG=debug rooch server start` | ||
6. Publish the Move project | ||
* *`RUST_LOG=debug rooch server start` for debugging information* | ||
|
||
6. Publishing the Move project | ||
```bash | ||
rooch move publish -p my_move_project | ||
``` | ||
|
||
*Experience Rooch through [examples](examples).* | ||
|
||
## Deep Dive into Rooch | ||
|
||
### [Storage Abstraction](./docs/website/pages/docs/tech-highlights/storage_abstraction.en-US.mdx) | ||
<details> | ||
<summary>Storage Abstraction</summary> | ||
|
||
Storage Abstraction module overview: | ||
- [Docs](./docs/website/pages/docs/tech-highlights/storage_abstraction.en-US.mdx) | ||
|
||
- Overview: | ||
|
||
![Storage Abstraction](./docs/website/public/docs/rooch-design-storage-abstraction.svg) | ||
</details> | ||
|
||
<details> | ||
<summary>State DB</summary> | ||
|
||
State DB: | ||
- Overview: | ||
|
||
![State DB](./docs/website/public/docs/rooch-design-statedb.svg) | ||
|
||
### [Transaction Flow](./docs/website/pages/docs/tech-highlights/transaction_flow.en-US.mdx) | ||
</details> | ||
|
||
<details> | ||
<summary>Transaction Flow</summary> | ||
|
||
- [Docs](./docs/website/pages/docs/tech-highlights/transaction_flow.en-US.mdx) | ||
- Overview: | ||
![Rooch Transaction Flow](./docs/website/public/docs/rooch-design-transaction-flow-functional-perspective.svg) | ||
|
||
</details> | ||
|
||
## Components | ||
|
||
* [MoveOS](./moveos): MoveOS is a standalone Move runtime environment based on [MoveVM](https://github.com/move-language/move). It provides Move execution environment for rooch. | ||
* [MoveOS](./moveos): MoveOS is a standalone Move runtime environment based on [MoveVM](https://github.com/move-language/move). 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](./CONTRIBUTING.md) | ||
|
||
## How to Contribute | ||
## Community | ||
|
||
You can learn more about contributing to the Rooch project by reading our [Contribution Guide](./CONTRIBUTING.md) and by viewing our [Code of Conduct](./CODE_OF_CONDUCT.md). | ||
* [Discord](https://discord.gg/rooch) | ||
* [Twitter](https://twitter.com/RoochNetwork) | ||
* [GitHub](https://github.com/rooch-network) | ||
|
||
Rooch Network Rooch is licensed under [Apache 2.0](./LICENSE). | ||
## License | ||
|
||
## Join the Community | ||
Current Rooch code is released under [Apache 2.0](./LICENSE). | ||
|
||
To connect with the Rooch Network community, please join our [Discord](https://discord.gg/rooch). | ||
When contributing to a Rooch feature, you can find the relevant license in the comments at the top of each file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.