> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inkyswap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Referral Program

> How referral links work, how points get attributed, and what users see.

When someone uses your referral link and then trades on InkyPump, you earn points on their trade volume. Referrals work for both V1 and V2 trades. They also work for token launches.

## How to share a referral link

Your referral code is your wallet address or a short alias you set on your account page. To refer someone, send them either:

```
https://inkypump.com/?ref=<your-code>
https://inkypump.com/join/<your-code>
```

Both work the same way. The `/join/<code>` route is meant for short links and message embedding. It stores the code in their browser and redirects to the home page.

## What happens when they visit

When a new visitor opens an InkyPump URL with your referral code, the site middleware stores the code in their browser's local storage under the key `ref`. From that point on, every trade and every token launch they make through the UI passes your code to the contract.

The user sees no difference in the UI. There is no banner. There is no obligation to use the link a second time. The code stays in their local storage and applies to every future trade.

The code persists until they clear browser storage or open the site with a different `?ref=` value, which overwrites it.

## What gets attributed to you

| Action                                                | What you earn                                             |
| ----------------------------------------------------- | --------------------------------------------------------- |
| They trade a V2 token with your code in local storage | Referral points equal to a fraction of their trade volume |
| They trade a V1 token with your code                  | Same, on the V1 trade volume                              |
| They launch a V2 token with your code                 | A flat referral bonus on the launch                       |

The exact share is computed off chain by the InkyPump backend. It is a multiplier on the volume points the trader themselves earn.

## How it works on chain

On V2, when a trader passes a referral code, the UI calls `buyWithReferral`, `sellWithReferral`, or `createLaunchWithReferral` on the InkyPump V2 hook. The contract emits a `Referral(launchId, trader, referralCode)` event in addition to the normal `Trade` or `LaunchCreated` event.

```solidity theme={null}
event Referral(
    uint256 indexed launchId,
    address indexed trader,
    string referralCode
);
```

The InkyPump indexer joins these events to the corresponding trade and credits points to the wallet behind the code.

On V1, the referral string was a parameter on every trade event. The indexer reads it directly from the V1 event log.

## What is not on chain

* No fee discount for using a referral
* No on chain payout. The referrer's points are tracked off chain
* No validation of the code. Any string is accepted by the contract

## Where to see your stats

On your account page on inkypump.com, the Team tab shows:

* Total referrals
* Number of unique referees
* Total volume from referees
* Total referral points earned

The data updates as new trades land and get indexed.

## API

To pull referral data programmatically, see [GET /api/referral/stats](/api-reference/inkypump/referral).
