staker state

Counter

NewCounter

DelegationType

DelegationType represents the type of delegation operation

DelegateType

UnDelegateType

Delegation

Delegation represents a delegation between two addresses

NewDelegation

NewDelegation creates a new delegation

NewDelegationTree

NewUserDelegationTree

DelegationManager

DelegationManager manages the mapping between users and their delegation IDs. It provides efficient lookup and management of user delegations organized by delegator and delegatee addresses.

NewDelegationManager

NewDelegationManager creates a new instance of DelegationManager. This factory function initializes the BPTree structure for tracking user delegations.

DelegationWithdraw

DelegationWithdraw represents a pending withdrawal from a delegation. This struct tracks undelegated amounts that are subject to lockup periods and manages the collection process once the lockup period expires.

NewDelegationWithdraw

NewDelegationWithdraw creates a new delegation withdrawal with lockup period. The withdrawal will be collectable after the lockup period expires. Parameters: - delegationID: unique identifier of the associated delegation - unDelegateAmount: amount being withdrawn - createdAt: timestamp when the withdrawal was created - unDelegationLockupPeriod: duration of the lockup period in seconds Returns: - \*DelegationWithdraw: new withdrawal instance with lockup

NewDelegationWithdrawWithoutLockup

NewDelegationWithdrawWithoutLockup creates a new delegation withdrawal that is immediately collectable. This is used for special cases like redelegation where no lockup period is required. Parameters: - delegationID: unique identifier of the associated delegation - unDelegateAmount: amount being withdrawn - createdAt: timestamp when the withdrawal was created Returns: - \*DelegationWithdraw: new withdrawal instance that is immediately collected

errFailedToCastRewardState

EmissionRewardManager

EmissionRewardManager manages the distribution of emission rewards to stakers.

NewEmissionRewardManager

NewEmissionRewardManager creates a new instance of EmissionRewardManager. This factory function initializes all tracking structures for emission reward management. NewEmissionRewardManager creates new emission reward manager instance.

EmissionRewardState

EmissionRewardState tracks emission reward information for an individual staker. This struct maintains reward debt, accumulated rewards, and claiming history to ensure accurate reward calculations and prevent double-claiming.

NewEmissionRewardState

NewEmissionRewardState creates a new emission reward state for a staker. This factory function initializes the state with the current system reward debt. Parameters: - accumulatedRewardX128PerStake: current system-wide accumulated reward per stake Returns: - \*EmissionRewardState: new emission reward state instance

ErrSpoofedRealm

ErrSpoofedRealm is returned by store Set\* methods when the supplied realm token does not match the current crossing frame (rlm.IsCurrent() is false), rejecting spoofed or stale realm tokens before any write is performed.

cloneInt64Slice

cloneAddressSlice

cloneStringInt64Map

cloneDelegationWithdraws

GetTotalxGnsSupply

GetTotalxGnsSupply returns the total supply of xGNS tokens.

GetTotalDelegated

GetTotalDelegated returns the total amount of GNS delegated.

GetTotalLockedAmount

GetTotalLockedAmount returns the total amount of GNS locked in undelegation.

GetUnDelegationLockupPeriod

GetUnDelegationLockupPeriod returns the undelegation lockup period in seconds.

GetDelegationCount

GetDelegationCount returns the total number of delegations.

GetDelegationIDs

GetDelegationIDs returns all delegation IDs for a specific delegator-delegatee pair.

ExistsDelegation

ExistsDelegation checks if a delegation exists.

GetDelegation

GetDelegation returns the delegation for the given ID.

GetDelegatorDelegateeCount

GetDelegatorDelegateeCount returns the number of delegatees for a specific delegator.

GetDelegatorDelegateeAddresses

GetUserDelegationCount

GetUserDelegationCount returns the number of delegations for a specific delegator-delegatee pair.

GetUserDelegationIDs

GetUserDelegationIDs returns a list of delegation IDs for a specific delegator-delegatee pair.

HasDelegationSnapshotsKey

HasDelegationSnapshotsKey returns true if delegation history exists.

GetTotalDelegationAmountAtSnapshot

GetTotalDelegationAmountAtSnapshot returns the total delegation amount at a specific snapshot time.

GetUserDelegationAmountAtSnapshot

GetUserDelegationAmountAtSnapshot returns the user delegation amount at a specific snapshot time.

GetClaimableRewardByAddress

GetClaimableRewardByAddress returns claimable rewards for an address. Returns: - int64: emission reward amount - map\[string]int64: protocol fee rewards by token path

GetClaimableRewardByLaunchpad

GetClaimableRewardByLaunchpad returns claimable launchpad rewards for an address. Returns: - int64: emission reward amount - map\[string]int64: protocol fee rewards by token path

GetClaimableRewardByRewardID

GetClaimableRewardByRewardID returns claimable reward details by reward ID. Returns: - int64: emission reward amount - map\[string]int64: protocol fee rewards by token path

GetLaunchpadProjectDeposit

GetLaunchpadProjectDeposit returns the deposit amount for a launchpad project.

GetDelegationWithdrawCount

GetDelegationWithdrawCount returns the total number of delegation withdraws for a specific delegation.

GetDelegationWithdraws

GetDelegationWithdraws returns a paginated list of delegation withdraws for a specific delegation.

GetCollectableWithdrawAmount

GetCollectableWithdrawAmount returns the collectable withdraw amount for a specific delegation.

GetProtocolFeeAccumulatedX128PerStake

GetProtocolFeeAccumulatedX128PerStake returns the accumulated protocol fee per stake (Q128) for a token path.

GetProtocolFeeAmount

GetProtocolFeeAmount returns the protocol fee amount for a specific token

GetProtocolFeeAccumulatedTimestamp

GetProtocolFeeAccumulatedTimestamp returns the accumulated timestamp for protocol fee rewards.

GetEmissionAccumulatedX128PerStake

GetEmissionAccumulatedX128PerStake returns the accumulated emission per stake (Q128).

GetEmissionDistributedAmount

GetEmissionDistributedAmount returns the total distributed emission amount.

GetEmissionAccumulatedTimestamp

GetEmissionAccumulatedTimestamp returns the accumulated timestamp for emission rewards.

LaunchpadProjectDeposits

LaunchpadProjectDeposits manages deposit amounts for launchpad projects. It tracks the total staked amount for each project identified by owner address.

NewLaunchpadProjectDeposits

NewLaunchpadProjectDeposits creates a new instance of LaunchpadProjectDeposits.

ProtocolFeeRewardManager

ProtocolFeeRewardManager manages the distribution of protocol fee rewards to stakers. Unlike emission rewards, protocol fees can come from multiple tokens, requiring separate tracking and distribution mechanisms for each token type.

NewProtocolFeeRewardManager

NewProtocolFeeRewardManager creates a new instance of ProtocolFeeRewardManager. This factory function initializes all tracking structures for multi-token protocol fee reward management. Returns: - \*ProtocolFeeRewardManager: new protocol fee reward manager instance

ProtocolFeeRewardState

ProtocolFeeRewardState tracks protocol fee reward information for an individual staker across multiple tokens. Unlike emission rewards which are single-token, protocol fees can come from various trading pairs, requiring separate tracking and calculation for each token type.

NewProtocolFeeRewardState

NewProtocolFeeRewardState creates a new protocol fee reward state for a staker. This factory function initializes the state with the current system reward debt for all tokens.

Delegate

Delegate stakes GNS tokens to a delegatee address. Parameters: - to: address to delegate to - amount: amount of GNS to delegate - referrer: referrer address for reward tracking Returns: - int64: delegation ID

Undelegate

Undelegate initiates the undelegation process for staked GNS. Parameters: - from: delegatee address to undelegate from - amount: amount of GNS to undelegate Returns: - int64: undelegation result code

Redelegate

Redelegate moves delegation from one delegatee to another. Parameters: - delegatee: current delegatee address - newDelegatee: new delegatee address - amount: amount to redelegate Returns: - int64: redelegation result code

CollectUndelegatedGns

CollectUndelegatedGns collects GNS tokens after the undelegation lockup period. Returns: - int64: amount of GNS collected

CollectReward

CollectReward claims accumulated staking rewards.

CollectEmissionReward

CollectEmissionReward claims accumulated GNS emission rewards.

CollectProtocolFeeReward

CollectProtocolFeeReward claims accumulated protocol fee rewards for the provided token path.

CollectRewardFromLaunchPad

CollectRewardFromLaunchPad claims rewards from launchpad projects. Parameters: - to: address to collect rewards for

CollectEmissionRewardFromLaunchPad

CollectEmissionRewardFromLaunchPad claims accumulated launchpad emission rewards. Parameters: - to: address to collect rewards for

CollectProtocolFeeRewardFromLaunchPad

CollectProtocolFeeRewardFromLaunchPad claims accumulated launchpad protocol fee rewards for the provided token path. Parameters: - to: address to collect rewards for - tokenPath: token path to collect

SetAmountByProjectWallet

SetAmountByProjectWallet sets reward amount for a project wallet. Only callable by launchpad contract. Parameters: - addr: project wallet address - amount: reward amount - add: true to add, false to subtract

CleanStakerDelegationSnapshotByAdmin

CleanStakerDelegationSnapshotByAdmin removes old delegation snapshots for the total history and the user history of a single target address. Only callable by admin. Parameters: - threshold: timestamp threshold for cleanup - target: user address whose delegation history to clean

SetUnDelegationLockupPeriodByAdmin

SetUnDelegationLockupPeriodByAdmin sets the undelegation lockup period. Only callable by admin. Parameters: - period: lockup period in seconds

currentAddress

domainPath

kvStore

versionManager

implementation

init.76

initializeDomainStore

getImplementation

getImplementation returns the current active implementation

updateImplementation

StoreKeyUnDelegationLockupPeriod

Storage key constants

StoreKeyTotalDelegatedAmount

Storage key constants

StoreKeyTotalLockedAmount

Storage key constants

StoreKeyDelegationNextID

Storage key constants

StoreKeyDelegations

// BPTree of delegations

StoreKeyTotalDelegationHistory

// UintTree: timestamp -> int64 (cumulative total)

StoreKeyUserDelegationHistory

// BPTree: address -> \*UintTree\[timestamp -> int64]

StoreKeyEmissionRewardManager

Storage key constants

StoreKeyProtocolFeeRewardManager

Storage key constants

StoreKeyDelegationManager

Storage key constants

StoreKeyLaunchpadProjectDeposits

Storage key constants

govStakerStore

govStakerStore is the concrete implementation of IGovStakerStore

NewGovStakerStore

NewGovStakerStore creates a new governance staker store instance

UintTree

UintTree is a wrapper around a BPTree 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.

NewUintTree

NewUintTree creates a new UintTree instance.

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

IGovStaker

Main interface that combines all sub-interfaces

IGovStakerDelegation

Delegation operations interface Mutating methods take \`\_ int, rlm realm\` so the realm token is threaded from the proxy entry points down to the cross-realm token transfers and store writes performed inside each implementation. The \`\_ int\` sentinel surfaces at every call site as a literal \`0\`, making the realm threading visible to readers.

IGovStakerReward

Reward management interface

IGovStakerGetter

Getter interface for read operations

IGovStakerAdmin

Admin interface for administrative functions

IGovStakerStore

IGovStakerStore mirrors the mutating-method realm-threading convention used by the public IGovStaker\* interfaces above. Setters take \`\_ int, rlm realm\` so KV-store writes execute under the proxy realm — the only address with write access to the shared store.

RegisterInitializer

RegisterInitializer registers an implementation. This function is called by each implementation version during init. The initializer function creates a new instance of the implementation using the provided IGovStakerStore. It receives a realm value that resolves to the gov/staker proxy realm — the only address with write permission on the shared KV store — so any per-version store bootstrapping performed inside the initializer passes the proxy's authorization check.

UpgradeImpl

UpgradeImpl upgrades the implementation to a new version Only admin or governance can call this function

GetImplementationPackagePath

GetImplementationPackagePath returns the package path of the currently active implementation.