Skip to content

Commit

Permalink
feat(referral): add guide
Browse files Browse the repository at this point in the history
  • Loading branch information
0xSacha committed May 22, 2024
1 parent 850e289 commit 056c11e
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 4 deletions.
4 changes: 0 additions & 4 deletions docs/concepts/guide/04-points.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,3 @@ So, the total pts earn by each user during the last 24 hours:
| 3 | 187 | 18 |
| 4 | 110 | 5 |
| 5 | 110 | 0 |

### Social

TBD
51 changes: 51 additions & 0 deletions docs/concepts/guide/05-referral.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: referrals
title: Referrals
sidebar_position: 5
---

## The Nimbora Affiliation Program

Referrals, within the context of Nimbora Protocol, are a vital component of our self-service affiliate program, designed to reward users for expanding our community. By referring new users, participants can earn additional points through a boosted calculation system, enhancing their overall earnings and helping to grow the Nimbora ecosystem.

When a user invites others to join Nimbora, they become the "parent" in the referral relationship, and the new user becomes their "child." This relationship forms a referral network where points are distributed based on user activity and their connections. For example, when a direct referral (child) earns points, a percentage of these points is also credited to the referring user (parent). This incentivizes users to actively recruit new members and support their engagement on the platform.

The Nimbora referral program is structured to provide significant benefits for active participants. Points earned through referrals are not just a flat rate; they are boosted by a percentage, which increases the more active the referred users are. This means that users who bring in highly engaged new members can see substantial rewards, promoting a vibrant and growing community.

Additionally, special boosted referral links can offer higher percentage rewards, encouraging users to utilize these links for maximum benefit. This layered incentive system ensures that both new and existing users are motivated to participate and contribute to the ongoing success and expansion of Nimbora.

### How to find a referral link

- Join our Discord community, and find some in the [Invite section](https://discord.com/channels/1157580917917892640/1242045588384514048)

- Explore partner protocols' social media channels, where referral links are often shared with additional boosts. Here are some examples of our partners: Spark, OnlyDust, Kakarot, StaknetQuest, zkLend, Herodotus, Carmine, Pragma.


### How to consume a referral link

- For now, access to the dapp requires a mandatory referral code. Access to the [Dapp](https://app.nimbora.io/referral/).

![Consume Referral](/content/refCode.png)


- Enter the referral code you found. Note that using a link will auto-complete the field. Finally sign a message and Voila! You are now referred and ready to start the aventure!

![Consume Referral](/content/refJoin.png)


### How to Become a Referrer

1. Head to the app points section: [Nimbora Points](https://app.nimbora.io/points/)
2. Find the box labeled "Refer a Friend."

![Refer a Friend](/content/ref.png)

3. Click the copy button to get your referral link, or directly click the X icon to share it with your community instantly. You can customize the tweet as you like.

### Benefits

Before calculating the referral points for each user, a boost is applied to the on-chain user's points (borrow + earn). By default, the boost is 10%, but some users who use partner links (boosted links) can receive a higher boost.

For more details, check the [points section](/docs/concepts/guide/points).


Binary file added static/content/ref.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/refCode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/refJoin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 056c11e

Please sign in to comment.