referral state

validCallerRoles

MUST BE IMMUTABLE, DO NOT MODIFY. validCallerRoles is a list of roles that are authorized to modify referral data. This includes governance contracts, router, position manager, and staker contracts.

assertValidCaller

assertValidCaller checks if the caller address has permission to modify referral data. Only addresses with specific roles defined in validCallerRoles are authorized. Errors: - ErrUnauthorized: the caller is not authorized to modify referral data

ErrInvalidAddress

ErrSelfReferral

ErrUnauthorized

ErrTooManyRequests

ErrNotFound

ErrInvalidTime

makeErrorWithDetails

gReferralKeeper

EventRegisterFailed

init.11

GetReferral

GetReferral returns the referral address for the given address.

HasReferral

HasReferral returns true if the given address has a referral.

IsEmpty

IsEmpty returns true if no referrals exist in the system.

GetLastOpTimestamp

GetLastOpTimestamp returns the last operation timestamp for the given address. Returns ErrNotFound if no operation exists.

ContractAddress

ContractAddress returns the address of the referral contract. Use this address as the referral parameter in TryRegister to remove an existing referral.

TryRegister

TryRegister attempts to register a new referral. Parameters: - addr: address to register - referral: referral address string Returns the effective referrer after applying registration or fallback. Empty input is treated as "no new referrer provided" and returns the stored referrer without attempting registration. Panics if the caller is not authorized for non-empty registration attempts.

MinTimeBetweenUpdates

keeper

keeper implements ReferralKeeper using BPTree storage. It includes rate limiting to prevent abuse.

NewKeeper

NewKeeper creates a new ReferralKeeper instance.

zeroAddress

selfAddress

init.23

contractAddress

isRemovalRequest

isRemovalRequest checks if the given address indicates a removal request. Removal is indicated by passing the contract's own address as the referral.

ReferralKeeper

ReferralKeeper defines the interface for managing referral relationships.