Merge pull request #229 from CosmWasm/add-gaiaflex

Add gaiaflex to Makefile and Dockerfile

Author: ethanfrey

Dockerfile

@@ -3,8 +3,6 @@
 FROM cosmwasm/go-ext-builder:0.8.2-alpine AS rust-builder
 
 RUN apk add git
-# without this, build with LEDGER_ENABLED=false
-RUN apk add libusb-dev linux-headers
 
 # copy all code into /code
 WORKDIR /code
@@ -34,19 +32,21 @@ COPY --from=rust-builder /lib/libgo_cosmwasm_muslc.a /lib/libgo_cosmwasm_muslc.a
 
 # force it to use static lib (from above) not standard libgo_cosmwasm.so file
 RUN LEDGER_ENABLED=false BUILD_TAGS=muslc make build
-# we also (temporarily) build the testnet binaries here
+# we also (temporarily?) build the testnet binaries here
 RUN LEDGER_ENABLED=false BUILD_TAGS=muslc make build-coral
+RUN LEDGER_ENABLED=false BUILD_TAGS=muslc make build-gaiaflex
 
 # --------------------------------------------------------
 FROM alpine:3.12
 
 COPY --from=go-builder /code/build/wasmd /usr/bin/wasmd
-COPY --from=go-builder /code/build/wasmgovd /usr/bin/wasmgovd
 COPY --from=go-builder /code/build/wasmcli /usr/bin/wasmcli
 
 # testnet
 COPY --from=go-builder /code/build/coral /usr/bin/coral
 COPY --from=go-builder /code/build/corald /usr/bin/corald
+COPY --from=go-builder /code/build/gaiaflex /usr/bin/gaiaflex
+COPY --from=go-builder /code/build/gaiaflexd /usr/bin/gaiaflexd
 
 COPY docker/* /opt/
 RUN chmod +x /opt/*.sh

Makefile

@@ -69,34 +69,59 @@ coral_ldflags = -X github.com/cosmos/cosmos-sdk/version.Name=coral \
 				  -X github.com/CosmWasm/wasmd/app.NodeDir=.corald \
 				  -X github.com/CosmWasm/wasmd/app.Bech32Prefix=coral \
 				  -X "github.com/cosmos/cosmos-sdk/version.BuildTags=$(build_tags_comma_sep)"
+# we could consider enabling governance override?
+#				  -X github.com/CosmWasm/wasmd/app.EnableSpecificProposals=MigrateContract,UpdateAdmin,ClearAdmin \
 
 coral_ldflags += $(LDFLAGS)
 coral_ldflags := $(strip $(coral_ldflags))
 
+flex_ldflags = -X github.com/cosmos/cosmos-sdk/version.Name=gaiaflex \
+				  -X github.com/cosmos/cosmos-sdk/version.ServerName=gaiaflexd \
+				  -X github.com/cosmos/cosmos-sdk/version.ClientName=gaiaflex \
+				  -X github.com/cosmos/cosmos-sdk/version.Version=$(VERSION) \
+				  -X github.com/cosmos/cosmos-sdk/version.Commit=$(COMMIT) \
+				  -X github.com/CosmWasm/wasmd/app.ProposalsEnabled=true \
+				  -X github.com/CosmWasm/wasmd/app.CLIDir=.gaiaflex \
+				  -X github.com/CosmWasm/wasmd/app.NodeDir=.gaiaflexd \
+				  -X github.com/CosmWasm/wasmd/app.Bech32Prefix=cosmos \
+				  -X "github.com/cosmos/cosmos-sdk/version.BuildTags=$(build_tags_comma_sep)"
+
+flex_ldflags += $(LDFLAGS)
+flex_ldflags := $(strip $(flex_ldflags))
+
 BUILD_FLAGS := -tags $(build_tags_comma_sep) -ldflags '$(ldflags)' -trimpath
 CORAL_BUILD_FLAGS := -tags $(build_tags_comma_sep) -ldflags '$(coral_ldflags)' -trimpath
+FLEX_BUILD_FLAGS := -tags $(build_tags_comma_sep) -ldflags '$(flex_ldflags)' -trimpath
 
 all: install lint test
 
 build: go.sum
 ifeq ($(OS),Windows_NT)
-    # wasmd nodes not supported on windows, maybe the cli?
+	# wasmd nodes not supported on windows, maybe the cli?
 	go build -mod=readonly $(BUILD_FLAGS) -o build/wasmcli.exe ./cmd/wasmcli
 else
 	go build -mod=readonly $(BUILD_FLAGS) -o build/wasmd ./cmd/wasmd
-	go build -mod=readonly $(BUILD_FLAGS) -o build/wasmgovd ./cmd/wasmgovd
 	go build -mod=readonly $(BUILD_FLAGS) -o build/wasmcli ./cmd/wasmcli
 endif
 
 build-coral: go.sum
 ifeq ($(OS),Windows_NT)
-    # wasmd nodes not supported on windows, maybe the cli?
+	# wasmd nodes not supported on windows, maybe the cli?
 	go build -mod=readonly $(CORAL_BUILD_FLAGS) -o build/coral.exe ./cmd/wasmcli
 else
 	go build -mod=readonly $(CORAL_BUILD_FLAGS) -o build/corald ./cmd/wasmd
 	go build -mod=readonly $(CORAL_BUILD_FLAGS) -o build/coral ./cmd/wasmcli
 endif
 
+build-gaiaflex: go.sum
+ifeq ($(OS),Windows_NT)
+	# wasmd nodes not supported on windows, maybe the cli?
+	go build -mod=readonly $(FLEX_BUILD_FLAGS) -o build/gaiaflex.exe ./cmd/wasmcli
+else
+	go build -mod=readonly $(FLEX_BUILD_FLAGS) -o build/gaiaflexd ./cmd/wasmd
+	go build -mod=readonly $(FLEX_BUILD_FLAGS) -o build/gaiaflex ./cmd/wasmcli
+endif
+
 build-linux: go.sum
 	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build
 

README.md

@@ -129,6 +129,37 @@ docker run --rm -it \
     cosmwasm/wasmd:latest ./logs.sh
 ```
 
+## Runtime flags
+
+We provide a number of variables in `app/app.go` that are intended to be set via `-ldflags -X ...`
+compile-time flags. This enables us to avoid copying a new binary directory over for each small change
+to the configuration.
+
+Available flags:
+
+* `-X github.com/CosmWasm/wasmd/app.CLIDir=.coral` - set the config directory for the cli (default `~/.wasmcli`) 
+* `-X github.com/CosmWasm/wasmd/app.NodeDir=.corald` - set the config/data directory for the node (default `~/.wasmd`)
+* `-X github.com/CosmWasm/wasmd/app.Bech32Prefix=coral` - set the bech32 prefix for all accounts (default `cosmos`)
+* `-X github.com/CosmWasm/wasmd/app.ProposalsEnabled=true` - enable all x/wasm governance proposals (default `false`)
+* `-X github.com/CosmWasm/wasmd/app.EnableSpecificProposals=MigrateContract,UpdateAdmin,ClearAdmin` - 
+    enable a subset of the x/wasm governance proposal types (overrides `ProposalsEnabled`)
+
+Examples:
+
+* [`wasmd`](./Makefile#L50-L55) is a generic, permissionless version using the `cosmos` bech32 prefix
+* [`gaiaflex`](./Makefile#L78-L87) is a generic, *permissioned* version using the `cosmos` bech32 prefix
+* [`coral`](./Makefile#L63-L71) is a permissionless version designed for a specific testnet, with a `coral` bech32 prefix
+
+## Genesis Configuration
+
+@alpe we should document all the genesis config for x/wasm even more.
+
+Tip: if you want to lock this down to a permisisoned network, the following script can edit the genesis file
+to only allow permissioned use of code upload or instantiating. (Make sure you set `app.ProposalsEnabled=true`
+in this binary):
+
+`sed -i 's/permission": "Everybody"/permission": "Nobody"/'  .../config/genesis.json`
+
 ## Contributors
 
 Much thanks to all who have contributed to this project, from this app, to the `cosmwasm` framework, to example contracts and documentation.

app/app.go

@@ -4,6 +4,7 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/CosmWasm/wasmd/x/wasm"
 	wasmclient "github.com/CosmWasm/wasmd/x/wasm/client"
@@ -44,8 +45,33 @@ var (
 	CLIDir       = ".wasmcli"
 	NodeDir      = ".wasmd"
 	Bech32Prefix = sdk.Bech32MainPrefix
+
+	// If EnabledSpecificProposals is "", and this is "true", then enable all x/wasm proposals.
+	// If EnabledSpecificProposals is "", and this is not "true", then disable all x/wasm proposals.
+	ProposalsEnabled = "false"
+	// If set to non-empty string it must be comma-separated list of values that are all a subset
+	// of "EnableAllProposals" (takes precedence over ProposalsEnabled)
+	// https://github.com/CosmWasm/wasmd/blob/02a54d33ff2c064f3539ae12d75d027d9c665f05/x/wasm/internal/types/proposal.go#L28-L34
+	EnableSpecificProposals = ""
 )
 
+// GetEnabledProposals parses the ProposalsEnabled / EnableSpecificProposals values to
+// produce a list of enabled proposals to pass into wasmd app.
+func GetEnabledProposals() []wasm.ProposalType {
+	if EnableSpecificProposals == "" {
+		if ProposalsEnabled == "true" {
+			return wasm.EnableAllProposals
+		}
+		return wasm.DisableAllProposals
+	}
+	chunks := strings.Split(EnableSpecificProposals, ",")
+	proposals, err := wasm.ConvertToProposals(chunks)
+	if err != nil {
+		panic(err)
+	}
+	return proposals
+}
+
 // These constants are derived from the above variables.
 // These are the ones we will want to use in the code, based on
 // any overrides above

app/app_test.go

@@ -1,18 +1,19 @@
 package app
 
 import (
+	"github.com/magiconair/properties/assert"
 	"os"
 	"testing"
 
-	"github.com/CosmWasm/wasmd/x/wasm"
 	"github.com/stretchr/testify/require"
 	"github.com/tendermint/tendermint/libs/log"
-	db "github.com/tendermint/tm-db"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/simapp"
-
 	abci "github.com/tendermint/tendermint/abci/types"
+	db "github.com/tendermint/tm-db"
+
+	"github.com/CosmWasm/wasmd/x/wasm"
 )
 
 func TestWasmdExport(t *testing.T) {
@@ -37,6 +38,37 @@ func TestBlackListedAddrs(t *testing.T) {
 	}
 }
 
+func TestGetEnabledProposals(t *testing.T) {
+	cases := map[string]struct {
+		proposalsEnabled string
+		specificEnabled  string
+		expected         []wasm.ProposalType
+	}{
+		"all disabled": {
+			proposalsEnabled: "false",
+			expected:         wasm.DisableAllProposals,
+		},
+		"all enabled": {
+			proposalsEnabled: "true",
+			expected:         wasm.EnableAllProposals,
+		},
+		"some enabled": {
+			proposalsEnabled: "okay",
+			specificEnabled:  "StoreCode,InstantiateContract",
+			expected:         []wasm.ProposalType{wasm.ProposalTypeStoreCode, wasm.ProposalTypeInstantiateContract},
+		},
+	}
+
+	for name, tc := range cases {
+		t.Run(name, func(t *testing.T) {
+			ProposalsEnabled = tc.proposalsEnabled
+			EnableSpecificProposals = tc.specificEnabled
+			proposals := GetEnabledProposals()
+			assert.Equal(t, tc.expected, proposals)
+		})
+	}
+}
+
 func setGenesis(gapp *WasmApp) error {
 	genesisState := simapp.NewDefaultGenesisState()
 	genesisState[wasm.ModuleName] = wasm.AppModuleBasic{}.DefaultGenesis()

cmd/wasmd/main.go

@@ -6,7 +6,6 @@ import (
 	"io"
 
 	"github.com/CosmWasm/wasmd/app"
-	"github.com/CosmWasm/wasmd/x/wasm"
 	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/client/debug"
 	"github.com/cosmos/cosmos-sdk/client/flags"
@@ -90,7 +89,8 @@ func newApp(logger log.Logger, db dbm.DB, traceStore io.Writer) abci.Application
 	}
 
 	return app.NewWasmApp(logger, db, traceStore, true, invCheckPeriod,
-		wasm.DisableAllProposals, skipUpgradeHeights,
+		app.GetEnabledProposals(),
+		skipUpgradeHeights,
 		baseapp.SetPruning(pruningOpts),
 		baseapp.SetMinGasPrices(viper.GetString(server.FlagMinGasPrices)),
 		baseapp.SetHaltHeight(viper.GetUint64(server.FlagHaltHeight)),
@@ -103,14 +103,14 @@ func exportAppStateAndTMValidators(
 ) (json.RawMessage, []tmtypes.GenesisValidator, error) {
 
 	if height != -1 {
-		gapp := app.NewWasmApp(logger, db, traceStore, false, uint(1), wasm.DisableAllProposals, nil)
+		gapp := app.NewWasmApp(logger, db, traceStore, false, uint(1), app.GetEnabledProposals(), nil)
 		err := gapp.LoadHeight(height)
 		if err != nil {
 			return nil, nil, err
 		}
 		return gapp.ExportAppStateAndValidators(forZeroHeight, jailWhiteList)
 	}
 
-	gapp := app.NewWasmApp(logger, db, traceStore, true, uint(1), wasm.DisableAllProposals, nil)
+	gapp := app.NewWasmApp(logger, db, traceStore, true, uint(1), app.GetEnabledProposals(), nil)
 	return gapp.ExportAppStateAndValidators(forZeroHeight, jailWhiteList)
 }

cmd/wasmd/replay.go

@@ -8,7 +8,6 @@ import (
 	"time"
 
 	"github.com/CosmWasm/wasmd/app"
-	"github.com/CosmWasm/wasmd/x/wasm"
 	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/cosmos/cosmos-sdk/server"
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
@@ -92,7 +91,7 @@ func replayTxs(rootDir string) error {
 	fmt.Fprintln(os.Stderr, "Creating application")
 	gapp := app.NewWasmApp(
 		// TODO: do we want to set skipUpgradeHieghts here?
-		ctx.Logger, appDB, traceStoreWriter, true, uint(1), wasm.DisableAllProposals, nil,
+		ctx.Logger, appDB, traceStoreWriter, true, uint(1), app.GetEnabledProposals(), nil,
 		baseapp.SetPruning(storetypes.PruneEverything))
 
 	// Genesis

cmd/wasmgovd/genaccounts.go

@@ -8,6 +8,7 @@ require (
 	github.com/golang/mock v1.4.3 // indirect
 	github.com/google/gofuzz v1.0.0
 	github.com/gorilla/mux v1.7.4
+	github.com/magiconair/properties v1.8.1
 	github.com/onsi/ginkgo v1.8.0 // indirect
 	github.com/onsi/gomega v1.5.0 // indirect
 	github.com/otiai10/copy v1.0.2

cmd/wasmgovd/main.go

@@ -11,34 +11,40 @@ import (
 )
 
 const (
-	DefaultParamspace             = types.DefaultParamspace
-	ModuleName                    = types.ModuleName
-	StoreKey                      = types.StoreKey
-	TStoreKey                     = types.TStoreKey
-	QuerierRoute                  = types.QuerierRoute
-	RouterKey                     = types.RouterKey
-	MaxWasmSize                   = types.MaxWasmSize
-	MaxLabelSize                  = types.MaxLabelSize
-	BuildTagRegexp                = types.BuildTagRegexp
-	MaxBuildTagSize               = types.MaxBuildTagSize
-	CustomEventType               = types.CustomEventType
-	AttributeKeyContractAddr      = types.AttributeKeyContractAddr
-	GasMultiplier                 = keeper.GasMultiplier
-	MaxGas                        = keeper.MaxGas
-	QueryListContractByCode       = keeper.QueryListContractByCode
-	QueryGetContract              = keeper.QueryGetContract
-	QueryGetContractState         = keeper.QueryGetContractState
-	QueryGetCode                  = keeper.QueryGetCode
-	QueryListCode                 = keeper.QueryListCode
-	QueryMethodContractStateSmart = keeper.QueryMethodContractStateSmart
-	QueryMethodContractStateAll   = keeper.QueryMethodContractStateAll
-	QueryMethodContractStateRaw   = keeper.QueryMethodContractStateRaw
+	DefaultParamspace               = types.DefaultParamspace
+	ModuleName                      = types.ModuleName
+	StoreKey                        = types.StoreKey
+	TStoreKey                       = types.TStoreKey
+	QuerierRoute                    = types.QuerierRoute
+	RouterKey                       = types.RouterKey
+	MaxWasmSize                     = types.MaxWasmSize
+	MaxLabelSize                    = types.MaxLabelSize
+	BuildTagRegexp                  = types.BuildTagRegexp
+	MaxBuildTagSize                 = types.MaxBuildTagSize
+	CustomEventType                 = types.CustomEventType
+	AttributeKeyContractAddr        = types.AttributeKeyContractAddr
+	ProposalTypeStoreCode           = types.ProposalTypeStoreCode
+	ProposalTypeInstantiateContract = types.ProposalTypeInstantiateContract
+	ProposalTypeMigrateContract     = types.ProposalTypeMigrateContract
+	ProposalTypeUpdateAdmin         = types.ProposalTypeUpdateAdmin
+	ProposalTypeClearAdmin          = types.ProposalTypeClearAdmin
+	GasMultiplier                   = keeper.GasMultiplier
+	MaxGas                          = keeper.MaxGas
+	QueryListContractByCode         = keeper.QueryListContractByCode
+	QueryGetContract                = keeper.QueryGetContract
+	QueryGetContractState           = keeper.QueryGetContractState
+	QueryGetCode                    = keeper.QueryGetCode
+	QueryListCode                   = keeper.QueryListCode
+	QueryMethodContractStateSmart   = keeper.QueryMethodContractStateSmart
+	QueryMethodContractStateAll     = keeper.QueryMethodContractStateAll
+	QueryMethodContractStateRaw     = keeper.QueryMethodContractStateRaw
 )
 
 var (
 	// functions aliases
 	RegisterCodec             = types.RegisterCodec
 	ValidateGenesis           = types.ValidateGenesis
+	ConvertToProposals        = types.ConvertToProposals
 	GetCodeKey                = types.GetCodeKey
 	GetContractAddressKey     = types.GetContractAddressKey
 	GetContractStorePrefixKey = types.GetContractStorePrefixKey

cmd/wasmgovd/replay.go

@@ -14,11 +14,11 @@ import (
 type ProposalType string
 
 const (
-	ProposalTypeStoreCode                ProposalType = "StoreCode"
-	ProposalTypeStoreInstantiateContract ProposalType = "InstantiateContract"
-	ProposalTypeMigrateContract          ProposalType = "MigrateContract"
-	ProposalTypeUpdateAdmin              ProposalType = "UpdateAdmin"
-	ProposalTypeClearAdmin               ProposalType = "ClearAdmin"
+	ProposalTypeStoreCode           ProposalType = "StoreCode"
+	ProposalTypeInstantiateContract ProposalType = "InstantiateContract"
+	ProposalTypeMigrateContract     ProposalType = "MigrateContract"
+	ProposalTypeUpdateAdmin         ProposalType = "UpdateAdmin"
+	ProposalTypeClearAdmin          ProposalType = "ClearAdmin"
 )
 
 // DisableAllProposals contains no wasm gov types.
@@ -27,15 +27,33 @@ var DisableAllProposals []ProposalType
 // EnableAllProposals contains all wasm gov types as keys.
 var EnableAllProposals = []ProposalType{
 	ProposalTypeStoreCode,
-	ProposalTypeStoreInstantiateContract,
+	ProposalTypeInstantiateContract,
 	ProposalTypeMigrateContract,
 	ProposalTypeUpdateAdmin,
 	ProposalTypeClearAdmin,
 }
 
+// ConvertToProposals maps each key to a ProposalType and returns a typed list.
+// If any string is not a valid type (in this file), then return an error
+func ConvertToProposals(keys []string) ([]ProposalType, error) {
+	valid := make(map[string]bool, len(EnableAllProposals))
+	for _, key := range EnableAllProposals {
+		valid[string(key)] = true
+	}
+
+	proposals := make([]ProposalType, len(keys))
+	for i, key := range keys {
+		if _, ok := valid[key]; !ok {
+			return nil, sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "'%s' is not a valid ProposalType", key)
+		}
+		proposals[i] = ProposalType(key)
+	}
+	return proposals, nil
+}
+
 func init() { // register new content types with the sdk
 	govtypes.RegisterProposalType(string(ProposalTypeStoreCode))
-	govtypes.RegisterProposalType(string(ProposalTypeStoreInstantiateContract))
+	govtypes.RegisterProposalType(string(ProposalTypeInstantiateContract))
 	govtypes.RegisterProposalType(string(ProposalTypeMigrateContract))
 	govtypes.RegisterProposalType(string(ProposalTypeUpdateAdmin))
 	govtypes.RegisterProposalType(string(ProposalTypeClearAdmin))
@@ -175,7 +193,7 @@ type InstantiateContractProposal struct {
 
 // ProposalType returns the type
 func (p InstantiateContractProposal) ProposalType() string {
-	return string(ProposalTypeStoreInstantiateContract)
+	return string(ProposalTypeInstantiateContract)
 }
 
 // ValidateBasic validates the proposal

cmd/wasmgovd/testnet.go

@@ -616,3 +616,41 @@ contract: cosmos18vd8fpwxzck93qlwghaj6arh4p7c5n89uzcee5
 		})
 	}
 }
+
+func TestConvertToProposals(t *testing.T) {
+	cases := map[string]struct {
+		input     string
+		isError   bool
+		proposals []ProposalType
+	}{
+		"one proper item": {
+			input:     "UpdateAdmin",
+			proposals: []ProposalType{ProposalTypeUpdateAdmin},
+		},
+		"multiple proper items": {
+			input:     "StoreCode,InstantiateContract,MigrateContract",
+			proposals: []ProposalType{ProposalTypeStoreCode, ProposalTypeInstantiateContract, ProposalTypeMigrateContract},
+		},
+		"empty trailing item": {
+			input:   "StoreCode,",
+			isError: true,
+		},
+		"invalid item": {
+			input:   "StoreCode,InvalidProposalType",
+			isError: true,
+		},
+	}
+
+	for name, tc := range cases {
+		t.Run(name, func(t *testing.T) {
+			chunks := strings.Split(tc.input, ",")
+			proposals, err := ConvertToProposals(chunks)
+			if tc.isError {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, proposals, tc.proposals)
+			}
+		})
+	}
+}