feat: distribution messages

crates/common/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "seda-common"
-version = "0.2.0"
+version = "0.4.0"
 edition = "2021"
 
 [features]

crates/common/src/msgs/data_requests/sudo/mod.rs

@@ -1,24 +1,79 @@
+use crate::types::{Bytes, U128};
+
 pub mod expire_data_requests;
 pub mod remove_requests;
 
 #[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
 #[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
 #[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
-pub struct RemoveDataRequest {
-    pub dr_id: String,
+pub struct DistributionExecutorReward {
+    /// The amount to burn
+    pub amount:   U128,
+    /// The identity to reward.
+    pub identity: String,
 }
 
-impl From<RemoveDataRequest> for crate::msgs::SudoMsg {
-    fn from(value: RemoveDataRequest) -> Self {
-        SudoMsg::RemoveDataRequest(value).into()
-    }
+#[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
+#[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
+#[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
+pub struct DistributionBurn {
+    /// The amount to burn
+    pub amount: U128,
+}
+
+#[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
+#[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
+#[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
+pub struct DistributionSend {
+    /// The address to send the funds to.
+    pub to:     Bytes,
+    /// The amount to send to the address.
+    pub amount: U128,
+}
+
+#[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
+#[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
+#[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
+pub enum DistributionKind {
+    /// For burning funds
+    Burn(DistributionBurn),
+    /// For rewarding an executor
+    ExecutorReward(DistributionExecutorReward),
+    /// For sending the funds to someone
+    Send(DistributionSend),
+}
+
+#[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
+#[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
+#[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
+pub enum DistributionType {
+    TallyReward,
+    ExecutorReward,
+    TimedOut,
+    NoConsensus,
+    RemainderRefund,
+}
+#[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
+#[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
+#[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
+pub struct DistributionMessage {
+    pub kind:  DistributionKind,
+    #[serde(rename = "type")]
+    pub type_: DistributionType,
+}
+
+#[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
+#[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
+#[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
+pub struct DistributionMessages {
+    pub messages:    Vec<DistributionMessage>,
+    pub refund_type: DistributionType,
 }
 
 #[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
 #[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
 #[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
 pub enum SudoMsg {
-    RemoveDataRequest(RemoveDataRequest),
     RemoveDataRequests(remove_requests::Sudo),
     ExpireDataRequests(expire_data_requests::Sudo),
 }

crates/common/src/msgs/data_requests/sudo/remove_requests.rs

@@ -1,10 +1,12 @@
+use std::collections::HashMap;
+
 use super::*;
 
 #[cfg_attr(feature = "cosmwasm", cosmwasm_schema::cw_serde)]
 #[cfg_attr(not(feature = "cosmwasm"), derive(serde::Serialize, Debug, PartialEq))]
 #[cfg_attr(not(feature = "cosmwasm"), serde(rename_all = "snake_case"))]
 pub struct Sudo {
-    pub requests: Vec<RemoveDataRequest>,
+    pub requests: HashMap<String, DistributionMessages>,
 }
 
 impl From<Sudo> for crate::msgs::SudoMsg {

crates/common/src/msgs/data_requests/sudo_tests.rs

@@ -1,23 +1,86 @@
+use std::collections::HashMap;
+
 use serde_json::json;
 
 use super::sudo::*;
-use crate::msgs;
 #[cfg(feature = "cosmwasm")]
 use crate::msgs::assert_json_deser;
 #[cfg(not(feature = "cosmwasm"))]
 use crate::msgs::assert_json_ser;
+use crate::{msgs, types::Bytes};
 
 #[test]
-fn json_remove_request() {
+fn json_remove_requests() {
+    #[cfg(not(feature = "cosmwasm"))]
+    let to: Bytes = "to".to_string();
+    #[cfg(feature = "cosmwasm")]
+    let to: Bytes = "to".as_bytes().into();
+
     let expected_json = json!({
-    "remove_data_request": {
-      "dr_id": "dr_id",
+    "remove_data_requests": {
+        "requests": {
+            "dr_id1": {
+                "messages": [
+                    {
+                        "kind": {
+                            "burn": {
+                                "amount": "100"
+                            }
+                        },
+                        "type": "executor_reward"
+                    },
+                    {
+                        "kind": {
+                            "executor_reward": {
+                                "amount": "100",
+                                "identity": "identity"
+                            }
+                        },
+                        "type": "executor_reward"
+                    },
+                    {
+                        "kind": {
+                            "send": {
+                                "amount": "100",
+                                "to": to
+                            }
+                        },
+                        "type": "executor_reward"
+                    }
+                ],
+                "refund_type": "remainder_refund"
+            },
+        }
     }
     });
-    let msg: msgs::SudoMsg = RemoveDataRequest {
-        dr_id: "dr_id".to_string(),
-    }
-    .into();
+    let mut requests = HashMap::new();
+    requests.insert(
+        "dr_id1".to_string(),
+        DistributionMessages {
+            messages:    vec![
+                DistributionMessage {
+                    kind:  DistributionKind::Burn(DistributionBurn { amount: 100u128.into() }),
+                    type_: DistributionType::ExecutorReward,
+                },
+                DistributionMessage {
+                    kind:  DistributionKind::ExecutorReward(DistributionExecutorReward {
+                        amount:   100u128.into(),
+                        identity: "identity".to_string(),
+                    }),
+                    type_: DistributionType::ExecutorReward,
+                },
+                DistributionMessage {
+                    kind:  DistributionKind::Send(DistributionSend {
+                        amount: 100u128.into(),
+                        to,
+                    }),
+                    type_: DistributionType::ExecutorReward,
+                },
+            ],
+            refund_type: DistributionType::RemainderRefund,
+        },
+    );
+    let msg: msgs::SudoMsg = remove_requests::Sudo { requests }.into();
     #[cfg(not(feature = "cosmwasm"))]
     assert_json_ser(msg, expected_json);
     #[cfg(feature = "cosmwasm")]

crates/common/src/types/hash_self.rs

@@ -40,7 +40,7 @@ impl HashSelf for Vec<u8> {
     }
 }
 
-impl<'a, T> HashSelf for &'a [T]
+impl<T> HashSelf for &[T]
 where
     T: HashSelf,
 {