Cartesi Rollups v2

[endersonmaia]

This is support for Rollups V2.
The run command has been deprecated and replaced by two separate steps: rollups start and rollups deploy.

The following are the new commands:

$ cartesi rollups --help
Usage: cartesi rollups [options] [command]

Options:
  -h, --help        display help for command

Commands:
  start [options]   Start a local rollups node environment.
  status [options]  Shows the status of a local rollups node environment.
  stop [options]    Stop a local rollups node environment.
  deploy [options]  Deploy a rollups application to a rollups node.

ps: deploy (not rollups deploy) will probably be deprecated. Or we may use a cartesi.toml property to redirect commands from <root> to either rollups or (upcoming) coprocessor.

The following flow works for me. Please help test.

// start server in detached mode
cartesi rollups start -d -v

// check if server is running
cartesi rollups status

// create a new deroll v2 project
npm init @deroll/app@2.0.0-alpha.0

// inside the dapp...
cartesi build
cartesi rollups deploy

// send an input
cartesi send

// stop the server
cartesi rollups stop

[changeset-bot]

🦋 Changeset detected

Latest commit: 24ad87e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@cartesi/cli	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

Coverage Report for ./apps/cli

Status	Category	Percentage	Covered / Total
🔵	Lines	28.14%	293 / 1041
🔵	Statements	28.24%	298 / 1055
🔵	Functions	30.17%	51 / 169
🔵	Branches	26.19%	121 / 462

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
apps/cli/src/base.ts	0%	0%	0%	0%	25-134
apps/cli/src/config.ts	89.5%	82.02%	96.77%	89.3%	66-67, 215, 222, 231, 246-249, 260, 269, 271, 280, 318, 328-332, 344
apps/cli/src/index.ts	0%	0%	0%	0%	18-58
apps/cli/src/wallet.ts	0%	0%	0%	0%	39-322
apps/cli/src/commands/address-book.ts	0%	0%	0%	0%	5-40
apps/cli/src/commands/build.ts	0%	0%	0%	0%	16-91
apps/cli/src/commands/clean.ts	0%	100%	0%	0%	5-9
apps/cli/src/commands/create.ts	0%	0%	0%	0%	7-65
apps/cli/src/commands/deploy.ts	0%	100%	0%	0%	5-18
apps/cli/src/commands/doctor.ts	0%	0%	0%	0%	7-135
apps/cli/src/commands/hash.ts	0%	0%	0%	0%	5-24
apps/cli/src/commands/rollups.ts	0%	100%	0%	0%	7-21
apps/cli/src/commands/run.ts	0%	100%	0%	0%	4-13
apps/cli/src/commands/send.ts	0%	0%	0%	0%	13-100
apps/cli/src/commands/shell.ts	0%	0%	0%	0%	8-55
apps/cli/src/commands/deploy/build.ts	0%	100%	0%	0%	4-10
apps/cli/src/commands/rollups/deploy.ts	0%	0%	0%	0%	29-320
apps/cli/src/commands/rollups/start.ts	0%	0%	0%	0%	8-190
apps/cli/src/commands/rollups/status.ts	0%	0%	0%	0%	8-46
apps/cli/src/commands/rollups/stop.ts	0%	100%	0%	0%	7-28
apps/cli/src/commands/send/erc20.ts	0%	0%	0%	0%	25-109
apps/cli/src/commands/send/erc721.ts	0%	0%	0%	0%	17-103
apps/cli/src/commands/send/ether.ts	0%	0%	0%	0%	12-49
apps/cli/src/commands/send/generic.ts	0%	0%	0%	0%	19-140
apps/cli/src/exec/rollups.ts	0%	0%	0%	0%	18-61

Generated in workflow #360 for commit 24ad87e by the Vitest Coverage Report Action

[tuler]

$ cartesi rollups start --help
Usage: cartesi rollups start [options]

Start a local rollups node environment.

Options:
  --block-time <number>     interval between blocks (in seconds) (default: 5)
  --default-block <string>  default block to be used when fetching new blocks. (choices: "latest", "safe", "pending", "finalized", default: "finalized")
  --cpus <number>           number of cpu limits for the rollups-node
  --memory <number>         memory limit for the rollups-node in MB
  --project-name <string>   name of environment (default: "cartesi-rollups")
  --services <string>       optional services to start, comma separated list from [bundler, explorer, graphql, paymaster] (default: [])
  -p, --port <number>       port to listen on (default: 8080)
  -d, --detach              run in detached mode (default: false)
  --dry-run                 show the docker compose configuration (default: false)
  -v, --verbose             verbose output (default: false)
  -h, --help                display help for command

[tuler]

$ cartesi rollups stop --help 
Usage: cartesi rollups stop [options]

Stop a local rollups node environment.

Options:
  --project-name <project-name>  Project name (default: "cartesi-rollups")
  -h, --help                     display help for command

[tuler]

$ cartesi rollups stop --help 
Usage: cartesi rollups stop [options]

Stop a local rollups node environment.

Options:
  --project-name <project-name>  Project name (default: "cartesi-rollups")
  -h, --help                     display help for command
➜  test2 cartesi-dev rollups status --help
Usage: cartesi rollups status [options]

Shows the status of a local rollups node environment.

Options:
  --project-name <string>  name of environment (default: "cartesi-rollups")
  --json                   output in JSON format
  -h, --help               display help for command

[tuler]

$ cartesi rollups deploy --help
Usage: cartesi rollups deploy [options]

Deploy a rollups application to a rollups node.

Options:
  --chain-id <id>                Chain ID (default: 31337)
  --rpc-url <url>                RPC URL
  --mnemonic <phrase>            Mnemonic passphrase
  --mnemonic-index <index>       Mnemonic account index (default: 0)
  --project-name <string>        name of environment (default: "cartesi-rollups")
  --name <string>                application name
  --authority-owner <address>    authority owner
  --application-owner <address>  application owner
  --epoch-length <number>        length of an epoch (in blocks) (default: 720)
  --salt <hash>                  salt for deployment (default: "0x0000000000000000000000000000000000000000000000000000000000000000")
  --json                         output in JSON format
  -h, --help                     display help for command

[endersonmaia]

Since this PR is mine, I can't request changes.

[endersonmaia]

The send behavior is still weird.

Even if I define the --dapp argument, it will override with the address of the dapp from the directory I'm calling the command from.

--dapp should take precedence

[tuler]

--dapp should take precedence

I think this is commander bug. Opened an issue at tj/commander.js#2335

[tuler]

I think this is commander bug. Opened an issue at tj/commander.js#2335

Problem solved.

ps: there are two ways of structuring commands and subcommands in commander.

1. .command(name).
2. .addCommand(new Command(name))

I was using (1), but switched to (2).

[tuler]

Need to check why the graphql container is continuously printing:

WRN No raw input references found

[endersonmaia]

... send --dapp= is working as expected

[endersonmaia]

@tuler I think we're good to go

[tuler]

Regarding the start + start issue, I was thinking of an elegant way to handle it without checking first if it's running.

What happens now is that docker compose up, when executed again, "reapplies" the services, which is usually harmless. But the one-shot containers get reexecutes, and the one which creates the graphql database fails because the database already exists.

The solutions to create only if exists are all ugly and not elegant.

[endersonmaia]

@tuler I think we're good to go

except that we need a rollups-node v2 release 🫠

[tuler]

Applied the idea of #151 but without the extends, just using an env var for the SDK image name.