Skip to content

feat(cli): use either Repository or JSON-RPC API to read data #738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
renatomaia wants to merge 6 commits into
base: next/2.0
Choose a base branch
from
+1,963 −881
Open

feat(cli): use either Repository or JSON-RPC API to read data #738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
db19aff
fix(cli): use URL to inspector instead of its listen setting
renatomaia Feb 23, 2026
f2c3dc5
fix(jsonrpc): require prefix '0x' on commit hash argument
renatomaia Feb 21, 2026
2bf59ea
refactor(cli): export 'ParseIndex' on package 'jsonrpc'
renatomaia Feb 21, 2026
8737787
refactor(cli): rename API function to match JSONRPC operation
renatomaia Feb 21, 2026
505c197
refactor(cli): rename field to follow a more string CamelCase
renatomaia Feb 21, 2026
d9ccb60
feat(cli): add support to read data using JSON-RPC API
renatomaia Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions cmd/cartesi-rollups-cli/root/inspect/inspect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (

"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/spf13/cobra"
"github.com/spf13/viper"

"github.com/cartesi/rollups-node/internal/config"
"github.com/cartesi/rollups-node/pkg/inspectclient"
Expand Down Expand Up @@ -50,7 +49,6 @@ func init() {

Cmd.Flags().StringVar(&inspectEndpoint, "inspect-endpoint", "http://localhost:10012/",
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This removes the previous viper/config binding (config.GetInspectAddress()), which likely changes behavior for users relying on environment/config-based configuration. If that's unintended, consider restoring config/env resolution (e.g., defaulting inspectEndpoint from config/env, or keeping the prior GetInspectAddress() behavior with the flag overriding it).

Suggested change
Cmd.Flags().StringVar(&inspectEndpoint, "inspect-endpoint", "http://localhost:10012/",
defaultInspectEndpoint := config.GetInspectAddress()
Cmd.Flags().StringVar(&inspectEndpoint, "inspect-endpoint", defaultInspectEndpoint,

Copilot uses AI. Check for mistakes.
"address used to connect to the inspect api")
cobra.CheckErr(viper.BindPFlag(config.INSPECT_ADDRESS, Cmd.Flags().Lookup("inspect-endpoint")))

origHelpFunc := Cmd.HelpFunc()
Cmd.SetHelpFunc(func(command *cobra.Command, strings []string) {
Expand Down Expand Up @@ -96,10 +94,7 @@ func run(cmd *cobra.Command, args []string) {
nameOrAddress, err := config.ToApplicationNameOrAddressFromString(args[0])
cobra.CheckErr(err)

endpoint, err := config.GetInspectAddress()
cobra.CheckErr(err)

client, err := inspectclient.NewClient(endpoint)
client, err := inspectclient.NewClient(inspectEndpoint)
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This removes the previous viper/config binding (config.GetInspectAddress()), which likely changes behavior for users relying on environment/config-based configuration. If that's unintended, consider restoring config/env resolution (e.g., defaulting inspectEndpoint from config/env, or keeping the prior GetInspectAddress() behavior with the flag overriding it).

Suggested change
client, err := inspectclient.NewClient(inspectEndpoint)
endpoint := inspectEndpoint
if !cmd.Flags().Changed("inspect-endpoint") {
if cfgEndpoint, cfgErr := config.GetInspectAddress(); cfgErr == nil && cfgEndpoint != "" {
endpoint = cfgEndpoint
}
}
client, err := inspectclient.NewClient(endpoint)

Copilot uses AI. Check for mistakes.
cobra.CheckErr(err)

payload, err := resolvePayload(args)
Expand Down
179 changes: 67 additions & 112 deletions cmd/cartesi-rollups-cli/root/read/commitments/commitments.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,17 @@ package commitments

import (
"encoding/json"
"errors"
"fmt"

"github.com/cartesi/rollups-node/internal/config"
"github.com/cartesi/rollups-node/internal/jsonrpc"
"github.com/cartesi/rollups-node/internal/model"
"github.com/cartesi/rollups-node/internal/repository"
"github.com/cartesi/rollups-node/internal/repository/factory"
"github.com/cartesi/rollups-node/internal/read"

"github.com/spf13/cobra"
)

var Cmd = &cobra.Command{
Use: "commitments [application-name-or-address] [epoch-index] [tournament-address] [commitment-hash]",
Use: "commitments <application> [epoch index] [tournament address] [commitment]",
Short: "Reads commitments",
Example: examples,
Args: cobra.RangeArgs(1, 4), // nolint: mnd
Expand All @@ -28,43 +25,42 @@ Supported Environment Variables:
CARTESI_DATABASE_CONNECTION Database connection string`,
}

const examples = `# Read all commitments:
cartesi-rollups-cli read commitments echo-dapp

# Read specific commitment by epoch, tournament and commitment hash:
cartesi-rollups-cli read commitments echo-dapp 1 0xa2835312696afa86c969e40831857dbb1412627f 0x1b7087e9580fb7946f37a40ced7ffeded336da790e00cc88e5f4e8e25301546a
const examples = `# Read specific commitment:
cartesi-rollups-cli read commitments echo-dapp 10 0x0073a8637d98649717bdc02ecb439c80aa8a10d0 0xdb99c9cdb2e2070a4e4e633c2e6874648dfe3971d14da843465b3d950df3dd19

# Read commitments filtered by epoch:
cartesi-rollups-cli read commitments echo-dapp --epoch-index 1
# Read all commitments:
cartesi-rollups-cli read commitments echo-dapp

# Read commitments with pagination:
cartesi-rollups-cli read commitments echo-dapp --limit 10 --offset 20`
# Read all commitments with filter:
cartesi-rollups-cli read commitments echo-dapp --epoch-index 10 --tournament-address 0x0073a8637d98649717bdc02ecb439c80aa8a10d0

func init() {
origHelpFunc := Cmd.HelpFunc()
Cmd.SetHelpFunc(func(command *cobra.Command, strings []string) {
command.Flags().Lookup("verbose").Hidden = false
command.Flags().Lookup("database-connection").Hidden = false
origHelpFunc(command, strings)
})
}
# Read all commitments with pagination:
cartesi-rollups-cli read commitments echo-dapp --limit 10 --offset 10
`

var (
epochIndex uint64
epochIndex string
tournamentAddress string
limit uint64
offset uint64
)

func init() {
Cmd.Flags().Uint64Var(&epochIndex, "epoch-index", 0,
Cmd.Flags().StringVar(&epochIndex, "epoch-index", "",
"Filter commitments by epoch index (decimal or hex encoded)")
Cmd.Flags().StringVar(&tournamentAddress, "tournament-address", "",
"Filter commitments by tournament address (hex encoded)")
Cmd.Flags().Uint64Var(&limit, "limit", 50, // nolint: mnd
"Maximum number of commitments to return")
Cmd.Flags().Uint64Var(&limit, "limit", 50,
"Maximum number of results to return")
Cmd.Flags().Uint64Var(&offset, "offset", 0,
"Starting point for the list of commitments")
"Starting point for the list of results")

origHelpFunc := Cmd.HelpFunc()
Cmd.SetHelpFunc(func(command *cobra.Command, strings []string) {
command.Flags().Lookup("verbose").Hidden = false
command.Flags().Lookup("database-connection").Hidden = false
origHelpFunc(command, strings)
})

Cmd.PreRunE = func(cmd *cobra.Command, args []string) error {
if limit > jsonrpc.LIST_ITEM_LIMIT {
Expand All @@ -79,106 +75,65 @@ func init() {
func run(cmd *cobra.Command, args []string) {
ctx := cmd.Context()

nameOrAddress, err := config.ToApplicationNameOrAddressFromString(args[0])
cobra.CheckErr(err)
var (
readServ read.ReadService
err error
)

dsn, err := config.GetDatabaseConnection()
cobra.CheckErr(err)
addr := cmd.Flags().Lookup("jsonrpc-api-address").Value.String()
if addr != "" {
readServ, err = read.NewJsonrpcReadService(ctx, addr)
} else {
dsn, err := config.GetDatabaseConnection()
cobra.CheckErr(err)

repo, err := factory.NewRepositoryFromConnectionString(ctx, dsn.String())
readServ, err = read.NewRepositoryReadService(ctx, dsn.String())
}
cobra.CheckErr(err)
defer repo.Close()

var result []byte
if len(args) == 4 { // nolint: mnd
// Get a specific commitment by epoch, tournament and commitment

epochIndex, err := config.ToUint64FromDecimalOrHexString(args[1])
if err != nil {
cobra.CheckErr(fmt.Errorf("invalid value for epoch-index: %w", err))
}

// TODO: [maia] check out if the following check is necessary, because
// such conversion is already done in the 'repo.GetCommitment' function,
// but it doesn't seem to check for invalid addresses.
tournamentAddressHex := args[2]
_, err = config.ToAddressFromString(tournamentAddressHex)
if err != nil {
cobra.CheckErr(fmt.Errorf("invalid tournament address: %w", err))
}
commitmentHashHex := args[3]
_, err = config.ToHashFromString(commitmentHashHex)
defer readServ.Close()

var result json.RawMessage
if len(args) >= 4 {
var params jsonrpc.GetCommitmentParams
params.Application = args[0]
// Convert from decimal to hexadecimal
epochIndexNumeric, err := config.ToUint64FromDecimalOrHexString(args[1])
if err != nil {
cobra.CheckErr(fmt.Errorf("invalid commitment hash: %w", err))
cobra.CheckErr(err)
}
params.EpochIndex = fmt.Sprintf("0x%02x", epochIndexNumeric)
params.TournamentAddress = args[2]
params.Commitment = args[3]

commitment, err := repo.GetCommitment(ctx, nameOrAddress, epochIndex, tournamentAddressHex, commitmentHashHex)
cobra.CheckErr(err)
if commitment == nil {
cobra.CheckErr(errors.New("not found"))
}

// Format response to match JSON-RPC API
response := struct {
Data *model.Commitment `json:"data"`
}{
Data: commitment,
}

result, err = json.MarshalIndent(response, "", " ")
cobra.CheckErr(err)
} else {
// Create filter based on flags
filter := repository.CommitmentFilter{}
result, err = readServ.GetCommitment(ctx, params)
} else if len(args) >= 1 {
var params jsonrpc.ListCommitmentsParams
params.Application = args[0]

// Add epoch index filter if provided
if cmd.Flags().Changed("epoch-index") {
filter.EpochIndex = &epochIndex
}

// Add parent commitment address filter if provided
if cmd.Flags().Changed("tournament-address") {
// TODO: [maia] check out if the following check is necessary.
_, err := config.ToAddressFromString(tournamentAddress)
// Convert from decimal to hexadecimal
epochIndexNumeric, err := config.ToUint64FromDecimalOrHexString(epochIndex)
if err != nil {
cobra.CheckErr(fmt.Errorf("invalid tournament address: %w", err))
cobra.CheckErr(err)
}
filter.TournamentAddress = &tournamentAddress
epochIndexConverted := fmt.Sprintf("0x%02x", epochIndexNumeric)
params.EpochIndex = &epochIndexConverted
}

// Limit is validated in PreRunE

// List commitments with filters
commitments, total, err := repo.ListCommitments(ctx, nameOrAddress, filter, repository.Pagination{
Limit: limit,
Offset: offset,
}, false)
cobra.CheckErr(err)

// Format response to match JSON-RPC API
response := struct {
Data []*model.Commitment `json:"data"`
Pagination struct {
TotalCount uint64 `json:"total_count"`
Limit uint64 `json:"limit"`
Offset uint64 `json:"offset"`
} `json:"pagination"`
}{
Data: commitments,
Pagination: struct {
TotalCount uint64 `json:"total_count"`
Limit uint64 `json:"limit"`
Offset uint64 `json:"offset"`
}{
TotalCount: total,
Limit: limit,
Offset: offset,
},
// Add tournament address filter if provided
if cmd.Flags().Changed("tournament-address") {
params.TournamentAddress = &tournamentAddress
}
params.Limit = limit
params.Offset = offset

result, err = json.MarshalIndent(response, "", " ")
cobra.CheckErr(err)
result, err = readServ.ListCommitments(ctx, params)
}
cobra.CheckErr(err)

formatted, err := json.MarshalIndent(result, "", " ")
cobra.CheckErr(err)

fmt.Println(string(result))
fmt.Println(string(formatted))
}
Loading
Loading