Rename to rollmint (#545)

- rename go module
- rename imports
- rename all comments
- rename variables/structs/etc with opti and optimint in their name
- fix links (badges/etc)
- update ADRs
- grep entire directory to ensure full rename

Reference: #535

Author: tzdybal

.github/workflows/docker-build-da-mockserv.yml

@@ -11,7 +11,7 @@ on:
 
 env:
   REGISTRY: ghcr.io
-  IMAGE_NAME: celestiaorg/optimint-mockserv
+  IMAGE_NAME: celestiaorg/rollmint-mockserv
 
 jobs:
   docker-build:

.github/workflows/docker-build-ethermint-debug.yml

@@ -12,7 +12,7 @@ on:
 env:
   REGISTRY: ghcr.io
   IMAGE_NAME: celestiaorg/ethermint-debug
-  TAG_PREFIX: optimint-
+  TAG_PREFIX: rollmint-
 
 jobs:
   docker-build:
@@ -40,10 +40,10 @@ jobs:
           ls
           mv ethermint ..
           cd ..
-          cp -R optimint ethermint
+          cp -R rollmint ethermint
           cd ethermint
           rm -rf .git
-          go mod edit -replace=github.com/celestiaorg/optimint=./optimint
+          go mod edit -replace=github.com/celestiaorg/rollmint=./rollmint
           go mod tidy -compat=1.17 -e
       - name: Docker meta
         id: meta

.github/workflows/docker-build-test-ethermint.yml

@@ -12,7 +12,7 @@ on:
 env:
   REGISTRY: ghcr.io
   IMAGE_NAME: celestiaorg/ethermint
-  TAG_PREFIX: optimint-
+  TAG_PREFIX: rollmint-
 
 jobs:
   docker-build:
@@ -37,16 +37,16 @@ jobs:
         with:
           repository: celestiaorg/ethermint
           path: ethermint
-          ref: optimint-v0.3.0-rebase
+          ref: rollmint-v0.3.0-rebase
       - name: Move Stuff and Tidy
         run: |
           ls
           mv ethermint ..
           cd ..
-          cp -R optimint ethermint
+          cp -R rollmint ethermint
           cd ethermint
           rm -rf .git
-          go mod edit -replace=github.com/celestiaorg/optimint=./optimint
+          go mod edit -replace=github.com/celestiaorg/rollmint=./rollmint
           go mod tidy -compat=1.17 -e
       - name: Docker meta
         id: meta
@@ -91,14 +91,14 @@ jobs:
       with:
         repository: celestiaorg/ethermint
         path: ethermint
-        ref: optimint-v0.3.0-rebase
+        ref: rollmint-v0.3.0-rebase
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
         go-version: 1.17
     - name: "Setup Cluster"
       run: |
-        export ETHERMINT_IMAGE_TAG=optimint-$(git rev-parse --short "$GITHUB_SHA")
+        export ETHERMINT_IMAGE_TAG=rollmint-$(git rev-parse --short "$GITHUB_SHA")
         echo $ETHERMINT_IMAGE_TAG
         cd ephemeral-cluster
         scripts/minimal-ethermint.sh

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Finding an issue
 
-GitHub issues are used to track the work associated with Optimint. That's where you can find things to work on.
+GitHub issues are used to track the work associated with rollmint. That's where you can find things to work on.
 
 Issue labels have been used to help designate the priority, status and beginner-friendliness of various issues. Here are some of the ones that are most relevant to finding a good issue to work on:
 
@@ -11,7 +11,7 @@ Issue labels have been used to help designate the priority, status and beginner-
 
 No explicit permission is needed to work on these issues but it would be good idea to tag the user who opened the issue and ask that the issue is assinged to yourself.
 
-All issue labels can be [found here](https://github.com/celestiaorg/optimint/labels) for you to explore and see what peaks your interest.
+All issue labels can be [found here](https://github.com/celestiaorg/rollmint/labels) for you to explore and see what peaks your interest.
 
 ## Contribution process
 

NOTICE

@@ -0,0 +1,2 @@
+rollmint
+Copyright 2021-2022 Celestia Labs

README.md

@@ -1,14 +1,14 @@
-# optimint
+# rollmint
 
 ABCI-client implementation for Optimistic Rollups.
 
 Design document: <https://docs.google.com/document/d/12gZow_JTJjRrmaD2mNTmYniLhyxVLSyDd7Fbxo5UnA8/edit?usp=sharing>
 
-[![build-and-test](https://github.com/celestiaorg/optimint/actions/workflows/test.yml/badge.svg)](https://github.com/celestiaorg/optimint/actions/workflows/test.yml)
-[![golangci-lint](https://github.com/celestiaorg/optimint/actions/workflows/lint.yml/badge.svg)](https://github.com/celestiaorg/optimint/actions/workflows/lint.yml)
-[![Go Report Card](https://goreportcard.com/badge/github.com/celestiaorg/optimint)](https://goreportcard.com/report/github.com/celestiaorg/optimint)
-[![codecov](https://codecov.io/gh/celestiaorg/optimint/branch/main/graph/badge.svg?token=CWGA4RLDS9)](https://codecov.io/gh/celestiaorg/optimint)
-[![GoDoc](https://godoc.org/github.com/celestiaorg/optimint?status.svg)](https://godoc.org/github.com/celestiaorg/optimint)
+[![build-and-test](https://github.com/celestiaorg/rollmint/actions/workflows/test.yml/badge.svg)](https://github.com/celestiaorg/rollmint/actions/workflows/test.yml)
+[![golangci-lint](https://github.com/celestiaorg/rollmint/actions/workflows/lint.yml/badge.svg)](https://github.com/celestiaorg/rollmint/actions/workflows/lint.yml)
+[![Go Report Card](https://goreportcard.com/badge/github.com/celestiaorg/rollmint)](https://goreportcard.com/report/github.com/celestiaorg/rollmint)
+[![codecov](https://codecov.io/gh/celestiaorg/rollmint/branch/main/graph/badge.svg?token=CWGA4RLDS9)](https://codecov.io/gh/celestiaorg/rollmint)
+[![GoDoc](https://godoc.org/github.com/celestiaorg/rollmint?status.svg)](https://godoc.org/github.com/celestiaorg/rollmint)
 [![Twitter Follow](https://img.shields.io/twitter/follow/CelestiaOrg?style=social)](https://twitter.com/CelestiaOrg)
 
 ## Building From Source
@@ -18,8 +18,8 @@ Requires Go version >= 1.17.
 To build:
 
 ```sh
-git clone https://github.com/celestiaorg/optimint.git
-cd optimint
+git clone https://github.com/celestiaorg/rollmint.git
+cd rollmint
 go build -v ./...
 ```
 
@@ -40,7 +40,7 @@ To regenerate protobuf types:
 We welcome your contributions! Everyone is welcome to contribute, whether it's in the form of code,
 documentation, bug reports, feature requests, or anything else.
 
-If you're looking for issues to work on, try looking at the [good first issue list](https://github.com/celestiaorg/optimint/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!
+If you're looking for issues to work on, try looking at the [good first issue list](https://github.com/celestiaorg/rollmint/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!
 
 See [the contributing guide](./CONTRIBUTING.md) for more details.
 

block/manager.go

@@ -15,19 +15,19 @@ import (
 	tmtypes "github.com/tendermint/tendermint/types"
 	"go.uber.org/multierr"
 
-	"github.com/celestiaorg/optimint/config"
-	"github.com/celestiaorg/optimint/da"
-	"github.com/celestiaorg/optimint/log"
-	"github.com/celestiaorg/optimint/mempool"
-	"github.com/celestiaorg/optimint/state"
-	"github.com/celestiaorg/optimint/store"
-	"github.com/celestiaorg/optimint/types"
+	"github.com/celestiaorg/rollmint/config"
+	"github.com/celestiaorg/rollmint/da"
+	"github.com/celestiaorg/rollmint/log"
+	"github.com/celestiaorg/rollmint/mempool"
+	"github.com/celestiaorg/rollmint/state"
+	"github.com/celestiaorg/rollmint/store"
+	"github.com/celestiaorg/rollmint/types"
 )
 
 // defaultDABlockTime is used only if DABlockTime is not configured for manager
 const defaultDABlockTime = 30 * time.Second
 
-// maxSubmitAttempts defines how many times Optimint will re-try to publish block to DA layer.
+// maxSubmitAttempts defines how many times rollmint will re-try to publish block to DA layer.
 // This is temporary solution. It will be removed in future versions.
 const maxSubmitAttempts = 30
 
@@ -497,7 +497,7 @@ func (m *Manager) submitBlockToDA(ctx context.Context, block *types.Block) error
 	for attempt := 1; ctx.Err() == nil && !submitted && attempt <= maxSubmitAttempts; attempt++ {
 		res := m.dalc.SubmitBlock(block)
 		if res.Code == da.StatusSuccess {
-			m.logger.Info("successfully submitted optimint block to DA layer", "optimintHeight", block.Header.Height, "daHeight", res.DAHeight)
+			m.logger.Info("successfully submitted rollmint block to DA layer", "rollmintHeight", block.Header.Height, "daHeight", res.DAHeight)
 			submitted = true
 		} else {
 			m.logger.Error("DA layer submission failed", "error", res.Message, "attempt", attempt)

block/manager_test.go

@@ -12,11 +12,11 @@ import (
 	"github.com/tendermint/tendermint/libs/log"
 	tmtypes "github.com/tendermint/tendermint/types"
 
-	"github.com/celestiaorg/optimint/config"
-	"github.com/celestiaorg/optimint/da"
-	mockda "github.com/celestiaorg/optimint/da/mock"
-	"github.com/celestiaorg/optimint/store"
-	"github.com/celestiaorg/optimint/types"
+	"github.com/celestiaorg/rollmint/config"
+	"github.com/celestiaorg/rollmint/da"
+	mockda "github.com/celestiaorg/rollmint/da/mock"
+	"github.com/celestiaorg/rollmint/store"
+	"github.com/celestiaorg/rollmint/types"
 )
 
 func TestInitialState(t *testing.T) {

config/config.go

@@ -9,23 +9,23 @@ import (
 )
 
 const (
-	flagAggregator    = "optimint.aggregator"
-	flagDALayer       = "optimint.da_layer"
-	flagDAConfig      = "optimint.da_config"
-	flagBlockTime     = "optimint.block_time"
-	flagDABlockTime   = "optimint.da_block_time"
-	flagDAStartHeight = "optimint.da_start_height"
-	flagNamespaceID   = "optimint.namespace_id"
+	flagAggregator    = "rollmint.aggregator"
+	flagDALayer       = "rollmint.da_layer"
+	flagDAConfig      = "rollmint.da_config"
+	flagBlockTime     = "rollmint.block_time"
+	flagDABlockTime   = "rollmint.da_block_time"
+	flagDAStartHeight = "rollmint.da_start_height"
+	flagNamespaceID   = "rollmint.namespace_id"
 )
 
-// NodeConfig stores Optimint node configuration.
+// NodeConfig stores rollmint node configuration.
 type NodeConfig struct {
 	// parameters below are translated from existing config
 	RootDir string
 	DBPath  string
 	P2P     P2PConfig
 	RPC     RPCConfig
-	// parameters below are optimint specific and read from config
+	// parameters below are rollmint specific and read from config
 	Aggregator         bool `mapstructure:"aggregator"`
 	BlockManagerConfig `mapstructure:",squash"`
 	DALayer            string `mapstructure:"da_layer"`
@@ -62,7 +62,7 @@ func (nc *NodeConfig) GetViperConfig(v *viper.Viper) error {
 	return nil
 }
 
-// AddFlags adds Optimint specific configuration options to cobra Command.
+// AddFlags adds rollmint specific configuration options to cobra Command.
 //
 // This function is called in cosmos-sdk.
 func AddFlags(cmd *cobra.Command) {

conv/abci/block.go

@@ -7,11 +7,11 @@ import (
 	tmversion "github.com/tendermint/tendermint/proto/tendermint/version"
 	tmtypes "github.com/tendermint/tendermint/types"
 
-	"github.com/celestiaorg/optimint/types"
+	"github.com/celestiaorg/rollmint/types"
 )
 
-// ToABCIHeaderPB converts Optimint header to Header format defined in ABCI.
-// Caller should fill all the fields that are not available in Optimint header (like ChainID).
+// ToABCIHeaderPB converts rollmint header to Header format defined in ABCI.
+// Caller should fill all the fields that are not available in rollmint header (like ChainID).
 func ToABCIHeaderPB(header *types.Header) (tmproto.Header, error) {
 	return tmproto.Header{
 		Version: tmversion.Consensus{
@@ -39,8 +39,8 @@ func ToABCIHeaderPB(header *types.Header) (tmproto.Header, error) {
 	}, nil
 }
 
-// ToABCIHeader converts Optimint header to Header format defined in ABCI.
-// Caller should fill all the fields that are not available in Optimint header (like ChainID).
+// ToABCIHeader converts rollmint header to Header format defined in ABCI.
+// Caller should fill all the fields that are not available in rollmint header (like ChainID).
 func ToABCIHeader(header *types.Header) (tmtypes.Header, error) {
 	return tmtypes.Header{
 		Version: tmversion.Consensus{
@@ -68,7 +68,7 @@ func ToABCIHeader(header *types.Header) (tmtypes.Header, error) {
 	}, nil
 }
 
-// ToABCIBlock converts Optimint block into block format defined by ABCI.
+// ToABCIBlock converts rollmint block into block format defined by ABCI.
 // Returned block should pass `ValidateBasic`.
 func ToABCIBlock(block *types.Block) (*tmtypes.Block, error) {
 	abciHeader, err := ToABCIHeader(&block.Header)
@@ -96,7 +96,7 @@ func ToABCIBlock(block *types.Block) (*tmtypes.Block, error) {
 	return &abciBlock, nil
 }
 
-// ToABCIBlockMeta converts Optimint block into BlockMeta format defined by ABCI
+// ToABCIBlockMeta converts rollmint block into BlockMeta format defined by ABCI
 func ToABCIBlockMeta(block *types.Block) (*tmtypes.BlockMeta, error) {
 	tmblock, err := ToABCIBlock(block)
 	if err != nil {
@@ -112,8 +112,8 @@ func ToABCIBlockMeta(block *types.Block) (*tmtypes.BlockMeta, error) {
 	}, nil
 }
 
-// ToABCICommit converts Optimint commit into commit format defined by ABCI.
-// This function only converts fields that are available in Optimint commit.
+// ToABCICommit converts rollmint commit into commit format defined by ABCI.
+// This function only converts fields that are available in rollmint commit.
 // Other fields (especially ValidatorAddress and Timestamp of Signature) has to be filled by caller.
 func ToABCICommit(commit *types.Commit) *tmtypes.Commit {
 	tmCommit := tmtypes.Commit{