Skip to content

Commit

Permalink
init bitcoin commiter module
Browse files Browse the repository at this point in the history
  • Loading branch information
zhouxing committed Nov 10, 2023
1 parent decd6e8 commit ff19a5e
Show file tree
Hide file tree
Showing 35 changed files with 2,215 additions and 1 deletion.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ require (
golang.org/x/text v0.9.0
google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f
google.golang.org/grpc v1.54.0
gopkg.in/yaml.v2 v2.4.0
sigs.k8s.io/yaml v1.3.0
)

Expand Down Expand Up @@ -191,7 +192,6 @@ require (
google.golang.org/protobuf v1.29.1 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
nhooyr.io/websocket v1.8.6 // indirect
)
Expand Down
12 changes: 12 additions & 0 deletions proto/ethermint/bitcoincommiter/v1/genesis.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
syntax = "proto3";
package ethermint.bitcoincommiter.v1;

import "gogoproto/gogo.proto";
import "ethermint/bitcoincommiter/v1/params.proto";

option go_package = "github.com/evmos/ethermint/x/bitcoincommiter/types";

// GenesisState defines the bitcoincommiter module's genesis state.
message GenesisState {
Params params = 1 [(gogoproto.nullable) = false];
}
12 changes: 12 additions & 0 deletions proto/ethermint/bitcoincommiter/v1/params.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
syntax = "proto3";
package ethermint.bitcoincommiter.v1;

import "gogoproto/gogo.proto";

option go_package = "github.com/evmos/ethermint/x/bitcoincommiter/types";

// Params defines the parameters for the module.
message Params {
option (gogoproto.goproto_stringer) = false;

}
26 changes: 26 additions & 0 deletions proto/ethermint/bitcoincommiter/v1/query.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
syntax = "proto3";
package ethermint.bitcoincommiter.v1;

import "gogoproto/gogo.proto";
import "google/api/annotations.proto";
import "cosmos/base/query/v1beta1/pagination.proto";

Check failure on line 6 in proto/ethermint/bitcoincommiter/v1/query.proto

View workflow job for this annotation

GitHub Actions / lint

Import "cosmos/base/query/v1beta1/pagination.proto" is unused.
import "ethermint/bitcoincommiter/v1/params.proto";

option go_package = "github.com/evmos/ethermint/x/bitcoincommiter/types";

// Query defines the gRPC querier service.
service Query {
// Parameters queries the parameters of the module.
rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
option (google.api.http).get = "/ethermint/bitcoincommiter/v1/params";
}
}

// QueryParamsRequest is request type for the Query/Params RPC method.
message QueryParamsRequest {}

// QueryParamsResponse is response type for the Query/Params RPC method.
message QueryParamsResponse {
// params holds all the parameters of this module.
Params params = 1 [(gogoproto.nullable) = false];
}
7 changes: 7 additions & 0 deletions proto/ethermint/bitcoincommiter/v1/tx.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
syntax = "proto3";
package ethermint.bitcoincommiter.v1;

option go_package = "github.com/evmos/ethermint/x/bitcoincommiter/types";

// Msg defines the Msg service.
service Msg {}
52 changes: 52 additions & 0 deletions testutil/keeper/bitcoincommiter.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package keeper

import (
"testing"

"github.com/cosmos/cosmos-sdk/codec"
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
"github.com/cosmos/cosmos-sdk/store"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
sdk "github.com/cosmos/cosmos-sdk/types"
typesparams "github.com/cosmos/cosmos-sdk/x/params/types"
"github.com/evmos/ethermint/x/bitcoincommiter/keeper"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
"github.com/stretchr/testify/require"
"github.com/tendermint/tendermint/libs/log"
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
tmdb "github.com/tendermint/tm-db"
)

func BitcoincommiterKeeper(t testing.TB) (*keeper.Keeper, sdk.Context) {
storeKey := sdk.NewKVStoreKey(types.StoreKey)
memStoreKey := storetypes.NewMemoryStoreKey(types.MemStoreKey)

db := tmdb.NewMemDB()
stateStore := store.NewCommitMultiStore(db)
stateStore.MountStoreWithDB(storeKey, storetypes.StoreTypeIAVL, db)
stateStore.MountStoreWithDB(memStoreKey, storetypes.StoreTypeMemory, nil)
require.NoError(t, stateStore.LoadLatestVersion())

registry := codectypes.NewInterfaceRegistry()
cdc := codec.NewProtoCodec(registry)

paramsSubspace := typesparams.NewSubspace(cdc,
types.Amino,
storeKey,
memStoreKey,
"BitcoincommiterParams",
)
k := keeper.NewKeeper(
cdc,
storeKey,
memStoreKey,
paramsSubspace,
)

ctx := sdk.NewContext(stateStore, tmproto.Header{}, false, log.NewNopLogger())

// Initialize params
k.SetParams(ctx, types.DefaultParams())

return k, ctx
}
31 changes: 31 additions & 0 deletions x/bitcoincommiter/client/cli/query.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package cli

import (
"fmt"
// "strings"

"github.com/spf13/cobra"

"github.com/cosmos/cosmos-sdk/client"
// "github.com/cosmos/cosmos-sdk/client/flags"
// sdk "github.com/cosmos/cosmos-sdk/types"

"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

// GetQueryCmd returns the cli query commands for this module
func GetQueryCmd(queryRoute string) *cobra.Command {

Check warning on line 17 in x/bitcoincommiter/client/cli/query.go

View workflow job for this annotation

GitHub Actions / Run golangci-lint

unused-parameter: parameter 'queryRoute' seems to be unused, consider removing or renaming it as _ (revive)
// Group bitcoincommiter queries under a subcommand
cmd := &cobra.Command{
Use: types.ModuleName,
Short: fmt.Sprintf("Querying commands for the %s module", types.ModuleName),
DisableFlagParsing: true,
SuggestionsMinimumDistance: 2,
RunE: client.ValidateCmd,
}

cmd.AddCommand(CmdQueryParams())
// this line is used by starport scaffolding # 1

return cmd
}
34 changes: 34 additions & 0 deletions x/bitcoincommiter/client/cli/query_params.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package cli

import (
"context"

"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/client/flags"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
"github.com/spf13/cobra"
)

func CmdQueryParams() *cobra.Command {
cmd := &cobra.Command{
Use: "params",
Short: "shows the parameters of the module",
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
clientCtx := client.GetClientContextFromCmd(cmd)

queryClient := types.NewQueryClient(clientCtx)

res, err := queryClient.Params(context.Background(), &types.QueryParamsRequest{})
if err != nil {
return err
}

return clientCtx.PrintProto(res)
},
}

flags.AddQueryFlagsToCmd(cmd)

return cmd
}
36 changes: 36 additions & 0 deletions x/bitcoincommiter/client/cli/tx.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package cli

import (
"fmt"
"time"

"github.com/spf13/cobra"

"github.com/cosmos/cosmos-sdk/client"
// "github.com/cosmos/cosmos-sdk/client/flags"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

var (
DefaultRelativePacketTimeoutTimestamp = uint64((time.Duration(10) * time.Minute).Nanoseconds())

Check failure

Code scanning / gosec

Potential integer overflow by integer type conversion Error

Potential integer overflow by integer type conversion
)

const (
flagPacketTimeoutTimestamp = "packet-timeout-timestamp"
listSeparator = ","
)

// GetTxCmd returns the transaction commands for this module
func GetTxCmd() *cobra.Command {
cmd := &cobra.Command{
Use: types.ModuleName,
Short: fmt.Sprintf("%s transactions subcommands", types.ModuleName),
DisableFlagParsing: true,
SuggestionsMinimumDistance: 2,
RunE: client.ValidateCmd,
}

// this line is used by starport scaffolding # 1

return cmd
}
23 changes: 23 additions & 0 deletions x/bitcoincommiter/genesis.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package bitcoincommiter

import (
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/evmos/ethermint/x/bitcoincommiter/keeper"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

// InitGenesis initializes the module's state from a provided genesis state.
func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState) {
// this line is used by starport scaffolding # genesis/module/init
k.SetParams(ctx, genState.Params)
}

// ExportGenesis returns the module's exported genesis
func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState {
genesis := types.DefaultGenesis()
genesis.Params = k.GetParams(ctx)

// this line is used by starport scaffolding # genesis/module/export

return genesis
}
29 changes: 29 additions & 0 deletions x/bitcoincommiter/genesis_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package bitcoincommiter_test

import (
"testing"

keepertest "github.com/evmos/ethermint/testutil/keeper"
//"github.com/evmos/ethermint/testutil/nullify"
"github.com/evmos/ethermint/x/bitcoincommiter"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
"github.com/stretchr/testify/require"
)

func TestGenesis(t *testing.T) {
genesisState := types.GenesisState{
Params: types.DefaultParams(),

// this line is used by starport scaffolding # genesis/test/state
}

k, ctx := keepertest.BitcoincommiterKeeper(t)
bitcoincommiter.InitGenesis(ctx, *k, genesisState)
got := bitcoincommiter.ExportGenesis(ctx, *k)
require.NotNil(t, got)

//nullify.Fill(&genesisState)
//nullify.Fill(got)

// this line is used by starport scaffolding # genesis/test/assert
}
47 changes: 47 additions & 0 deletions x/bitcoincommiter/keeper/keeper.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package keeper

import (
"fmt"

"github.com/cosmos/cosmos-sdk/codec"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
"github.com/tendermint/tendermint/libs/log"

"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

type (
Keeper struct {
cdc codec.BinaryCodec
storeKey storetypes.StoreKey
memKey storetypes.StoreKey
paramstore paramtypes.Subspace
}
)

func NewKeeper(
cdc codec.BinaryCodec,
storeKey,
memKey storetypes.StoreKey,
ps paramtypes.Subspace,


) *Keeper {
// set KeyTable if it has not already been set
if !ps.HasKeyTable() {
ps = ps.WithKeyTable(types.ParamKeyTable())
}

return &Keeper{
cdc: cdc,
storeKey: storeKey,
memKey: memKey,
paramstore: ps,
}
}

func (k Keeper) Logger(ctx sdk.Context) log.Logger {
return ctx.Logger().With("module", fmt.Sprintf("x/%s", types.ModuleName))
}
17 changes: 17 additions & 0 deletions x/bitcoincommiter/keeper/msg_server.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package keeper

import (
"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

type msgServer struct {
Keeper
}

// NewMsgServerImpl returns an implementation of the MsgServer interface
// for the provided Keeper.
func NewMsgServerImpl(keeper Keeper) types.MsgServer {
return &msgServer{Keeper: keeper}
}

var _ types.MsgServer = msgServer{}
16 changes: 16 additions & 0 deletions x/bitcoincommiter/keeper/msg_server_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package keeper_test

import (
"context"
"testing"

sdk "github.com/cosmos/cosmos-sdk/types"
keepertest "github.com/evmos/ethermint/testutil/keeper"
"github.com/evmos/ethermint/x/bitcoincommiter/keeper"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

func setupMsgServer(t testing.TB) (types.MsgServer, context.Context) {
k, ctx := keepertest.BitcoincommiterKeeper(t)
return keeper.NewMsgServerImpl(*k), sdk.WrapSDKContext(ctx)
}
16 changes: 16 additions & 0 deletions x/bitcoincommiter/keeper/params.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package keeper

import (
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/evmos/ethermint/x/bitcoincommiter/types"
)

// GetParams get all parameters as types.Params
func (k Keeper) GetParams(ctx sdk.Context) types.Params {

Check warning on line 9 in x/bitcoincommiter/keeper/params.go

View workflow job for this annotation

GitHub Actions / Run golangci-lint

unused-parameter: parameter 'ctx' seems to be unused, consider removing or renaming it as _ (revive)
return types.NewParams()
}

// SetParams set the params
func (k Keeper) SetParams(ctx sdk.Context, params types.Params) {
k.paramstore.SetParamSet(ctx, &params)
}
Loading

0 comments on commit ff19a5e

Please sign in to comment.