feat(lst): automatic staking and rebasing (#5191)

Author: benluelo

Cargo.lock

@@ -9,6 +9,7 @@ members = [
   "cosmwasm/ibc-union/app/ucs06-funded-dispatch",
   "cosmwasm/multicall",
   "cosmwasm/lst",
+  "cosmwasm/lst-staker",
 
   "cosmwasm/ibc-union/core",
   "cosmwasm/ibc-union/core/msg",
@@ -390,7 +391,10 @@ ibc-union-msg          = { path = "cosmwasm/ibc-union/core/msg", default-feature
 
 frissitheto = { path = "lib/frissitheto", default-features = false }
 
-access-manager       = { path = "cosmwasm/access-manager", default-features = false }
+access-manager = { path = "cosmwasm/access-manager", default-features = false }
+
+lst = { path = "cosmwasm/lst", default-features = false }
+
 cw-account           = { path = "cosmwasm/cw-account", default-features = false }
 cw-escrow-vault      = { path = "cosmwasm/cw-escrow-vault", default-features = false }
 cw-unionversal-token = { path = "cosmwasm/cw-unionversal-token", default-features = false }

Cargo.toml

@@ -1018,6 +1018,7 @@ _: {
       cw-unionversal-token = crane.buildWasmContract "cosmwasm/cw-unionversal-token" { };
 
       lst = crane.buildWasmContract "cosmwasm/lst" { };
+      lst-staker = crane.buildWasmContract "cosmwasm/lst-staker" { };
 
       access-manager = crane.buildWasmContract "cosmwasm/access-manager" { };
 
@@ -1095,6 +1096,7 @@ _: {
             cw-unionversal-token
             lst
             access-manager
+            lst-staker
             ;
           cosmwasm-scripts =
             {

cosmwasm/cosmwasm.nix

@@ -33,4 +33,5 @@ hex-literal = { workspace = true }
 
 [features]
 default  = []
+library  = []
 schemars = ["dep:schemars"]

cosmwasm/cw-account/Cargo.toml

@@ -1,15 +1,15 @@
 use std::num::NonZeroU32;
 
 use cosmwasm_std::{
-    entry_point, from_json, Addr, CosmosMsg, Deps, DepsMut, Env, Event, MessageInfo, Order,
-    Response, StdError,
+    from_json, to_json_binary, Addr, Binary, CosmosMsg, Deps, DepsMut, Env, Event, MessageInfo,
+    Order, Response, StdError,
 };
 use depolama::{self, StorageExt};
 use frissitheto::{InitStateVersionError, UpgradeError, UpgradeMsg};
 use ucs03_zkgmable::Zkgmable;
 
 use crate::{
-    msg::{ExecuteMsg, InitMsg, MigrateMsg},
+    msg::{ExecuteMsg, InitMsg, MigrateMsg, QueryMsg},
     state::{Admins, Zkgm},
     types::{Admin, LocalAdmin, RemoteAdmin},
 };
@@ -21,27 +21,35 @@ pub mod types;
 #[cfg(test)]
 mod tests;
 
-fn ensure_remote_admin(deps: Deps, info: &MessageInfo, admin: &RemoteAdmin) -> Result<(), Error> {
+pub fn ensure_remote_admin(
+    deps: Deps,
+    info: &MessageInfo,
+    admin: &RemoteAdmin,
+) -> Result<(), ContractError> {
     // for remote admins, first ensure that info.sender is zkgm
     if info.sender
         != deps
             .storage
             .maybe_read_item::<Zkgm>()?
-            .ok_or(Error::ZkgmNotConfigured)?
+            .ok_or(ContractError::ZkgmNotConfigured)?
     {
-        return Err(Error::OnlyZkgm {
+        return Err(ContractError::OnlyZkgm {
             sender: info.sender.clone(),
         });
     }
 
     deps.storage
         .maybe_read::<Admins>(&Admin::Remote(admin.clone()))?
-        .ok_or_else(|| Error::OnlyAdmin {
+        .ok_or_else(|| ContractError::OnlyAdmin {
             sender: Admin::Remote(admin.clone()),
         })
 }
 
-fn ensure_local_admin_or_self(deps: Deps, env: &Env, info: &MessageInfo) -> Result<String, Error> {
+pub fn ensure_local_admin_or_self(
+    deps: Deps,
+    env: &Env,
+    info: &MessageInfo,
+) -> Result<String, ContractError> {
     // allow reentrant calls into this contract
     if info.sender != env.contract.address {
         let local_admin = Admin::Local(LocalAdmin {
@@ -50,7 +58,7 @@ fn ensure_local_admin_or_self(deps: Deps, env: &Env, info: &MessageInfo) -> Resu
 
         deps.storage
             .maybe_read::<Admins>(&local_admin)?
-            .ok_or_else(|| Error::OnlyAdmin {
+            .ok_or_else(|| ContractError::OnlyAdmin {
                 sender: Admin::Local(LocalAdmin {
                     address: info.sender.to_string(),
                 }),
@@ -62,7 +70,7 @@ fn ensure_local_admin_or_self(deps: Deps, env: &Env, info: &MessageInfo) -> Resu
     }
 }
 
-fn init(deps: DepsMut, msg: InitMsg) -> Response {
+pub fn init(deps: DepsMut, msg: InitMsg) -> Response {
     match msg {
         InitMsg::Zkgm {
             zkgm,
@@ -93,25 +101,25 @@ fn init(deps: DepsMut, msg: InitMsg) -> Response {
     Response::default()
 }
 
-#[entry_point]
+#[cfg_attr(not(feature = "library"), cosmwasm_std::entry_point)]
 pub fn instantiate(
     mut deps: DepsMut,
     _: Env,
     _: MessageInfo,
     msg: InitMsg,
-) -> Result<Response, Error> {
+) -> Result<Response, ContractError> {
     frissitheto::init_state_version(&mut deps, const { NonZeroU32::new(1).unwrap() })?;
 
     Ok(init(deps, msg))
 }
 
-#[entry_point]
+#[cfg_attr(not(feature = "library"), cosmwasm_std::entry_point)]
 pub fn execute(
     deps: DepsMut,
     env: Env,
     info: MessageInfo,
     msg: ExecuteMsg,
-) -> Result<Response, Error> {
+) -> Result<Response, ContractError> {
     match msg {
         ExecuteMsg::SetZkgm(zkgm) => {
             let actor = ensure_local_admin_or_self(deps.as_ref(), &env, &info)?;
@@ -155,7 +163,7 @@ pub fn execute(
                 .collect::<Result<Vec<_>, _>>()?
                 .is_empty()
             {
-                Err(Error::OneAdminRequired)
+                Err(ContractError::OneAdminRequired)
             } else {
                 Ok(Response::new().add_events(maybe_event))
             }
@@ -184,16 +192,29 @@ pub fn execute(
                 ]))
                 .add_messages(from_json::<Vec<CosmosMsg>>(&on_zkgm.message)?))
         }
-        ExecuteMsg::Zkgmable(Zkgmable::OnIntentZkgm(_)) => Err(Error::IntentsNotSupported),
+        ExecuteMsg::Zkgmable(Zkgmable::OnIntentZkgm(_)) => Err(ContractError::IntentsNotSupported),
     }
 }
 
-#[entry_point]
+#[cfg_attr(not(feature = "library"), cosmwasm_std::entry_point)]
+pub fn query(deps: Deps, _: Env, msg: QueryMsg) -> Result<Binary, ContractError> {
+    match msg {
+        QueryMsg::Admins {} => Ok(to_json_binary(
+            &deps
+                .storage
+                .iter::<Admins>(Order::Ascending)
+                .map(|r| r.map(|(admin, _)| admin))
+                .collect::<Result<Vec<_>, _>>()?,
+        )?),
+    }
+}
+
+#[cfg_attr(not(feature = "library"), cosmwasm_std::entry_point)]
 pub fn migrate(
     deps: DepsMut,
     _: Env,
     msg: UpgradeMsg<InitMsg, MigrateMsg>,
-) -> Result<Response, Error> {
+) -> Result<Response, ContractError> {
     msg.run(
         deps,
         |deps, init_msg| {
@@ -205,7 +226,7 @@ pub fn migrate(
 }
 
 #[derive(Debug, PartialEq, thiserror::Error)]
-pub enum Error {
+pub enum ContractError {
     #[error(transparent)]
     Std(#[from] StdError),
 
@@ -215,7 +236,7 @@ pub enum Error {
     #[error("init state version error: {0}")]
     InitStateVersion(#[from] InitStateVersionError),
 
-    #[error("sender {sender} is a configured admin")]
+    #[error("sender {sender} is not a configured admin")]
     OnlyAdmin { sender: Admin },
 
     #[error("sender {sender} is not zkgm")]

cosmwasm/cw-account/src/lib.rs

@@ -32,6 +32,12 @@ pub enum ExecuteMsg {
     Zkgmable(Zkgmable),
 }
 
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(deny_unknown_fields, rename_all = "snake_case")]
+pub enum QueryMsg {
+    Admins {},
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(deny_unknown_fields, rename_all = "snake_case")]
 pub struct MigrateMsg {}

cosmwasm/cw-account/src/msg.rs

@@ -133,7 +133,7 @@ fn only_admin() {
             ExecuteMsg::Dispatch(vec![]),
         )
         .unwrap_err(),
-        Error::OnlyAdmin {
+        ContractError::OnlyAdmin {
             sender: Admin::Local(LocalAdmin {
                 address: non_admin.to_string()
             })
@@ -150,7 +150,7 @@ fn only_admin() {
             })),
         )
         .unwrap_err(),
-        Error::OnlyAdmin {
+        ContractError::OnlyAdmin {
             sender: Admin::Local(LocalAdmin {
                 address: non_admin.to_string()
             })
@@ -167,7 +167,7 @@ fn only_admin() {
             })),
         )
         .unwrap_err(),
-        Error::OnlyAdmin {
+        ContractError::OnlyAdmin {
             sender: Admin::Local(LocalAdmin {
                 address: non_admin.to_string()
             })
@@ -182,7 +182,7 @@ fn only_admin() {
             ExecuteMsg::SetZkgm(Addr::unchecked(ZKGM)),
         )
         .unwrap_err(),
-        Error::OnlyAdmin {
+        ContractError::OnlyAdmin {
             sender: Admin::Local(LocalAdmin {
                 address: non_admin.to_string()
             })
@@ -383,7 +383,7 @@ fn require_one_admin() {
             }))
         )
         .unwrap_err(),
-        Error::OneAdminRequired
+        ContractError::OneAdminRequired
     );
 }
 
@@ -411,7 +411,7 @@ fn only_zkgm() {
             })),
         )
         .unwrap_err(),
-        Error::OnlyZkgm {
+        ContractError::OnlyZkgm {
             sender: relayer.clone()
         }
     );
@@ -435,7 +435,7 @@ fn only_zkgm() {
             })),
         )
         .unwrap_err(),
-        Error::OnlyAdmin {
+        ContractError::OnlyAdmin {
             sender: Admin::Remote(RemoteAdmin {
                 address: b"uhoh".into(),
                 channel_id: ChannelId!(1),
@@ -462,7 +462,7 @@ fn only_zkgm() {
             })),
         )
         .unwrap_err(),
-        Error::IntentsNotSupported
+        ContractError::IntentsNotSupported
     );
 }
 
@@ -534,7 +534,7 @@ fn zkgmable_invalid_message() {
 
     assert_eq!(
         res,
-        Error::Std(StdError::parse_err(
+        ContractError::Std(StdError::parse_err(
             "alloc::vec::Vec<cosmwasm_std::results::cosmos_msg::CosmosMsg>",
             "EOF while parsing a JSON value."
         ))
@@ -636,6 +636,6 @@ fn ensure_remote_admin_fails_if_zkgm_not_set() {
             })),
         )
         .unwrap_err(),
-        Error::ZkgmNotConfigured
+        ContractError::ZkgmNotConfigured
     );
 }

cosmwasm/cw-account/src/tests.rs

@@ -0,0 +1,37 @@
+[package]
+name    = "lst-staker"
+version = "0.0.0"
+
+authors      = { workspace = true }
+edition      = { workspace = true }
+license-file = { workspace = true }
+publish      = { workspace = true }
+repository   = { workspace = true }
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[lints]
+workspace = true
+
+[dependencies]
+bincode              = { workspace = true, features = ["derive"] }
+cosmwasm-std         = { workspace = true }
+cw-account           = { workspace = true, features = ["library"] }
+cw-utils             = { version = "2.0" }
+depolama             = { workspace = true, features = ["iterator"] }
+embed-commit         = { workspace = true }
+frissitheto          = { workspace = true }
+lst                  = { workspace = true, features = ["library"] }
+schemars             = { workspace = true, optional = true, features = ["derive"] }
+serde                = { workspace = true, features = ["derive"] }
+thiserror            = { workspace = true }
+unionlabs-encoding   = { workspace = true, features = ["bincode"] }
+unionlabs-primitives = { workspace = true, features = ["bincode"] }
+
+[dev-dependencies]
+hex-literal = { workspace = true }
+
+[features]
+default  = []
+schemars = ["dep:schemars"]