dApp staking v3 breaking changes fixes (#1136) (#1145)

* hotfix: disable XCM transaction from/to Equilibrium (#1134)

* Breaking changes fixes

* Read periods per cycle

* Fetch and store dApp leaderboard

---------

Co-authored-by: impelcrypto <[email protected]>

src/staking-v3/hooks/useDappStaking.ts

@@ -496,9 +496,13 @@ export function useDappStaking() {
 
   const fetchTiersConfigurationToStore = async (): Promise<void> => {
     const stakingRepo = container.get<IDappStakingRepository>(Symbols.DappStakingRepositoryV3);
-    const tiersConfiguration = await stakingRepo.getTiersConfiguration();
+    const [tiersConfiguration, leaderboard] = await Promise.all([
+      stakingRepo.getTiersConfiguration(),
+      stakingRepo.getLeaderboard(),
+    ]);
 
     store.commit('stakingV3/setTiersConfiguration', tiersConfiguration);
+    store.commit('stakingV3/setLeaderboard', leaderboard);
   };
 
   const fetchEraLengthsToStore = async (): Promise<void> => {

src/staking-v3/logic/interfaces/DappStakingV3.ts

@@ -1,4 +1,16 @@
-import { Compact, Enum, Option, Struct, Vec, bool, u128, u16, u32, u8 } from '@polkadot/types';
+import {
+  BTreeMap,
+  Compact,
+  Enum,
+  Option,
+  Struct,
+  Vec,
+  bool,
+  u128,
+  u16,
+  u32,
+  u8,
+} from '@polkadot/types';
 import { AccountId32, Permill } from '@polkadot/types/interfaces';
 import { Codec } from '@polkadot/types/types';
 
@@ -57,7 +69,7 @@ export interface PalletDappStakingV3DAppInfo extends Struct {
   readonly owner: AccountId32;
   readonly id: Compact<u16>;
   readonly state: PalletDappStakingV3DAppState;
-  readonly rewardDestination: Option<AccountId32>;
+  readonly rewardBeneficiary: Option<AccountId32>;
 }
 
 export interface SmartContractAddress extends Struct {
@@ -106,16 +118,11 @@ interface PalletDappStakingV3EraReward extends Struct {
 }
 
 export interface PalletDappStakingV3DAppTierRewards extends Struct {
-  readonly dapps: Vec<PalletDappStakingV3DAppTier>;
+  readonly dapps: BTreeMap<Compact<u16>, Compact<u8>>;
   readonly rewards: Vec<u128>;
   readonly period: Compact<u32>;
 }
 
-interface PalletDappStakingV3DAppTier extends Struct {
-  readonly dappId: Compact<u16>;
-  readonly tierId: Option<u8>;
-}
-
 export interface PalletDappStakingV3EraInfo extends Struct {
   readonly activeEraLocked: Compact<u128>;
   readonly totalLocked: Compact<u128>;

src/staking-v3/logic/models/DappStaking.ts

@@ -131,6 +131,7 @@ export interface EraLengths {
   standardErasPerBuildAndEarnPeriod: number;
   standardErasPerVotingPeriod: number;
   standardEraLength: number;
+  periodsPerCycle: number;
 }
 
 export interface DAppTierRewards {
@@ -139,7 +140,7 @@ export interface DAppTierRewards {
   readonly period: number;
 }
 
-interface DAppTier {
+export interface DAppTier {
   readonly dappId: number;
   readonly tierId: number | undefined;
 }

src/staking-v3/logic/repositories/DappStakingRepository.ts

@@ -4,6 +4,7 @@ import {
   AccountLedgerChangedMessage,
   Constants,
   ContractStakeAmount,
+  DAppTier,
   DAppTierRewards,
   Dapp,
   DappBase,
@@ -277,16 +278,18 @@ export class DappStakingRepository implements IDappStakingRepository {
     const getNumber = (bytes: Bytes): number => u8aToNumber(bytes.toU8a().slice(1, 4));
     const api = await this.api.getApi();
 
-    const [erasPerBuildAndEarn, erasPerVoting, eraLength] = await Promise.all([
+    const [erasPerBuildAndEarn, erasPerVoting, eraLength, periodsPerCycle] = await Promise.all([
       api.rpc.state.call('DappStakingApi_eras_per_build_and_earn_subperiod', ''),
       api.rpc.state.call('DappStakingApi_eras_per_voting_subperiod', ''),
       api.rpc.state.call('DappStakingApi_blocks_per_era', ''),
+      api.rpc.state.call('DappStakingApi_periods_per_cycle', ''),
     ]);
 
     return {
       standardErasPerBuildAndEarnPeriod: getNumber(erasPerBuildAndEarn),
       standardErasPerVotingPeriod: getNumber(erasPerVoting),
       standardEraLength: getNumber(eraLength),
+      periodsPerCycle: getNumber(periodsPerCycle),
     };
   }
 
@@ -320,16 +323,35 @@ export class DappStakingRepository implements IDappStakingRepository {
     }
 
     const tiers = tiersWrapped.unwrap();
+    const dapps: DAppTier[] = [];
+    tiers.dapps.forEach((value, key) =>
+      dapps.push({
+        dappId: key.toNumber(),
+        tierId: value.toNumber(),
+      })
+    );
     return {
       period: tiers.period.toNumber(),
-      dapps: tiers.dapps.map((dapp) => ({
-        dappId: dapp.dappId.toNumber(),
-        tierId: dapp.tierId.unwrapOr(undefined)?.toNumber(),
-      })),
+      dapps,
       rewards: tiers.rewards.map((reward) => reward.toBigInt()),
     };
   }
 
+  //* @inheritdoc
+  public async getLeaderboard(): Promise<Map<number, number>> {
+    const api = await this.api.getApi();
+    const tierAssignmentsBytes = await api.rpc.state.call(
+      'DappStakingApi_get_dapp_tier_assignment',
+      ''
+    );
+    const tierAssignment = api.createType('BTreeMap<u16, u8>', tierAssignmentsBytes);
+
+    const result = new Map<number, number>();
+    tierAssignment.forEach((value, key) => result.set(key.toNumber(), value.toNumber()));
+
+    return result;
+  }
+
   public async getStakerInfo(
     address: string,
     includePreviousPeriods = false
@@ -517,7 +539,7 @@ export class DappStakingRepository implements IDappStakingRepository {
       owner: dapp.owner.toString(),
       id: dapp.id.toNumber(),
       state: dapp.state.isUnregistered ? DappState.Unregistered : DappState.Registered,
-      rewardDestination: dapp.rewardDestination.unwrapOr(undefined)?.toString(),
+      rewardDestination: dapp.rewardBeneficiary.unwrapOr(undefined)?.toString(),
     };
   }
 

src/staking-v3/logic/repositories/IDappStakingRepository.ts

@@ -219,4 +219,9 @@ export interface IDappStakingRepository {
   getEraLengths(): Promise<EraLengths>;
 
   getCleanupExpiredEntriesCall(): Promise<ExtrinsicPayload>;
+
+  /**
+   * Gets dApps tier assignment map.
+   */
+  getLeaderboard(): Promise<Map<number, number>>;
 }

src/staking-v3/store/getters.ts

@@ -30,6 +30,7 @@ export interface DappStakingGetters {
   getDappTiers(state: DappStakingState): DAppTierRewards;
   getTiersConfiguration(state: DappStakingState): TiersConfiguration;
   getEraLengths(state: DappStakingState): EraLengths;
+  getLeaderboard(state: DappStakingState): Map<number, number>;
 }
 
 const getters: GetterTree<DappStakingState, StateInterface> & DappStakingGetters = {
@@ -46,6 +47,7 @@ const getters: GetterTree<DappStakingState, StateInterface> & DappStakingGetters
   getDappTiers: (state) => state.dAppTiers,
   getTiersConfiguration: (state) => state.tiersConfiguration,
   getEraLengths: (state) => state.eraLengths,
+  getLeaderboard: (state) => state.leaderboard,
 };
 
 export default getters;

src/staking-v3/store/mutations.ts

@@ -32,6 +32,7 @@ export interface DappStakingMutations<S = DappStakingState> {
   setDappTiers(state: DappStakingState, dAppTiers: DAppTierRewards): void;
   setTiersConfiguration(state: DappStakingState, tiersConfiguration: TiersConfiguration): void;
   setEraLengths(state: DappStakingState, eraLengths: EraLengths): void;
+  setLeaderboard(state: DappStakingState, leaderboard: Map<number, number>): void;
 }
 
 const updateDapp = <T>(
@@ -99,6 +100,9 @@ const mutations: MutationTree<DappStakingState> & DappStakingMutations = {
   setEraLengths(state, eraLengths) {
     state.eraLengths = eraLengths;
   },
+  setLeaderboard(state, leaderboard) {
+    state.leaderboard = leaderboard;
+  },
 };
 
 export default mutations;

src/staking-v3/store/state.ts

@@ -25,6 +25,7 @@ export interface DappStakingState {
   dAppTiers: DAppTierRewards;
   tiersConfiguration: TiersConfiguration;
   eraLengths: EraLengths;
+  leaderboard: Map<number, number>;
 }
 
 function state(): DappStakingState {
@@ -41,6 +42,7 @@ function state(): DappStakingState {
     dAppTiers: initialDappTiersConfiguration,
     tiersConfiguration: initialTiersConfiguration,
     eraLengths: initialEraLengths,
+    leaderboard: new Map<number, number>(),
   };
 }
 
@@ -61,6 +63,7 @@ export const initialEraLengths: EraLengths = {
   standardErasPerBuildAndEarnPeriod: 0,
   standardErasPerVotingPeriod: 0,
   standardEraLength: 0,
+  periodsPerCycle: 0,
 };
 
 export default state;