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

Remove shard partial offline state #923

Merged
merged 13 commits into from
Jun 13, 2024
Binary file modified config/subxt/metadata.scale
Binary file not shown.
38 changes: 27 additions & 11 deletions pallets/shards/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ pub mod pallet {
OptionQuery,
>;

#[pallet::storage]
pub type ShardMembersOnline<T: Config> =
StorageMap<_, Blake2_128Concat, ShardId, u16, ValueQuery>;

#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
Expand Down Expand Up @@ -303,8 +307,13 @@ pub mod pallet {
fn member_online(id: &AccountId, _network: NetworkId) {
let Some(shard_id) = MemberShard::<T>::get(id) else { return };
let Some(old_status) = ShardState::<T>::get(shard_id) else { return };
let new_status = old_status.online_member();
ShardState::<T>::insert(shard_id, new_status);
ShardMembersOnline::<T>::mutate(shard_id, |x| *x = x.saturating_plus_one());
match old_status {
ShardStatus::Created | ShardStatus::Committed => {
ShardState::<T>::insert(shard_id, ShardStatus::Offline)
},
_ => (),
}
}

fn member_offline(id: &AccountId, _: NetworkId) -> Weight {
Expand All @@ -317,12 +326,22 @@ pub mod pallet {
let Some(shard_threshold) = ShardThreshold::<T>::get(shard_id) else {
return T::DbWeight::get().reads(3);
};
let total_members = Self::get_shard_members(shard_id).len();
let max_members_offline = total_members.saturating_sub(shard_threshold.into());
let Ok(max_members_offline) = max_members_offline.try_into() else {
return T::DbWeight::get().reads(4);
let mut members_online = ShardMembersOnline::<T>::get(shard_id);
members_online = members_online.saturating_less_one();
ShardMembersOnline::<T>::insert(shard_id, members_online);
let new_status = match old_status {
// if a member goes offline before the group key is submitted,
// then the shard will never go online
ShardStatus::Created | ShardStatus::Committed => ShardStatus::Offline,
ShardStatus::Online => {
if members_online < shard_threshold {
ShardStatus::Offline
} else {
ShardStatus::Online
}
},
_ => old_status,
};
let new_status = old_status.offline_member(max_members_offline);
if matches!(new_status, ShardStatus::Offline)
&& !matches!(old_status, ShardStatus::Offline)
{
Expand All @@ -336,10 +355,7 @@ pub mod pallet {

impl<T: Config> ShardsInterface for Pallet<T> {
fn is_shard_online(shard_id: ShardId) -> bool {
matches!(
ShardState::<T>::get(shard_id),
Some(ShardStatus::Online | ShardStatus::PartialOffline(_))
)
matches!(ShardState::<T>::get(shard_id), Some(ShardStatus::Online))
}

fn is_shard_member(member: &AccountId) -> bool {
Expand Down
22 changes: 0 additions & 22 deletions pallets/shards/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,16 +122,6 @@ fn dkg_times_out() {
});
}

#[test]
fn member_offline_sets_online_shard_partially_offline() {
let shard = shard();
new_test_ext().execute_with(|| {
create_shard(0, &shard, 1);
Shards::member_offline(&shard[0].account_id, ETHEREUM);
assert_eq!(ShardState::<Test>::get(0), Some(ShardStatus::PartialOffline(1)));
});
}

#[test]
fn member_offline_above_threshold_sets_online_shard_offline() {
let shard = shard();
Expand All @@ -141,15 +131,3 @@ fn member_offline_above_threshold_sets_online_shard_offline() {
assert_eq!(ShardState::<Test>::get(0), Some(ShardStatus::Offline));
});
}

#[test]
fn member_online_sets_partially_offline_shard_back_online() {
let shard = shard();
new_test_ext().execute_with(|| {
create_shard(0, &shard, 1);
Shards::member_offline(&shard[0].account_id, ETHEREUM);
assert_eq!(ShardState::<Test>::get(0), Some(ShardStatus::PartialOffline(1)));
Shards::member_online(&shard[0].account_id, ETHEREUM);
assert_eq!(ShardState::<Test>::get(0), Some(ShardStatus::Online));
});
}
43 changes: 0 additions & 43 deletions primitives/src/shard.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ use scale_info::prelude::string::String;
use scale_info::TypeInfo;
#[cfg(feature = "std")]
use serde::{Deserialize, Serialize};
use sp_runtime::traits::{Saturating, Zero};
use sp_std::vec::Vec;
pub type TssPublicKey = [u8; 33];
pub type TssSignature = [u8; 64];
Expand Down Expand Up @@ -55,7 +54,6 @@ pub enum ShardStatus {
Created,
Committed,
Online,
PartialOffline(u16),
Offline,
}

Expand All @@ -65,47 +63,6 @@ impl Default for ShardStatus {
}
}

impl ShardStatus {
pub fn online_member(&self) -> Self {
match self {
ShardStatus::PartialOffline(count) => {
let new_count = count.saturating_less_one();
if new_count.is_zero() {
ShardStatus::Online
} else {
ShardStatus::PartialOffline(new_count)
}
},
ShardStatus::Created | ShardStatus::Committed => ShardStatus::Offline,
_ => *self,
}
}

pub fn offline_member(&self, max: u16) -> Self {
match self {
ShardStatus::PartialOffline(count) => {
let new_count = count.saturating_plus_one();
if new_count > max {
ShardStatus::Offline
} else {
ShardStatus::PartialOffline(new_count)
}
},
// if a member goes offline before the group key is submitted,
// then the shard will never go online
ShardStatus::Created | ShardStatus::Committed => ShardStatus::Offline,
ShardStatus::Online => {
if max.is_zero() {
ShardStatus::Offline
} else {
ShardStatus::PartialOffline(1)
}
},
_ => *self,
}
}
}

#[cfg(feature = "std")]
pub struct TssSigningRequest {
pub request_id: TssId,
Expand Down
4 changes: 2 additions & 2 deletions runtime/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ fn register_unregister_kills_task() {
assert_eq!(Tasks::task_shard(0).unwrap(), 0);
// member unregisters
assert_ok!(Members::unregister_member(RawOrigin::Signed(a.clone()).into(),));
// task still assigned to shard 0
assert_eq!(Tasks::task_shard(0).unwrap(), 0);
// task not assigned to shard 0
assert_eq!(Tasks::task_shard(0), None);
// member unregisters
assert_ok!(Members::unregister_member(RawOrigin::Signed(b.clone()).into(),));
Elections::shard_offline(ETHEREUM, old_shard);
Expand Down
Loading