Affiliate Facet
The Affiliate Facet manages the lifecycle of affiliates (frontends/brokers) within the Account Layer. It handles registration, admin management, fee distribution configuration, hook contracts, operator permissions, express deposit settings, and delegated calls to Symmio core.
The Account Layer is a separate diamond from the Symmio Core diamond. It provides account management, affiliate infrastructure, and deposit routing on top of the core trading protocol.
Overview
The Affiliate Facet provides:
Registration: Affiliates submit registration requests which are approved by an
APPROVER_ROLE. Upon approval, an AccountManager contract is deployed and the affiliate is registered on its Symmio cores.Admin Management: Two-step admin transfer (propose → accept), display name/brand updates, and affiliate pause/unpause.
Fee Management: Two-step fee configuration updates (request → approve). Fees are split between stakeholders and a Symmio protocol share, summing to 100% (1e18 precision). Any stakeholder or
DISTRIBUTOR_ROLEcan trigger fee claims.Hook Management: Affiliates can set hook contracts per function selector that are called during account lifecycle events (account creation, call execution, deletion).
Operator Management: Affiliates authorize operators to call specific functions via
callAsAffiliate.Express Deposit Configuration: Affiliates configure the express deposit rate and virtual provider for split deposits.
Delegated Calls:
callAsAffiliateallows the affiliate admin or authorized operators to execute whitelisted Symmio core functions on behalf of the affiliate.
Affiliate Registration
requestToRegisterAffiliate()
Submits a registration request. The affiliate address is deterministic based on the registrant and name. The affiliate enters PENDING state.
Events: AffiliateRegistered(address affiliate, string name)
cancelRegistration()
Affiliate admin cancels a pending registration.
Events: RegistrationCancelled(address affiliate)
rejectRegistration()
Approver rejects a pending registration.
Events: RegistrationRejected(address affiliate, address rejector)
approveAffiliate()
Approver approves a pending affiliate. Deploys the AccountManager contract, generates a fee distributor address, registers the affiliate on all configured Symmio cores, and transitions to ACTIVE state.
Events: AffiliateApproved(address affiliate, address feeDistributor)
Admin Management
proposeAdminTransfer()
Proposes transferring the affiliate admin role to a new address (two-step).
Events: AdminTransferProposed(address affiliate, address newAdmin)
acceptAdminTransfer()
The proposed new admin accepts the transfer.
Events: AdminTransferCompleted(address affiliate, address oldAdmin, address newAdmin)
cancelAdminTransfer()
Cancels a pending admin transfer.
Events: AdminTransferCancelled(address affiliate)
updateAffiliateDetails()
Updates the display name and brand color.
Events: AffiliateUpdated(address affiliate, string name, string brandColor)
pauseAffiliate() / unpauseAffiliate()
Pauses an affiliate (callable by admin or PAUSER_ROLE), preventing new account creation. Unpausing requires UNPAUSER_ROLE.
Events: AffiliatePaused(address affiliate) / AffiliateUnpaused(address affiliate)
Fee Management
Fee shares are configured as stakeholders (each with a receiver address and share) plus a Symmio protocol share. All shares must sum to exactly 1e18 (100%).
requestFeeUpdate()
Requests a fee configuration update (two-step). Must be approved by APPROVER_ROLE.
Events: StakeholdersUpdateRequested(address affiliate)
cancelFeeUpdate()
Cancels a pending fee update.
Events: FeeUpdateCancelled(address affiliate)
approveFeeUpdate()
Approver applies the pending fee update.
Events: StakeholdersUpdated(address affiliate)
claimAllFees() / claimFees()
Claims accrued fees from a Symmio core and distributes to all stakeholders proportionally. Callable by any stakeholder or DISTRIBUTOR_ROLE.
Events: FeesClaimed(address affiliate, address symmio, uint256 amount) and FeesDistributed(address receiver, uint256 amount) per stakeholder
Hook & Operator Management
setHook() / removeHook()
Sets or removes a hook contract for a specific function selector.
Events: HookSet(address affiliate, bytes4 selector, address hook) / HookRemoved(address affiliate, bytes4 selector)
setOperator()
Grants or revokes operator permission for a function selector.
Events: OperatorSet(address affiliate, bytes4 selector, address operator, bool status)
Express Deposit Configuration
setExpressRate()
Sets the fraction of deposits routed to the virtual provider (1e18 precision, e.g., 0.1e18 = 10%).
Events: ExpressRateSet(address affiliate, uint256 expressRate)
setVirtualProvider()
Sets the virtual provider contract for express deposits. Required when expressRate > 0.
Events: VirtualProviderSet(address affiliate, address virtualProvider)
Delegated Calls
callAsAffiliate()
Executes a whitelisted function call on a Symmio core as the affiliate. The caller must be the affiliate admin or an authorized operator for the function selector. The selector must be in callAllowedSelectors for the affiliate.
Access: Affiliate admin or authorized operator. Symmio core must be in the affiliate's registered cores.
Last updated