feat: adding x/cwerrors module

CHANGELOG.md

@@ -41,6 +41,7 @@ Contains all the PRs that improved the code without changing the behaviors.
 - [#542](https://github.com/archway-network/archway/pull/542) - Adding x/cwica module
 - [#543](https://github.com/archway-network/archway/pull/543) - Bumping sdk to v0.47.9
 - [#544](https://github.com/archway-network/archway/pull/544) - Bumping sdk to v0.47.10
+- [#546](https://github.com/archway-network/archway/pull/546) - Adding x/cwerrors module
 
 ### Improvements
 

app/app.go

@@ -130,6 +130,10 @@ import (
 	callbackKeeper "github.com/archway-network/archway/x/callback/keeper"
 	callbackTypes "github.com/archway-network/archway/x/callback/types"
 
+	"github.com/archway-network/archway/x/cwerrors"
+	cwerrorsKeeper "github.com/archway-network/archway/x/cwerrors/keeper"
+	cwerrorsTypes "github.com/archway-network/archway/x/cwerrors/types"
+
 	"github.com/archway-network/archway/x/rewards"
 	rewardsKeeper "github.com/archway-network/archway/x/rewards/keeper"
 	"github.com/archway-network/archway/x/rewards/mintbankkeeper"
@@ -217,6 +221,7 @@ var (
 		callback.AppModuleBasic{},
 		cwfees.AppModule{},
 		cwica.AppModuleBasic{},
+		cwerrors.AppModuleBasic{},
 	)
 
 	// module account permissions
@@ -314,9 +319,9 @@ func NewArchwayApp(
 		feegrant.StoreKey, authzkeeper.StoreKey, wasmdTypes.StoreKey, consensusparamtypes.StoreKey,
 		icacontrollertypes.StoreKey, icahosttypes.StoreKey, ibcfeetypes.StoreKey, crisistypes.StoreKey, group.StoreKey, nftkeeper.StoreKey, cwicatypes.StoreKey,
 
-		trackingTypes.StoreKey, rewardsTypes.StoreKey, callbackTypes.StoreKey, cwfees.ModuleName,
+		trackingTypes.StoreKey, rewardsTypes.StoreKey, callbackTypes.StoreKey, cwfees.ModuleName, cwerrorsTypes.StoreKey,
 	)
-	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
+	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey, cwerrorsTypes.TStoreKey)
 	memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)
 
 	app := &ArchwayApp{
@@ -536,6 +541,10 @@ func NewArchwayApp(
 	trackingWasmVm := wasmdTypes.NewTrackingWasmerEngine(wasmer, &wasmdTypes.NoOpContractGasProcessor{})
 
 	wasmOpts = append(wasmOpts, wasmdKeeper.WithWasmEngine(trackingWasmVm), wasmdKeeper.WithGasRegister(defaultGasRegister))
+	// Include the x/cwerrors query to stargate queries
+	wasmOpts = append(wasmOpts, wasmdKeeper.WithQueryPlugins(&wasmdKeeper.QueryPlugins{
+		Stargate: wasmdKeeper.AcceptListStargateQuerier(getAcceptedStargateQueries(), app.GRPCQueryRouter(), appCodec),
+	}))
 	// Archway specific options (using a pointer as the keeper is post-initialized below)
 	wasmOpts = append(wasmOpts, wasmbinding.BuildWasmOptions(&app.Keepers.RewardsKeeper, &app.Keepers.GovKeeper)...)
 
@@ -606,6 +615,16 @@ func NewArchwayApp(
 		govModuleAddr,
 	)
 
+	app.Keepers.CWErrorsKeeper = cwerrorsKeeper.NewKeeper(
+		appCodec,
+		keys[cwerrorsTypes.StoreKey],
+		tkeys[cwerrorsTypes.TStoreKey],
+		app.Keepers.WASMKeeper,
+		app.Keepers.BankKeeper,
+		app.Keepers.RewardsKeeper,
+		govModuleAddr,
+	)
+
 	var transferStack porttypes.IBCModule
 	transferStack = transfer.NewIBCModule(app.Keepers.TransferKeeper)
 	transferStack = ibcfee.NewIBCMiddleware(transferStack, app.Keepers.IBCFeeKeeper)
@@ -690,6 +709,7 @@ func NewArchwayApp(
 		genmsg.NewAppModule(app.MsgServiceRouter()),
 		callback.NewAppModule(app.appCodec, app.Keepers.CallbackKeeper, app.Keepers.WASMKeeper),
 		cwica.NewAppModule(appCodec, app.Keepers.CWICAKeeper, app.Keepers.AccountKeeper),
+		cwerrors.NewAppModule(app.appCodec, app.Keepers.CWErrorsKeeper, app.Keepers.WASMKeeper),
 		crisis.NewAppModule(&app.Keepers.CrisisKeeper, skipGenesisInvariants, app.getSubspace(crisistypes.ModuleName)), // always be last to make sure that it checks for all invariants and not only part of them
 	)
 
@@ -731,6 +751,7 @@ func NewArchwayApp(
 		callbackTypes.ModuleName,
 		cwfees.ModuleName, // does not have being blocker.
 		cwicatypes.ModuleName,
+		cwerrorsTypes.ModuleName, // does not have begin blocker
 	)
 
 	app.mm.SetOrderEndBlockers(
@@ -764,6 +785,7 @@ func NewArchwayApp(
 		trackingTypes.ModuleName,
 		rewardsTypes.ModuleName,
 		callbackTypes.ModuleName,
+		cwerrorsTypes.ModuleName,
 		// invariants checks are always the last to run
 		crisistypes.ModuleName,
 		cwfees.ModuleName, // does not have end blocker
@@ -809,6 +831,7 @@ func NewArchwayApp(
 		trackingTypes.ModuleName,
 		genmsg.ModuleName,
 		callbackTypes.ModuleName,
+		cwerrorsTypes.ModuleName,
 		// invariants checks are always the last to run
 		crisistypes.ModuleName,
 		cwicatypes.ModuleName,
@@ -1081,3 +1104,9 @@ func initParamsKeeper(appCodec codec.BinaryCodec, legacyAmino *codec.LegacyAmino
 
 	return paramsKeeper
 }
+
+func getAcceptedStargateQueries() wasmdKeeper.AcceptedStargateQueries {
+	return wasmdKeeper.AcceptedStargateQueries{
+		"/archway.cwerrors.v1.Query/Errors": &cwerrorsTypes.QueryErrorsRequest{},
+	}
+}

app/keepers/keepers.go

@@ -29,6 +29,7 @@ import (
 	ibckeeper "github.com/cosmos/ibc-go/v7/modules/core/keeper"
 
 	callbackKeeper "github.com/archway-network/archway/x/callback/keeper"
+	cwerrorsKeeper "github.com/archway-network/archway/x/cwerrors/keeper"
 	cwicaKeeper "github.com/archway-network/archway/x/cwica/keeper"
 	rewardsKeeper "github.com/archway-network/archway/x/rewards/keeper"
 	trackingKeeper "github.com/archway-network/archway/x/tracking/keeper"
@@ -64,5 +65,6 @@ type ArchwayKeepers struct {
 	RewardsKeeper  rewardsKeeper.Keeper
 	CWFeesKeeper   cwfees.Keeper
 	CallbackKeeper callbackKeeper.Keeper
+	CWErrorsKeeper cwerrorsKeeper.Keeper
 	CWICAKeeper    cwicaKeeper.Keeper
 }

app/upgrades/latest/upgrades.go

@@ -11,6 +11,7 @@ import (
 	"github.com/archway-network/archway/app/keepers"
 	"github.com/archway-network/archway/app/upgrades"
 	callbackTypes "github.com/archway-network/archway/x/callback/types"
+	cwerrorstypes "github.com/archway-network/archway/x/cwerrors/types"
 	"github.com/archway-network/archway/x/cwfees"
 	cwicatypes "github.com/archway-network/archway/x/cwica/types"
 )
@@ -37,6 +38,7 @@ var Upgrade = upgrades.Upgrade{
 		Added: []string{
 			callbackTypes.ModuleName,
 			cwfees.ModuleName,
+			cwerrorstypes.ModuleName,
 			icacontrollertypes.StoreKey,
 			cwicatypes.ModuleName,
 		},

proto/archway/cwerrors/v1/cwerrors.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+package archway.cwerrors.v1;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/archway-network/archway/x/cwerrors/types";
+
+// SudoError defines the sudo message for the error callback
+message SudoError {
+  // module_name is the name of the module throwing the error
+  string module_name = 1;
+  // error_code is the module level error code
+  uint32 error_code = 2;
+  // contract_address is the address of the contract which will receive the
+  // error callback
+  string contract_address = 3;
+  // input_payload is any input which caused the error
+  string input_payload = 4;
+  // error_message is the error message
+  string error_message = 5;
+}

proto/archway/cwerrors/v1/events.proto

@@ -0,0 +1,51 @@
+syntax = "proto3";
+package archway.cwerrors.v1;
+
+import "gogoproto/gogo.proto";
+import "archway/cwerrors/v1/params.proto";
+import "archway/cwerrors/v1/cwerrors.proto";
+import "cosmos/base/v1beta1/coin.proto";
+
+option go_package = "github.com/archway-network/archway/x/cwerrors/types";
+
+// ParamsUpdatedEvent defines the event which is thrown when the module
+// parameters are updated
+message ParamsUpdatedEvent {
+  // new_params are the new parameters for the module
+  Params new_params = 1 [ (gogoproto.nullable) = false ];
+  // authority is the address of the authority that updated the parameters
+  string authority = 2;
+}
+
+// SubscribedToErrorsEvent defines the event which is thrown when a contract
+// subscribes to errors
+message SubscribedToErrorsEvent {
+  // sender is the address which initiated the subscription
+  string sender = 1;
+  // contract_address is the address of the contract which is subscribed to
+  // errors
+  string contract_address = 2;
+  // fees_paid is the fees paid for the subscription
+  cosmos.base.v1beta1.Coin fees_paid = 3 [ (gogoproto.nullable) = false ];
+  // subscription_valid_till is the block height till which the subscription is
+  // valid
+  int64 subscription_valid_till = 4;
+}
+
+// StoringErrorEvent defines the event which is thrown when an error is stored
+message StoringErrorEvent {
+  // error is the error which is stored
+  SudoError error = 1 [ (gogoproto.nullable) = false ];
+  // deletion_block_height is the block height at which the error will be pruned
+  // from the state
+  int64 deletion_block_height = 2;
+}
+
+// SudoErrorCallbackFailedEvent defines the event which is thrown when a sudo
+// error callback fails
+message SudoErrorCallbackFailedEvent {
+  // error is the error for which the callback is executed
+  SudoError error = 1 [ (gogoproto.nullable) = false ];
+  // callback_error_message is the error message of why the callback failed
+  string callback_error_message = 2;
+}

proto/archway/cwerrors/v1/genesis.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package archway.cwerrors.v1;
+
+import "gogoproto/gogo.proto";
+import "archway/cwerrors/v1/params.proto";
+import "archway/cwerrors/v1/cwerrors.proto";
+
+option go_package = "github.com/archway-network/archway/x/cwerrors/types";
+
+// GenesisState defines the cwerrors module's genesis state.
+message GenesisState {
+  // params defines all the module parameters.
+  Params params = 1 [ (gogoproto.nullable) = false ];
+  // errors defines all the sudo errors currently registered.
+  repeated SudoError errors = 2 [ (gogoproto.nullable) = false ];
+}

proto/archway/cwerrors/v1/params.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package archway.cwerrors.v1;
+
+import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
+
+option go_package = "github.com/archway-network/archway/x/cwerrors/types";
+
+// Params defines the set of parameters for the cwerrors module.
+message Params {
+  // error_stored_time is the block height until which error is stored
+  int64 error_stored_time = 1;
+  // subsciption_fee is the fee required to subscribe to error callbacks
+  cosmos.base.v1beta1.Coin subscription_fee = 2
+      [ (gogoproto.nullable) = false ];
+  // subscription_period is the period for which the subscription is valid
+  int64 subscription_period = 3;
+}

proto/archway/cwerrors/v1/query.proto

@@ -0,0 +1,65 @@
+syntax = "proto3";
+package archway.cwerrors.v1;
+
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "archway/cwerrors/v1/cwerrors.proto";
+import "archway/cwerrors/v1/params.proto";
+
+option go_package = "github.com/archway-network/archway/x/cwerrors/types";
+
+// Query service for the cwerrors module.
+service Query {
+  // Params queries all the module parameters.
+  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
+    option (google.api.http).get = "/archway/cwerrors/v1/params";
+  }
+
+  // Errors queries all the errors for a given contract.
+  rpc Errors(QueryErrorsRequest) returns (QueryErrorsResponse) {
+    option (google.api.http).get = "/archway/cwerrors/v1/errors";
+  }
+
+  // IsSubscribed queries if a contract is subscribed to sudo error callbacks.
+  rpc IsSubscribed(QueryIsSubscribedRequest)
+      returns (QueryIsSubscribedResponse) {
+    option (google.api.http).get = "/archway/cwerrors/v1/is_subscribed";
+  }
+}
+
+// QueryParamsRequest is the request for Query.Params.
+message QueryParamsRequest {}
+
+// QueryParamsResponse is the response for Query.Params.
+message QueryParamsResponse {
+  // params defines all the module parameters.
+  Params params = 1 [ (gogoproto.nullable) = false ];
+}
+
+// QueryErrorsRequest is the request for Query.Errors.
+message QueryErrorsRequest {
+  // contract_address is the address of the contract whose errors to query for
+  string contract_address = 1;
+}
+
+// QueryErrorsResponse is the response for Query.Errors.
+message QueryErrorsResponse {
+  // errors defines all the contract errors which will be returned
+  repeated SudoError errors = 1 [ (gogoproto.nullable) = false ];
+}
+
+// QueryIsSubscribedRequest is the request for Query.IsSubscribed.
+message QueryIsSubscribedRequest {
+  // contract_address is the address of the contract to query if subscribed
+  string contract_address = 1;
+}
+
+// QueryIsSubscribedResponse is the response for Query.IsSubscribed.
+message QueryIsSubscribedResponse {
+  // subscribed defines if the contract is subscribed to sudo error callbacks
+  bool subscribed = 1;
+  // subscription_valid_till defines the block height till which the
+  // subscription is valid
+  int64 subscription_valid_till = 2;
+}

proto/archway/cwerrors/v1/tx.proto

@@ -0,0 +1,60 @@
+syntax = "proto3";
+package archway.cwerrors.v1;
+
+import "gogoproto/gogo.proto";
+import "cosmos/msg/v1/msg.proto";
+import "cosmos/base/v1beta1/coin.proto";
+import "archway/cwerrors/v1/params.proto";
+
+option go_package = "github.com/archway-network/archway/x/cwerrors/types";
+
+// Msg defines the cwerrors Msg service.
+service Msg {
+  // UpdateParams defines a governance operation for updating the x/cwerrors
+  // module parameters. The authority is defined in the keeper.
+  rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse);
+  // SubscribeToError defines an operation which will register a contract for a
+  // sudo callback on errors
+  rpc SubscribeToError(MsgSubscribeToError)
+      returns (MsgSubscribeToErrorResponse);
+}
+
+// MsgUpdateParams is the Msg/UpdateParams request type.
+message MsgUpdateParams {
+  option (cosmos.msg.v1.signer) = "authority";
+  // authority is the address that controls the module (defaults to x/gov unless
+  // overwritten).
+  string authority = 1;
+  // params defines the x/cwerrors parameters to update.
+  //
+  // NOTE: All parameters must be supplied.
+  Params params = 2 [
+    (gogoproto.nullable) = false,
+    (gogoproto.jsontag) = "params,omitempty"
+  ];
+}
+
+// MsgUpdateParamsResponse defines the response structure for executing a
+// MsgUpdateParams message.
+message MsgUpdateParamsResponse {}
+
+// MsgSubscribeToError is the Msg/SubscribeToError request type.
+message MsgSubscribeToError {
+  option (cosmos.msg.v1.signer) = "sender";
+  // sender is the address of who is registering the contarcts for callback on
+  // error
+  string sender = 1;
+  // contract is the address of the contract that will be called on error
+  string contract_address = 2;
+  // fee is the subscription fee for the feature (current no fee is charged for
+  // this feature)
+  cosmos.base.v1beta1.Coin fee = 3 [ (gogoproto.nullable) = false ];
+}
+
+// MsgSubscribeToErrorResponse defines the response structure for executing a
+// MsgSubscribeToError message.
+message MsgSubscribeToErrorResponse {
+  // subscription_valid_till is the block height till which the subscription is
+  // valid
+  int64 subscription_valid_till = 1;
+}