chore: add extrinsic to update credits rate (#1007)

Author: 1xstj

Cargo.lock

@@ -145,6 +145,9 @@ pub mod pallet {
 		#[pallet::constant]
 		type MaxStakeTiers: Get<u32>;
 
+		/// Type for the origin that is allowed to update stake tiers.
+		type ForceOrigin: frame_support::traits::EnsureOrigin<Self::RuntimeOrigin>;
+
 		/// The weight information for the pallet.
 		type WeightInfo: WeightInfo;
 	}
@@ -202,20 +205,22 @@ pub mod pallet {
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
 	pub enum Event<T: Config> {
 		/// TNT tokens were successfully burned, granting potential off-chain credits.
-		/// \[who, tnt_burned, credits_granted]
+		/// Credits granted = amount_burned * conversion_rate.
+		/// [who, amount_burned, credits_granted, offchain_account_id]
 		CreditsGrantedFromBurn {
 			who: T::AccountId,
 			tnt_burned: BalanceOf<T>,
 			credits_granted: BalanceOf<T>,
 		},
-		/// A user successfully claimed credits, emitting details for off-chain processing.
-		/// The amount is the value requested by the user, verified against the claimable window.
-		/// \[who, amount_claimed, offchain_account_id]
+		/// Credits were claimed from staking rewards, within the allowed window.
+		/// [who, amount_claimed, offchain_account_id]
 		CreditsClaimed {
 			who: T::AccountId,
 			amount_claimed: BalanceOf<T>,
 			offchain_account_id: OffchainAccountIdOf<T>,
 		},
+		/// Stake tiers were updated.
+		StakeTiersUpdated,
 	}
 
 	// --- Errors ---
@@ -225,16 +230,20 @@ pub mod pallet {
 		InsufficientTntBalance,
 		/// The requested claim amount exceeds the maximum calculated within the allowed window.
 		ClaimAmountExceedsWindowAllowance,
-		/// The provided off-chain account ID exceeds the maximum allowed length.
-		OffchainAccountIdTooLong,
-		/// An arithmetic operation resulted in an overflow.
-		Overflow,
-		/// No staking tiers are configured in the runtime.
-		NoStakeTiersConfigured,
+		/// Invalid claim ID (e.g., too long).
+		InvalidClaimId,
+		/// No stake tiers are configured or the stake amount is below the lowest tier threshold.
+		NoValidTier,
 		/// Amount specified for burn or claim must be greater than zero.
 		AmountZero,
 		/// Cannot transfer burned tokens to target account (feature not fully implemented).
 		BurnTransferNotImplemented,
+		/// The stake tiers are not properly sorted by threshold.
+		StakeTiersNotSorted,
+		/// There are no stake tiers provided for the update.
+		EmptyStakeTiers,
+		/// Amount overflowed.
+		Overflow,
 	}
 
 	#[pallet::call]
@@ -279,7 +288,7 @@ pub mod pallet {
 			ensure!(amount_to_claim > Zero::zero(), Error::<T>::AmountZero);
 			ensure!(
 				offchain_account_id.len() <= T::MaxOffchainAccountIdLength::get() as usize,
-				Error::<T>::OffchainAccountIdTooLong
+				Error::<T>::InvalidClaimId
 			);
 
 			let current_block = frame_system::Pallet::<T>::block_number();
@@ -302,6 +311,50 @@ pub mod pallet {
 			});
 			Ok(())
 		}
+
+		/// Update the stake tiers. This function can only be called by the configured ForceOrigin.
+		/// Stake tiers must be provided in ascending order by threshold.
+		///
+		/// Parameters:
+		/// - `origin`: Must be the ForceOrigin
+		/// - `new_tiers`: A vector of StakeTier structs representing the new tiers configuration
+		///
+		/// Emits `StakeTiersUpdated` on success.
+		///
+		/// Weight: O(n) where n is the number of tiers
+		#[pallet::call_index(2)]
+		#[pallet::weight(T::WeightInfo::burn())]
+		pub fn set_stake_tiers(
+			origin: OriginFor<T>,
+			new_tiers: Vec<StakeTier<BalanceOf<T>>>,
+		) -> DispatchResult {
+			// Ensure the call is from the configured ForceOrigin
+			T::ForceOrigin::ensure_origin(origin)?;
+
+			// Check that we have at least one tier
+			ensure!(!new_tiers.is_empty(), Error::<T>::EmptyStakeTiers);
+
+			// Ensure tiers are properly sorted by threshold in ascending order
+			for i in 1..new_tiers.len() {
+				ensure!(
+					new_tiers[i - 1].threshold <= new_tiers[i].threshold,
+					Error::<T>::StakeTiersNotSorted
+				);
+			}
+
+			// Try to create a bounded vector
+			let bounded_tiers =
+				BoundedVec::<StakeTier<BalanceOf<T>>, T::MaxStakeTiers>::try_from(new_tiers)
+					.map_err(|_| Error::<T>::EmptyStakeTiers)?; // Reusing error since we don't have a specific one for exceeding max tiers
+
+			// Update storage
+			StoredStakeTiers::<T>::set(bounded_tiers);
+
+			// Emit event
+			Self::deposit_event(Event::<T>::StakeTiersUpdated);
+
+			Ok(())
+		}
 	}
 
 	impl<T: Config> Pallet<T> {

pallets/credits/src/lib.rs

@@ -557,6 +557,7 @@ impl pallet_credits::Config for Runtime {
 	type CreditBurnRecipient = CreditBurnRecipient;
 	type MaxOffchainAccountIdLength = ConstU32<100>;
 	type MaxStakeTiers = MaxStakeTiers;
+	type ForceOrigin = frame_system::EnsureRoot<AccountId>;
 	type WeightInfo = ();
 }
 

pallets/credits/src/mock.rs

@@ -575,3 +575,93 @@ fn burn_and_claim_interact_correctly_via_last_update_block() {
 		assert_eq!(last_reward_update(user), 150);
 	});
 }
+
+#[test]
+fn set_stake_tiers_works() {
+	new_test_ext(vec![]).execute_with(|| {
+		// Get initial stake tiers
+		let initial_tiers = CreditsPallet::<Runtime>::stake_tiers();
+		assert_eq!(initial_tiers.len(), 3, "Should have 3 initial tiers");
+
+		// Create new stake tiers
+		let new_tiers = vec![
+			StakeTier { threshold: 100, rate_per_block: 2 },
+			StakeTier { threshold: 500, rate_per_block: 10 },
+			StakeTier { threshold: 2000, rate_per_block: 25 },
+			StakeTier { threshold: 10000, rate_per_block: 100 },
+		];
+
+		// Verify non-root origin is rejected
+		assert_noop!(
+			CreditsPallet::<Runtime>::set_stake_tiers(
+				RuntimeOrigin::signed(ALICE),
+				new_tiers.clone()
+			),
+			frame_support::error::BadOrigin,
+		);
+
+		// Verify empty tiers list is rejected
+		assert_noop!(
+			CreditsPallet::<Runtime>::set_stake_tiers(RuntimeOrigin::root(), vec![]),
+			Error::<Runtime>::EmptyStakeTiers,
+		);
+
+		// Verify unsorted tiers are rejected
+		let unsorted_tiers = vec![
+			StakeTier { threshold: 500, rate_per_block: 10 },
+			StakeTier {
+				threshold: 100, // This is less than the previous tier threshold
+				rate_per_block: 2,
+			},
+		];
+		assert_noop!(
+			CreditsPallet::<Runtime>::set_stake_tiers(RuntimeOrigin::root(), unsorted_tiers),
+			Error::<Runtime>::StakeTiersNotSorted,
+		);
+
+		// Update stake tiers with root origin
+		let set_tiers_call =
+			CreditsPallet::<Runtime>::set_stake_tiers(RuntimeOrigin::root(), new_tiers.clone());
+		assert_ok!(set_tiers_call);
+
+		// Verify event was emitted
+		System::assert_has_event(Event::StakeTiersUpdated.into());
+
+		// Verify tiers were updated in storage
+		let updated_tiers = CreditsPallet::<Runtime>::stake_tiers();
+		assert_eq!(updated_tiers.len(), 4, "Should now have 4 tiers");
+
+		for (i, tier) in updated_tiers.iter().enumerate() {
+			assert_eq!(tier.threshold, new_tiers[i].threshold, "Tier threshold should match");
+			assert_eq!(tier.rate_per_block, new_tiers[i].rate_per_block, "Tier rate should match");
+		}
+
+		// Set some tiers that have the same threshold but different rates
+		let same_threshold_tiers = vec![
+			StakeTier { threshold: 100, rate_per_block: 1 },
+			StakeTier {
+				threshold: 100, // Same threshold as previous tier
+				rate_per_block: 2,
+			},
+		];
+
+		// Should be accepted since thresholds are considered properly sorted if they are <=
+		assert_ok!(CreditsPallet::<Runtime>::set_stake_tiers(
+			RuntimeOrigin::root(),
+			same_threshold_tiers.clone()
+		));
+
+		// Verify tiers were updated
+		let final_tiers = CreditsPallet::<Runtime>::stake_tiers();
+		assert_eq!(final_tiers.len(), 2, "Should now have 2 tiers");
+
+		// Test tier-based reward calculation with the new tiers
+		let stake_amount_tier1 = 50; // Below first tier
+		let rate_tier1 = CreditsPallet::<Runtime>::get_current_rate(stake_amount_tier1);
+		assert_eq!(rate_tier1, 0, "Rate should be 0 for stake below lowest tier");
+
+		let stake_amount_tier2 = 100; // At first tier
+		let rate_tier2 = CreditsPallet::<Runtime>::get_current_rate(stake_amount_tier2);
+		assert_eq!(rate_tier2, 2, "Rate should match the tier 2 rate");
+	});
+}

pallets/credits/src/tests.rs

@@ -425,6 +425,7 @@ impl pallet_credits::Config for Runtime {
 	type CreditBurnRecipient = CreditBurnRecipient;
 	type MaxOffchainAccountIdLength = ConstU32<100>;
 	type MaxStakeTiers = MaxStakeTiers;
+	type ForceOrigin = frame_system::EnsureRoot<AccountId>;
 	type WeightInfo = ();
 }
 

precompiles/credits/src/mock.rs

@@ -1397,6 +1397,7 @@ impl pallet_credits::Config for Runtime {
 	type CreditBurnRecipient = CreditBurnRecipient;
 	type MaxOffchainAccountIdLength = ConstU32<100>;
 	type MaxStakeTiers = MaxStakeTiers;
+	type ForceOrigin = EnsureRoot<AccountId>;
 	type WeightInfo = ();
 }
 

runtime/mainnet/src/lib.rs

@@ -1282,6 +1282,7 @@ impl pallet_credits::Config for Runtime {
 	type CreditBurnRecipient = CreditBurnRecipient;
 	type MaxOffchainAccountIdLength = ConstU32<100>;
 	type MaxStakeTiers = MaxStakeTiers;
+	type ForceOrigin = EnsureRoot<AccountId>;
 	type WeightInfo = ();
 }
 

runtime/testnet/src/lib.rs

@@ -361,22 +361,30 @@ declare module '@polkadot/api-base/types/errors' {
        * The requested claim amount exceeds the maximum calculated within the allowed window.
        **/
       ClaimAmountExceedsWindowAllowance: AugmentedError<ApiType>;
+      /**
+       * There are no stake tiers provided for the update.
+       **/
+      EmptyStakeTiers: AugmentedError<ApiType>;
       /**
        * Insufficient TNT balance to perform the burn operation.
        **/
       InsufficientTntBalance: AugmentedError<ApiType>;
       /**
-       * No staking tiers are configured in the runtime.
+       * Invalid claim ID (e.g., too long).
        **/
-      NoStakeTiersConfigured: AugmentedError<ApiType>;
+      InvalidClaimId: AugmentedError<ApiType>;
       /**
-       * The provided off-chain account ID exceeds the maximum allowed length.
+       * No stake tiers are configured or the stake amount is below the lowest tier threshold.
        **/
-      OffchainAccountIdTooLong: AugmentedError<ApiType>;
+      NoValidTier: AugmentedError<ApiType>;
       /**
-       * An arithmetic operation resulted in an overflow.
+       * Amount overflowed.
        **/
       Overflow: AugmentedError<ApiType>;
+      /**
+       * The stake tiers are not properly sorted by threshold.
+       **/
+      StakeTiersNotSorted: AugmentedError<ApiType>;
       /**
        * Generic error
        **/

types/src/interfaces/augment-api-errors.ts

@@ -365,16 +365,20 @@ declare module '@polkadot/api-base/types/events' {
     };
     credits: {
       /**
-       * A user successfully claimed credits, emitting details for off-chain processing.
-       * The amount is the value requested by the user, verified against the claimable window.
-       * \[who, amount_claimed, offchain_account_id]
+       * Credits were claimed from staking rewards, within the allowed window.
+       * [who, amount_claimed, offchain_account_id]
        **/
       CreditsClaimed: AugmentedEvent<ApiType, [who: AccountId32, amountClaimed: u128, offchainAccountId: Bytes], { who: AccountId32, amountClaimed: u128, offchainAccountId: Bytes }>;
       /**
        * TNT tokens were successfully burned, granting potential off-chain credits.
-       * \[who, tnt_burned, credits_granted]
+       * Credits granted = amount_burned * conversion_rate.
+       * [who, amount_burned, credits_granted, offchain_account_id]
        **/
       CreditsGrantedFromBurn: AugmentedEvent<ApiType, [who: AccountId32, tntBurned: u128, creditsGranted: u128], { who: AccountId32, tntBurned: u128, creditsGranted: u128 }>;
+      /**
+       * Stake tiers were updated.
+       **/
+      StakeTiersUpdated: AugmentedEvent<ApiType, []>;
       /**
        * Generic event
        **/

types/src/interfaces/augment-api-events.ts

@@ -10,7 +10,7 @@ import type { Data } from '@polkadot/types';
 import type { BTreeMap, Bytes, Compact, Null, Option, U256, U8aFixed, Vec, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
 import type { AnyNumber, IMethod, ITuple } from '@polkadot/types-codec/types';
 import type { AccountId32, Call, H160, H256, MultiAddress, Perbill, Percent, Permill } from '@polkadot/types/interfaces/runtime';
-import type { EthereumTransactionTransactionV2, FrameSupportPreimagesBounded, IsmpGrandpaAddStateMachine, IsmpHostStateMachine, IsmpMessagingCreateConsensusState, IsmpMessagingMessage, PalletAirdropClaimsStatementKind, PalletAirdropClaimsUtilsMultiAddress, PalletAirdropClaimsUtilsMultiAddressSignature, PalletBalancesAdjustmentDirection, PalletDemocracyConviction, PalletDemocracyMetadataOwner, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityJudgement, PalletIdentityLegacyIdentityInfo, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletIsmpUtilsFundMessageParams, PalletIsmpUtilsUpdateConsensusState, PalletMultiAssetDelegationDelegatorDelegatorBlueprintSelection, PalletMultisigTimepoint, PalletNominationPoolsBondExtra, PalletNominationPoolsClaimPermission, PalletNominationPoolsCommissionChangeRate, PalletNominationPoolsCommissionClaimPermission, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpPerbill, PalletNominationPoolsConfigOpU128, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletRewardsAssetAction, PalletRewardsRewardConfigForAssetVault, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingUnlockChunk, PalletStakingValidatorPrefs, PalletTangleLstBondExtra, PalletTangleLstCommissionCommissionChangeRate, PalletTangleLstCommissionCommissionClaimPermission, PalletTangleLstConfigOpAccountId32, PalletTangleLstConfigOpPerbill, PalletTangleLstConfigOpU128, PalletTangleLstConfigOpU32, PalletTangleLstPoolsPoolState, PalletTokenGatewayAssetRegistration, PalletTokenGatewayPrecisionUpdate, PalletTokenGatewayTeleportParams, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpCoreVoid, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeMultiSignature, SpSessionMembershipProof, SpWeightsWeightV2Weight, TanglePrimitivesRewardsLockMultiplier, TanglePrimitivesServicesField, TanglePrimitivesServicesPricingPricingQuote, TanglePrimitivesServicesServiceServiceBlueprint, TanglePrimitivesServicesTypesAsset, TanglePrimitivesServicesTypesAssetSecurityCommitment, TanglePrimitivesServicesTypesAssetSecurityRequirement, TanglePrimitivesServicesTypesMembershipModel, TanglePrimitivesServicesTypesOperatorPreferences, TangleTestnetRuntimeOpaqueSessionKeys, TangleTestnetRuntimeOriginCaller, TangleTestnetRuntimeProxyType, TokenGatewayPrimitivesGatewayAssetUpdate } from '@polkadot/types/lookup';
+import type { EthereumTransactionTransactionV2, FrameSupportPreimagesBounded, IsmpGrandpaAddStateMachine, IsmpHostStateMachine, IsmpMessagingCreateConsensusState, IsmpMessagingMessage, PalletAirdropClaimsStatementKind, PalletAirdropClaimsUtilsMultiAddress, PalletAirdropClaimsUtilsMultiAddressSignature, PalletBalancesAdjustmentDirection, PalletCreditsStakeTier, PalletDemocracyConviction, PalletDemocracyMetadataOwner, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityJudgement, PalletIdentityLegacyIdentityInfo, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletIsmpUtilsFundMessageParams, PalletIsmpUtilsUpdateConsensusState, PalletMultiAssetDelegationDelegatorDelegatorBlueprintSelection, PalletMultisigTimepoint, PalletNominationPoolsBondExtra, PalletNominationPoolsClaimPermission, PalletNominationPoolsCommissionChangeRate, PalletNominationPoolsCommissionClaimPermission, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpPerbill, PalletNominationPoolsConfigOpU128, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletRewardsAssetAction, PalletRewardsRewardConfigForAssetVault, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingUnlockChunk, PalletStakingValidatorPrefs, PalletTangleLstBondExtra, PalletTangleLstCommissionCommissionChangeRate, PalletTangleLstCommissionCommissionClaimPermission, PalletTangleLstConfigOpAccountId32, PalletTangleLstConfigOpPerbill, PalletTangleLstConfigOpU128, PalletTangleLstConfigOpU32, PalletTangleLstPoolsPoolState, PalletTokenGatewayAssetRegistration, PalletTokenGatewayPrecisionUpdate, PalletTokenGatewayTeleportParams, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpCoreVoid, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeMultiSignature, SpSessionMembershipProof, SpWeightsWeightV2Weight, TanglePrimitivesRewardsLockMultiplier, TanglePrimitivesServicesField, TanglePrimitivesServicesPricingPricingQuote, TanglePrimitivesServicesServiceServiceBlueprint, TanglePrimitivesServicesTypesAsset, TanglePrimitivesServicesTypesAssetSecurityCommitment, TanglePrimitivesServicesTypesAssetSecurityRequirement, TanglePrimitivesServicesTypesMembershipModel, TanglePrimitivesServicesTypesOperatorPreferences, TangleTestnetRuntimeOpaqueSessionKeys, TangleTestnetRuntimeOriginCaller, TangleTestnetRuntimeProxyType, TokenGatewayPrimitivesGatewayAssetUpdate } from '@polkadot/types/lookup';
 
 export type __AugmentedSubmittable = AugmentedSubmittable<() => unknown>;
 export type __SubmittableExtrinsic<ApiType extends ApiTypes> = SubmittableExtrinsic<ApiType>;
@@ -1214,6 +1214,19 @@ declare module '@polkadot/api-base/types/submittable' {
        * processing.
        **/
       claimCredits: AugmentedSubmittable<(amountToClaim: Compact<u128> | AnyNumber | Uint8Array, offchainAccountId: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u128>, Bytes]>;
+      /**
+       * Update the stake tiers. This function can only be called by the configured ForceOrigin.
+       * Stake tiers must be provided in ascending order by threshold.
+       * 
+       * Parameters:
+       * - `origin`: Must be the ForceOrigin
+       * - `new_tiers`: A vector of StakeTier structs representing the new tiers configuration
+       * 
+       * Emits `StakeTiersUpdated` on success.
+       * 
+       * Weight: O(n) where n is the number of tiers
+       **/
+      setStakeTiers: AugmentedSubmittable<(newTiers: Vec<PalletCreditsStakeTier> | (PalletCreditsStakeTier | { threshold?: any; ratePerBlock?: any } | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [Vec<PalletCreditsStakeTier>]>;
       /**
        * Generic tx
        **/