chore: support legacy querying cosmwasm proposals

x/wasm/legacy/proposal.go

@@ -0,0 +1,390 @@
+package legacy
+
+import (
+	"encoding/base64"
+	"encoding/json"
+	"fmt"
+	"strings"
+
+	"github.com/CosmWasm/wasmd/x/wasm/types"
+	wasmtypes "github.com/CosmWasm/wasmd/x/wasm/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+)
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p StoreCodeProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *StoreCodeProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p StoreCodeProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p StoreCodeProposal) ProposalType() string { return string(types.ProposalTypeStoreCode) }
+
+// ValidateBasic validates the proposal
+func (p StoreCodeProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if _, err := sdk.AccAddressFromBech32(p.RunAs); err != nil {
+		return sdkerrors.Wrap(err, "run as")
+	}
+
+	if err := validateWasmCode(p.WASMByteCode); err != nil {
+		return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "code bytes %s", err.Error())
+	}
+
+	if err := validateSourceURL(p.Source); err != nil {
+		return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "source %s", err.Error())
+	}
+
+	if err := validateBuilder(p.Builder); err != nil {
+		return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "builder %s", err.Error())
+	}
+	if p.InstantiatePermission != nil {
+		if err := p.InstantiatePermission.ValidateBasic(); err != nil {
+			return sdkerrors.Wrap(err, "instantiate permission")
+		}
+	}
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p StoreCodeProposal) String() string {
+	return fmt.Sprintf(`Store Code Proposal:
+  Title:       %s
+  Description: %s
+  Run as:      %s
+  WasmCode:    %X
+  Source:      %s
+  Builder:     %s
+`, p.Title, p.Description, p.RunAs, p.WASMByteCode, p.Source, p.Builder)
+}
+
+// MarshalYAML pretty prints the wasm byte code
+func (p StoreCodeProposal) MarshalYAML() (interface{}, error) {
+	return struct {
+		Title                 string                  `yaml:"title"`
+		Description           string                  `yaml:"description"`
+		RunAs                 string                  `yaml:"run_as"`
+		WASMByteCode          string                  `yaml:"wasm_byte_code"`
+		Source                string                  `yaml:"source"`
+		Builder               string                  `yaml:"builder"`
+		InstantiatePermission *wasmtypes.AccessConfig `yaml:"instantiate_permission"`
+	}{
+		Title:                 p.Title,
+		Description:           p.Description,
+		RunAs:                 p.RunAs,
+		WASMByteCode:          base64.StdEncoding.EncodeToString(p.WASMByteCode),
+		Source:                p.Source,
+		Builder:               p.Builder,
+		InstantiatePermission: p.InstantiatePermission,
+	}, nil
+}
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p InstantiateContractProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *InstantiateContractProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p InstantiateContractProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p InstantiateContractProposal) ProposalType() string {
+	return string(types.ProposalTypeInstantiateContract)
+}
+
+// ValidateBasic validates the proposal
+func (p InstantiateContractProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if _, err := sdk.AccAddressFromBech32(p.RunAs); err != nil {
+		return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "run as")
+	}
+
+	if p.CodeID == 0 {
+		return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "code id is required")
+	}
+
+	if err := validateLabel(p.Label); err != nil {
+		return err
+	}
+
+	if !p.Funds.IsValid() {
+		return sdkerrors.ErrInvalidCoins
+	}
+
+	if len(p.Admin) != 0 {
+		if _, err := sdk.AccAddressFromBech32(p.Admin); err != nil {
+			return err
+		}
+	}
+	if !json.Valid(p.InitMsg) {
+		return sdkerrors.Wrap(types.ErrInvalid, "init msg json")
+	}
+
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p InstantiateContractProposal) String() string {
+	return fmt.Sprintf(`Instantiate Code Proposal:
+  Title:       %s
+  Description: %s
+  Run as:      %s
+  Admin:       %s
+  Code id:     %d
+  Label:       %s
+  InitMsg:     %q
+  Funds:       %s
+`, p.Title, p.Description, p.RunAs, p.Admin, p.CodeID, p.Label, p.InitMsg, p.Funds)
+}
+
+// MarshalYAML pretty prints the init message
+func (p InstantiateContractProposal) MarshalYAML() (interface{}, error) {
+	return struct {
+		Title       string    `yaml:"title"`
+		Description string    `yaml:"description"`
+		RunAs       string    `yaml:"run_as"`
+		Admin       string    `yaml:"admin"`
+		CodeID      uint64    `yaml:"code_id"`
+		Label       string    `yaml:"label"`
+		InitMsg     string    `yaml:"init_msg"`
+		Funds       sdk.Coins `yaml:"funds"`
+	}{
+		Title:       p.Title,
+		Description: p.Description,
+		RunAs:       p.RunAs,
+		Admin:       p.Admin,
+		CodeID:      p.CodeID,
+		Label:       p.Label,
+		InitMsg:     string(p.InitMsg),
+		Funds:       p.Funds,
+	}, nil
+}
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p MigrateContractProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *MigrateContractProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p MigrateContractProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p MigrateContractProposal) ProposalType() string {
+	return string(types.ProposalTypeMigrateContract)
+}
+
+// ValidateBasic validates the proposal
+func (p MigrateContractProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if p.CodeID == 0 {
+		return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "code_id is required")
+	}
+	if _, err := sdk.AccAddressFromBech32(p.Contract); err != nil {
+		return sdkerrors.Wrap(err, "contract")
+	}
+	if _, err := sdk.AccAddressFromBech32(p.RunAs); err != nil {
+		return sdkerrors.Wrap(err, "run as")
+	}
+	if !json.Valid(p.MigrateMsg) {
+		return sdkerrors.Wrap(types.ErrInvalid, "migrate msg json")
+	}
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p MigrateContractProposal) String() string {
+	return fmt.Sprintf(`Migrate Contract Proposal:
+  Title:       %s
+  Description: %s
+  Contract:    %s
+  Code id:     %d
+  Run as:      %s
+  MigrateMsg   %q
+`, p.Title, p.Description, p.Contract, p.CodeID, p.RunAs, p.MigrateMsg)
+}
+
+// MarshalYAML pretty prints the migrate message
+func (p MigrateContractProposal) MarshalYAML() (interface{}, error) {
+	return struct {
+		Title       string `yaml:"title"`
+		Description string `yaml:"description"`
+		Contract    string `yaml:"contract"`
+		CodeID      uint64 `yaml:"code_id"`
+		MigrateMsg  string `yaml:"msg"`
+		RunAs       string `yaml:"run_as"`
+	}{
+		Title:       p.Title,
+		Description: p.Description,
+		Contract:    p.Contract,
+		CodeID:      p.CodeID,
+		MigrateMsg:  string(p.MigrateMsg),
+		RunAs:       p.RunAs,
+	}, nil
+}
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p UpdateAdminProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *UpdateAdminProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p UpdateAdminProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p UpdateAdminProposal) ProposalType() string { return string(types.ProposalTypeUpdateAdmin) }
+
+// ValidateBasic validates the proposal
+func (p UpdateAdminProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if _, err := sdk.AccAddressFromBech32(p.Contract); err != nil {
+		return sdkerrors.Wrap(err, "contract")
+	}
+	if _, err := sdk.AccAddressFromBech32(p.NewAdmin); err != nil {
+		return sdkerrors.Wrap(err, "new admin")
+	}
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p UpdateAdminProposal) String() string {
+	return fmt.Sprintf(`Update Contract Admin Proposal:
+  Title:       %s
+  Description: %s
+  Contract:    %s
+  New Admin:   %s
+`, p.Title, p.Description, p.Contract, p.NewAdmin)
+}
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p ClearAdminProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *ClearAdminProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p ClearAdminProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p ClearAdminProposal) ProposalType() string { return string(types.ProposalTypeClearAdmin) }
+
+// ValidateBasic validates the proposal
+func (p ClearAdminProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if _, err := sdk.AccAddressFromBech32(p.Contract); err != nil {
+		return sdkerrors.Wrap(err, "contract")
+	}
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p ClearAdminProposal) String() string {
+	return fmt.Sprintf(`Clear Contract Admin Proposal:
+  Title:       %s
+  Description: %s
+  Contract:    %s
+`, p.Title, p.Description, p.Contract)
+}
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p PinCodesProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *PinCodesProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p PinCodesProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p PinCodesProposal) ProposalType() string { return string(types.ProposalTypePinCodes) }
+
+// ValidateBasic validates the proposal
+func (p PinCodesProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if len(p.CodeIDs) == 0 {
+		return sdkerrors.Wrap(types.ErrEmpty, "code ids")
+	}
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p PinCodesProposal) String() string {
+	return fmt.Sprintf(`Pin Wasm Codes Proposal:
+  Title:       %s
+  Description: %s
+  Codes:       %v
+`, p.Title, p.Description, p.CodeIDs)
+}
+
+// ProposalRoute returns the routing key of a parameter change proposal.
+func (p UnpinCodesProposal) ProposalRoute() string { return types.RouterKey }
+
+// GetTitle returns the title of the proposal
+func (p *UnpinCodesProposal) GetTitle() string { return p.Title }
+
+// GetDescription returns the human readable description of the proposal
+func (p UnpinCodesProposal) GetDescription() string { return p.Description }
+
+// ProposalType returns the type
+func (p UnpinCodesProposal) ProposalType() string { return string(types.ProposalTypeUnpinCodes) }
+
+// ValidateBasic validates the proposal
+func (p UnpinCodesProposal) ValidateBasic() error {
+	if err := validateProposalCommons(p.Title, p.Description); err != nil {
+		return err
+	}
+	if len(p.CodeIDs) == 0 {
+		return sdkerrors.Wrap(types.ErrEmpty, "code ids")
+	}
+	return nil
+}
+
+// String implements the Stringer interface.
+func (p UnpinCodesProposal) String() string {
+	return fmt.Sprintf(`Unpin Wasm Codes Proposal:
+  Title:       %s
+  Description: %s
+  Codes:       %v
+`, p.Title, p.Description, p.CodeIDs)
+}
+
+func validateProposalCommons(title, description string) error {
+	if strings.TrimSpace(title) != title {
+		return sdkerrors.Wrap(govtypes.ErrInvalidProposalContent, "proposal title must not start/end with white spaces")
+	}
+	if len(title) == 0 {
+		return sdkerrors.Wrap(govtypes.ErrInvalidProposalContent, "proposal title cannot be blank")
+	}
+	if len(title) > govtypes.MaxTitleLength {
+		return sdkerrors.Wrapf(govtypes.ErrInvalidProposalContent, "proposal title is longer than max length of %d", govtypes.MaxTitleLength)
+	}
+	if strings.TrimSpace(description) != description {
+		return sdkerrors.Wrap(govtypes.ErrInvalidProposalContent, "proposal description must not start/end with white spaces")
+	}
+	if len(description) == 0 {
+		return sdkerrors.Wrap(govtypes.ErrInvalidProposalContent, "proposal description cannot be blank")
+	}
+	if len(description) > govtypes.MaxDescriptionLength {
+		return sdkerrors.Wrapf(govtypes.ErrInvalidProposalContent, "proposal description is longer than max length of %d", govtypes.MaxDescriptionLength)
+	}
+	return nil
+}