https://github.com/mugen-builders/learn-rollmelette
An example in Golang using Cartesi CLI, Nonodo, and Rollmelette as framework
https://github.com/mugen-builders/learn-rollmelette
cartesi golang rollmelette
Last synced: 13 days ago
JSON representation
An example in Golang using Cartesi CLI, Nonodo, and Rollmelette as framework
- Host: GitHub
- URL: https://github.com/mugen-builders/learn-rollmelette
- Owner: Mugen-Builders
- Created: 2024-07-28T03:01:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T01:24:36.000Z (7 months ago)
- Last Synced: 2025-02-18T00:57:31.080Z (3 months ago)
- Topics: cartesi, golang, rollmelette
- Language: Go
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
An example in Golang using Cartesi CLI, Nonodo, and Rollmelette
This example aims to demonstrate the lifecycle of a Cartesi DApp through unit tests using Rollmelette as a framework. In addition it serves as a template for integration with Avail.
## User Stories:
Here is a list of user stories that the application covers:
| # | User Story Description |
| --- | ---------------------------------------------------------------------------------------------------------- |
| 1 | As a user, I want to send Ether tokens to my wallet on Layer 2. |
| 2 | As a user, I want to send ERC20 tokens to my wallet on Layer 2. |
| 3 | As a user, I want to transfer Ether tokens between wallets on Layer 2. |
| 4 | As a user, I want to transfer ERC20 tokens between wallets on Layer 2. |
| 5 | As a user, I want to withdraw my deposit in ERC20. |
| 6 | As a user, I want to withdraw my deposit in Ether. |
| 7 | As a user, I want to request the balance of Ether in my wallet on Layer 2. |
| 8 | As a user, I want to request the balance of ERC20 tokens in my wallet on Layer 2. |
| 9 | As a user, I want to verify if the Ether deposit was received correctly on Layer 2. |
| 10 | As a user, I want to verify if the ERC20 token deposit was received correctly on Layer 2. |
| 11 | As a user, I want to receive a confirmation of Ether transfer between wallets on Layer 2. |
| 12 | As a user, I want to receive a confirmation of ERC20 token transfer between wallets on Layer 2. |
## Setup:
#### The system setup is divided into three parts:
1º - Install all dependencies:
+ Cartesi CLI:
```bash
$ npm i -g @cartesi/cli
```
+ Foundry:
Follow the instruction [here](https://book.getfoundry.sh/getting-started/installation)
2º - Clone this repo using the code below:
```bash
git clone https://github.com/Mugen-Builders/learn-rollmelette.git
```
## Running the tests:
The command below will run all unit tests present in the repository.
```bash
make test
```
> [!NOTE]
> All user stories covered here can also be fulfilled using the CLI. For more information, please refer to the [documentation](https://docs.cartesi.io/cartesi-rollups/1.3/).
## Avail Integration + Cartesi bare metal:
This section will help you set up a Cartesi dApp with Avail on your local machine. You'll be able to send transactions either directly through Cartesi Rollups Smart Contracts on L1 or via Avail DA using EIP-712 signed messages. You'll also learn how to check the dApp's state and outputs using Cartesi Rollups Framework APIs.
### Requirements:
As a reference for setting up your machine, [follow these steps](https://github.com/Mugen-Builders/cartesi-avail-tutorial?tab=readme-ov-file#prerequisites)
### Running your node locally ( A mocked implementation ):
- Start brunodo using the command with the flag with the flag that enables integration with Avail:
```bash
$ brunodo
```
- Build your machine:
```bash
$ cartesi build
```
- Run the Cartesi Machine Locally on bare metal using the command:
```bash
$ cartesi-machine --network \
--flash-drive=label:root,filename:.cartesi/image.ext2 \
--env=ROLLUP_HTTP_SERVER_URL=http://10.0.2.2:5004 -- /var/opt/cartesi-app/app
```
### Running your node locally with a testnet:
- Start brunodo using the command with the flag with the flag that enables integration with Avail:
```bash
$ brunodo --avail-enabled -d --contracts-input-box-block 6850934 --rpc-url https://sepolia.drpc.org
```
- Build your machine:
```bash
$ cartesi build
```
- Run the Cartesi Machine Locally on bare metal using the command:
```bash
$ cartesi-machine --network \
--flash-drive=label:root,filename:.cartesi/image.ext2 \
--env=ROLLUP_HTTP_SERVER_URL=http://10.0.2.2:5004 -- /var/opt/cartesi-app/app
```