Ethereum Referral Protocol
Interfaces

IERP.sol

contracts/src/IERP.sol

newReferralProgram

function newReferralProgram(
    bytes32 programId, 
    address hook
) external

Parameters

NameTypeDescription
programIdbytes32Unique ID of the referral program
hookaddressReferral program hook

newReferral

function newReferral(
    bytes32 programId, 
    address referrer
) external

Parameters

NameTypeDescription
programIdbytes32Unique ID of the referral program
referreraddressAddress of the referrer

getReferrer

function getReferrer(
    bytes32 programId,
    address referral
) external view returns (
    address referrer
)

Parameters

NameTypeDescription
programIdbytes32Unique ID of the referral program
referraladdressAddress of the referral

Returns

NameTypeDescription
referreraddressAddress of the referrer

getTotalReferrals

function getTotalReferrals(
    bytes32 programId,
    address referrer
) external view returns (
    uint256 totalReferrals
)

Parameters

NameTypeDescription
programIdbytes32Unique ID of the referral program
referreraddressAddress of the referrer

Returns

NameTypeDescription
totalReferralsuint256Referrers total referrals in a program

getReferralProgramHook

function getReferralProgramHook(
    uint256 programId
) external view returns (
    address hook
)

Parameters

NameTypeDescription
programIdbytes32Unique ID of the referral program

Returns

NameTypeDescription
hookaddressReferral program hook

On this page