refactor: 'CustomerUsage' is renamed to 'BucketUsage'

pallets/ddc-clusters/src/cluster.rs

@@ -15,8 +15,8 @@ pub struct Cluster<AccountId> {
 	pub reserve_id: AccountId,
 	pub props: ClusterProps<AccountId>,
 	pub status: ClusterStatus,
-	// todo(yahortsaryk): this should be renamed to `last_paid_era` to eliminate ambiguity,
-	// as the validation step is decoupled from payout step.
+	// todo(yahortsaryk): `last_validated_era_id` should be renamed to `last_paid_era` to eliminate
+	// ambiguity, as the validation step is decoupled from payout step.
 	pub last_validated_era_id: DdcEra,
 }
 

pallets/ddc-customers/src/lib.rs

@@ -19,7 +19,7 @@ use ddc_primitives::{
 		cluster::{ClusterCreator, ClusterProtocol, ClusterQuery},
 		customer::{CustomerCharger, CustomerDepositor, CustomerVisitor},
 	},
-	BucketId, BucketParams, ClusterId, CustomerUsage,
+	BucketId, BucketParams, BucketUsage, ClusterId,
 };
 use frame_support::{
 	parameter_types,
@@ -67,7 +67,9 @@ pub struct Bucket<T: Config> {
 	cluster_id: ClusterId,
 	is_public: bool,
 	is_removed: bool,
-	total_customers_usage: Option<CustomerUsage>,
+	// todo(yahortsaryk): `total_customers_usage` should be renamed to `total_usage` to eliminate
+	// ambiguity, as the bucket owner is the only customer of the bucket who pays for its usage.
+	total_customers_usage: Option<BucketUsage>,
 }
 
 #[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug, TypeInfo)]
@@ -665,7 +667,7 @@ pub mod pallet {
 			cluster_id: &ClusterId,
 			bucket_id: BucketId,
 			content_owner: &T::AccountId,
-		) -> Result<Option<CustomerUsage>, DispatchError> {
+		) -> Result<Option<BucketUsage>, DispatchError> {
 			let bucket = Self::buckets(bucket_id).ok_or(Error::<T>::NoBucketWithId)?;
 			ensure!(bucket.owner_id == *content_owner, Error::<T>::NotBucketOwner);
 			ensure!(bucket.cluster_id == *cluster_id, Error::<T>::ClusterMismatch);
@@ -677,7 +679,7 @@ pub mod pallet {
 			cluster_id: &ClusterId,
 			bucket_id: BucketId,
 			content_owner: T::AccountId,
-			customer_usage: &CustomerUsage,
+			customer_usage: &BucketUsage,
 		) -> DispatchResult {
 			let mut bucket = Self::buckets(bucket_id).ok_or(Error::<T>::NoBucketWithId)?;
 			ensure!(bucket.owner_id == content_owner, Error::<T>::NotBucketOwner);
@@ -691,7 +693,7 @@ pub mod pallet {
 					total_customers_usage.number_of_gets += customer_usage.number_of_gets;
 				},
 				None => {
-					bucket.total_customers_usage = Some(CustomerUsage {
+					bucket.total_customers_usage = Some(BucketUsage {
 						transferred_bytes: customer_usage.transferred_bytes,
 						stored_bytes: customer_usage.stored_bytes,
 						number_of_puts: customer_usage.number_of_puts,
@@ -730,7 +732,7 @@ pub mod pallet {
 			bucket_id: BucketId,
 			content_owner: T::AccountId,
 			billing_vault: T::AccountId,
-			customer_usage: &CustomerUsage,
+			customer_usage: &BucketUsage,
 			amount: u128,
 		) -> Result<u128, DispatchError> {
 			let actually_charged: BalanceOf<T>;

pallets/ddc-customers/src/migration.rs

@@ -162,7 +162,7 @@ pub mod v2 {
 		cluster_id: ClusterId,
 		is_public: bool,
 		is_removed: bool,
-		total_customers_usage: Option<CustomerUsage>, // new field
+		total_customers_usage: Option<BucketUsage>, // new field
 	}
 
 	#[storage_alias]

pallets/ddc-customers/src/tests.rs

@@ -182,7 +182,7 @@ fn charge_content_owner_works() {
 		let bucket_id2: BucketId = 2;
 		let cluster_id = ClusterId::from([1; 20]);
 		let bucket_1_params = BucketParams { is_public: false };
-		let customer_usage = CustomerUsage {
+		let customer_usage = BucketUsage {
 			transferred_bytes: 1,
 			stored_bytes: 2,
 			number_of_puts: 3,

pallets/ddc-payouts/src/lib.rs

@@ -29,9 +29,9 @@ use ddc_primitives::{
 		customer::CustomerCharger as CustomerChargerType, node::NodeManager,
 		pallet::PalletVisitor as PalletVisitorType, payout::PayoutProcessor,
 	},
-	BatchIndex, BucketId, ClusterId, CustomerCharge, CustomerUsage, DdcEra, MMRProof, NodePubKey,
-	NodeReward, NodeUsage, PayoutError, PayoutState, MAX_PAYOUT_BATCH_COUNT, MAX_PAYOUT_BATCH_SIZE,
-	MILLICENTS,
+	BatchIndex, BucketId, BucketUsage, ClusterId, CustomerCharge, DdcEra, MMRProof, NodePubKey,
+	NodeUsage, PayoutError, PayoutState, ProviderReward, MAX_PAYOUT_BATCH_COUNT,
+	MAX_PAYOUT_BATCH_SIZE, MILLICENTS,
 };
 use frame_election_provider_support::SortedListProvider;
 use frame_support::{
@@ -392,8 +392,8 @@ pub mod pallet {
 		node_usage: &NodeUsage,
 		total_nodes_usage: &NodeUsage,
 		total_customer_charge: &CustomerCharge,
-	) -> Option<NodeReward> {
-		let mut node_reward = NodeReward::default();
+	) -> Option<ProviderReward> {
+		let mut node_reward = ProviderReward::default();
 
 		let mut ratio = Perquintill::from_rational(
 			node_usage.transferred_bytes as u128,
@@ -422,7 +422,7 @@ pub mod pallet {
 
 	fn get_customer_charge<T: Config>(
 		cluster_id: &ClusterId,
-		usage: &CustomerUsage,
+		usage: &BucketUsage,
 		bucket_id: BucketId,
 		customer_id: &T::AccountId,
 		start_era: i64,
@@ -609,7 +609,7 @@ pub mod pallet {
 			cluster_id: ClusterId,
 			era: DdcEra,
 			batch_index: BatchIndex,
-			payers: &[(NodePubKey, BucketId, CustomerUsage)],
+			payers: &[(NodePubKey, BucketId, BucketUsage)],
 			batch_proof: MMRProof,
 		) -> DispatchResult {
 			ensure!(

pallets/ddc-payouts/src/mock.rs

@@ -207,7 +207,7 @@ where
 		_era: DdcEra,
 		_batch_index: BatchIndex,
 		_max_batch_index: BatchIndex,
-		_payers: &[(NodePubKey, BucketId, CustomerUsage)],
+		_payers: &[(NodePubKey, BucketId, BucketUsage)],
 		_batch_proof: &MMRProof,
 	) -> bool {
 		true
@@ -258,15 +258,15 @@ where
 		_cluster_id: &ClusterId,
 		_bucket_id: BucketId,
 		_content_owner: &T::AccountId,
-	) -> Result<Option<CustomerUsage>, DispatchError> {
+	) -> Result<Option<BucketUsage>, DispatchError> {
 		Ok(None)
 	}
 
 	fn inc_total_bucket_usage(
 		_cluster_id: &ClusterId,
 		_bucket_id: BucketId,
 		_content_owner: T::AccountId,
-		_customer_usage: &CustomerUsage,
+		_customer_usage: &BucketUsage,
 	) -> DispatchResult {
 		unimplemented!()
 	}
@@ -292,7 +292,7 @@ where
 		_bucket_id: BucketId,
 		content_owner: T::AccountId,
 		billing_vault: T::AccountId,
-		_customer_usage: &CustomerUsage,
+		_customer_usage: &BucketUsage,
 		amount: u128,
 	) -> Result<u128, DispatchError> {
 		let mut amount_to_charge = amount;