deepbookv3-referral

Installation
SKILL.md

DeepBook V3: Referrals

DeepBook V3 includes a built-in referral system. It allows integrators and referrers to earn a portion of the trading fees generated by traders they refer to the platform.


1. Key Concepts

Referral Lifecycle

  1. Minting a Referral: Anyone can mint a DeepBookPoolReferral object for a specific pool. The referral is permanently tied to that pool.
  2. Associating a Referral: A trader associates their BalanceManager with the referrer's DeepBookPoolReferral ID.
  3. Earning Fees: When the trader executes taker orders in that pool, a portion of the taker fee is redirected to the referrer's accumulated balance. Maker orders do not generate referral fees.
  4. Claiming Rewards: The referrer can claim their accumulated base, quote, and DEEP tokens at any time.

Multiplier Rules

  • The referral multiplier determines the portion of trading fees allocated.
  • Multiple of 0.1: The multiplier must be a multiple of 0.1 (e.g., 0.1, 0.5, 1.2).
  • Maximum Limit: The multiplier cannot exceed 2.0.
  • Upgrades: Only the owner of the referral object can update its multiplier.
Installs
1
First Seen
Sep 4, 2026
deepbookv3-referral — nickthelegend/sui-deepbook-skills