protocol_fee state

GetDomainPath

GetDomainPath returns the domain path of the protocol fee contract. Returns: - domainPath: protocol fee contract domain path

GetVersionPackagePath

GetVersionPackagePath returns the current implementation package path. Returns: - packagePath: current implementation package path

cloneStringInt64Map

cloneStringSlice

cloneInt64Slice

DistributeProtocolFee

DistributeProtocolFee distributes accumulated protocol fees to DevOps and GovStaker, subject to the implementation's caller authorization and halt checks. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. Halt check: returns without distributing while the Withdraw halt scope is active.

DistributeProtocolFeeByTokenPath

DistributeProtocolFeeByTokenPath distributes accumulated protocol fees reserved for one token path; an unreserved path has nothing to distribute. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - tokenPath: token contract path whose reserved fee balance should be distributed Halt check: returns without distributing while the Withdraw halt scope is active.

SetDevOpsPct

SetDevOpsPct persists the DevOps allocation percentage. Parameters: - \_: Crossing discriminator for the store operation; pass 0. - rlm: Propagated realm context for this store write; it must be current (\`rlm.IsCurrent()\`). - pct: DevOps share of protocol fees in basis points; the state layer constrains this value to 0 through 10000 before calling the store. Returns: - err: Nil when the percentage is persisted; otherwise the current-realm or KV-store write error.

SetGovStakerPct

SetGovStakerPct sets the share of protocol fees allocated to GovStaker. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - pct: GovStaker allocation in basis-point units, from 0 through 10000 inclusive (10000 = 100%) Halt check: reverts while the ProtocolFee halt scope is active.

AddToProtocolFee

AddToProtocolFee pulls an approved fee amount from an authorized protocol caller into protocol-fee accounting. Authorized callers are pool, position, router, and staker realms; direct transfers to this address do not register a fee. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - tokenPath: token contract path whose fee is being collected - amount: non-negative fee amount in the token's base units; zero performs no transfer Returns: - err: nil on success; errSpoofedRealm for a spoofed-realm call; errProtocolFeeHalted when protocol-fee collection is halted Halt check: returns errProtocolFeeHalted without transferring while the ProtocolFee halt scope is active.

AdvanceAccrualEpoch

AdvanceAccrualEpoch closes the current accrual epoch and returns the new one. Fees arriving from now on are bucketed under the returned epoch. Only gov/staker may call it, on every stake change. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. Returns: - epoch: newly active non-negative accrual epoch used for subsequently collected GovStaker fees

ConsumeAccrualBuckets

ConsumeAccrualBuckets returns and clears up to limit of the oldest pending buckets of tokenPath as parallel epoch and amount slices. A limit of zero or less consumes every pending bucket. Only gov/staker may call it. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - tokenPath: token contract path whose pending GovStaker accrual buckets are consumed - limit: maximum number of oldest buckets to consume; zero or negative consumes all pending buckets Returns: - epochs: consumed accrual epoch numbers in ascending epoch order - amounts: GovStaker fee amounts corresponding positionally to epochs, in token base units

GetDevOpsPct

GetDevOpsPct reads the persisted DevOps allocation percentage. Returns: - pct: The stored DevOps allocation percentage in basis points; the method panics if the key is missing or cannot be decoded as int64.

GetGovStakerPct

GetGovStakerPct returns the GovStaker fee allocation in basis-point units. Returns: - pct: configured GovStaker allocation from 0 through 10000 (10000 = 100%)

GetAccrualEpoch

GetAccrualEpoch reads the epoch under which new Gov/Staker accrual buckets are recorded. Returns: - epoch: The persisted current accrual epoch; the method panics if the key is missing or cannot be decoded as int64.

GetAccrualPendingTokens

GetAccrualPendingTokens returns token paths that still own accrual buckets. Returns: - tokenPaths: Token paths in the pending-accrual index, in BP-tree iteration order.

GetAccrualBuckets

GetAccrualBuckets returns up to limit of the oldest pending buckets of tokenPath in epoch order. A limit of zero or less returns every pending bucket. Parameters: - tokenPath: Token path whose pending Gov/Staker accrual buckets should be read. - limit: Maximum number of buckets to return; zero or a negative value returns all pending buckets. Returns: - epochs: Epoch numbers for the returned buckets, in ascending BP-tree iteration order. - amounts: Gov/Staker amounts for the returned epochs; amounts\[i] corresponds to epochs\[i].

GetReservedTokens

GetReservedTokens returns all token paths currently reserved for distribution. Returns: - tokenPaths: Token paths present in the reserved-token index, in BP-tree iteration order.

GetAccuTransfersToGovStaker

GetAccuTransfersToGovStaker returns accumulated transfers to GovStaker. Returns: - transfers: map of token paths to accumulated amounts

GetAccuTransfersToDevOps

GetAccuTransfersToDevOps returns accumulated transfers to DevOps. Returns: - transfers: map of token paths to accumulated amounts

GetAccuTransferToGovStakerByTokenPath

GetAccuTransferToGovStakerByTokenPath returns accumulated GovStaker transfer for a token. Parameters: - tokenPath: path of the token Returns: - amount: accumulated transfer amount

GetAccuTransferToDevOpsByTokenPath

GetAccuTransferToDevOpsByTokenPath returns accumulated DevOps transfer for a token. Parameters: - tokenPath: path of the token Returns: - amount: accumulated transfer amount

GetActualDistributedToGovStaker

GetActualDistributedToGovStaker returns actual transfers completed to GovStaker. Returns: - transfers: map of token paths to actual distributed amounts

GetActualDistributedToDevOps

GetActualDistributedToDevOps returns actual transfers completed to DevOps. Returns: - transfers: map of token paths to actual distributed amounts

GetActualDistributedToGovStakerByTokenPath

GetActualDistributedToGovStakerByTokenPath returns actual GovStaker transfer for a token. Parameters: - tokenPath: path of the token Returns: - amount: actual distributed amount for the token

GetActualDistributedToDevOpsByTokenPath

GetActualDistributedToDevOpsByTokenPath returns actual DevOps transfer for a token. Parameters: - tokenPath: path of the token Returns: - amount: actual distributed amount for the token

Render

Render delegates web rendering to the active implementation.

currentAddress

domainPath

kvStore

versionManager

implementation

init.32

initializeDomainStore

getImplementation

updateImplementation

StoreKey

StoreKeyDevOpsPct

StoreKeyAccuToGovStaker

// tokenPath -> amount

StoreKeyAccuToDevOps

// tokenPath -> amount

StoreKeyDistributedToGovStakerHistory

// tokenPath -> amount

StoreKeyDistributedToDevOpsHistory

// tokenPath -> amount

StoreKeyReservedTokens

StoreKeyAccrualEpoch

StoreKeyAccrualBuckets

// tokenPath -> (epoch -> amount)

StoreKeyAccrualPendingTokens

// tokenPath -> true

defaultDevOpsPct

errSpoofedRealm

NewBPTreeN

NewBPTreeN allocates a BP-tree under /r/gnoswap/protocol\_fee's realm context so tree.Set leaf-slot writes clear the readonly-taint gate regardless of which realm (protocol\_fee/v1, mock, tests) calls Set. Callers must allocate protocol\_fee trees through here rather than bptree.NewBPTreeN directly. Parameters: - fanout: Branching factor passed to the BP-tree constructor. Returns: - tree: A new BP-tree configured with fanout and allocated in the protocol-fee realm context.

protocolFeeStore

collectTreeKeys

encodeEpochKey

decodeEpochKey

NewProtocolFeeStore

NewProtocolFeeStore creates a protocol-fee store backed by the provided KV store. This function is used by the upgrade system to create storage instances for each implementation. Parameters: - kvStore: Domain KV store used to persist protocol-fee state. Returns: - protocolFeeStore: An IProtocolFeeStore implementation backed by kvStore.

IProtocolFee

IProtocolFeeManager

IProtocolFeeGetter

IProtocolFeeStore

RegisterInitializer

RegisterInitializer registers a new protocol fee 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 protocolFeeStore interface. It receives a realm value that resolves to the protocol\_fee 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. Security: Only contracts within the domain path can register initializers. Each package path can only register once to prevent duplicate registrations. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - initializer: callback that receives the proxy realm context and protocol-fee store, initializes version-specific state, and returns the implementation instance

UpgradeImpl

UpgradeImpl switches the active protocol fee 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. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - packagePath: registered implementation package path to activate

GetImplementationPackagePath

GetImplementationPackagePath returns the package path of the currently active implementation. Returns: - packagePath: package path of the active implementation