Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce VirtualStakingMock #149

Merged
merged 6 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/basic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ jobs:
with:
toolchain: 1.70.0
command: wasm
args: --workspace --exclude mesh-virtual-staking-mock
env:
RUSTFLAGS: "-C link-arg=-s"

Expand Down
13 changes: 13 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ repository = "https://github.com/osmosis-labs/mesh-security"
mesh-apis = { path = "./packages/apis" }
mesh-bindings = { path = "./packages/bindings" }
mesh-sync = { path = "./packages/sync" }
mesh-virtual-staking-mock = { path = "./packages/virtual-staking-mock" }

mesh-vault = { path = "./contracts/provider/vault" }
mesh-external-staking = { path = "./contracts/provider/external-staking" }
Expand Down
3 changes: 3 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
ignore:
# this is a mock for testing - worrying about it being tested itself is a bit much
- "packages/virtual-staking-mock"
2 changes: 1 addition & 1 deletion packages/bindings/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "mesh-bindings"
version = { workspace = true }
edition = { workspace = true }
license = { workspace = true }
license = { workspace = true }

[dependencies]
cosmwasm-std = { workspace = true }
Expand Down
16 changes: 16 additions & 0 deletions packages/virtual-staking-mock/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[package]
name = "mesh-virtual-staking-mock"
edition.workspace = true
version.workspace = true
license.workspace = true
repository.workspace = true
publish = false

[dependencies]
anyhow = { workspace = true }
cosmwasm-std = { workspace = true }
cw-multi-test = { workspace = true }
cw-storage-plus = { workspace = true }
mesh-bindings = { workspace = true }
schemars = { workspace = true }
serde = { workspace = true }
188 changes: 188 additions & 0 deletions packages/virtual-staking-mock/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
use anyhow::Result as AnyResult;
use cosmwasm_std::{
coin,
testing::{MockApi, MockStorage},
to_binary, Addr, Api, Binary, BlockInfo, CustomQuery, Empty, Querier, QuerierWrapper, Storage,
Uint128,
};
use cw_multi_test::{AppResponse, BankKeeper, Module, WasmKeeper};
use cw_storage_plus::{Item, Map};
use mesh_bindings::{
BondStatusResponse, SlashRatioResponse, VirtualStakeCustomMsg, VirtualStakeCustomQuery,
};
use schemars::JsonSchema;
use serde::de::DeserializeOwned;

pub type App = cw_multi_test::App<
BankKeeper,
MockApi,
MockStorage,
VirtualStakingModule,
WasmKeeper<VirtualStakeCustomMsg, VirtualStakeCustomQuery>,
>;

pub struct VirtualStakingModule {
/// virtual-staking contract -> max cap
caps: Map<'static, Addr, Uint128>,
/// (virtual-staking contract, validator) -> bonded amount
bonds: Map<'static, (Addr, Addr), Uint128>,
slash_ratio: Item<'static, SlashRatioResponse>,
}

impl VirtualStakingModule {
pub fn new() -> Self {
Self {
caps: Map::new("virtual_staking_caps"),
bonds: Map::new("virtual_staking_bonds"),
slash_ratio: Item::new("virtual_staking_slash_ratios"),
}
}

pub fn init_slash_ratios(
&self,
storage: &mut dyn Storage,
slash_for_downtime: impl Into<String>,
slash_for_double_sign: impl Into<String>,
) -> AnyResult<()> {
self.slash_ratio.save(
storage,
&SlashRatioResponse {
slash_fraction_downtime: slash_for_downtime.into(),
slash_fraction_double_sign: slash_for_double_sign.into(),
},
)?;

Ok(())
}

fn bonded_for_contract(&self, storage: &dyn Storage, contract: Addr) -> AnyResult<Uint128> {
Ok(self
.bonds
.range(storage, None, None, cosmwasm_std::Order::Ascending)
.collect::<Result<Vec<_>, _>>()?
.into_iter()
.filter_map(|((c, _), amt)| if c == contract { Some(amt) } else { None })
.sum())
}
}

impl Default for VirtualStakingModule {
fn default() -> Self {
Self::new()
}
}

impl Module for VirtualStakingModule {
type ExecT = VirtualStakeCustomMsg;

type QueryT = VirtualStakeCustomQuery;

type SudoT = Empty;

fn execute<ExecC, QueryC>(
&self,
_api: &dyn Api,
storage: &mut dyn Storage,
_router: &dyn cw_multi_test::CosmosRouter<ExecC = ExecC, QueryC = QueryC>,
_block: &BlockInfo,
sender: Addr,
msg: Self::ExecT,
) -> AnyResult<cw_multi_test::AppResponse>
where
ExecC: std::fmt::Debug + Clone + PartialEq + JsonSchema + DeserializeOwned + 'static,
QueryC: CustomQuery + DeserializeOwned + 'static,
{
let VirtualStakeCustomMsg::VirtualStake(msg) = msg;

let cap = self.caps.load(storage, sender.clone())?;

match msg {
mesh_bindings::VirtualStakeMsg::Bond { amount, validator } => {
let all_bonded = self.bonded_for_contract(storage, sender.clone())?;

if all_bonded + amount.amount <= cap {
let current_bonded = self
.bonds
.may_load(storage, (sender.clone(), Addr::unchecked(&validator)))?
.unwrap_or(Uint128::zero());

self.bonds.save(
storage,
(sender, Addr::unchecked(validator)),
&(current_bonded + amount.amount),
)?;

Ok(AppResponse::default())
} else {
Err(anyhow::anyhow!("cap exceeded"))
}
}
mesh_bindings::VirtualStakeMsg::Unbond { amount, validator } => {
let current_bonded = self
.bonds
.may_load(storage, (sender.clone(), Addr::unchecked(&validator)))?
.unwrap_or(Uint128::zero());

if current_bonded - amount.amount >= Uint128::zero() {
self.bonds.save(
storage,
(sender, Addr::unchecked(validator)),
&(current_bonded - amount.amount),
)?;

Ok(AppResponse::default())
} else {
Err(anyhow::anyhow!("bonded amount exceeded"))
}
}
}
}

fn sudo<ExecC, QueryC>(
&self,
_api: &dyn Api,
_storage: &mut dyn Storage,
_router: &dyn cw_multi_test::CosmosRouter<ExecC = ExecC, QueryC = QueryC>,
_block: &BlockInfo,
_msg: Self::SudoT,
) -> AnyResult<cw_multi_test::AppResponse>
where
ExecC: std::fmt::Debug + Clone + PartialEq + JsonSchema + DeserializeOwned + 'static,
QueryC: CustomQuery + DeserializeOwned + 'static,
{
Err(anyhow::anyhow!(
"sudo not implemented for the virtual staking module"
))
}

fn query(
&self,
_api: &dyn Api,
storage: &dyn Storage,
querier: &dyn Querier,
_block: &BlockInfo,
request: Self::QueryT,
) -> AnyResult<Binary> {
let VirtualStakeCustomQuery::VirtualStake(query) = request;

let result = match query {
mesh_bindings::VirtualStakeQuery::BondStatus { contract } => {
let denom =
QuerierWrapper::<VirtualStakeCustomQuery>::new(querier).query_bonded_denom()?;

let cap = self.caps.load(storage, Addr::unchecked(&contract))?;
let bonded = self.bonded_for_contract(storage, Addr::unchecked(contract))?;

to_binary(&BondStatusResponse {
cap: coin(cap.u128(), &denom),
delegated: coin(bonded.u128(), denom),
})?
}
mesh_bindings::VirtualStakeQuery::SlashRatio {} => {
to_binary(&self.slash_ratio.load(storage)?)?
}
};

Ok(to_binary(&result)?)
}
}