|
|
@@ -0,0 +1,344 @@
|
|
|
+import BaseTransport from './base';
|
|
|
+import { ApiPromise } from '@polkadot/api';
|
|
|
+import CouncilTransport from './council';
|
|
|
+import WorkingGroupsTransport from './workingGroups';
|
|
|
+import { APIQueryCache } from './APIQueryCache';
|
|
|
+import { Seats } from '@joystream/types/council';
|
|
|
+import { Option } from '@polkadot/types';
|
|
|
+import { BlockNumber, BalanceOf, Exposure } from '@polkadot/types/interfaces';
|
|
|
+import { WorkerId } from '@joystream/types/working-group';
|
|
|
+import { RewardRelationshipId, RewardRelationship } from '@joystream/types/recurring-rewards';
|
|
|
+import { StakeId, Stake } from '@joystream/types/stake';
|
|
|
+import { CuratorId, Curator, LeadId } from '@joystream/types/content-working-group';
|
|
|
+import { TokenomicsData } from '@polkadot/joy-utils/src/types/tokenomics';
|
|
|
+import { calculateValidatorsRewardsPerEra } from '../functions/staking';
|
|
|
+
|
|
|
+export default class TokenomicsTransport extends BaseTransport {
|
|
|
+ private councilT: CouncilTransport;
|
|
|
+ private workingGroupT: WorkingGroupsTransport;
|
|
|
+
|
|
|
+ constructor (api: ApiPromise, cacheApi: APIQueryCache, councilTransport: CouncilTransport, workingGroups: WorkingGroupsTransport) {
|
|
|
+ super(api, cacheApi);
|
|
|
+ this.councilT = councilTransport;
|
|
|
+ this.workingGroupT = workingGroups;
|
|
|
+ }
|
|
|
+
|
|
|
+ async councilSizeAndStake () {
|
|
|
+ let totalCouncilStake = 0;
|
|
|
+ const activeCouncil = await this.council.activeCouncil() as Seats;
|
|
|
+
|
|
|
+ activeCouncil.map((member) => {
|
|
|
+ let stakeAmount = 0;
|
|
|
+
|
|
|
+ stakeAmount += member.stake.toNumber();
|
|
|
+ member.backers.forEach((backer) => {
|
|
|
+ stakeAmount += backer.stake.toNumber();
|
|
|
+ });
|
|
|
+ totalCouncilStake += stakeAmount;
|
|
|
+ });
|
|
|
+
|
|
|
+ return {
|
|
|
+ numberOfCouncilMembers: activeCouncil.length,
|
|
|
+ totalCouncilStake
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ private async councilRewardsPerWeek (numberOfCouncilMembers: number) {
|
|
|
+ const payoutInterval = Number((await this.api.query.council.payoutInterval() as Option<BlockNumber>).unwrapOr(0));
|
|
|
+ const amountPerPayout = (await this.api.query.council.amountPerPayout() as BalanceOf).toNumber();
|
|
|
+ const totalCouncilRewardsPerBlock = (amountPerPayout && payoutInterval)
|
|
|
+ ? (amountPerPayout * numberOfCouncilMembers) / payoutInterval
|
|
|
+ : 0;
|
|
|
+
|
|
|
+ const { new_term_duration, voting_period, revealing_period, announcing_period } = await this.councilT.electionParameters();
|
|
|
+ const termDuration = new_term_duration.toNumber();
|
|
|
+ const votingPeriod = voting_period.toNumber();
|
|
|
+ const revealingPeriod = revealing_period.toNumber();
|
|
|
+ const announcingPeriod = announcing_period.toNumber();
|
|
|
+ const weekInBlocks = 100800;
|
|
|
+
|
|
|
+ const councilTermDurationRatio = termDuration / (termDuration + votingPeriod + revealingPeriod + announcingPeriod);
|
|
|
+ const avgCouncilRewardPerBlock = councilTermDurationRatio * totalCouncilRewardsPerBlock;
|
|
|
+ const avgCouncilRewardPerWeek = avgCouncilRewardPerBlock * weekInBlocks;
|
|
|
+
|
|
|
+ return avgCouncilRewardPerWeek;
|
|
|
+ }
|
|
|
+
|
|
|
+ async getCouncilData () {
|
|
|
+ const { numberOfCouncilMembers, totalCouncilStake } = await this.councilSizeAndStake();
|
|
|
+ const totalCouncilRewardsInOneWeek = await this.councilRewardsPerWeek(numberOfCouncilMembers);
|
|
|
+
|
|
|
+ return {
|
|
|
+ numberOfCouncilMembers,
|
|
|
+ totalCouncilRewardsInOneWeek,
|
|
|
+ totalCouncilStake
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ private async storageProviderSizeAndIds () {
|
|
|
+ const stakeIds: StakeId[] = [];
|
|
|
+ const rewardIds: RewardRelationshipId[] = [];
|
|
|
+ let leadStakeId: StakeId | null = null;
|
|
|
+ let leadRewardId: RewardRelationshipId | null = null;
|
|
|
+ let numberOfStorageProviders = 0;
|
|
|
+ let leadNumber = 0;
|
|
|
+ const allWorkers = await this.workingGroupT.allWorkers('Storage');
|
|
|
+ const currentLeadId = (await this.api.query.storageWorkingGroup.currentLead() as Option<WorkerId>).unwrapOr(null)?.toNumber();
|
|
|
+
|
|
|
+ allWorkers.forEach(([workerId, worker]) => {
|
|
|
+ const stakeId = worker.role_stake_profile.isSome ? worker.role_stake_profile.unwrap().stake_id : null;
|
|
|
+ const rewardId = worker.reward_relationship.unwrapOr(null);
|
|
|
+
|
|
|
+ if (currentLeadId !== undefined && currentLeadId === workerId.toNumber()) {
|
|
|
+ leadStakeId = stakeId;
|
|
|
+ leadRewardId = rewardId;
|
|
|
+ leadNumber += 1;
|
|
|
+ } else {
|
|
|
+ numberOfStorageProviders += 1;
|
|
|
+
|
|
|
+ if (stakeId) {
|
|
|
+ stakeIds.push(stakeId);
|
|
|
+ }
|
|
|
+
|
|
|
+ if (rewardId) {
|
|
|
+ rewardIds.push(rewardId);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ });
|
|
|
+
|
|
|
+ return {
|
|
|
+ numberOfStorageProviders,
|
|
|
+ stakeIds,
|
|
|
+ rewardIds,
|
|
|
+ leadNumber,
|
|
|
+ leadRewardId,
|
|
|
+ leadStakeId
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ private async storageProviderStakeAndRewards (
|
|
|
+ stakeIds: StakeId[],
|
|
|
+ leadStakeId: StakeId | null,
|
|
|
+ rewardIds: RewardRelationshipId[],
|
|
|
+ leadRewardId: RewardRelationshipId | null
|
|
|
+ ) {
|
|
|
+ let totalStorageProviderStake = 0;
|
|
|
+ let leadStake = 0;
|
|
|
+ let storageProviderRewardsPerBlock = 0;
|
|
|
+ let storageLeadRewardsPerBlock = 0;
|
|
|
+
|
|
|
+ (await this.api.query.stake.stakes.multi<Stake>(stakeIds)).forEach((stake) => {
|
|
|
+ totalStorageProviderStake += stake.value.toNumber();
|
|
|
+ });
|
|
|
+ (await this.api.query.recurringRewards.rewardRelationships.multi<RewardRelationship>(rewardIds)).map((rewardRelationship) => {
|
|
|
+ const amount = rewardRelationship.amount_per_payout.toNumber();
|
|
|
+ const payoutInterval = rewardRelationship.payout_interval.isSome
|
|
|
+ ? rewardRelationship.payout_interval.unwrap().toNumber()
|
|
|
+ : null;
|
|
|
+
|
|
|
+ if (amount && payoutInterval) {
|
|
|
+ storageProviderRewardsPerBlock += amount / payoutInterval;
|
|
|
+ }
|
|
|
+ });
|
|
|
+
|
|
|
+ if (leadStakeId !== null) {
|
|
|
+ leadStake += (await this.api.query.stake.stakes(leadStakeId) as Stake).value.toNumber();
|
|
|
+ }
|
|
|
+
|
|
|
+ if (leadRewardId !== null) {
|
|
|
+ const leadRewardData = (await this.api.query.recurringRewards.rewardRelationships(leadRewardId) as RewardRelationship);
|
|
|
+ const leadAmount = leadRewardData.amount_per_payout.toNumber();
|
|
|
+ const leadRewardInterval = leadRewardData.payout_interval.isSome ? leadRewardData.payout_interval.unwrap().toNumber() : null;
|
|
|
+
|
|
|
+ if (leadAmount && leadRewardInterval) {
|
|
|
+ storageLeadRewardsPerBlock += leadAmount / leadRewardInterval;
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ return {
|
|
|
+ totalStorageProviderStake,
|
|
|
+ leadStake,
|
|
|
+ storageProviderRewardsPerWeek: storageProviderRewardsPerBlock * 100800,
|
|
|
+ storageProviderLeadRewardsPerWeek: storageLeadRewardsPerBlock * 100800
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ async getStorageProviderData () {
|
|
|
+ const { numberOfStorageProviders, leadNumber, stakeIds, rewardIds, leadRewardId, leadStakeId } = await this.storageProviderSizeAndIds();
|
|
|
+ const { totalStorageProviderStake, leadStake, storageProviderRewardsPerWeek, storageProviderLeadRewardsPerWeek } =
|
|
|
+ await this.storageProviderStakeAndRewards(stakeIds, leadStakeId, rewardIds, leadRewardId);
|
|
|
+
|
|
|
+ return {
|
|
|
+ numberOfStorageProviders,
|
|
|
+ storageProviderLeadNumber: leadNumber,
|
|
|
+ totalStorageProviderStake,
|
|
|
+ totalStorageProviderLeadStake: leadStake,
|
|
|
+ storageProviderRewardsPerWeek,
|
|
|
+ storageProviderLeadRewardsPerWeek
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ private async contentCuratorSizeAndIds () {
|
|
|
+ const stakeIds: StakeId[] = []; const rewardIds: RewardRelationshipId[] = []; let numberOfContentCurators = 0;
|
|
|
+ const contentCurators = await this.entriesByIds<CuratorId, Curator>(this.api.query.contentWorkingGroup.curatorById);
|
|
|
+ const currentLeadId = (await this.api.query.contentWorkingGroup.currentLeadId() as Option<LeadId>).unwrapOr(null)?.toNumber();
|
|
|
+
|
|
|
+ contentCurators.forEach(([curatorId, curator]) => {
|
|
|
+ const stakeId = curator.role_stake_profile.isSome ? curator.role_stake_profile.unwrap().stake_id : null;
|
|
|
+ const rewardId = curator.reward_relationship.unwrapOr(null);
|
|
|
+
|
|
|
+ if (curator.is_active) {
|
|
|
+ numberOfContentCurators += 1;
|
|
|
+
|
|
|
+ if (stakeId) {
|
|
|
+ stakeIds.push(stakeId);
|
|
|
+ }
|
|
|
+
|
|
|
+ if (rewardId) {
|
|
|
+ rewardIds.push(rewardId);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ });
|
|
|
+
|
|
|
+ return {
|
|
|
+ stakeIds,
|
|
|
+ rewardIds,
|
|
|
+ numberOfContentCurators,
|
|
|
+ contentCuratorLeadNumber: currentLeadId ? 1 : 0
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ private async contentCuratorStakeAndRewards (stakeIds: StakeId[], rewardIds: RewardRelationshipId[]) {
|
|
|
+ let totalContentCuratorStake = 0;
|
|
|
+ let contentCuratorRewardsPerBlock = 0;
|
|
|
+
|
|
|
+ (await this.api.query.stake.stakes.multi<Stake>(stakeIds)).forEach((stake) => {
|
|
|
+ totalContentCuratorStake += stake.value.toNumber();
|
|
|
+ });
|
|
|
+ (await this.api.query.recurringRewards.rewardRelationships.multi<RewardRelationship>(rewardIds)).map((rewardRelationship) => {
|
|
|
+ const amount = rewardRelationship.amount_per_payout.toNumber();
|
|
|
+ const payoutInterval = rewardRelationship.payout_interval.isSome
|
|
|
+ ? rewardRelationship.payout_interval.unwrap().toNumber()
|
|
|
+ : null;
|
|
|
+
|
|
|
+ if (amount && payoutInterval) {
|
|
|
+ contentCuratorRewardsPerBlock += amount / payoutInterval;
|
|
|
+ }
|
|
|
+ });
|
|
|
+
|
|
|
+ return {
|
|
|
+ totalContentCuratorStake,
|
|
|
+ contentCuratorRewardsPerBlock
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ async getContentCuratorData () {
|
|
|
+ const { stakeIds, rewardIds, numberOfContentCurators, contentCuratorLeadNumber } = await this.contentCuratorSizeAndIds();
|
|
|
+ const { totalContentCuratorStake, contentCuratorRewardsPerBlock } = await this.contentCuratorStakeAndRewards(stakeIds, rewardIds);
|
|
|
+
|
|
|
+ return {
|
|
|
+ numberOfContentCurators,
|
|
|
+ contentCuratorLeadNumber,
|
|
|
+ totalContentCuratorStake,
|
|
|
+ contentCuratorRewardsPerWeek: contentCuratorRewardsPerBlock * 100800
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ async validatorSizeAndStake () {
|
|
|
+ const validatorIds = await this.api.query.session.validators();
|
|
|
+ const currentEra = (await this.api.query.staking.currentEra()).unwrapOr(null);
|
|
|
+ let totalValidatorStake = 0; let numberOfNominators = 0;
|
|
|
+
|
|
|
+ if (currentEra !== null) {
|
|
|
+ const validatorStakeData = await this.api.query.staking.erasStakers.multi<Exposure>(
|
|
|
+ validatorIds.map((validatorId) => [currentEra, validatorId])
|
|
|
+ );
|
|
|
+
|
|
|
+ validatorStakeData.forEach((data) => {
|
|
|
+ if (!data.total.isEmpty) {
|
|
|
+ totalValidatorStake += data.total.toNumber();
|
|
|
+ }
|
|
|
+
|
|
|
+ if (!data.others.isEmpty) {
|
|
|
+ numberOfNominators += data.others.length;
|
|
|
+ }
|
|
|
+ });
|
|
|
+ }
|
|
|
+
|
|
|
+ return {
|
|
|
+ numberOfValidators: validatorIds.length,
|
|
|
+ numberOfNominators,
|
|
|
+ totalValidatorStake
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ async getValidatorData () {
|
|
|
+ const totalIssuance = (await this.api.query.balances.totalIssuance()).toNumber();
|
|
|
+ const { numberOfValidators, numberOfNominators, totalValidatorStake } = await this.validatorSizeAndStake();
|
|
|
+ const validatorRewardsPerEra = calculateValidatorsRewardsPerEra(totalValidatorStake, totalIssuance);
|
|
|
+
|
|
|
+ return {
|
|
|
+ totalIssuance,
|
|
|
+ numberOfValidators,
|
|
|
+ numberOfNominators,
|
|
|
+ totalValidatorStake,
|
|
|
+ validatorRewardsPerWeek: validatorRewardsPerEra * 168 // Assuming 1 era = 1h
|
|
|
+ };
|
|
|
+ }
|
|
|
+
|
|
|
+ async getTokenomicsData (): Promise<TokenomicsData> {
|
|
|
+ const { numberOfCouncilMembers, totalCouncilRewardsInOneWeek, totalCouncilStake } = await this.getCouncilData();
|
|
|
+ const { numberOfStorageProviders, storageProviderLeadNumber, totalStorageProviderStake, totalStorageProviderLeadStake, storageProviderLeadRewardsPerWeek, storageProviderRewardsPerWeek } = await this.getStorageProviderData();
|
|
|
+ const { numberOfContentCurators, contentCuratorLeadNumber, totalContentCuratorStake, contentCuratorRewardsPerWeek } = await this.getContentCuratorData();
|
|
|
+ const { numberOfValidators, numberOfNominators, totalValidatorStake, validatorRewardsPerWeek, totalIssuance } = await this.getValidatorData();
|
|
|
+ const currentlyStakedTokens = totalCouncilStake + totalStorageProviderStake + totalStorageProviderLeadStake + totalContentCuratorStake + totalValidatorStake;
|
|
|
+ const totalWeeklySpending = totalCouncilRewardsInOneWeek + storageProviderRewardsPerWeek + storageProviderLeadRewardsPerWeek + contentCuratorRewardsPerWeek + validatorRewardsPerWeek;
|
|
|
+ const totalNumberOfActors = numberOfCouncilMembers + numberOfStorageProviders + storageProviderLeadNumber + numberOfContentCurators + contentCuratorLeadNumber + numberOfValidators;
|
|
|
+
|
|
|
+ return {
|
|
|
+ totalIssuance,
|
|
|
+ currentlyStakedTokens,
|
|
|
+ totalWeeklySpending,
|
|
|
+ totalNumberOfActors,
|
|
|
+ validators: {
|
|
|
+ number: numberOfValidators,
|
|
|
+ nominators: {
|
|
|
+ number: numberOfNominators
|
|
|
+ },
|
|
|
+ rewardsPerWeek: validatorRewardsPerWeek,
|
|
|
+ rewardsShare: validatorRewardsPerWeek / totalWeeklySpending,
|
|
|
+ totalStake: totalValidatorStake,
|
|
|
+ stakeShare: totalValidatorStake / currentlyStakedTokens
|
|
|
+ },
|
|
|
+ council: {
|
|
|
+ number: numberOfCouncilMembers,
|
|
|
+ rewardsPerWeek: totalCouncilRewardsInOneWeek,
|
|
|
+ rewardsShare: totalCouncilRewardsInOneWeek / totalWeeklySpending,
|
|
|
+ totalStake: totalCouncilStake,
|
|
|
+ stakeShare: totalCouncilStake / currentlyStakedTokens
|
|
|
+ },
|
|
|
+ storageProviders: {
|
|
|
+ number: numberOfStorageProviders,
|
|
|
+ totalStake: totalStorageProviderStake,
|
|
|
+ stakeShare: totalStorageProviderStake / currentlyStakedTokens,
|
|
|
+ rewardsPerWeek: storageProviderRewardsPerWeek,
|
|
|
+ rewardsShare: storageProviderRewardsPerWeek / totalWeeklySpending,
|
|
|
+ lead: {
|
|
|
+ number: storageProviderLeadNumber,
|
|
|
+ totalStake: totalStorageProviderLeadStake,
|
|
|
+ stakeShare: totalStorageProviderLeadStake / currentlyStakedTokens,
|
|
|
+ rewardsPerWeek: storageProviderLeadRewardsPerWeek,
|
|
|
+ rewardsShare: storageProviderLeadRewardsPerWeek / totalWeeklySpending
|
|
|
+ }
|
|
|
+ },
|
|
|
+ contentCurators: {
|
|
|
+ number: numberOfContentCurators,
|
|
|
+ contentCuratorLead: contentCuratorLeadNumber,
|
|
|
+ rewardsPerWeek: contentCuratorRewardsPerWeek,
|
|
|
+ rewardsShare: contentCuratorRewardsPerWeek / totalWeeklySpending,
|
|
|
+ totalStake: totalContentCuratorStake,
|
|
|
+ stakeShare: totalContentCuratorStake / currentlyStakedTokens
|
|
|
+ }
|
|
|
+ };
|
|
|
+ }
|
|
|
+}
|
Mokhtar Naamani