PhalaStakePoolv2¶

Calls¶

add_worker¶

See [Pallet::add_worker].

Attributes¶

Name	Type
pid	`u64`
pubkey	`WorkerPublicKey`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'add_worker', {'pid': 'u64', 'pubkey': '[u8; 32]'}
)

check_and_maybe_force_withdraw¶

See [Pallet::check_and_maybe_force_withdraw].

Attributes¶

Name	Type
pid	`u64`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'check_and_maybe_force_withdraw', {'pid': 'u64'}
)

claim_legacy_rewards¶

See [Pallet::claim_legacy_rewards].

Attributes¶

Name	Type
pid	`u64`
target	`T::AccountId`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'claim_legacy_rewards', {'pid': 'u64', 'target': 'AccountId'}
)

claim_owner_rewards¶

See [Pallet::claim_owner_rewards].

Attributes¶

Name	Type
pid	`u64`
target	`T::AccountId`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'claim_owner_rewards', {'pid': 'u64', 'target': 'AccountId'}
)

contribute¶

See [Pallet::contribute].

Attributes¶

Name	Type
pid	`u64`
amount	`BalanceOf<T>`
as_vault	`Option<u64>`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'contribute', {
    'amount': 'u128',
    'as_vault': (None, 'u64'),
    'pid': 'u64',
}
)

create¶

See [Pallet::create].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'create', {}
)

reclaim_pool_worker¶

See [Pallet::reclaim_pool_worker].

Attributes¶

Name	Type
pid	`u64`
worker	`WorkerPublicKey`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'reclaim_pool_worker', {'pid': 'u64', 'worker': '[u8; 32]'}
)

remove_worker¶

See [Pallet::remove_worker].

Attributes¶

Name	Type
pid	`u64`
worker	`WorkerPublicKey`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'remove_worker', {'pid': 'u64', 'worker': '[u8; 32]'}
)

restart_computing¶

See [Pallet::restart_computing].

Attributes¶

Name	Type
pid	`u64`
worker	`WorkerPublicKey`
stake	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'restart_computing', {
    'pid': 'u64',
    'stake': 'u128',
    'worker': '[u8; 32]',
}
)

set_cap¶

See [Pallet::set_cap].

Attributes¶

Name	Type
pid	`u64`
cap	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'set_cap', {'cap': 'u128', 'pid': 'u64'}
)

set_payout_pref¶

See [Pallet::set_payout_pref].

Attributes¶

Name	Type
pid	`u64`
payout_commission	`Option<Permill>`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'set_payout_pref', {
    'payout_commission': (None, 'u32'),
    'pid': 'u64',
}
)

start_computing¶

See [Pallet::start_computing].

Attributes¶

Name	Type
pid	`u64`
worker	`WorkerPublicKey`
stake	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'start_computing', {
    'pid': 'u64',
    'stake': 'u128',
    'worker': '[u8; 32]',
}
)

stop_computing¶

See [Pallet::stop_computing].

Attributes¶

Name	Type
pid	`u64`
worker	`WorkerPublicKey`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'stop_computing', {'pid': 'u64', 'worker': '[u8; 32]'}
)

withdraw¶

See [Pallet::withdraw].

Attributes¶

Name	Type
pid	`u64`
shares	`BalanceOf<T>`
as_vault	`Option<u64>`

Python¶

call = substrate.compose_call(
    'PhalaStakePoolv2', 'withdraw', {
    'as_vault': (None, 'u64'),
    'pid': 'u64',
    'shares': 'u128',
}
)

Events¶

Contribution¶

Someone contributed to a pool

Affected states: - the stake related fields in [Pools] - the user W-PHA balance reduced - the user recive ad share NFT once contribution succeeded - when there was any request in the withdraw queue, the action may trigger withdrawals (Withdrawal event)

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
user	`T::AccountId`	`AccountId`
amount	`BalanceOf<T>`	`u128`
shares	`BalanceOf<T>`	`u128`
as_vault	`Option<u64>`	`(None, 'u64')`

OwnerRewardsWithdrawn¶

Owner rewards were withdrawn by pool owner

Affected states: - the stake related fields in [Pools] - the owner asset account

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
user	`T::AccountId`	`AccountId`
amount	`BalanceOf<T>`	`u128`

PoolCapacitySet¶

The stake capacity of the pool is updated

Affected states: - the cap field in [Pools] is updated

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
cap	`BalanceOf<T>`	`u128`

PoolCommissionSet¶

The commission of a pool is updated

The commission ratio is represented by an integer. The real value is commission / 1_000_000u32.

Affected states: - the payout_commission field in [Pools] is updated

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
commission	`u32`	`u32`

PoolCreated¶

A stake pool is created by owner

Affected states: - a new entry in [Pools] with the pid

Attributes¶

Name	Type	Composition
owner	`T::AccountId`	`AccountId`
pid	`u64`	`u64`
cid	`CollectionId`	`u32`
pool_account_id	`T::AccountId`	`AccountId`

PoolSlashed¶

The pool received a slash event from one of its workers (currently disabled)

The slash is accured to the pending slash accumulator.

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
amount	`BalanceOf<T>`	`u128`

PoolWorkerAdded¶

A worker is added to the pool

Affected states: - the worker is added to the vector workers in [Pools] - the worker in the [WorkerAssignments] is pointed to pid - the worker-session binding is updated in computation pallet (WorkerBindings, SessionBindings)

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
worker	`WorkerPublicKey`	`[u8; 32]`
session	`T::AccountId`	`AccountId`

PoolWorkerRemoved¶

A worker is removed from a pool.

Affected states: - the worker item in [WorkerAssignments] is removed - the worker is removed from the [Pools] item

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
worker	`WorkerPublicKey`	`[u8; 32]`

RewardDismissedDust¶

Some reward is dismissed because the amount is too tiny (dust)

There's no affected state.

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
amount	`BalanceOf<T>`	`u128`

RewardDismissedNoShare¶

Some reward is dismissed because the pool doesn't have any share

There's no affected state.

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
amount	`BalanceOf<T>`	`u128`

RewardDismissedNotInPool¶

Some reward is dismissed because the worker is no longer bound to a pool

There's no affected state.

Attributes¶

Name	Type	Composition
worker	`WorkerPublicKey`	`[u8; 32]`
amount	`BalanceOf<T>`	`u128`

RewardReceived¶

The amount of reward that distributed to owner and stakers

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
to_owner	`BalanceOf<T>`	`u128`
to_stakers	`BalanceOf<T>`	`u128`

RewardToDistributionDismissedDust¶

Some to-distribute reward is dismissed because the amount is too tiny (dust)

There's no affected state.

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
amount	`BalanceOf<T>`	`u128`

RewardToOwnerDismissedDust¶

Some to-distribute reward is dismissed because the amount is too tiny (dust)

There's no affected state.

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
amount	`BalanceOf<T>`	`u128`

SlashSettled¶

Some slash is actually settled to a contributor (currently disabled)

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
user	`T::AccountId`	`AccountId`
amount	`BalanceOf<T>`	`u128`

WorkerReclaimed¶

A worker is reclaimed from the pool

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
worker	`WorkerPublicKey`	`[u8; 32]`

WorkingStarted¶

The amount of stakes for a worker to start computing

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
worker	`WorkerPublicKey`	`[u8; 32]`
amount	`BalanceOf<T>`	`u128`

Storage functions¶

LegacyRewards¶

Python¶

result = substrate.query(
    'PhalaStakePoolv2', 'LegacyRewards', [('AccountId', 'u64')]
)

Return value¶

'u128'

StakepoolIterateStartPos¶

Python¶

result = substrate.query(
    'PhalaStakePoolv2', 'StakepoolIterateStartPos', []
)

Return value¶

(None, 'u64')

SubAccountAssignments¶

(Deprecated)

Python¶

result = substrate.query(
    'PhalaStakePoolv2', 'SubAccountAssignments', ['AccountId']
)

Return value¶

'u64'

SubAccountPreimages¶

Helper storage to track the preimage of the computing sub-accounts. Not used in consensus.

Python¶

result = substrate.query(
    'PhalaStakePoolv2', 'SubAccountPreimages', ['AccountId']
)

Return value¶

('u64', '[u8; 32]')

WorkerAssignments¶

Mapping from workers to the pool they belong to

The map entry lasts from add_worker() to remove_worker() or force unbinding.

Python¶

result = substrate.query(
    'PhalaStakePoolv2', 'WorkerAssignments', ['[u8; 32]']
)

Return value¶

'u64'

Constants¶

GracePeriod¶

The grace period for force withdraw request, in seconds.

Value¶

Python¶

constant = substrate.get_constant('PhalaStakePoolv2', 'GracePeriod')

MaxPoolWorkers¶

The max allowed workers in a pool

Value¶

Python¶

constant = substrate.get_constant('PhalaStakePoolv2', 'MaxPoolWorkers')

MinContribution¶

Value¶

10000000000

Python¶

constant = substrate.get_constant('PhalaStakePoolv2', 'MinContribution')

Errors¶

BenchmarkMissing¶

The worker doesn't have a valid benchmark when adding to the pool

CannotRestartWithLessStake¶

Restarted with a less stake is not allowed in the tokenomic.

FailedToBindSessionAndWorker¶

Couldn't bind worker and the pool computing subaccount

FeatureNotEnabled¶

The StakePool is not enabled yet.

InadequateCapacity¶

The stake capacity is set too low to cover the existing stake

InsufficientBalance¶

Trying to contribute more than the available balance

InsufficientContribution¶

The contributed stake is smaller than the minimum threshold

InsufficientFreeStake¶

Cannot start computing because there's no enough free stake

InternalSubsidyPoolCannotWithdraw¶

Internal error: Cannot withdraw from the subsidy pool. This should never happen.

InvalidForceRewardAmount¶

Invalid amount of balance input when force reward.

InvalidWithdrawalAmount¶

The withdrawal amount is too small (considered as dust)

LockAccountStakeError¶

MissingCollectionId¶

Stakepool's collection_id isn't founded

NoLegacyRewardToClaim¶

NoNftToWithdraw¶

The caller has no nft to withdraw

NoRewardToClaim¶

There's no pending reward to claim

PoolBankrupt¶

The pool has already got all the stake completely slashed.

In this case, no more funds can be contributed to the pool until all the pending slash has been resolved.

PoolDoesNotExist¶

The specified pool doesn't exist

PoolStakeNotFound¶

The user doesn't have stake in a pool

SessionDoesNotExist¶

The target miner is not in the miner storage

StakeExceedsCapacity¶

The stake added to a pool exceeds its capacity

UnauthorizedOperator¶

The owner of the pool doesn't have the access to the worker

The access to a worker is granted by it's operator parameter set by register_worker

UnauthorizedPoolOwner¶

The caller is not the owner of the pool

VaultIsLocked¶

Vault is forced locked for it has some expired withdrawal

WithdrawQueueNotEmpty¶

Withdraw queue is not empty so that we can't restart computing

WorkerAlreadyStopped¶

The worker is already in cd_workers

WorkerDoesNotExist¶

The target worker is not in the pool

WorkerExists¶

The worker is already added to the pool

WorkerInAnotherPool¶

The worker is already added to another pool

WorkerIsNotReady¶

The target worker is not reclaimed and can not be removed from a pool.

WorkerNotRegistered¶

The worker is not registered in the registry when adding to the pool

WorkersExceedLimit¶

Failed to add a worker because the number of the workers exceeds the upper limit.