v1 state

validCallerRoles

MUST BE IMMUTABLE, DO NOT MODIFY. validCallerRoles is a list of roles that are authorized to modify referral data. This includes governance, governance staker, router, position, staker, and launchpad 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

EventRegisterFailed is emitted when an authorized non-empty write fails. Successful non-empty writes emit the RegisterReferral event.

init.11

GetReferral

GetReferral returns the referral address string stored for the given address. Parameters: - addr: address string whose referral relationship is queried. Returns: - referral: stored referrer address string, or an empty string when no valid referral is found.

HasReferral

HasReferral reports whether the given address has a stored referral. Parameters: - addr: address string whose referral relationship is checked. Returns: - hasReferral: true when a referral record exists; false when it is absent or invalid.

IsEmpty

IsEmpty reports whether the referral keeper contains no referral records. Returns: - empty: true when the keeper store has zero referral records.

GetLastOpTimestamp

GetLastOpTimestamp returns the last non-removal registration or update timestamp for an address. Parameters: - addr: address string whose last non-removal operation is queried. Returns: - timestamp: Unix timestamp of the last successful registration or update. - error: nil when a timestamp exists; otherwise an invalid-address or ErrNotFound error.

ContractAddress

ContractAddress returns the address of the referral contract. Use this address as the referral parameter in TryRegister to remove an existing referral. Returns: - address: referral contract address string, used as the removal sentinel.

TryRegister

TryRegister attempts to register, update, or remove a referral. Parameters: - cur: Current realm context; callers use cross(cur) when crossing into this realm. - addr: address whose referral relationship is read or changed. - referral: empty string for a read, ContractAddress() to remove, or a candidate referrer address string. Returns: - effectiveReferral: stored referrer after the operation or fallback; empty when none is stored. Empty input is treated as a read and returns the stored referrer without authorization, rate-limit checks, or event emission. Non-empty input requires an authorized caller.

MinTimeBetweenUpdates

keeper

keeper implements ReferralKeeper using BPTree storage. Non-removal registrations and updates use a 24-hour cooldown; removal via the contract-address sentinel bypasses that check and preserves the timestamp.

NewKeeper

NewKeeper creates an empty ReferralKeeper backed by independent referral and last-operation BPTrees. Returns: - keeper: new referral store with no relationships or operation timestamps

Render

Render describes referral registration or shows the referral for an address.

zeroAddress

selfAddress

init.24

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.