staker state

PoolAccessor

poolAccessor

newPoolAccessor

EmissionAccessor

emissionAccessor

newEmissionAccessor

NFTAccessor

gnftAccessor

newNFTAccessor

Counter

NewCounter

Deposit

NewDeposit

Warmup

NewWarmup

DefaultWarmupTemplate

GNS_PATH

WUGNOT_PATH

DefaultAllowedTokens

GetPool

GetPool returns a copy of the pool for the given path.

GetIncentive

GetIncentive returns a copy of the incentive for the given pool and ID.

GetDeposit

GetDeposit returns a copy of the deposit for the given position ID.

CollectableEmissionReward

CollectableEmissionReward returns the claimable internal reward amount.

CollectableExternalIncentiveReward

CollectableExternalIncentiveReward returns the claimable external reward amount.

GetCreatedHeightOfIncentive

GetCreatedHeightOfIncentive returns the block height when an incentive was created.

GetIncentiveCreatedTimestamp

GetIncentiveCreatedTimestamp returns the creation timestamp of an incentive.

GetIncentiveTotalRewardAmount

GetIncentiveTotalRewardAmount returns the total reward amount of an incentive.

GetIncentiveDistributedRewardAmount

GetIncentiveDistributedRewardAmount returns the distributed reward amount of an incentive.

GetIncentiveRemainingRewardAmount

GetIncentiveRemainingRewardAmount returns the remaining reward amount of an incentive.

GetIncentiveAccumulatedPenaltyAmount

GetIncentiveAccumulatedPenaltyAmount returns the accumulated warmup penalty amount of an incentive.

GetIncentiveDepositGnsAmount

GetIncentiveDepositGnsAmount returns the deposited GNS amount of an incentive.

GetIncentiveRefunded

GetIncentiveRefunded returns whether an incentive has been refunded.

IsIncentiveActive

IsIncentiveActive returns whether an incentive is active.

GetDepositExternalRewardLastCollectTimestamp

GetDepositExternalRewardLastCollectTimestamp returns the last external reward collection time for a position.

GetDepositGnsAmount

GetDepositGnsAmount returns the required GNS deposit amount for staking.

GetDepositInternalRewardLastCollectTimestamp

GetDepositInternalRewardLastCollectTimestamp returns the last internal reward collection time for a position.

GetDepositCollectedInternalReward

GetDepositCollectedInternalReward returns the collected internal reward amount of a position.

GetDepositCollectedExternalReward

GetDepositCollectedExternalReward returns the collected external reward amount of a position.

GetDepositLiquidity

GetDepositLiquidity returns the liquidity amount of a staked position.

GetDepositLiquidityAsString

GetDepositLiquidityAsString returns the liquidity amount of a staked position as string.

GetDepositOwner

GetDepositStakeTime

GetDepositStakeTime returns the staking duration of a position.

GetDepositTargetPoolPath

GetDepositTargetPoolPath returns the pool path of a staked position.

GetDepositTickLower

GetDepositTickLower returns the lower tick of a staked position.

GetDepositTickUpper

GetDepositTickUpper returns the upper tick of a staked position.

GetDepositWarmUp

GetDepositWarmUp returns the warmup records of a staked position.

GetDepositExternalIncentiveIdList

GetDepositExternalIncentiveIdList returns external incentive IDs for a deposit.

GetExternalIncentiveByPoolPath

GetExternalIncentiveByPoolPath returns all external incentives for a pool.

GetIncentiveEndTimestamp

GetIncentiveEndTimestamp returns the end timestamp of an incentive.

GetIncentiveCreator

GetIncentiveRewardAmount

GetIncentiveRewardAmount returns the total reward amount of an incentive.

GetIncentiveRewardAmountAsString

GetIncentiveRewardAmountAsString returns the total reward amount of an incentive as string.

GetIncentiveRewardPerSecondX128

GetIncentiveRewardPerSecondX128 returns the reward rate per second of an incentive, expressed as a Q128 fixed-point number (i.e. actual rate = value / 2^128). Callers needing an integer rate can right-shift the result by 128.

GetIncentiveRewardToken

GetIncentiveRewardToken returns the reward token of an incentive.

GetIncentiveStartTimestamp

GetIncentiveStartTimestamp returns the start timestamp of an incentive.

GetMinimumRewardAmount

GetMinimumRewardAmount returns the minimum reward amount to distribute.

GetMinimumRewardAmountForToken

GetMinimumRewardAmountForToken returns the minimum reward amount for a specific token.

GetPoolIncentiveIdList

GetPoolIncentiveIdList returns all incentive IDs for a pool.

GetPoolStakedLiquidity

GetPoolStakedLiquidity returns the current total staked liquidity of a pool.

GetPoolsByTier

GetPoolsByTier returns the pool list for a tier.

GetPoolReward

GetPoolReward returns the reward amount for a tier.

GetPoolTier

GetPoolTier returns the tier of a pool.

GetPoolTierCount

GetPoolTierCount returns the number of pools in a tier.

GetPoolTierRatio

GetPoolTierRatio returns the reward ratio of a pool.

GetSpecificTokenMinimumRewardAmount

GetSpecificTokenMinimumRewardAmount returns the minimum reward amount for a specific token.

GetTargetPoolPathByIncentiveId

GetTargetPoolPathByIncentiveId returns the pool path for an incentive ID.

GetUnstakingFee

GetUnstakingFee returns the unstaking fee percentage.

IsStaked

IsStaked returns whether a position is staked.

GetTotalEmissionSent

GetTotalEmissionSent returns the total GNS emission sent.

GetAllowedTokens

GetAllowedTokens returns the allowed external incentive tokens.

GetWarmupTemplate

GetWarmupTemplate returns the current warmup template.

GetPoolRewardCacheCount

GetPoolRewardCacheCount returns the number of reward cache entries for a pool.

GetPoolRewardCacheIDs

GetPoolRewardCacheIDs returns a paginated list of reward cache timestamps for a pool.

GetPoolRewardCache

GetPoolRewardCache returns the reward cache value at a specific timestamp for a pool.

GetPoolIncentiveCount

GetPoolIncentiveCount returns the number of incentives for a pool.

GetPoolIncentiveIDs

GetPoolIncentiveIDs returns a paginated list of incentive IDs for a pool.

GetPoolGlobalRewardRatioAccumulationCount

GetPoolGlobalRewardRatioAccumulationCount returns the number of global reward ratio accumulation entries for a pool.

GetPoolGlobalRewardRatioAccumulationIDs

GetPoolGlobalRewardRatioAccumulationIDs returns a paginated list of timestamps for global reward ratio accumulation entries.

GetPoolGlobalRewardRatioAccumulation

GetPoolGlobalRewardRatioAccumulation returns the global reward ratio accumulation at a specific timestamp for a pool.

GetPoolHistoricalTickCount

GetPoolHistoricalTickCount returns the number of historical tick entries for a pool.

GetPoolHistoricalTickIDs

GetPoolHistoricalTickIDs returns a paginated list of historical tick values for a pool.

GetPoolHistoricalTick

GetPoolHistoricalTick returns the historical tick at a specific timestamp for a pool.

cloneStringSlice

cloneUint64Slice

cloneInt64Slice

cloneInt32Slice

cloneStringInt64Map

cloneStringBoolMap

cloneExternalIncentives

cloneWarmups

AllTierCount

// 0, 1, 2, 3

Pool

Pool is a struct for storing an incentivized pool information Each pool stores Incentives and Ticks associated with it. Fields: - poolPath: The path of the pool. - currentStakedLiquidity: The current total staked liquidity of the in-range positions for the pool. Updated when tick cross happens or stake/unstake happens. Used to calculate the global reward ratio accumulation or decide whether to enter/exit unclaimable period. - lastUnclaimableTime: The time at which the unclaimable period started. Set to 0 when the pool is not in an unclaimable period. - unclaimableAcc: The accumulated undisributed unclaimable reward. Reset to 0 when processUnclaimableReward is called and sent to community pool. - rewardCache: The cached per-second reward emitted for this pool. Stores new entry only when the reward is changed. PoolTier.cacheReward() updates this. \- incentives: The external incentives associated with the pool. \- ticks: The Ticks associated with the pool. - globalRewardRatioAccumulation: Global ratio of Time / TotalStake accumulation(since the pool creation) Stores new entry only when tick cross or stake/unstake happens. It is used to calculate the reward for a staked position at certain time. - historicalTick: The historical tick for the pool at a given time. It does not reflect the exact tick at the timestamp, but it provides correct ordering for the staked position's ticks. Therefore, you should not compare it for equality, only for ordering. Set when tick cross happens or a new position is created.

NewPool

NewPool creates a new pool with the given poolPath and currentHeight.

Incentives

Incentives represents a collection of external incentives for a specific pool. Fields: - incentives: BPTree storing ExternalIncentive objects indexed by incentiveId The incentiveId serves as the key to efficiently lookup incentive details - targetPoolPath: String identifier for the pool this incentive collection belongs to Used to associate incentives with their corresponding liquidity pool - unclaimablePeriods: Tree storing periods when rewards cannot be claimed Maps start timestamp (key) to end timestamp (value) An end timestamp of 0 indicates an ongoing unclaimable period Used to track intervals when staking rewards are not claimable

NewIncentives

ExternalIncentive

NewExternalIncentive

NewExternalIncentive creates a new external incentive

Ticks

Tick mapping for each pool

NewTicks

Tick

Tick represents the state of a specific tick in a pool. Fields: - id (int32): The ID of the tick. - stakedLiquidityGross (\*u256.Uint): Total gross staked liquidity at this tick. - stakedLiquidityDelta (\*i256.Int): Net change in staked liquidity at this tick. - outsideAccumulation (\*UintTree): RewardRatioAccumulation outside the tick.

NewTick

TierRatio

100%, 0%, 0% if no tier2 and tier3 80%, 0%, 20% if no tier2 70%, 30%, 0% if no tier3 50%, 30%, 20% if has tier2 and tier3

NewTierRatio

SwapBatchProcessor

SwapBatchProcessor processes tick crosses in batch for a swap This processor accumulates all tick crosses that occur during a single swap and processes them together at the end, reducing redundant calculations and state updates that would occur with individual tick processing

NewSwapBatchProcessor

SwapTickCross

SwapTickCross stores information about a tick cross during a swap This struct is used to accumulate tick cross events during a single swap transaction for batch processing to optimize gas usage and computational efficiency

NewSwapTickCross

StakeToken

StakeToken stakes a position NFT to earn rewards. Parameters: - positionId: ID of the position to stake - referrer: referrer address for reward tracking Returns: - string: deposit ID

UnStakeToken

UnStakeToken unstakes a position NFT and collects rewards. Parameters: - positionId: ID of the position to unstake Returns: - string: collected reward details

CollectReward

CollectReward collects accumulated rewards from a staked position. Parameters: - positionId: ID of the staked position Returns: - string: pool path - string: staking details - map\[string]int64: internal rewards - map\[string]int64: external rewards

SetPoolTier

SetPoolTier sets the reward tier for a pool.

ChangePoolTier

ChangePoolTier changes the reward tier of a pool.

RemovePoolTier

RemovePoolTier removes a pool from the tier system.

CreateExternalIncentive

CreateExternalIncentive creates an external reward incentive for a pool. Parameters: - targetPoolPath: pool to incentivize - rewardToken: token to use as reward - rewardAmount: total reward amount - startTimestamp: incentive start time - endTimestamp: incentive end time

EndExternalIncentive

EndExternalIncentive terminates an external incentive early.

CollectExternalIncentivePenalty

CollectExternalIncentivePenalty collects accumulated warmup penalties for an ended incentive.

AddToken

AddToken adds a token to the reward token whitelist.

RemoveToken

RemoveToken removes a token from the reward token whitelist.

SetWarmUp

SetWarmUp sets the warm-up period parameters for staking.

SetDepositGnsAmount

SetDepositGnsAmount sets the deposit GNS amount

SetMinimumRewardAmount

SetMinimumRewardAmount sets the minimum reward amount to distribute.

SetTokenMinimumRewardAmount

SetTokenMinimumRewardAmount sets minimum reward amounts per token.

SetUnStakingFee

SetUnStakingFee sets the unstaking fee percentage.

ErrSpoofedRealm

kvStore

versionManager

implementation

init.127

initRegisterWritableContract

initializeDomainStore

getImplementation

updateImplementation

StoreKey

StoreKeyDepositGnsAmount

StoreKeyMinimumRewardAmount

StoreKeyDeposits

StoreKeyExternalIncentives

StoreKeyTotalEmissionSent

StoreKeyAllowedTokens

StoreKeyIncentiveCounter

StoreKeyTokenSpecificMinimumRewards

StoreKeyUnstakingFee

StoreKeyPendingProtocolFees

StoreKeyPools

StoreKeyPoolTierMemberships

StoreKeyPoolTierRatio

StoreKeyPoolTierCounts

StoreKeyPoolTierLastRewardCacheTimestamp

StoreKeyPoolTierCurrentEmission

StoreKeyPoolTierGetEmission

StoreKeyPoolTierGetHalvingBlocksInRange

StoreKeyWarmupTemplate

StoreKeyCurrentSwapBatch

StoreKeyExternalIncentivesByCreationTime

stakerStore

NewStakerStore

NewStakerStore creates a new staker store instance with the provided KV store. This function is used by the upgrade system to create storage instances for each implementation.

makeIncentiveID

contains

UintTree

UintTree is a wrapper around a B+ tree for storing block timestamps as strings. Since block timestamps are defined as int64, we take int64 and convert it to uint64 for the tree. Methods: - Get: Retrieves a value associated with a uint64 key. - Set: Stores a value with a uint64 key. - Has: Checks if a uint64 key exists in the tree. - Remove: Removes a uint64 key and its associated value. - Iterate: Iterates over keys and values in a range. - ReverseIterate: Iterates in reverse order over keys and values in a range.

NewBPTreeN

NewBPTreeN allocates a raw BP-tree under /r/gnoswap/staker's realm context (the realm that declares Pool/Deposit/ExternalIncentive). The tree's PkgID is therefore /r/gnoswap/staker, matching the domain values it stores, so tree.Set leaf-slot writes clear the readonly-taint gate regardless of which realm (staker/v1, mock) calls Set (borrow rule #2 borrows m.Realm to the tree's owning realm). Implementations and mocks must allocate trees that hold /r/gnoswap/staker-declared values through here rather than calling bptree.NewBPTreeN directly in their own realm.

NewUintTree

NewUintTree creates a new UintTree instance with default fanout 64.

NewUintTreeN

NewUintTreeN creates a new UintTree instance with the specified fanout.

EncodeUint

EncodeUint converts a uint64 number into a zero-padded 20-character string. Parameters: - num (uint64): The number to encode. Returns: - string: A zero-padded string representation of the number. Example: Input: 12345 Output: "00000000000000012345"

EncodeInt64

DecodeUint

DecodeUint converts a zero-padded string back into a uint64 number. Parameters: - s (string): The zero-padded string. Returns: - uint64: The decoded number. Panics: - If the string cannot be parsed into a uint64. Example: Input: "00000000000000012345" Output: 12345

DecodeInt64

EncodeInt

EncodeInt takes an int32 and returns a zero-padded decimal string with up to 10 digits for the absolute value. If the number is negative, the '-' sign comes first, followed by zeros, then digits.

IStaker

IStakerManager

IStakerGetter

IStakerStore

RegisterInitializer

RegisterInitializer registers a new staker implementation version. This function is called by each version (v1, v2, etc.) during initialization to register their implementation with the proxy system. The initializer function creates a new instance of the implementation using the provided stakerStore interface. Security: Only contracts within the domain path can register initializers. Each package path can only register once to prevent duplicate registrations.

UpgradeImpl

UpgradeImpl switches the active staker implementation to a different version. This function allows seamless upgrades from one version to another without data migration or downtime. Security: Only admin or governance can perform upgrades. The new implementation must have been previously registered via RegisterInitializer.

GetImplementationPackagePath

GetImplementationPackagePath returns the package path of the currently active implementation.