IReferralsUtils

Interface for GNSReferrals facet (inherits types and also contains functions, events, and custom errors)

initializeReferrals

function initializeReferrals(uint256 _allyFeeP, uint256 _startReferrerFeeP, uint256 _openFeeP, uint256 _targetVolumeUsd) external

Parameters

Name	Type	Description
_allyFeeP	uint256	% of total referral fee going to ally
_startReferrerFeeP	uint256	initial % of total referral fee earned when zero volume referred
_openFeeP	uint256	% of open fee going to referral fee
_targetVolumeUsd	uint256	usd opening volume to refer to reach 100% of referral fee

updateAllyFeeP

function updateAllyFeeP(uint256 _value) external

Updates allyFeeP

Parameters

Name	Type	Description
_value	uint256	new ally fee %

updateStartReferrerFeeP

function updateStartReferrerFeeP(uint256 _value) external

Updates startReferrerFeeP

Parameters

Name	Type	Description
_value	uint256	new start referrer fee %

updateReferralsOpenFeeP

function updateReferralsOpenFeeP(uint256 _value) external

Updates openFeeP

Parameters

Name	Type	Description
_value	uint256	new open fee %

updateReferralsTargetVolumeUsd

function updateReferralsTargetVolumeUsd(uint256 _value) external

Updates targetVolumeUsd

Parameters

Name	Type	Description
_value	uint256	new target volume in usd

whitelistAllies

function whitelistAllies(address[] _allies) external

Whitelists ally addresses

Parameters

Name	Type	Description
_allies	address[]	array of ally addresses

unwhitelistAllies

function unwhitelistAllies(address[] _allies) external

Unwhitelists ally addresses

Parameters

Name	Type	Description
_allies	address[]	array of ally addresses

whitelistReferrers

function whitelistReferrers(address[] _referrers, address[] _allies) external

Whitelists referrer addresses

Parameters

Name	Type	Description
_referrers	address[]	array of referrer addresses
_allies	address[]	array of corresponding ally addresses

unwhitelistReferrers

function unwhitelistReferrers(address[] _referrers) external

Unwhitelists referrer addresses

Parameters

Name	Type	Description
_referrers	address[]	array of referrer addresses

registerPotentialReferrer

function registerPotentialReferrer(address _trader, address _referral) external

Registers potential referrer for trader (only works if trader wasn't referred yet by someone else)

Parameters

Name	Type	Description
_trader	address	trader address
_referral	address	referrer address

distributeReferralReward

function distributeReferralReward(address _trader, uint256 _volumeUsd, uint256 _pairOpenFeeP, uint256 _gnsPriceUsd) external returns (uint256)

Distributes ally and referrer rewards

Parameters

Name	Type	Description
_trader	address	trader address
_volumeUsd	uint256	trading volume in usd (1e18 precision)
_pairOpenFeeP	uint256	pair open fee in % (1e10 precision)
_gnsPriceUsd	uint256	token price in usd (1e10 precision)

Return Values

Name	Type	Description
[0]	uint256	USD value of distributed reward (referrer + ally)

claimAllyRewards

function claimAllyRewards() external

Claims pending GNS ally rewards of caller

claimReferrerRewards

function claimReferrerRewards() external

Claims pending GNS referrer rewards of caller

getReferrerFeeP

function getReferrerFeeP(uint256 _pairOpenFeeP, uint256 _volumeReferredUsd) external view returns (uint256)

Returns referrer fee % of trade position size

Parameters

Name	Type	Description
_pairOpenFeeP	uint256	pair open fee in % (1e10 precision)
_volumeReferredUsd	uint256	referred trading volume in usd (1e18 precision)

getTraderLastReferrer

function getTraderLastReferrer(address _trader) external view returns (address)

Returns last referrer of trader (whether referrer active or not)

Parameters

Name	Type	Description
_trader	address	address of trader

getTraderActiveReferrer

function getTraderActiveReferrer(address _trader) external view returns (address)

Returns active referrer of trader

Parameters

Name	Type	Description
_trader	address	address of trader

getReferrersReferred

function getReferrersReferred(address _ally) external view returns (address[])

Returns referrers referred by ally

Parameters

Name	Type	Description
_ally	address	address of ally

getTradersReferred

function getTradersReferred(address _referrer) external view returns (address[])

Returns traders referred by referrer

Parameters

Name	Type	Description
_referrer	address	address of referrer

getReferralsAllyFeeP

function getReferralsAllyFeeP() external view returns (uint256)

Returns ally fee % of total referral fee

getReferralsStartReferrerFeeP

function getReferralsStartReferrerFeeP() external view returns (uint256)

Returns start referrer fee % of total referral fee when zero volume was referred

getReferralsOpenFeeP

function getReferralsOpenFeeP() external view returns (uint256)

Returns % of opening fee going to referral fee

getReferralsTargetVolumeUsd

function getReferralsTargetVolumeUsd() external view returns (uint256)

Returns target volume in usd to reach 100% of referral fee

getAllyDetails

function getAllyDetails(address _ally) external view returns (struct IReferrals.AllyDetails)

Returns ally details

Parameters

Name	Type	Description
_ally	address	address of ally

getReferrerDetails

function getReferrerDetails(address _referrer) external view returns (struct IReferrals.ReferrerDetails)

Returns referrer details

Parameters

Name	Type	Description
_referrer	address	address of referrer

UpdatedAllyFeeP

event UpdatedAllyFeeP(uint256 value)

Emitted when allyFeeP is updated

Parameters

Name	Type	Description
value	uint256	new ally fee %

UpdatedStartReferrerFeeP

event UpdatedStartReferrerFeeP(uint256 value)

Emitted when startReferrerFeeP is updated

Parameters

Name	Type	Description
value	uint256	new start referrer fee %

UpdatedOpenFeeP

event UpdatedOpenFeeP(uint256 value)

Emitted when openFeeP is updated

Parameters

Name	Type	Description
value	uint256	new open fee %

UpdatedTargetVolumeUsd

event UpdatedTargetVolumeUsd(uint256 value)

Emitted when targetVolumeUsd is updated

Parameters

Name	Type	Description
value	uint256	new target volume in usd

AllyWhitelisted

event AllyWhitelisted(address ally)

Emitted when an ally is whitelisted

Parameters

Name	Type	Description
ally	address	ally address

AllyUnwhitelisted

event AllyUnwhitelisted(address ally)

Emitted when an ally is unwhitelisted

Parameters

Name	Type	Description
ally	address	ally address

ReferrerWhitelisted

event ReferrerWhitelisted(address referrer, address ally)

Emitted when a referrer is whitelisted

Parameters

Name	Type	Description
referrer	address	referrer address
ally	address	ally address

ReferrerUnwhitelisted

event ReferrerUnwhitelisted(address referrer)

Emitted when a referrer is unwhitelisted

Parameters

Name	Type	Description
referrer	address	referrer address

ReferrerRegistered

event ReferrerRegistered(address trader, address referrer)

Emitted when a trader has a new active referrer

AllyRewardDistributed

event AllyRewardDistributed(address ally, address trader, uint256 volumeUsd, uint256 amountGns, uint256 amountValueUsd)

Emitted when ally rewards are distributed for a trade

Parameters

Name	Type	Description
ally	address	address of ally
trader	address	address of trader
volumeUsd	uint256	trade volume in usd (1e18 precision)
amountGns	uint256	amount of GNS reward (1e18 precision)
amountValueUsd	uint256	USD value of GNS reward (1e18 precision)

ReferrerRewardDistributed

event ReferrerRewardDistributed(address referrer, address trader, uint256 volumeUsd, uint256 amountGns, uint256 amountValueUsd)

Emitted when referrer rewards are distributed for a trade

Parameters

Name	Type	Description
referrer	address	address of referrer
trader	address	address of trader
volumeUsd	uint256	trade volume in usd (1e18 precision)
amountGns	uint256	amount of GNS reward (1e18 precision)
amountValueUsd	uint256	USD value of GNS reward (1e18 precision)

AllyRewardsClaimed

event AllyRewardsClaimed(address ally, uint256 amountGns)

Emitted when an ally claims his pending rewards

Parameters

Name	Type	Description
ally	address	address of ally
amountGns	uint256	GNS pending rewards amount

ReferrerRewardsClaimed

event ReferrerRewardsClaimed(address referrer, uint256 amountGns)

Emitted when a referrer claims his pending rewards

Parameters

Name	Type	Description
referrer	address	address of referrer
amountGns	uint256	GNS pending rewards amount

NoPendingRewards

error NoPendingRewards()

AlreadyActive

error AlreadyActive()

AlreadyInactive

error AlreadyInactive()

AllyNotActive

error AllyNotActive()