PhalaBasePool¶

Calls¶

add_staker_to_whitelist¶

See [Pallet::add_staker_to_whitelist].

Attributes¶

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

Python¶

call = substrate.compose_call(
    'PhalaBasePool', 'add_staker_to_whitelist', {'pid': 'u64', 'staker': 'AccountId'}
)

claim_reimbursement¶

See [Pallet::claim_reimbursement].

Attributes¶

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

Python¶

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

remove_staker_from_whitelist¶

See [Pallet::remove_staker_from_whitelist].

Attributes¶

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

Python¶

call = substrate.compose_call(
    'PhalaBasePool', 'remove_staker_from_whitelist', {'pid': 'u64', 'staker': 'AccountId'}
)

set_pool_description¶

See [Pallet::set_pool_description].

Attributes¶

Name	Type
pid	`u64`
description	`DescStr`

Python¶

call = substrate.compose_call(
    'PhalaBasePool', 'set_pool_description', {'description': 'Bytes', 'pid': 'u64'}
)

set_reimbursements¶

See [Pallet::set_reimbursements].

Attributes¶

Name	Type
input	`Vec<(T::AccountId, u64, BalanceOf<T>)>`

Python¶

call = substrate.compose_call(
    'PhalaBasePool', 'set_reimbursements', {
    'input': [
        ('AccountId', 'u64', 'u128'),
    ],
}
)

Events¶

NftCreated¶

A Nft is created to contain pool shares

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
cid	`CollectionId`	`u32`
nft_id	`NftId`	`u32`
owner	`T::AccountId`	`AccountId`
shares	`BalanceOf<T>`	`u128`

PoolWhitelistCreated¶

A pool contribution whitelist is added

lazy operated when the first staker is added to the whitelist

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`

PoolWhitelistDeleted¶

The pool contribution whitelist is deleted

lazy operated when the last staker is removed from the whitelist

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`

PoolWhitelistStakerAdded¶

A staker is added to the pool contribution whitelist

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
staker	`T::AccountId`	`AccountId`

PoolWhitelistStakerRemoved¶

A staker is removed from the pool contribution whitelist

Attributes¶

Name	Type	Composition
pid	`u64`	`u64`
staker	`T::AccountId`	`AccountId`

Withdrawal¶

Some stake was withdrawn from a pool

The lock in Balances is updated to release the locked stake.

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

Attributes¶

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

WithdrawalQueued¶

A withdrawal request is inserted to a queue

Affected states: - a new item is inserted to or an old item is being replaced by the new item in the withdraw queue in [Pools]

Attributes¶

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

Storage functions¶

CollectionIndex¶

The Next available collectionid to be created

Python¶

result = substrate.query(
    'PhalaBasePool', 'CollectionIndex', []
)

Return value¶

'u32'

LockIterateStartPos¶

Python¶

result = substrate.query(
    'PhalaBasePool', 'LockIterateStartPos', []
)

Return value¶

(None, ('u32', 'u32'))

NextNftId¶

Mapping from the next self-increased nft ids to collections

Python¶

result = substrate.query(
    'PhalaBasePool', 'NextNftId', ['u32']
)

Return value¶

'u32'

NftLocks¶

Mapping from the NftId to its internal locking status

Used to ensure nft attributes can't be read and override when it has already be accessed and haven't updated yet.

Python¶

result = substrate.query(
    'PhalaBasePool', 'NftLocks', [('u32', 'u32')]
)

Return value¶

()

PoolCollections¶

Mapping from collectionids to pids

Python¶

result = substrate.query(
    'PhalaBasePool', 'PoolCollections', ['u32']
)

Return value¶

'u64'

PoolContributionWhitelists¶

Mapping for pools that specify certain stakers to contribute stakes

Python¶

result = substrate.query(
    'PhalaBasePool', 'PoolContributionWhitelists', ['u64']
)

Return value¶

['AccountId']

PoolCount¶

The number of total pools

Python¶

result = substrate.query(
    'PhalaBasePool', 'PoolCount', []
)

Return value¶

'u64'

PoolDescriptions¶

Mapping for pools that store their descriptions set by owner

Python¶

result = substrate.query(
    'PhalaBasePool', 'PoolDescriptions', ['u64']
)

Return value¶

'Bytes'

Pools¶

Mapping from pids to pools (including stake pools and vaults)

Python¶

result = substrate.query(
    'PhalaBasePool', 'Pools', ['u64']
)

Return value¶

{
    'StakePool': {
        'basepool': {
            'cid': 'u32',
            'owner': 'AccountId',
            'pid': 'u64',
            'pool_account_id': 'AccountId',
            'total_shares': 'u128',
            'total_value': 'u128',
            'value_subscribers': ['u64'],
            'withdraw_queue': [
                {'nft_id': 'u32', 'start_time': 'u64', 'user': 'AccountId'},
            ],
        },
        'cap': (None, 'u128'),
        'cd_workers': ['[u8; 32]'],
        'lock_account': 'AccountId',
        'owner_reward_account': 'AccountId',
        'payout_commission': (None, 'u32'),
        'workers': ['[u8; 32]'],
    },
    'Vault': {
        'basepool': {
            'cid': 'u32',
            'owner': 'AccountId',
            'pid': 'u64',
            'pool_account_id': 'AccountId',
            'total_shares': 'u128',
            'total_value': 'u128',
            'value_subscribers': ['u64'],
            'withdraw_queue': [
                {'nft_id': 'u32', 'start_time': 'u64', 'user': 'AccountId'},
            ],
        },
        'commission': (None, 'u32'),
        'invest_pools': ['u64'],
        'last_share_price_checkpoint': 'u128',
        'owner_shares': 'u128',
    },
}

Reimbursements¶

Claimable reimbursement due to previous on-chain issues.

Python¶

result = substrate.query(
    'PhalaBasePool', 'Reimbursements', [('AccountId', 'u64')]
)

Return value¶

'u128'

Errors¶

AlreadyInContributeWhitelist¶

Can not add the staker to whitelist because the staker is already in whitelist.

AttrLocked¶

Tried to get a NftGuard when the nft is locked. It indicates an internal error occured.

BurnNftFailed¶

Burn nft failed

DeprecatedTransferSharesAmountInvalid¶

ExceedMaxDescriptionLen¶

Too long for pool description length

ExceedWhitelistMaxLen¶

Too many stakers in contribution whitelist that exceed the limit

InternalSubsidyPoolCannotWithdraw¶

InvalidSharePrice¶

Occurs when pool's shares is zero

InvalidShareToWithdraw¶

CheckSub less than zero, indicate share amount is invalid

InvalidWithdrawalAmount¶

The withdrawal amount is too small (considered as dust)

MissCollectionId¶

basepool's collection_id isn't founded

NftIdNotFound¶

NftId does not match any nft

NoReimbursementToClaim¶

No reimbursement to claim

NoWhitelistCreated¶

The pool hasn't have a whitelist created

NotInContributeWhitelist¶

Invalid staker to contribute because origin isn't in Pool's contribution whitelist.

NotMigrationRoot¶

Migration root not authorized

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 pid does not match to any pool

PoolTypeNotMatch¶

Tried to access a pool type that doesn't match the actual pool type in the storage.

E.g. Try to access a vault but it's actually a stake pool.

RmrkError¶

RMRK errors

UnauthorizedPoolOwner¶

The caller is not the owner of the pool