Skip to content
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.

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

feat(rollkit): add rollkit init #92

Merged
merged 7 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
5 changes: 3 additions & 2 deletions rollkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ This Ignite App is aimed to extend [Ignite CLI](https://github.com/ignite/cli) a
## Usage

```sh
ignite s chain gm --address-prefix gm
ignite s chain gm --address-prefix gm --minimal
cd gm
ignite app install -g github.com/ignite/apps/rollkit@rollkit/v0.1.0
ignite app install -g github.com/ignite/apps/rollkit@rollkit/v0.2.0
ignite rollkit add
ignite chain build
ignite rollkit init
```

Learn more about Rollkit and Ignite in their respective documentation:
Expand Down
7 changes: 4 additions & 3 deletions rollkit/cmd/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ import (
const (
statusScaffolding = "Scaffolding..."

flagPath = "path"
flagPath = "path"
flagLocalDa = "local-da"
)

func NewRollkitAdd() *cobra.Command {
Expand All @@ -40,7 +41,7 @@ func NewRollkitAdd() *cobra.Command {
return err
}

chain, err := chain.New(absPath)
chain, err := chain.New(absPath, chain.CollectEvents(session.EventBus()))
if err != nil {
return err
}
Expand All @@ -59,7 +60,7 @@ func NewRollkitAdd() *cobra.Command {
return err
}

session.Printf("\n🎉 RollKit added (`%[1]v`).\n\n", chain.AppPath())
session.Printf("🎉 RollKit added (`%[1]v`).\n", chain.AppPath(), chain.Name())
return nil
},
}
Expand Down
1 change: 1 addition & 0 deletions rollkit/cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ func NewRollkit() *cobra.Command {
// add sub commands.
c.AddCommand(
NewRollkitAdd(),
NewRollkitInit(),
)
return c
}
123 changes: 123 additions & 0 deletions rollkit/cmd/init.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
package cmd

import (
"os"
"path/filepath"

"github.com/cometbft/cometbft/crypto"
cmtjson "github.com/cometbft/cometbft/libs/json"
cmprivval "github.com/cometbft/cometbft/privval"
cmttypes "github.com/cometbft/cometbft/types"
genutiltypes "github.com/cosmos/cosmos-sdk/x/genutil/types"
"github.com/pkg/errors"
"github.com/spf13/cobra"

configchain "github.com/ignite/cli/v28/ignite/config/chain"
"github.com/ignite/cli/v28/ignite/pkg/cliui"
"github.com/ignite/cli/v28/ignite/pkg/cliui/colors"
"github.com/ignite/cli/v28/ignite/services/chain"
)

func NewRollkitInit() *cobra.Command {
c := &cobra.Command{
Use: "init",
Short: "Init rollkit support",
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
session := cliui.New()
defer session.End()

appPath, err := cmd.Flags().GetString(flagPath)
if err != nil {
return err
}
absPath, err := filepath.Abs(appPath)
if err != nil {
return err
}

rc, err := chain.New(absPath, chain.CollectEvents(session.EventBus()))
if err != nil {
return err
}

if localDa, err := cmd.Flags().GetBool(flagLocalDa); err == nil && localDa {
igniteConfig, err := rc.Config()
if err != nil {
return err
}

igniteConfig.Validators[0].Bonded = "1000000000stake"
for i, account := range igniteConfig.Accounts {
if account.Name == igniteConfig.Validators[0].Name {
igniteConfig.Accounts[i].Coins = []string{"10000000000000000000000000stake"}
}
}

if err := configchain.Save(*igniteConfig, rc.ConfigPath()); err != nil {
return err
}
}

if err := rc.Init(cmd.Context(), chain.InitArgsAll); err != nil {
return err
}

home, err := rc.Home()
if err != nil {
return err
}

// modify genesis (add sequencer)
genesisPath, err := rc.GenesisPath()
if err != nil {
return err
}

genesis, err := genutiltypes.AppGenesisFromFile(genesisPath)
if err != nil {
return err
}

pubKey, err := getPubKey(home)
if err != nil {
return err
}

genesis.Consensus.Validators = []cmttypes.GenesisValidator{
{
Name: "Rollkit Sequencer",
Address: pubKey.Address(),
PubKey: pubKey,
Power: 1000,
},
}

if err := genesis.SaveAs(genesisPath); err != nil {
return err
}

return session.Printf("🗃 Initialized. Checkout your rollkit chain's home (data) directory: %s\n", colors.Info(home))
},
}

c.Flags().StringP(flagPath, "p", ".", "path of the app")
c.Flags().BoolP(flagLocalDa, "l", false, "use local-da (creates the expected genesis account for local-da)")

return c
}

// getPubKey returns the validator public key.
func getPubKey(chainHome string) (crypto.PubKey, error) {
keyFilePath := filepath.Join(chainHome, "config", "priv_validator_key.json")
keyJSONBytes, err := os.ReadFile(keyFilePath)
if err != nil {
return nil, err
}
var pvKey cmprivval.FilePVKey
err = cmtjson.Unmarshal(keyJSONBytes, &pvKey)
if err != nil {
return nil, errors.Errorf("error reading PrivValidator key from %v: %s", keyFilePath, err)
}
return pvKey.PubKey, nil
}
6 changes: 3 additions & 3 deletions rollkit/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ module github.com/ignite/apps/rollkit
go 1.22.0

require (
github.com/cometbft/cometbft v0.38.6
github.com/cosmos/cosmos-sdk v0.50.6
github.com/gobuffalo/genny/v2 v2.1.0
github.com/gobuffalo/plush/v4 v4.1.19
github.com/hashicorp/go-plugin v1.6.0
github.com/ignite/cli/v28 v28.4.0
github.com/pkg/errors v0.9.1
github.com/spf13/cobra v1.8.0
github.com/stretchr/testify v1.9.0
)
Expand Down Expand Up @@ -49,13 +52,11 @@ require (
github.com/cockroachdb/pebble v1.1.0 // indirect
github.com/cockroachdb/redact v1.1.5 // indirect
github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06 // indirect
github.com/cometbft/cometbft v0.38.6 // indirect
github.com/cometbft/cometbft-db v0.9.1 // indirect
github.com/containerd/containerd v1.7.11 // indirect
github.com/cosmos/btcutil v1.0.5 // indirect
github.com/cosmos/cosmos-db v1.0.2 // indirect
github.com/cosmos/cosmos-proto v1.0.0-beta.5 // indirect
github.com/cosmos/cosmos-sdk v0.50.6 // indirect
github.com/cosmos/go-bip39 v1.0.0 // indirect
github.com/cosmos/gogogateway v1.2.0 // indirect
github.com/cosmos/gogoproto v1.4.12 // indirect
Expand Down Expand Up @@ -164,7 +165,6 @@ require (
github.com/pelletier/go-toml/v2 v2.1.0 // indirect
github.com/petermattis/goid v0.0.0-20231207134359-e60b3f734c67 // indirect
github.com/pjbgf/sha1cd v0.3.0 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
github.com/prometheus/client_golang v1.19.0 // indirect
github.com/prometheus/client_model v0.6.1 // indirect
Expand Down
2 changes: 2 additions & 0 deletions rollkit/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6r
github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
github.com/bgentry/speakeasy v0.1.1-0.20220910012023-760eaf8b6816 h1:41iFGWnSlI2gVpmOtVTJZNodLdLQLn/KsJqFvXwnd/s=
github.com/bgentry/speakeasy v0.1.1-0.20220910012023-760eaf8b6816/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
github.com/bits-and-blooms/bitset v1.8.0 h1:FD+XqgOZDUxxZ8hzoBFuV9+cGWY9CslN6d5MS5JVb4c=
github.com/bits-and-blooms/bitset v1.8.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
github.com/blang/semver/v4 v4.0.0 h1:1PFHFE6yCCTv8C1TeyNNarDzntLi7wMI5i/pzqYIsAM=
github.com/blang/semver/v4 v4.0.0/go.mod h1:IbckMUScFkM3pff0VJDNKRiT6TG/YpiHIM2yvyW5YoQ=
github.com/briandowns/spinner v1.23.0 h1:alDF2guRWqa/FOZZYWjlMIx2L6H0wyewPxo/CH4Pt2A=
Expand Down
26 changes: 22 additions & 4 deletions rollkit/integration/app_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func TestRollkit(t *testing.T) {
assertLocalPlugins(t, app, []pluginsconfig.Plugin{{Path: pluginPath}})
assertGlobalPlugins(t, nil)

env.Must(env.Exec("run rollkit app",
env.Must(env.Exec("run rollkit add",
step.NewSteps(step.New(
step.Exec(
envtest.IgniteApp,
Expand All @@ -62,9 +62,6 @@ func TestRollkit(t *testing.T) {
),
step.New(
step.Exec(bin, "start", "--help"),
step.PostExec(func(exitErr error) error {
return os.Remove(bin)
}),
step.Stdout(buf),
step.Workdir(app.SourcePath()),
)),
Expand All @@ -73,6 +70,27 @@ func TestRollkit(t *testing.T) {
if !strings.Contains(buf.String(), "--rollkit.da_") {
t.Errorf("rollkitd doesn't contain --rollkit flags: %s", buf.String())
}

buf.Reset()

env.Must(env.Exec("run rollkit init", step.NewSteps(
step.New(
step.Exec(
envtest.IgniteApp,
"rollkit",
"init",
),
step.PostExec(func(exitErr error) error {
return os.Remove(bin)
}),
step.Workdir(app.SourcePath()),
step.Stdout(buf),
),
)))

if !strings.Contains(buf.String(), "Initialized. Checkout your rollkit chain's home") {
t.Errorf("ignite rollkit init has failed: %s", buf.String())
}
}

func assertLocalPlugins(t *testing.T, app envtest.App, expectedPlugins []pluginsconfig.Plugin) {
Expand Down
Loading