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

Jump to bottom

fix: 🐛 change update_x_payment_stream functions to not error out if user is insolvent #273

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+209 −215
Open

fix: 🐛 change update_x_payment_stream functions to not error out if user is insolvent #273

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
294 changes: 143 additions & 151 deletions pallets/file-system/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6839,157 +6839,6 @@ mod delete_file_and_pending_deletions_tests {
.any(|x| *x == (file_key, Some(TrieRemoveMutation))),);
});
}

#[test]
fn delete_file_expired_pending_file_deletion_request_with_insolvent_user() {
new_test_ext().execute_with(|| {
let owner_account_id = Keyring::Alice.to_account_id();
let owner_signed = RuntimeOrigin::signed(owner_account_id.clone());
let msp = Keyring::Charlie.to_account_id();
let location = FileLocation::<Test>::try_from(b"test".to_vec()).unwrap();
let size = 4;
let file_content = b"test".to_vec();
let fingerprint = BlakeTwo256::hash(&file_content);
let peer_id = BoundedVec::try_from(vec![1]).unwrap();
let peer_ids: PeerIds<Test> = BoundedVec::try_from(vec![peer_id]).unwrap();

let (msp_id, _) = add_msp_to_provider_storage(&msp);

// Create a new value proposition with a high price per gigabyte per tick so deleting the 4 byte file will
// actually make a difference in the rate of the fixed-rate payment stream between the user and the MSP.
let value_prop = ValueProposition::<Test>::new(1024 * 1024 * 1024, bounded_vec![], 10000);
let value_prop_id = value_prop.derive_id();
pallet_storage_providers::MainStorageProviderIdsToValuePropositions::<Test>::insert(
msp_id,
value_prop_id,
value_prop,
);

let name = BoundedVec::try_from(b"bucket".to_vec()).unwrap();
let bucket_id = create_bucket(&owner_account_id.clone(), name, msp_id, value_prop_id);

let file_key = FileSystem::compute_file_key(
owner_account_id.clone(),
bucket_id,
location.clone(),
size,
fingerprint,
);

// Issue storage request
assert_ok!(FileSystem::issue_storage_request(
owner_signed.clone(),
bucket_id,
location.clone(),
fingerprint,
size,
Some(msp_id),
peer_ids,
));

// Dispatch MSP confirm storing.
assert_ok!(FileSystem::msp_respond_storage_requests_multiple_buckets(
RuntimeOrigin::signed(msp.clone()),
bounded_vec![StorageRequestMspBucketResponse {
bucket_id,
accept: Some(StorageRequestMspAcceptedFileKeys {
file_keys_and_proofs: bounded_vec![FileKeyWithProof {
file_key,
proof: CompactProof {
encoded_nodes: vec![H256::default().as_ref().to_vec()],
}
}],
non_inclusion_forest_proof: CompactProof {
encoded_nodes: vec![H256::default().as_ref().to_vec()],
},
}),
reject: bounded_vec![],
}],
));

// Delete file
assert_ok!(FileSystem::delete_file(
owner_signed.clone(),
bucket_id,
file_key,
location,
size,
fingerprint,
None,
));

// Assert that the correct event was deposited
System::assert_last_event(
Event::FileDeletionRequest {
user: owner_account_id.clone(),
file_key,
bucket_id,
msp_id: Some(msp_id),
proof_of_inclusion: false,
}
.into(),
);

// Assert that the pending file deletion request was added to storage
assert_eq!(
file_system::PendingFileDeletionRequests::<Test>::get(owner_account_id.clone()),
BoundedVec::<_, <Test as file_system::Config>::MaxUserPendingDeletionRequests>::try_from(
vec![(file_key, bucket_id)]
)
.unwrap()
);

let pending_file_deletion_request_ttl: u32 =
PendingFileDeletionRequestTtl::<Test>::get();
let pending_file_deletion_request_ttl: BlockNumberFor<Test> =
pending_file_deletion_request_ttl.into();
let expiration_block = pending_file_deletion_request_ttl + System::block_number();

// Assert that the pending file deletion request was added to storage
assert_eq!(
file_system::FileDeletionRequestExpirations::<Test>::get(expiration_block),
vec![FileDeletionRequestExpirationItem {
user: owner_account_id.clone(),
file_key,
bucket_id,
file_size: size,
}]
);

pallet_payment_streams::UsersWithoutFunds::<Test>::insert(owner_account_id.clone(), System::block_number());

// Roll past the expiration block
roll_to(pending_file_deletion_request_ttl + 1);

// Item expiration should be removed
assert_eq!(
file_system::FileDeletionRequestExpirations::<Test>::get(expiration_block),
vec![]
);

// Assert that the pending file deletion request was removed from storage
assert_eq!(
file_system::PendingFileDeletionRequests::<Test>::get(owner_account_id.clone()),
BoundedVec::<_, <Test as file_system::Config>::MaxUserPendingDeletionRequests>::default()
);

// Assert that the bucket size was not decreased because the user was marked without funds
System::assert_has_event(Event::FailedToDecreaseBucketSize {
user: owner_account_id.clone(),
bucket_id,
file_key,
file_size: size,
error: pallet_payment_streams::Error::<Test>::UserWithoutFunds.into(),
}.into());

// Assert that there is a queued priority challenge for file key in proofs dealer pallet
// Since failing to update the payment stream from decreasing the bucket size is purely an operation between the MSP and the user,
// we proceed to delete the files from the BSPs.
assert!(pallet_proofs_dealer::PriorityChallengesQueue::<Test>::get()
.iter()
.any(|x| *x == (file_key, Some(TrieRemoveMutation))),);
});
}
}

mod success {
Expand Down Expand Up @@ -7393,6 +7242,149 @@ mod delete_file_and_pending_deletions_tests {
);
});
}

#[test]
fn delete_file_expired_pending_file_deletion_request_with_insolvent_user() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice test!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It's just the previous test with some changes hehe

new_test_ext().execute_with(|| {
let owner_account_id = Keyring::Alice.to_account_id();
let owner_signed = RuntimeOrigin::signed(owner_account_id.clone());
let msp = Keyring::Charlie.to_account_id();
let location = FileLocation::<Test>::try_from(b"test".to_vec()).unwrap();
let size = 4;
let file_content = b"test".to_vec();
let fingerprint = BlakeTwo256::hash(&file_content);
let peer_id = BoundedVec::try_from(vec![1]).unwrap();
let peer_ids: PeerIds<Test> = BoundedVec::try_from(vec![peer_id]).unwrap();

let (msp_id, _) = add_msp_to_provider_storage(&msp);

// Create a new value proposition with a high price per gigabyte per tick so deleting the 4 byte file will
// actually make a difference in the rate of the fixed-rate payment stream between the user and the MSP.
let value_prop = ValueProposition::<Test>::new(1024 * 1024 * 1024, bounded_vec![], 10000);
let value_prop_id = value_prop.derive_id();
pallet_storage_providers::MainStorageProviderIdsToValuePropositions::<Test>::insert(
msp_id,
value_prop_id,
value_prop,
);

let name = BoundedVec::try_from(b"bucket".to_vec()).unwrap();
let bucket_id = create_bucket(&owner_account_id.clone(), name, msp_id, value_prop_id);

let file_key = FileSystem::compute_file_key(
owner_account_id.clone(),
bucket_id,
location.clone(),
size,
fingerprint,
);

// Issue storage request
assert_ok!(FileSystem::issue_storage_request(
owner_signed.clone(),
bucket_id,
location.clone(),
fingerprint,
size,
Some(msp_id),
peer_ids,
));

// Dispatch MSP confirm storing.
assert_ok!(FileSystem::msp_respond_storage_requests_multiple_buckets(
RuntimeOrigin::signed(msp.clone()),
bounded_vec![StorageRequestMspBucketResponse {
bucket_id,
accept: Some(StorageRequestMspAcceptedFileKeys {
file_keys_and_proofs: bounded_vec![FileKeyWithProof {
file_key,
proof: CompactProof {
encoded_nodes: vec![H256::default().as_ref().to_vec()],
}
}],
non_inclusion_forest_proof: CompactProof {
encoded_nodes: vec![H256::default().as_ref().to_vec()],
},
}),
reject: bounded_vec![],
}],
));

// Delete file
assert_ok!(FileSystem::delete_file(
owner_signed.clone(),
bucket_id,
file_key,
location,
size,
fingerprint,
None,
));

// Assert that the correct event was deposited
System::assert_last_event(
Event::FileDeletionRequest {
user: owner_account_id.clone(),
file_key,
bucket_id,
msp_id: Some(msp_id),
proof_of_inclusion: false,
}
.into(),
);

// Assert that the pending file deletion request was added to storage
assert_eq!(
file_system::PendingFileDeletionRequests::<Test>::get(owner_account_id.clone()),
BoundedVec::<_, <Test as file_system::Config>::MaxUserPendingDeletionRequests>::try_from(
vec![(file_key, bucket_id)]
)
.unwrap()
);

let pending_file_deletion_request_ttl: u32 =
PendingFileDeletionRequestTtl::<Test>::get();
let pending_file_deletion_request_ttl: BlockNumberFor<Test> =
pending_file_deletion_request_ttl.into();
let expiration_block = pending_file_deletion_request_ttl + System::block_number();

// Assert that the pending file deletion request was added to storage
assert_eq!(
file_system::FileDeletionRequestExpirations::<Test>::get(expiration_block),
vec![FileDeletionRequestExpirationItem {
user: owner_account_id.clone(),
file_key,
bucket_id,
file_size: size,
}]
);

pallet_payment_streams::UsersWithoutFunds::<Test>::insert(owner_account_id.clone(), System::block_number());

// Roll past the expiration block
roll_to(pending_file_deletion_request_ttl + 1);

// Item expiration should be removed
assert_eq!(
file_system::FileDeletionRequestExpirations::<Test>::get(expiration_block),
vec![]
);

// Assert that the pending file deletion request was removed from storage
assert_eq!(
file_system::PendingFileDeletionRequests::<Test>::get(owner_account_id.clone()),
BoundedVec::<_, <Test as file_system::Config>::MaxUserPendingDeletionRequests>::default()
);

// Assert that the payment stream was correctly deleted since the user is without funds
assert!(pallet_payment_streams::FixedRatePaymentStreams::<Test>::get(msp_id, owner_account_id.clone()).is_none());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how did the payment stream get automatically deleted?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea is that when a provider tries to charge a user that is deemed as without funds, the manage_user_without_funds logic gets executed, which basically charges the debt of the payment stream from the user deposit and then clears it. After this, the provider is free to delete without penalty any files from the user since the runtime knows that it is not getting paid for them


// Assert that there is a queued priority challenge for file key in proofs dealer pallet
assert!(pallet_proofs_dealer::PriorityChallengesQueue::<Test>::get()
.iter()
.any(|x| *x == (file_key, Some(TrieRemoveMutation))),);
});
}
}
}

Expand Down
22 changes: 14 additions & 8 deletions pallets/payment-streams/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,8 @@ mod fixed_rate_streams {
/// This module holds the tests for updating a payment stream (right now, only the rate can be updated)
mod update_stream {

use crate::FixedRatePaymentStreams;

use super::*;

#[test]
Expand Down Expand Up @@ -539,7 +541,7 @@ mod fixed_rate_streams {
}

#[test]
fn update_payment_stream_fails_if_user_is_flagged_as_without_funds() {
fn update_payment_stream_deletes_payment_stream_if_user_is_flagged_as_without_funds() {
ExtBuilder::build().execute_with(|| {
let alice: AccountId = 0;
let bob: AccountId = 1;
Expand Down Expand Up @@ -604,14 +606,16 @@ mod fixed_rate_streams {

// Try to update the rate of the payment stream from Bob to Charlie to 20 units per block
let new_rate: BalanceOf<Test> = 20;
assert_noop!(
assert_ok!(
<PaymentStreams as PaymentStreamsInterface>::update_fixed_rate_payment_stream(
&charlie_msp_id,
&bob,
new_rate
),
Error::<Test>::UserWithoutFunds
)
);

// Check that the payment stream from Bob to Charlie was deleted
assert!(FixedRatePaymentStreams::<Test>::get(&charlie_msp_id, &bob).is_none());
});
}

Expand Down Expand Up @@ -2953,7 +2957,7 @@ mod dynamic_rate_streams {
}

#[test]
fn update_payment_stream_fails_if_user_is_flagged_as_without_funds() {
fn update_payment_stream_deletes_payment_stream_if_user_is_flagged_as_without_funds() {
ExtBuilder::build().execute_with(|| {
let alice: AccountId = 0;
let bob: AccountId = 1;
Expand Down Expand Up @@ -3039,14 +3043,16 @@ mod dynamic_rate_streams {

// Try to update the amount provided of the payment stream from Bob to Charlie to 200 units
let new_amount_provided = 200;
assert_noop!(
assert_ok!(
<PaymentStreams as PaymentStreamsInterface>::update_dynamic_rate_payment_stream(
&charlie_bsp_id,
&bob,
&new_amount_provided,
),
Error::<Test>::UserWithoutFunds
)
);

// Check that the payment stream from Bob to Charlie was deleted
assert!(DynamicRatePaymentStreams::<Test>::get(&charlie_bsp_id, &bob).is_none());
});
}

Expand Down
Loading
Loading