feat(cwgrants): Implement x/cwgrants module

CHANGELOG.md

@@ -38,6 +38,7 @@ Contains all the PRs that improved the code without changing the behaviors.
 - [#462](https://github.com/archway-network/archway/pull/462) - adding docs ADR-008 – Improvements on rewards withdrawal experience
 - [#501](https://github.com/archway-network/archway/pull/501) - Adding x/callback module
 - [#532](https://github.com/archway-network/archway/pull/532) - Adding ADR-009 for x/callback module
+- [#527](https://github.com/archway-network/archway/pull/527) - Add x/cwfees module for 
 
 ### Improvements
 

app/ante.go

@@ -13,6 +13,8 @@ import (
 	ibcante "github.com/cosmos/ibc-go/v7/modules/core/ante"
 	ibckeeper "github.com/cosmos/ibc-go/v7/modules/core/keeper"
 
+	"github.com/archway-network/archway/x/cwfees"
+
 	rewardsAnte "github.com/archway-network/archway/x/rewards/ante"
 	rewardsKeeper "github.com/archway-network/archway/x/rewards/keeper"
 	trackingAnte "github.com/archway-network/archway/x/tracking/ante"
@@ -33,7 +35,8 @@ type HandlerOptions struct {
 	TrackingKeeper trackingKeeper.Keeper
 	RewardsKeeper  rewardsKeeper.Keeper
 
-	Codec codec.BinaryCodec
+	Codec        codec.BinaryCodec
+	CWFeesKeeper cwfees.Keeper
 }
 
 func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error) {
@@ -78,7 +81,7 @@ func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error) {
 		// Custom Archway interceptor to track new transactions
 		trackingAnte.NewTxGasTrackingDecorator(options.TrackingKeeper),
 		// Custom Archway fee deduction, which splits fees between x/rewards and x/auth fee collector
-		rewardsAnte.NewDeductFeeDecorator(options.Codec, options.AccountKeeper, options.RewardsAnteBankKeeper, options.FeegrantKeeper, options.RewardsKeeper),
+		rewardsAnte.NewDeductFeeDecorator(options.Codec, options.AccountKeeper, options.RewardsAnteBankKeeper, options.FeegrantKeeper, options.RewardsKeeper, options.CWFeesKeeper),
 		// SetPubKeyDecorator must be called before all signature verification decorators
 		ante.NewSetPubKeyDecorator(options.AccountKeeper),
 		ante.NewValidateSigCountDecorator(options.AccountKeeper),

app/app.go

@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 
 	"github.com/archway-network/archway/app/keepers"
+	"github.com/archway-network/archway/x/cwfees"
 	"github.com/archway-network/archway/x/genmsg"
 
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
@@ -207,6 +208,7 @@ var (
 		rewards.AppModuleBasic{},
 		genmsg.AppModule{},
 		callback.AppModuleBasic{},
+		cwfees.AppModule{},
 	)
 
 	// module account permissions
@@ -304,7 +306,7 @@ func NewArchwayApp(
 		feegrant.StoreKey, authzkeeper.StoreKey, wasmdTypes.StoreKey, consensusparamtypes.StoreKey,
 		icahosttypes.StoreKey, ibcfeetypes.StoreKey, crisistypes.StoreKey, group.StoreKey, nftkeeper.StoreKey,
 
-		trackingTypes.StoreKey, rewardsTypes.StoreKey, callbackTypes.StoreKey,
+		trackingTypes.StoreKey, rewardsTypes.StoreKey, callbackTypes.StoreKey, cwfees.ModuleName,
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
 	memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)
@@ -572,6 +574,8 @@ func NewArchwayApp(
 		govModuleAddr,
 	)
 
+	app.Keepers.CWFeesKeeper = cwfees.NewKeeper(appCodec, keys[cwfees.ModuleName], app.Keepers.WASMKeeper)
+
 	var transferStack porttypes.IBCModule
 	transferStack = transfer.NewIBCModule(app.Keepers.TransferKeeper)
 	transferStack = ibcfee.NewIBCMiddleware(transferStack, app.Keepers.IBCFeeKeeper)
@@ -644,6 +648,7 @@ func NewArchwayApp(
 		consensus.NewAppModule(appCodec, app.Keepers.ConsensusParamsKeeper),
 		tracking.NewAppModule(app.appCodec, app.Keepers.TrackingKeeper),
 		rewards.NewAppModule(app.appCodec, app.Keepers.RewardsKeeper),
+		cwfees.NewAppModule(app.Keepers.CWFeesKeeper),
 		genmsg.NewAppModule(app.MsgServiceRouter()),
 		callback.NewAppModule(app.appCodec, app.Keepers.CallbackKeeper, 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
@@ -685,6 +690,7 @@ func NewArchwayApp(
 		trackingTypes.ModuleName,
 		rewardsTypes.ModuleName,
 		callbackTypes.ModuleName,
+		cwfees.ModuleName, // does not have being blocker.
 	)
 
 	app.mm.SetOrderEndBlockers(
@@ -720,6 +726,7 @@ func NewArchwayApp(
 		callbackTypes.ModuleName,
 		// invariants checks are always the last to run
 		crisistypes.ModuleName,
+		cwfees.ModuleName, // does not have end blocker
 	)
 
 	// NOTE: The genutils module must occur after staking so that pools are
@@ -757,6 +764,7 @@ func NewArchwayApp(
 		// wasm after ibc transfer
 		wasmdTypes.ModuleName,
 		// wasm gas tracking
+		cwfees.ModuleName, // depends on wasmd.
 		trackingTypes.ModuleName,
 		genmsg.ModuleName,
 		callbackTypes.ModuleName,
@@ -817,6 +825,7 @@ func NewArchwayApp(
 			TXCounterStoreKey:     keys[wasmdTypes.StoreKey],
 			TrackingKeeper:        app.Keepers.TrackingKeeper,
 			RewardsKeeper:         app.Keepers.RewardsKeeper,
+			CWFeesKeeper:          app.Keepers.CWFeesKeeper,
 		},
 	)
 	if err != nil {

app/keepers/keepers.go

@@ -20,6 +20,8 @@ import (
 	stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
 	upgradekeeper "github.com/cosmos/cosmos-sdk/x/upgrade/keeper"
 
+	"github.com/archway-network/archway/x/cwfees"
+
 	icahostkeeper "github.com/cosmos/ibc-go/v7/modules/apps/27-interchain-accounts/host/keeper"
 	ibcfeekeeper "github.com/cosmos/ibc-go/v7/modules/apps/29-fee/keeper"
 	ibctransferkeeper "github.com/cosmos/ibc-go/v7/modules/apps/transfer/keeper"
@@ -57,5 +59,6 @@ type ArchwayKeepers struct {
 	// Archway Keepers
 	TrackingKeeper trackingKeeper.Keeper
 	RewardsKeeper  rewardsKeeper.Keeper
+	CWFeesKeeper   cwfees.Keeper
 	CallbackKeeper callbackKeeper.Keeper
 }

app/upgrades/latest/upgrades.go

@@ -9,6 +9,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"
+	"github.com/archway-network/archway/x/cwfees"
 )
 
 // This upgrade handler is used for all the current changes to the protocol
@@ -32,6 +33,7 @@ var Upgrade = upgrades.Upgrade{
 	StoreUpgrades: storetypes.StoreUpgrades{
 		Added: []string{
 			callbackTypes.ModuleName,
+			cwfees.ModuleName,
 		},
 	},
 }

contracts/cwfees/Cargo.toml

@@ -0,0 +1,50 @@
+[package]
+name = "cwgrant"
+version = "0.1.0"
+authors = ["Frojdi"]
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[profile.release]
+opt-level = 3
+debug = false
+rpath = false
+lto = true
+debug-assertions = false
+codegen-units = 1
+panic = 'abort'
+incremental = false
+overflow-checks = true
+
+[features]
+# for more explicit tests, cargo test --features=backtraces
+backtraces = ["cosmwasm-std/backtraces"]
+# use library feature to disable all instantiate/execute/query exports
+library = []
+
+[package.metadata.scripts]
+optimize = """docker run --rm -v "$(pwd)":/code \
+  --mount type=volume,source="$(basename "$(pwd)")_cache",target=/target \
+  --mount type=volume,source=registry_cache,target=/usr/local/cargo/registry \
+  cosmwasm/optimizer:0.15.0
+"""
+
+[dependencies]
+cosmwasm-schema = "1.5.0"
+cosmwasm-std = { version = "1.5.0", features = [
+    "cosmwasm_1_3",
+    # Enable this if you only deploy to chains that have CosmWasm 1.4 or higher
+    # "cosmwasm_1_4",
+] }
+cw-storage-plus = "1.1.0"
+cw2 = "1.1.1"
+schemars = "0.8.15"
+serde = { version = "1.0.189", default-features = false, features = ["derive"] }
+thiserror = { version = "1.0.49" }
+
+[dev-dependencies]
+cw-multi-test = "0.17.0"

contracts/cwfees/artifacts/checksums.txt

@@ -0,0 +1,2 @@
+87a239f88d13f5d6f4a170d95f281563a91e01dcaae4a699ef1981dfef24115b  cwgrant-aarch64.wasm
+72cdb4ffa538ff9365328a65427469c603a87007c3155b52515bf728a9b02c95  cwgrant.wasm

contracts/cwfees/artifacts/checksums_intermediate.txt

@@ -0,0 +1 @@
+92df70ecf8e205915633d93114aefd0340e65a72de4390ea2e14c27161271408  /target/wasm32-unknown-unknown/release/cwgrant.wasm

contracts/cwfees/src/contract.rs

@@ -0,0 +1,57 @@
+use cosmwasm_std::{DepsMut, Empty, Env, MessageInfo, Response, entry_point};
+use crate::errors::ContractError;
+use crate::msgs::{CwGrant, InstantiateMsg, SudoMsg};
+use crate::state::GRANTS;
+
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn instantiate(
+    deps: DepsMut,
+    _env: Env,
+    _: MessageInfo,
+    msg: InstantiateMsg,
+) -> Result<Response, ContractError> {
+    for addr in &msg.grants {
+        let addr = deps.api.addr_validate(addr)?;
+        GRANTS.save(deps.storage, &addr, &Empty{})?
+    }
+    Ok(Response::default())
+}
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn sudo(
+    deps: DepsMut,
+    _env: Env,
+    msg: SudoMsg,
+) -> Result<Response, ContractError> {
+    return match msg {
+        SudoMsg::CwGrant(grant) => {
+            sudo_grant(deps, grant)
+        }
+    }
+}
+
+fn sudo_grant(deps: DepsMut, msg: CwGrant) -> Result<Response, ContractError> {
+    // in order to pay the fees all message senders need to be
+    // in the grants list.
+    for m in &msg.msgs {
+        let sender = deps.api.addr_validate(&m.sender)?;
+        if !GRANTS.has(deps.storage, &sender) {
+            return Err(ContractError::Unauthorized {})
+        }
+    }
+
+    Ok(Response::default())
+}
+
+#[cfg(test)]
+mod test {
+    use cosmwasm_std::to_json_binary;
+    use crate::msgs::{CwGrant, SudoMsg};
+
+    #[test]
+    fn encoding() {
+        println!("{}", to_json_binary(&SudoMsg::CwGrant(CwGrant{
+            fee_requested: vec![],
+            msgs: vec![],
+        })).unwrap());
+    }
+}

contracts/cwfees/src/errors.rs

@@ -0,0 +1,11 @@
+use cosmwasm_std::StdError;
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum ContractError {
+    #[error("{0}")]
+    Std(#[from] StdError),
+
+    #[error("Unauthorized")]
+    Unauthorized {},
+}

contracts/cwfees/src/lib.rs

@@ -0,0 +1,4 @@
+mod msgs;
+mod contract;
+mod errors;
+mod state;

contracts/cwfees/src/msgs.rs

@@ -0,0 +1,29 @@
+use cosmwasm_schema::{cw_serde};
+use cosmwasm_std::{Binary, Coin};
+
+#[cw_serde]
+pub struct InstantiateMsg {
+    pub grants: Vec<String>
+}
+
+#[cw_serde]
+pub enum SudoMsg {
+    CwGrant(CwGrant)
+}
+#[cw_serde]
+pub struct CwGrant {
+    pub fee_requested: Vec<Coin>,
+    pub msgs: Vec<CwGrantMessage>,
+}
+#[cw_serde]
+pub struct CwGrantMessage {
+    pub sender: String,
+    pub type_url: String,
+    pub msg: Binary,
+}
+
+#[cfg(test)]
+mod test {
+    #[test]
+    fn build() {}
+}

contracts/cwfees/src/state.rs

@@ -0,0 +1,4 @@
+use cosmwasm_std::{Addr, Empty};
+use cw_storage_plus::Map;
+
+pub const GRANTS: Map<&Addr, Empty> = Map::new("grants");

docs/adr/ADR-010-cw-fees.md

@@ -0,0 +1,64 @@
+---
+
+# ADR-010: Introduction of CWFees Module
+
+Date: 2023-01-16
+
+## Status
+
+Accepted | Implemented.
+
+## Context
+
+The introduction of the CWFees module marks a significant advancement in how transaction fees are handled within the
+ecosystem. Previously confined to entities registered under the standard x/feegrant module, the `FeeGranter` role within
+a transaction's `AuthInfo.Fee` can now be assumed by a CosmWasm contract. This transition from a static,
+binary-implemented fee grant logic to a dynamic, contract-based approach enhances flexibility, eliminating the need for
+chain upgrades for modifications in fee grant logic.
+
+## Decision
+
+We have expanded the capabilities of the CWFees module by introducing two key message entry points: `RegisterAsGranter`
+and `UnregisterAsGranter`, exclusively accessible to CosmWasm contracts. This enables a contract, for example during its
+instantiation phase, to declare itself as a fee granter by issuing a `StargateMsg` containing a `RegisterAsGranter`
+message. Once registered, the system acknowledges the contract as an eligible fee granter.
+
+In the event of a transaction, the user can designate a registered CosmWasm contract as the `Tx.AuthInfo.Fee.Granter`.
+The system, in turn, invokes this contract via sudo, providing it with critical information encapsulated in a structured
+JSON format:
+
+```golang
+type SudoMsg struct {
+CWGrant *CWGrant `json:"cw_grant"`
+}
+
+type CWGrant struct {
+FeeRequested wasmVmTypes.Coins `json:"fee_requested"`
+Msgs []CWGrantMessage `json:"msgs"`
+}
+
+type CWGrantMessage struct {
+Sender string `json:"sender"`
+TypeUrl string `json:"type_url"`
+Msg []byte `json:"msg"`
+}
+```
+
+This detailed information empowers the contract to make an informed decision regarding the grant request. If the contract
+consents (i.e., no errors are returned), the runtime itself handles the transfer of fees from the contract to the
+auth collector. Conversely, if the contract opts to decline the grant, it must issue an error response. Overall, the contract
+is not required to do anything besides signaling it accepts or refuses the grant (no coin moving is required!).
+
+## Consequences
+
+### Positive
+1. Grants developers enhanced control over the application of fee grants.
+2. Enables transactions where contracts absorb the gas costs for users, creating a gas-less experience.
+3. Supports the development of diverse incentive models.
+4. Accommodates the use of multiple coin types for fee payments.
+
+### Negative
+1. Introduces a layer of complexity to the system's architecture.
+
+### Security Considerations
+- To mitigate potential risks, the gas usage within a CWGrant will be capped, preventing a CWFees contract from incurring excessive gas consumption.