Frontend Integration
This guide explains how to integrate a frontend with Divvi V0 to register user referrals and receive rewards.
Registry Contract Details
ABI: You can find the contract ABI on the block explorer for the network you are using. For example, on Arbitrum, it is available near the bottom of this Arbiscan page.
Getting Started
To participate, complete this form. In the form, you will need to provide a referrer ID, which uniquely identifies your frontend. See Data Formatting Guidelines for details. Once your request is processed, this referrer ID will be added to the Registry Contract, enabling you to register referrals and receive Divvy rewards.
Registering User Referrals
Once your referrer ID is added, your frontend can register users as referrals. When these users transact with eligible protocols, Divvi V0 distributes rewards based on their activity.
Key Points to Remember
✅ Gas Fees: Registration requires an on-chain transaction, so the user must have sufficient funds for cover gas costs.
✅ Timing Matters: The registration transaction must be completed before the user interacts with the protocol. Transactions made before registration will not be tracked by Divvi V0.
For a frictionless user experience, we recommend including the registration transaction as part of the first transaction that the user makes with the protocol. This ensures they can complete the registration and immediately proceed with their intended action.
Checking If a User Is Already Registered
Before registering a user, it's important to check if they are already registered. Attempting to register a user who is already linked to a protocol is unnecessary and will result in a failed transaction. Use the isUserRegistered contract method to determine if a user is already registered with a protocol. The method returns a list of boolean values for each protocol.
import {
stringToHex,
createWalletClient,
http,
publicActions,
privateKeyToAccount,
} from 'viem'
import { arbitrum } from 'viem/chains'
const account = privateKeyToAccount('0x...')
const client = createWalletClient({
chain: arbitrum,
transport: http(),
account,
}).extend(publicActions)
const supportedProtocols = ['somm', 'celo']
const protocolsHex = supportedProtocols.map((protocol) =>
stringToHex(protocol, { size: 32 }),
)
const isUserRegisteredForProtocols = await client.readContract({
address: REGISTRY_CONTRACT_ADDRESS,
abi: registryContractAbi,
functionName: 'isUserRegistered',
args: [account.address, protocolsHex],
})
const protocolsToRegisterHex = protocolsHex.filter(
(_, index) => !isUserRegisteredForProtocols[index],
)
Submitting a Registration Transaction
For the protocols that the user is not already registered for, your frontend should send a transaction to register them.
import { encodeFunctionData } from 'viem'
const referrerId = 'awesome-frontend'
const referrerIdHex = stringToHex(referrerId, { size: 32 })
const registrationTransaction = {
from: walletAddress,
to: REGISTRY_CONTRACT_ADDRESS,
data: encodeFunctionData({
abi: registryContractAbi,
functionName: 'registerReferrals',
args: [referrerIdHex, protocolsToRegisterHex],
}),
}
const hash = await client.sendTransaction(registrationTransaction)
Confirming Registration
If the transaction succeeded, then it is guaranteed all passed protocols were registered. Alternatively, you can read the ReferralRegistered event(s) to confirm all registered protocols.
import { parseEventLogs, hexToString } from 'viem'
const receipt = await client.waitForTransactionReceipt({ hash })
if (receipt.status === 'success') {
const parsedLogs = parseEventLogs({
abi: registryContractAbi,
eventName: ['ReferralRegistered'],
logs: receipt.logs,
})
const registeredProtocolIds = parsedLogs.map((log) =>
hexToString(log.args.protocolId, { size: 32 }),
)
}
Data Formatting Guidelines
Referrer ID: This is the unique identifier you provide when registering your frontend. It should be a simple string (up to 32 characters) and must be converted to a 32-byte hex string for contract interactions.
Protocol Identifiers: Each protocol is identified by a specific string. Use the correct string when referencing a protocol and convert them to 32-byte hex strings for contract interactions. The recognized protocol identifiers are:
aerodrome, allbridge, beefy, celo, fonbnk, mento, somm, vana