staking_pool

Module0x0000…0003

Move path: 0x0000…0003::staking_pool
Functions: 4219 public, 2 entry
Structs: 7
Friend modules: sui_system validator validator_set

staking_pool

Functions42

fungible_staked_sui_pool_idBytecode
public fun fungible_staked_sui_pool_id(&FungibleStakedSui): ID
fungible_staked_sui_valueBytecode
public fun fungible_staked_sui_value(&FungibleStakedSui): u64
is_equal_staking_metadataBytecode
public fun is_equal_staking_metadata(&StakedSui,&StakedSui): bool
is_inactiveBytecode
public fun is_inactive(&StakingPool): bool
is_preactiveBytecode
public fun is_preactive(&StakingPool): bool
join_fungible_staked_suiBytecode
public fun join_fungible_staked_sui(&mut FungibleStakedSui,FungibleStakedSui)
join_staked_suipublicentryBytecode
public entry fun join_staked_sui(&mut StakedSui,StakedSui)
pending_stake_amountBytecode
public fun pending_stake_amount(&StakingPool): u64
pending_stake_withdraw_amountBytecode
public fun pending_stake_withdraw_amount(&StakingPool): u64
pool_idBytecode
public fun pool_id(&StakedSui): ID
pool_token_amountBytecode
public fun pool_token_amount(&PoolTokenExchangeRate): u64
pool_token_exchange_rate_at_epochBytecode
public fun pool_token_exchange_rate_at_epoch(&StakingPool,u64): PoolTokenExchangeRate
splitBytecode
public fun split(&mut StakedSui,u64): StakedSui
split_fungible_staked_suiBytecode
public fun split_fungible_staked_sui(&mut FungibleStakedSui,u64): FungibleStakedSui
split_staked_suipublicentryBytecode
public entry fun split_staked_sui(&mut StakedSui,u64)
stake_activation_epochBytecode
public fun stake_activation_epoch(&StakedSui): u64
staked_sui_amountBytecode
public fun staked_sui_amount(&StakedSui): u64
sui_amountBytecode
public fun sui_amount(&PoolTokenExchangeRate): u64
sui_balanceBytecode
public fun sui_balance(&StakingPool): u64

Structs7

key is an object with an id. store can be kept inside other objects. copy can be duplicated. drop can be thrown away.

FungibleStakedSuistorekey
id UID
pool_id ID
value u64
FungibleStakedSuiDatastorekey
id UID
total_supply u64
principal Balance<SUI>
FungibleStakedSuiDataKeycopydropstore
dummy_field bool
PoolTokenExchangeRatecopydropstore
sui_amount u64
pool_token_amount u64
StakedSuistorekey
id UID
pool_id ID
stake_activation_epoch u64
principal Balance<SUI>

dummy_field	bool

sui_amount	u64
pool_token_amount	u64

StakingPoolstorekey

id	UID
activation_epoch	Option<u64>
deactivation_epoch	Option<u64>
sui_balance	u64
rewards_pool	Balance<SUI>
pool_token_balance	u64
exchange_rates	Table<u64, PoolTokenExchangeRate>
pending_stake	u64
pending_total_sui_withdraw	u64
pending_pool_token_withdraw	u64
extra_fields	Bag

UnderflowSuiBalancecopydropstore
dummy_field bool

dummy_field	bool

Constants22

Constants are shown the way the code loads them. Bytecode does not keep their names.

Index	Value	Type	Use	Used in
0	1000000000	u64	Value	split
1	0	u64	Abort code	split_fungible_staked_sui
2	1	u64	Abort code	redeem_fungible_staked_sui convert_to_fungible_staked_sui withdraw_from_principal join_fungible_staked_sui
3	2	u64	Value
4	3	u64	Abort code	split
5	4	u64	Value
6	5	u64	Value
7	6	u64	Value
8	7	u64	Value
9	8	u64	Value
10	9	u64	Abort code	check_balance_invariants
11	10	u64	Abort code	request_add_stake
12	11	u64	Abort code	deactivate_staking_pool
13	12	u64	Abort code	split
14	13	u64	Value
15	14	u64	Abort code	activate_staking_pool
16	15	u64	Abort code	convert_to_fungible_staked_sui
17	16	u64	Abort code	activate_staking_pool
18	17	u64	Abort code	request_add_stake
19	18	u64	Abort code	convert_to_fungible_staked_sui split
20	19	u64	Abort code	convert_to_fungible_staked_sui
21	20	u64	Abort code	calculate_fungible_staked_sui_withdraw_amount

id	UID
pool_id	ID
stake_activation_epoch	u64
principal	Balance<SUI>