feat: Add referral feature #2355

bonomat · 2024-04-03T03:21:42Z

I thought I'd create a draft PR so that you can already have a looks.

Open todos:

subtract discount from order matching fee
stop subtracting discount after X time: 6673e84 (#2355)

Left user was referred by right user. I've manipulated the referral bonus requirements so that 1 trade pushed the referrer to level 3.
On the trade screen you see that the fee has been deducted. I didn't do the math, but it should be ~60% less.

Screen.Recording.2024-04-04.at.5.12.31.pm.mov

resolves #2341

coordinator/src/routes.rs

holzeis · 2024-04-03T06:18:22Z

coordinator/src/db/user.rs

-            users::version.eq(version),
-        ))
-        .execute(conn)?;
+    let affected_rows =


The logic above would have done an update on conflict. Isn't it safer the way it was before?

bonomat · 2024-04-03T22:51:45Z

Oh boy, you rebased it on top of feat/collab-liquidation? this is going to be painful as your PR #2354 is not small and I'm afraid it will take a while before it will land :/

bonomat · 2024-04-04T00:53:58Z

coordinator/src/routes.rs

@@ -167,10 +166,6 @@ pub fn router(
        // pass registration
        .route("/api/register", post(post_register))
        .route("/api/users", post(post_register))
-        .route(


I'd like to keep this endpoint as it's useful for debugging. I've moved it into admin

A database query would also do, though.. :)

bonomat · 2024-04-04T06:16:11Z

TODO:

we want to be able to share a link which leads to a 10101 website to download the app
update the bragging/share-meme image with this link
show fee discount on order view and summary
add referral code to share meme image

holzeis · 2024-04-04T06:18:35Z

Oh boy, you rebased it on top of feat/collab-liquidation? this is going to be painful as your PR #2354 is not small and I'm afraid it will take a while before it will land :/

I didn't expect a lot of changes on the PR #2354, but you can simple rebase again on main.. There haven't been many conflicts.

bonomat · 2024-04-05T06:42:23Z

Boy, this is harder than I thought...

In the last patch I've added that a referred user gets a bonus and rewrote the referring logic. We might want to squash those commits because I aint gonna rebase this 🙈.

In the final testing I've introduced a bug though: a user who enters a wrong referral code should not get a referral bonus.

I'll see to work on this on the weekend. But please review already.

holzeis

I didn't review it in a lot of detail, but it looks good to me and if it works it works 🙂

Overall this PR adds far more features than I would have anticipated for the first referral feature. Maybe a smaller change upon which we could have iterated would have made the change easier. 🙈

coordinator/src/db/bonus_tiers.rs

coordinator/src/orderbook/async_match.rs

coordinator/src/referrals.rs

mobile/lib/common/settings/user_screen.dart

mobile/native/src/ln_dlc/mod.rs

mobile/native/src/referrals.rs

bonomat · 2024-04-07T11:26:54Z

@holzeis : the last commit (c67f02f) simplifies the logic a lot again. I've removed unneeded features and reduced the program to refer X user-based referral program. A referred user only counts if he trades at least once. The referred user gets a bonus imediately.

bonomat · 2024-04-08T10:36:48Z

Last important point done:

holzeis · 2024-04-08T12:22:23Z

coordinator/migrations/2024-04-03-035827_add_matching_fee_to_trade_params/up.sql

@@ -0,0 +1,4 @@
+-- Your SQL goes here
+-- TODO: calculate the matching fee


I don't think this is necessary, since the trade params are only used temporarily. However, if you still want to do it I think its not hard to do.

Either way, lets get rid of that TODO :)

holzeis · 2024-04-08T12:25:25Z

coordinator/src/db/bonus_status.rs

+use time::OffsetDateTime;
+
+/// A user's referral bonus status may be active for this much days at max
+const MAX_DAYS_FOR_ACTIVE_REFERRAL_STATUS: i64 = 30;


❓ Shouldn't that go to the settings?

holzeis · 2024-04-08T12:28:32Z

coordinator/src/db/trades.rs

+    trader_pubkey: PublicKey,
+) -> Result<Vec<crate::trade::models::Trade>> {
+    // only take trades with open or closed positions
+    let subquery = positions::table


🔧 That should not be required anymore, since we only create a trade if the dlc protocol finished.

holzeis · 2024-04-08T15:01:38Z

coordinator/src/db/user.rs

@@ -128,6 +195,8 @@ pub fn login_user(
            fcm_token: token.clone(),
            version: version.clone(),
            last_login,
+            // TODO: this breaks the used referral code


❓ Why will this break the used referral code?

Break might be the wrong term, but since we allow users to register on login their referral code might not be forwarded. Alternatively we would need to add the referral code on login as well but that's a bit weird.
So imho, this function here is wrong, we shouldn't create a new user on login. :)

holzeis · 2024-04-08T15:03:22Z

coordinator/src/orderbook/trading.rs

+    let fee_discount = status.referral_fee_bonus;
+    let fee_percent = fee_percent - (fee_percent * fee_discount);
+
+    tracing::debug!(%fee_discount, total_fee_percent = %fee_percent, "Fee discount calculated");


🔧 We should add the trader_id here as otherwise this log message gets pretty useless.

holzeis · 2024-04-08T16:00:13Z

coordinator/src/referrals.rs

+    let user = db::user::get_user(connection, &trader_pubkey)?.context("User not found")?;
+
+    // we sort by tier_level, higher tier means better bonus
+    bonus_status.sort_by(|a, b| b.tier_level.cmp(&a.tier_level));


🤔 will that work? below are the bonus tiers. Any referred user will get the Referent tier as bonus tier when installing the app. Now this user might refer 50 user, thus he should get a 50% fee_rabate, but that won't happen because 4>3 so he is stuck on the Referent bonus tier until it gets inactive.

(0, 0, 0.0, 'Referral', true), (1, 3, 0.20, 'Referral', true), (2, 5, 0.35, 'Referral', true), (3, 10, 0.50, 'Referral', true), (4, 0, 0.1, 'Referent', true);

Am I missing something?

Note, I don't think we should order by bonus tier, which i think is not needed at all, just ordering by the fee_rabate should be sufficient, as we always want to give the user the best fee_rabate he is eligible for.

Any referred user will get the Referent tier as bonus tier when installing the app.

Not quite, only if you have a valid referral code.

Good catch though.

Fixed by adding the fee_rebate into the bonus table.

holzeis · 2024-04-08T16:04:56Z

coordinator/src/referrals.rs

+    }
+
+    // if he has no one referred so far, we check for an active referent bonus
+    if let Some(status) = has_active_referent_bonus(connection, bonus_status.as_slice(), &user)? {


🤔 Shouldn't that be already covered in the bonus status above

db::bonus_status::active_status_for_user(connection, &trader_pubkey)?; doesn't differentiate between Referent or Referral

good catch, removed

holzeis · 2024-04-08T16:06:29Z

coordinator/src/scheduler.rs

+    pool: Pool<ConnectionManager<PgConnection>>,
+) -> Result<Job, JobSchedulerError> {
+    Job::new_async(schedule, move |_, _| {
+        let mut conn = pool.get().expect("To be able to get a db connection");


🔧 do not expect here #2371

holzeis · 2024-04-08T16:11:52Z

mobile/lib/features/brag/brag.dart

+                                    return const CircularProgressIndicator();
+                                  }
+                                  return QrImageView(
+                                    data: "https://referral.10101.finance?referral=${snapshot.data!.referralCode}",


holzeis · 2024-04-08T18:41:48Z

mobile/native/src/api.rs

+    /// The user has been referred and gets a bonus
+    Referent,
+    /// This bonus is part of a promotion
+    Promotion,


🔧 this doesn't exist anymore

holzeis · 2024-04-08T18:45:28Z

nit: It would be great if we could show the fee_rabate on the order view, confirmation dialog and trade dialog.

No need for all this text. Imho this is self-explanatory.

In the app, we always register the user first, so we should do this here as well.

By default a referral status can be used for up to 1 month.

This patch also foresees a promo code. it has not been fully pulled through yet though.

These are the rules: - if a user gets referred, he gets a new `Referent` bonus. - after X referred users, the referring user gets a `Referral` bonus. - a `Referral` bonus is higher than a `Referent` bonus, hence, if a user got referred, but refers himself, he will only get the referral bonus. The bonus levels are as following for the time being: - get referred: -10% matching fee - refer 3 (active users - trade > 1): -20% - refer 5: -35% - refer 10: -50% The referral bonus is active for max 1 month.

This will make the text automatically scale down. Also, I've incorporated a feedback I've received a long time ago : Removing the opening price

bonomat · 2024-04-08T23:59:55Z

nit: It would be great if we could show the fee_rabate on the order view, confirmation dialog and trade dialog.

I propose doing this in a follow-up PR

bonomat marked this pull request as draft April 3, 2024 03:21

github-actions bot assigned bonomat Apr 3, 2024

holzeis reviewed Apr 3, 2024

View reviewed changes

coordinator/src/routes.rs Show resolved Hide resolved

holzeis reviewed Apr 3, 2024

View reviewed changes

bonomat force-pushed the feat/referrals branch from a4b1630 to 9faeb71 Compare April 3, 2024 07:46

holzeis force-pushed the feat/referrals branch 2 times, most recently from bc56097 to 9daf509 Compare April 3, 2024 14:22

holzeis changed the base branch from main to feat/collab-liquidation April 3, 2024 14:31

holzeis force-pushed the feat/referrals branch from 9daf509 to 7818723 Compare April 3, 2024 16:23

bonomat commented Apr 4, 2024

View reviewed changes

bonomat force-pushed the feat/referrals branch 2 times, most recently from 4e15aab to 6673e84 Compare April 4, 2024 05:42

bonomat marked this pull request as ready for review April 4, 2024 06:11

bonomat changed the title ~~[draft] feat: add referral feature~~ feat: add referral feature Apr 4, 2024

holzeis force-pushed the feat/collab-liquidation branch from 3d6cfc0 to 0f1ca45 Compare April 4, 2024 09:53

holzeis force-pushed the feat/referrals branch from 6673e84 to 6328365 Compare April 4, 2024 11:35

holzeis force-pushed the feat/collab-liquidation branch from 8675cc1 to b53e0c3 Compare April 4, 2024 11:50

holzeis force-pushed the feat/referrals branch 2 times, most recently from 3d50c00 to cdd499b Compare April 4, 2024 19:18

holzeis changed the title ~~feat: add referral feature~~ feat: Add referral feature Apr 4, 2024

bonomat force-pushed the feat/referrals branch 2 times, most recently from 6337229 to 3619217 Compare April 5, 2024 06:39

holzeis force-pushed the feat/collab-liquidation branch from b53e0c3 to e245c9c Compare April 5, 2024 11:56

holzeis force-pushed the feat/referrals branch from 3619217 to f6dad38 Compare April 5, 2024 11:56

holzeis approved these changes Apr 5, 2024

View reviewed changes

Base automatically changed from feat/collab-liquidation to main April 8, 2024 02:27

bonomat force-pushed the feat/referrals branch from c67f02f to 96d4dc0 Compare April 8, 2024 04:46

holzeis reviewed Apr 8, 2024

View reviewed changes

bonomat and others added 10 commits April 9, 2024 08:25

chore: add diesel just directives

101d345

chore: move user settings above wallet settings

1001f52

chore: simplify user screen

990f369

No need for all this text. Imho this is self-explanatory.

feat: allow users to provide referral code

10bc1b3

chore: register user before starting to trade

a711bbb

In the app, we always register the user first, so we should do this here as well.

chore: pull through order matching fee

ccb312c

feat: use fee rebate from deserved referral status

26bac46

chore: Load order matching fee rate from settings

456d387

chore(settings): Minor ui adjustments

9047b26

feat: add possibilty to expire referral status

26da582

By default a referral status can be used for up to 1 month.

bonomat force-pushed the feat/referrals branch from 470e682 to eda9f1a Compare April 8, 2024 23:53

bonomat added 6 commits April 9, 2024 09:54

feat: introduce referrer and referent

7d78459

This patch also foresees a promo code. it has not been fully pulled through yet though.

chore: change layout of brag mem

df4fe07

This will make the text automatically scale down. Also, I've incorporated a feedback I've received a long time ago : Removing the opening price

feat: add referral website into bragging meme

5c5399f

chore: print trader pubkey as well

4e3c245

fix: make sure to sort bonus tiers by fee rebate

8c5727d

bonomat force-pushed the feat/referrals branch from eda9f1a to 8c5727d Compare April 8, 2024 23:54

bonomat enabled auto-merge April 8, 2024 23:59

bonomat added this pull request to the merge queue Apr 9, 2024

Merged via the queue into main with commit 41afeb3 Apr 9, 2024
21 checks passed

bonomat deleted the feat/referrals branch April 9, 2024 00:29

bonomat mentioned this pull request Apr 9, 2024

Show the fee_rebate on the order view, confirmation dialog and trade dialog #2376

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add referral feature #2355

feat: Add referral feature #2355

bonomat commented Apr 3, 2024 •

edited

holzeis Apr 3, 2024

bonomat commented Apr 3, 2024

bonomat Apr 4, 2024

holzeis Apr 4, 2024

bonomat commented Apr 4, 2024 •

edited

holzeis commented Apr 4, 2024

bonomat commented Apr 5, 2024

holzeis left a comment •

edited

bonomat commented Apr 7, 2024

bonomat commented Apr 8, 2024

holzeis Apr 8, 2024

holzeis Apr 8, 2024

holzeis Apr 8, 2024

bonomat Apr 8, 2024

holzeis Apr 8, 2024

bonomat Apr 8, 2024

holzeis Apr 8, 2024

holzeis Apr 8, 2024

holzeis Apr 8, 2024

bonomat Apr 8, 2024

bonomat Apr 8, 2024

bonomat Apr 8, 2024

holzeis Apr 8, 2024

bonomat Apr 8, 2024

holzeis Apr 8, 2024

holzeis Apr 8, 2024

holzeis Apr 8, 2024

holzeis commented Apr 8, 2024

bonomat commented Apr 8, 2024

		@@ -0,0 +1,4 @@
		-- Your SQL goes here
		-- TODO: calculate the matching fee

feat: Add referral feature #2355

feat: Add referral feature #2355

Conversation

bonomat commented Apr 3, 2024 • edited

Choose a reason for hiding this comment

bonomat commented Apr 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bonomat commented Apr 4, 2024 • edited

holzeis commented Apr 4, 2024

bonomat commented Apr 5, 2024

holzeis left a comment • edited

Choose a reason for hiding this comment

bonomat commented Apr 7, 2024

bonomat commented Apr 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holzeis commented Apr 8, 2024

bonomat commented Apr 8, 2024

bonomat commented Apr 3, 2024 •

edited

bonomat commented Apr 4, 2024 •

edited

holzeis left a comment •

edited