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.

Sign up for GitHub

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

make subscription details immutable #124

Merged
merged 1 commit into from
Mar 7, 2025
Merged

make subscription details immutable #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 19 additions & 20 deletions pallets/idn-manager/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,21 @@ pub type SubscriptionOf<T> =

#[derive(Encode, Decode, Clone, TypeInfo, MaxEncodedLen, Debug)]
pub struct Subscription<AccountId, BlockNumber: Unsigned, Metadata> {
details: SubscriptionDetails<AccountId, BlockNumber, Metadata>,
details: SubscriptionDetails<AccountId, Metadata>,
// Number of random values left to distribute
credits_left: BlockNumber,
state: SubscriptionState,
created_at: BlockNumber,
updated_at: BlockNumber,
credits: BlockNumber,
frequency: BlockNumber,
}

// TODO: details should be immutable, they are what make the subscription unique
// https://github.com/ideal-lab5/idn-sdk/issues/114
#[derive(Encode, Decode, Clone, TypeInfo, MaxEncodedLen, Debug)]
pub struct SubscriptionDetails<AccountId, BlockNumber, Metadata> {
pub struct SubscriptionDetails<AccountId, Metadata> {
subscriber: AccountId,
created_at: BlockNumber,
updated_at: BlockNumber,
credits: BlockNumber,
frequency: BlockNumber,
target: Location,
metadata: Metadata,
}
Expand All @@ -132,8 +132,8 @@ where
{
pub fn id(&self) -> SubscriptionId {
let id_tuple = (
self.created_at,
&self.details.subscriber,
self.details.created_at,
self.details.target.clone(),
self.details.metadata.clone(),
);
Expand Down Expand Up @@ -356,19 +356,15 @@ pub mod pallet {
let sub = maybe_sub.as_mut().ok_or(Error::<T>::SubscriptionDoesNotExist)?;
ensure!(sub.details.subscriber == subscriber, Error::<T>::NotSubscriber);

let fees_diff = T::FeesManager::calculate_diff_fees(&sub.details.credits, &credits);
let fees_diff = T::FeesManager::calculate_diff_fees(&sub.credits, &credits);
let deposit_diff = T::DepositCalculator::calculate_diff_deposit(
sub,
&Subscription {
state: sub.state.clone(),
credits_left: credits,
details: sub.details.clone(),
},
&Subscription { credits, frequency, ..sub.clone() },
);

sub.details.credits = credits;
sub.details.frequency = frequency;
sub.details.updated_at = frame_system::Pallet::<T>::block_number();
sub.credits = credits;
sub.frequency = frequency;
sub.updated_at = frame_system::Pallet::<T>::block_number();

// Hold or refund diff fees
Self::manage_diff_fees(&subscriber, &fees_diff)?;
Expand Down Expand Up @@ -498,15 +494,18 @@ impl<T: Config> Pallet<T> {
let current_block = frame_system::Pallet::<T>::block_number();
let details = SubscriptionDetails {
subscriber: subscriber.clone(),
target: target.clone(),
metadata: metadata.unwrap_or_default(),
};
let subscription = Subscription {
state: SubscriptionState::Active,
credits_left: credits,
details,
created_at: current_block,
updated_at: current_block,
credits,
target: target.clone(),
frequency,
metadata: metadata.unwrap_or_default(),
};
let subscription =
Subscription { state: SubscriptionState::Active, credits_left: credits, details };

Self::hold_deposit(
&subscriber,
Expand Down
17 changes: 13 additions & 4 deletions pallets/idn-manager/src/tests/pallet.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ fn update_subscription(

let subscription = Subscriptions::<Test>::get(sub_id).unwrap();

assert_eq!(subscription.created_at, System::block_number());
assert_eq!(subscription.updated_at, System::block_number());

assert_eq!(subscription.details.subscriber, subscriber);

let original_fees =
Expand All @@ -102,6 +105,9 @@ fn update_subscription(
original_deposit
);

// Advance a block
System::set_block_number(System::block_number() + 1);

assert_ok!(IdnManager::update_subscription(
RuntimeOrigin::signed(subscriber.clone()),
sub_id,
Expand Down Expand Up @@ -135,9 +141,12 @@ fn update_subscription(

let subscription = Subscriptions::<Test>::get(sub_id).unwrap();

assert_eq!(subscription.created_at, System::block_number() - 1);
assert_eq!(subscription.updated_at, System::block_number());

// assert subscription details has been updated
assert_eq!(subscription.details.credits, new_credits);
assert_eq!(subscription.details.frequency, new_frequency);
assert_eq!(subscription.credits, new_credits);
assert_eq!(subscription.frequency, new_frequency);

System::assert_last_event(RuntimeEvent::IdnManager(Event::<Test>::SubscriptionUpdated {
sub_id,
Expand Down Expand Up @@ -179,9 +188,9 @@ fn create_subscription_works() {

// assert that the subscription details are correct
assert_eq!(subscription.details.subscriber, ALICE);
assert_eq!(subscription.details.credits, credits);
assert_eq!(subscription.credits, credits);
assert_eq!(subscription.details.target, target);
assert_eq!(subscription.details.frequency, frequency);
assert_eq!(subscription.frequency, frequency);
assert_eq!(
subscription.details.metadata,
BoundedVec::<u8, SubMetadataLen>::try_from(vec![]).unwrap()
Expand Down