ParachainStaking¶

Calls¶

cancel_leave_candidates¶

See [Pallet::cancel_leave_candidates].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'cancel_leave_candidates', {}
)

candidate_stake_less¶

See [Pallet::candidate_stake_less].

Attributes¶

Name	Type
less	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'candidate_stake_less', {'less': 'u128'}
)

candidate_stake_more¶

See [Pallet::candidate_stake_more].

Attributes¶

Name	Type
more	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'candidate_stake_more', {'more': 'u128'}
)

claim_rewards¶

See [Pallet::claim_rewards].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'claim_rewards', {}
)

delegator_stake_less¶

See [Pallet::delegator_stake_less].

Attributes¶

Name	Type
less	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'delegator_stake_less', {'less': 'u128'}
)

delegator_stake_more¶

See [Pallet::delegator_stake_more].

Attributes¶

Name	Type
more	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'delegator_stake_more', {'more': 'u128'}
)

execute_leave_candidates¶

See [Pallet::execute_leave_candidates].

Attributes¶

Name	Type
collator	`<T::Lookup as StaticLookup>::Source`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'execute_leave_candidates', {
    'collator': {
        'Address20': '[u8; 20]',
        'Address32': '[u8; 32]',
        'Id': 'AccountId',
        'Index': (),
        'Raw': 'Bytes',
    },
}
)

execute_scheduled_reward_change¶

See [Pallet::execute_scheduled_reward_change].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'execute_scheduled_reward_change', {}
)

force_new_round¶

See [Pallet::force_new_round].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'force_new_round', {}
)

force_remove_candidate¶

See [Pallet::force_remove_candidate].

Attributes¶

Name	Type
collator	`<T::Lookup as StaticLookup>::Source`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'force_remove_candidate', {
    'collator': {
        'Address20': '[u8; 20]',
        'Address32': '[u8; 32]',
        'Id': 'AccountId',
        'Index': (),
        'Raw': 'Bytes',
    },
}
)

increment_collator_rewards¶

See [Pallet::increment_collator_rewards].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'increment_collator_rewards', {}
)

increment_delegator_rewards¶

See [Pallet::increment_delegator_rewards].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'increment_delegator_rewards', {}
)

init_leave_candidates¶

See [Pallet::init_leave_candidates].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'init_leave_candidates', {}
)

join_candidates¶

See [Pallet::join_candidates].

Attributes¶

Name	Type
stake	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'join_candidates', {'stake': 'u128'}
)

join_delegators¶

See [Pallet::join_delegators].

Attributes¶

Name	Type
collator	`<T::Lookup as StaticLookup>::Source`
amount	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'join_delegators', {
    'amount': 'u128',
    'collator': {
        'Address20': '[u8; 20]',
        'Address32': '[u8; 32]',
        'Id': 'AccountId',
        'Index': (),
        'Raw': 'Bytes',
    },
}
)

leave_delegators¶

See [Pallet::leave_delegators].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'leave_delegators', {}
)

set_blocks_per_round¶

See [Pallet::set_blocks_per_round].

Attributes¶

Name	Type
new	`BlockNumberFor<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'set_blocks_per_round', {'new': 'u64'}
)

set_inflation¶

See [Pallet::set_inflation].

Attributes¶

Name	Type
collator_max_rate_percentage	`Perquintill`
collator_annual_reward_rate_percentage	`Perquintill`
delegator_max_rate_percentage	`Perquintill`
delegator_annual_reward_rate_percentage	`Perquintill`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'set_inflation', {
    'collator_annual_reward_rate_percentage': 'u64',
    'collator_max_rate_percentage': 'u64',
    'delegator_annual_reward_rate_percentage': 'u64',
    'delegator_max_rate_percentage': 'u64',
}
)

set_max_candidate_stake¶

See [Pallet::set_max_candidate_stake].

Attributes¶

Name	Type
new	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'set_max_candidate_stake', {'new': 'u128'}
)

set_max_selected_candidates¶

See [Pallet::set_max_selected_candidates].

Attributes¶

Name	Type
new	`u32`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'set_max_selected_candidates', {'new': 'u32'}
)

unlock_unstaked¶

See [Pallet::unlock_unstaked].

Attributes¶

Name	Type
target	`<T::Lookup as StaticLookup>::Source`

Python¶

call = substrate.compose_call(
    'ParachainStaking', 'unlock_unstaked', {
    'target': {
        'Address20': '[u8; 20]',
        'Address32': '[u8; 32]',
        'Id': 'AccountId',
        'Index': (),
        'Raw': 'Bytes',
    },
}
)

Events¶

BlocksPerRoundSet¶

The length in blocks for future validation rounds has changed. [round number, first block in the current round, old value, new value]

Attributes¶

Name	Type	Composition
None	`SessionIndex`	`u32`
None	`BlockNumberFor<T>`	`u64`
None	`BlockNumberFor<T>`	`u64`
None	`BlockNumberFor<T>`	`u64`

CandidateLeft¶

An account has left the set of collator candidates. [account, amount of funds un-staked]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

CollatorCanceledExit¶

A collator candidate has canceled the process to leave the set of candidates and was added back to the candidate pool. [collator's account]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`

CollatorRemoved¶

An account was forcedly removed from the set of collator candidates. [account, amount of funds un-staked]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

CollatorScheduledExit¶

A collator candidate has started the process to leave the set of candidates. [round number, collator's account, round number when the collator will be effectively removed from the set of candidates]

Attributes¶

Name	Type	Composition
None	`SessionIndex`	`u32`
None	`T::AccountId`	`AccountId`
None	`SessionIndex`	`u32`

CollatorStakedLess¶

A collator candidate has decreased the amount of funds at stake. [collator's account, previous stake, new stake]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`BalanceOf<T>`	`u128`

CollatorStakedMore¶

A collator candidate has increased the amount of funds at stake. [collator's account, previous stake, new stake]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`BalanceOf<T>`	`u128`

Delegation¶

An account has delegated a new collator candidate. [account, amount of funds staked, total amount of delegators' funds staked for the collator candidate]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

DelegationReplaced¶

A new delegation has replaced an existing one in the set of ongoing delegations for a collator candidate. [new delegator's account, amount of funds staked in the new delegation, replaced delegator's account, amount of funds staked in the replace delegation, collator candidate's account, new total amount of delegators' funds staked for the collator candidate]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

DelegatorLeft¶

An account has left the set of delegators. [account, amount of funds un-staked]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

DelegatorLeftCollator¶

An account has stopped delegating a collator candidate. [account, collator candidate's account, old amount of delegators' funds staked, new amount of delegators' funds staked]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`BalanceOf<T>`	`u128`

DelegatorStakedLess¶

A delegator has decreased the amount of funds at stake for a collator. [delegator's account, collator's account, previous delegation stake, new delegation stake]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`BalanceOf<T>`	`u128`

DelegatorStakedMore¶

A delegator has increased the amount of funds at stake for a collator. [delegator's account, collator's account, previous delegation stake, new delegation stake]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`
None	`BalanceOf<T>`	`u128`

EnteredTopCandidates¶

A new account has joined the set of top candidates. [account]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`

JoinedCollatorCandidates¶

A new account has joined the set of collator candidates. [account, amount staked by the new candidate]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

LeftTopCandidates¶

An account was removed from the set of top candidates. [account]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`

MaxCandidateStakeChanged¶

The maximum candidate stake has been changed. [new max amount]

Attributes¶

Name	Type	Composition
None	`BalanceOf<T>`	`u128`

MaxSelectedCandidatesSet¶

The maximum number of collator candidates selected in future validation rounds has changed. [old value, new value]

Attributes¶

Name	Type	Composition
None	`u32`	`u32`
None	`u32`	`u32`

NewRound¶

A new staking round has started. [block number, round number]

Attributes¶

Name	Type	Composition
None	`BlockNumberFor<T>`	`u64`
None	`SessionIndex`	`u32`

Rewarded¶

A collator or a delegator has received a reward. [account, amount of reward]

Attributes¶

Name	Type	Composition
None	`T::AccountId`	`AccountId`
None	`BalanceOf<T>`	`u128`

RoundInflationSet¶

Inflation configuration for future validation rounds has changed. [maximum collator's staking rate, maximum collator's reward rate, maximum delegator's staking rate, maximum delegator's reward rate]

Attributes¶

Name	Type	Composition
None	`Perquintill`	`u64`
None	`Perquintill`	`u64`
None	`Perquintill`	`u64`
None	`Perquintill`	`u64`

Storage functions¶

BlocksAuthored¶

The number of authored blocks for collators. It is updated via the note_author hook when authoring a block .

Python¶

result = substrate.query(
    'ParachainStaking', 'BlocksAuthored', ['AccountId']
)

Return value¶

'u64'

BlocksRewarded¶

The number of blocks for which rewards have been claimed by an address.

For collators, this can be at most BlocksAuthored. It is updated when incrementing collator rewards, either when calling inc_collator_rewards or updating the InflationInfo.

For delegators, this can be at most BlocksAuthored of the collator.It is updated when incrementing delegator rewards, either when calling inc_delegator_rewards or updating the InflationInfo.

Python¶

result = substrate.query(
    'ParachainStaking', 'BlocksRewarded', ['AccountId']
)

Return value¶

'u64'

CandidatePool¶

The staking information for a candidate.

It maps from an account to its information. Moreover, it counts the number of candidates.

Python¶

result = substrate.query(
    'ParachainStaking', 'CandidatePool', ['AccountId']
)

Return value¶

{
    'delegators': [{'amount': 'u128', 'owner': 'AccountId'}],
    'id': 'AccountId',
    'stake': 'u128',
    'status': {'Active': None, 'Leaving': 'u32'},
    'total': 'u128',
}

CounterForCandidatePool¶

Counter for the related counted storage map

Python¶

result = substrate.query(
    'ParachainStaking', 'CounterForCandidatePool', []
)

Return value¶

'u32'

DelegatorState¶

Delegation staking information.

It maps from an account to its delegation details.

Python¶

result = substrate.query(
    'ParachainStaking', 'DelegatorState', ['AccountId']
)

Return value¶

{'amount': 'u128', 'owner': 'AccountId'}

ForceNewRound¶

Python¶

result = substrate.query(
    'ParachainStaking', 'ForceNewRound', []
)

Return value¶

'bool'

InflationConfig¶

Inflation configuration.

Python¶

result = substrate.query(
    'ParachainStaking', 'InflationConfig', []
)

Return value¶

{
    'collator': {
        'max_rate': 'u64',
        'reward_rate': {'annual': 'u64', 'per_block': 'u64'},
    },
    'delegator': {
        'max_rate': 'u64',
        'reward_rate': {'annual': 'u64', 'per_block': 'u64'},
    },
}

LastDelegation¶

Delegation information for the latest session in which a delegator delegated.

It maps from an account to the number of delegations in the last session in which they (re-)delegated.

Python¶

result = substrate.query(
    'ParachainStaking', 'LastDelegation', ['AccountId']
)

Return value¶

{'counter': 'u32', 'round': 'u32'}

LastRewardReduction¶

The year in which the last automatic reduction of the reward rates occurred.

It starts at zero at genesis and increments by one every BLOCKS_PER_YEAR many blocks.

Python¶

result = substrate.query(
    'ParachainStaking', 'LastRewardReduction', []
)

Return value¶

'u64'

MaxCollatorCandidateStake¶

The maximum amount a collator candidate can stake.

Python¶

result = substrate.query(
    'ParachainStaking', 'MaxCollatorCandidateStake', []
)

Return value¶

'u128'

MaxSelectedCandidates¶

The maximum number of collator candidates selected at each round.

Python¶

result = substrate.query(
    'ParachainStaking', 'MaxSelectedCandidates', []
)

Return value¶

'u32'

Rewards¶

The accumulated rewards for collator candidates and delegators.

It maps from accounts to their total rewards since the last payout.

Python¶

result = substrate.query(
    'ParachainStaking', 'Rewards', ['AccountId']
)

Return value¶

'u128'

Round¶

Current round number and next round scheduled transition.

Python¶

result = substrate.query(
    'ParachainStaking', 'Round', []
)

Return value¶

{'current': 'u32', 'first': 'u64', 'length': 'u64'}

TopCandidates¶

The collator candidates with the highest amount of stake.

Each time the stake of a collator is increased, it is checked whether this pushes another candidate out of the list. When the stake is reduced however, it is not checked if another candidate has more stake, since this would require iterating over the entire CandidatePool.

There must always be more candidates than MaxSelectedCandidates so that a collator can drop out of the collator set by reducing their stake.

Python¶

result = substrate.query(
    'ParachainStaking', 'TopCandidates', []
)

Return value¶

[{'amount': 'u128', 'owner': 'AccountId'}]

TotalCollatorStake¶

Total funds locked to back the currently selected collators. The sum of all collator and their delegator stakes.

Note: There are more funds locked by this pallet, since the backing for non collating candidates is not included in TotalCollatorStake.

Python¶

result = substrate.query(
    'ParachainStaking', 'TotalCollatorStake', []
)

Return value¶

{'collators': 'u128', 'delegators': 'u128'}

Unstaking¶

The funds waiting to be unstaked.

It maps from accounts to all the funds addressed to them in the future blocks.

Python¶

result = substrate.query(
    'ParachainStaking', 'Unstaking', ['AccountId']
)

Return value¶

'scale_info::257'

Constants¶

DefaultBlocksPerRound¶

Default number of blocks validation rounds last, as set in the genesis configuration.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'DefaultBlocksPerRound')

ExitQueueDelay¶

Number of rounds a collator has to stay active after submitting a request to leave the set of collator candidates.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'ExitQueueDelay')

MaxDelegationsPerRound¶

Maximum number of delegations which can be made within the same round.

NOTE: To prevent re-delegation-reward attacks, we should keep this to be one.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MaxDelegationsPerRound')

MaxDelegatorsPerCollator¶

Maximum number of delegators a single collator can have.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MaxDelegatorsPerCollator')

MaxTopCandidates¶

Maximum size of the top candidates set.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MaxTopCandidates')

MaxUnstakeRequests¶

Max number of concurrent active unstaking requests before unlocking.

NOTE: To protect against irremovability of a candidate or delegator, we only allow for MaxUnstakeRequests - 1 many manual unstake requests. The last one serves as a placeholder for the cases of calling either kick_delegator, force_remove_candidateorexecute_leave_candidates`. Otherwise, a user could max out their unstake requests and prevent themselves from being kicked from the set of candidates/delegators until they unlock their funds.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MaxUnstakeRequests')

MinBlocksPerRound¶

Minimum number of blocks validation rounds can last.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MinBlocksPerRound')

MinCollatorCandidateStake¶

Minimum stake required for any account to be added to the set of candidates.

Value¶

10000000000000000000

Python¶

constant = substrate.get_constant('ParachainStaking', 'MinCollatorCandidateStake')

MinCollatorStake¶

Minimum stake required for any account to be elected as validator for a round.

Value¶

10000000000000000000

Python¶

constant = substrate.get_constant('ParachainStaking', 'MinCollatorStake')

MinCollators¶

Minimum number of collators selected from the set of candidates at every validation round.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MinCollators')

MinDelegatorStake¶

Minimum stake required for any account to become a delegator.

Value¶

20000000000000000

Python¶

constant = substrate.get_constant('ParachainStaking', 'MinDelegatorStake')

MinRequiredCollators¶

Minimum number of collators which cannot leave the network if there are no others.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'MinRequiredCollators')

NetworkRewardRate¶

The rate in percent for the network rewards which are based on the maximum number of collators and the maximum amount a collator can stake.

Value¶

100000000000000000

Python¶

constant = substrate.get_constant('ParachainStaking', 'NetworkRewardRate')

NetworkRewardStart¶

The starting block number for the network rewards. Once the current block number exceeds this start, the beneficiary will receive the configured reward in each block.

Value¶

13149000

Python¶

constant = substrate.get_constant('ParachainStaking', 'NetworkRewardStart')

StakeDuration¶

Number of blocks for which unstaked balance will still be locked before it can be unlocked by actively calling the extrinsic unlock_unstaked.

Value¶

Python¶

constant = substrate.get_constant('ParachainStaking', 'StakeDuration')

Errors¶

AlreadyDelegatedCollator¶

The delegator has already previously delegated the collator candidate.

AlreadyDelegating¶

The account is already delegating the collator candidate.

AlreadyLeaving¶

The collator candidate has already trigger the process to leave the set of collator candidates.

CandidateExists¶

The account is already part of the collator candidates set.

CandidateNotFound¶

The account is not part of the collator candidates set.

CannotDelegateIfLeaving¶

The collator candidate is in the process of leaving the set of candidates and thus cannot be delegated to.

CannotJoinBeforeUnlocking¶

The account has a full list of unstaking requests and needs to unlock at least one of these before being able to join (again). NOTE: Can only happen if the account was a candidate or delegator before and either got kicked or exited voluntarily.

CannotLeaveYet¶

The collator tried to leave before waiting at least for ExitQueueDelay many rounds.

CannotSetAboveMax¶

The number of selected candidates per staking round is above the maximum value allowed.

CannotSetBelowMin¶

The number of selected candidates per staking round is below the minimum value allowed.

CannotStakeIfLeaving¶

The collator candidate is in the process of leaving the set of candidates and cannot perform any other actions in the meantime.

DelegationBelowMin¶

The account has not staked enough funds to delegate a collator candidate.

DelegationNotFound¶

The given delegation does not exist in the set of delegations.

DelegationsPerRoundExceeded¶

The delegator has exceeded the number of delegations per round which is equal to MaxDelegatorsPerCollator.

This protects against attacks in which a delegator can re-delegate from a collator who has already authored a block, to another one which has not in this round.

DelegatorExists¶

The account is already part of the delegators set.

DelegatorNotFound¶

The account is not part of the delegators set.

InvalidSchedule¶

An invalid inflation configuration is trying to be set.

MaxCollatorsPerDelegatorExceeded¶

The delegator has already delegated the maximum number of candidates allowed.

NoMoreUnstaking¶

The staking reward being unlocked does not exist. Max unlocking requests reached.

NotLeaving¶

The collator candidate wanted to execute the exit but has not requested to leave before by calling init_leave_candidates.

NotYetDelegating¶

The account has not delegated any collator candidate yet, hence it is not in the set of delegators.

RewardsNotFound¶

Cannot claim rewards if empty.

StakeNotFound¶

Provided staked value is zero. Should never be thrown.

TooEarly¶

The reward rate cannot be adjusted yet as an entire year has not passed.

TooFewCollatorCandidates¶

The set of collator candidates would fall below the required minimum if the collator left.

TooManyDelegators¶

The collator candidate has already reached the maximum number of delegators.

This error is generated in case a new delegation request does not stake enough funds to replace some other existing delegation.

Underflow¶

The collator delegate or the delegator is trying to un-stake more funds that are currently staked.

UnstakingIsEmpty¶

Cannot unlock when Unstaked is empty.

ValStakeAboveMax¶

The account has already staked the maximum amount of funds possible.

ValStakeBelowMin¶

The account has not staked enough funds to be added to the collator candidates set.

ValStakeZero¶

The account tried to stake more or less with amount zero.