Add new Staking messages and queries under feature flag

Author: ethanfrey

.circleci/config.yml

@@ -78,9 +78,9 @@ jobs:
           working_directory: ~/project/packages/std
           command: cargo wasm --locked --features iterator
       - run:
-          name: Run unit tests (with iterator support)
+          name: Run unit tests (with iterator and staking support)
           working_directory: ~/project/packages/std
-          command: cargo test --locked --features iterator
+          command: cargo test --locked --features iterator,staking
       - run:
           name: Build and run schema generator
           working_directory: ~/project/packages/std

CHANGELOG.md

@@ -91,12 +91,13 @@
 - `ExternalStorage.get` now returns an empty vector if a storage entry exists
   but has an empty value. Before, this was normalized to `None`.
 - Reorganize `CosmosMsg` enum types. They are now split by modules:
-  `CosmosMsg::Bank(BankMsg)`, `CosmosMsg::Custom(T)`,
-  `CosmosMsg::Wasm(WasmMsg)`
+  `CosmosMsg::Bank(BankMsg)`, `CosmosMsg::Custom(T)`, `CosmosMsg::Wasm(WasmMsg)`
 - CosmosMsg is now generic over the content of `Custom` variant. This allows
   blockchains to support custom native calls in their Cosmos-SDK apps and
   developers to make use of them in CosmWasm apps without forking the
   `cosmwasm-vm` and `go-cosmwasm` runtime.
+- Add `staking` feature flag to expose new `StakingMsg` types under `CosmosMsg`
+  and new `StakingRequest` types under `QueryRequest`.
 
 **cosmwasm-vm**
 

packages/std/Cargo.toml

@@ -18,6 +18,10 @@ maintenance = { status = "actively-developed" }
 # given Ethereum 1.0, 2.0, Substrate, and other major projects use Tries
 # we keep this optional, to allow possible future integration (or different Cosmos Backends)
 iterator = []
+# staking exposes bindings to a required staking moudle in the runtime, via new
+# CosmosMsg types, and new QueryRequest types. This should only be enabled on contracts
+# that require these types, so other contracts can be used on systems with eg. PoA consensus
+staking = []
 # backtraces provides much better context at runtime errors (in non-wasm code)
 # at the cost of a bit of code size and performance.
 backtraces = ["snafu/backtraces"]

packages/std/src/init_handle.rs

@@ -20,6 +20,8 @@ where
     // by default we use RawMsg, but a contract can override that
     // to call into more app-specific code (whatever they define)
     Custom(T),
+    #[cfg(feature = "staking")]
+    Staking(StakingMsg),
     Wasm(WasmMsg),
 }
 
@@ -39,6 +41,35 @@ pub enum BankMsg {
 /// those contracts that don't explicitly set a custom message.
 pub enum NoMsg {}
 
+#[cfg(feature = "staking")]
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum StakingMsg {
+    Delegate {
+        // delegator is automatically set to address of the calling contract
+        validator: HumanAddr,
+        amount: Coin,
+    },
+    Undelegate {
+        // delegator is automatically set to address of the calling contract
+        validator: HumanAddr,
+        amount: Coin,
+    },
+    Withdraw {
+        // delegator is automatically set to address of the calling contract
+        validator: HumanAddr,
+        // this is the "withdraw address", the one that should receive the rewards
+        // if None, then use delegator address
+        recipient: Option<HumanAddr>,
+    },
+    Redelegate {
+        // delegator is automatically set to address of the calling contract
+        src_validator: HumanAddr,
+        dst_validator: HumanAddr,
+        amount: Coin,
+    },
+}
+
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
 #[serde(rename_all = "snake_case")]
 pub enum WasmMsg {

packages/std/src/mock.rs

@@ -166,6 +166,10 @@ impl Querier for MockQuerier {
                 let api_res = to_vec(&bank_res).map(Binary).map_err(|e| e.into());
                 Ok(api_res)
             }
+            #[cfg(feature = "staking")]
+            QueryRequest::Staking(_) => Err(ApiSystemError::InvalidRequest {
+                error: "staking not yet implemented".to_string(),
+            }),
             QueryRequest::Wasm(msg) => {
                 let addr = match msg {
                     WasmQuery::Smart { contract_addr, .. } => contract_addr,

packages/std/src/query.rs

@@ -14,6 +14,8 @@ pub type QueryResult = ApiResult<QueryResponse>;
 #[serde(rename_all = "snake_case")]
 pub enum QueryRequest {
     Bank(BankQuery),
+    #[cfg(feature = "staking")]
+    Staking(StakingRequest),
     Wasm(WasmQuery),
 }
 
@@ -61,3 +63,66 @@ pub struct AllBalanceResponse {
     // Returns all non-zero coins held by this account.
     pub amount: Vec<Coin>,
 }
+
+#[cfg(feature = "staking")]
+pub use staking::{Delegation, DelegationsResponse, StakingRequest, Validator, ValidatorsResponse};
+
+#[cfg(feature = "staking")]
+mod staking {
+    use schemars::JsonSchema;
+    use serde::{Deserialize, Serialize};
+
+    use crate::coins::Coin;
+    use crate::types::HumanAddr;
+
+    #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+    #[serde(rename_all = "snake_case")]
+    pub enum StakingRequest {
+        Validators {},
+        // Delegations will return all delegations by the delegator,
+        // or just those to the given validator (if set)
+        Delegations {
+            delegator: HumanAddr,
+            validator: Option<HumanAddr>,
+        },
+    }
+
+    #[cfg(feature = "staking")]
+    #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+    /// ValidatorsResponse is data format returned from StakingRequest::Validators query
+    pub struct ValidatorsResponse {
+        pub validators: Vec<Validator>,
+    }
+
+    #[cfg(feature = "staking")]
+    #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+    pub struct Validator {
+        pub address: HumanAddr,
+        // rates are denominated in 10^-6 - 1_000_000 (max) = 100%, 10_000 = 1%
+        // TODO: capture this in some Dec type?
+        pub commission: u64,
+        pub max_commission: u64,
+        // what units are these (in terms of time)?
+        pub max_change_rate: u64,
+    }
+
+    #[cfg(feature = "staking")]
+    #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+    #[serde(rename_all = "snake_case")]
+    /// DelegationsResponse is data format returned from StakingRequest::Delegations query
+    pub struct DelegationsResponse {
+        pub delegations: Vec<Delegation>,
+    }
+
+    #[cfg(feature = "staking")]
+    #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+    pub struct Delegation {
+        pub delegator: HumanAddr,
+        pub validator: HumanAddr,
+        pub amount: Coin,
+        pub can_redelegate: bool,
+        // Review this: this is how much we can withdraw
+        pub accumulated_rewards: Coin,
+        // TODO: do we want to expose more info?
+    }
+}