sendtag checkout referral rewards (#615)

* shovel: update config to include URLs

* contracts: sendtag checkout emit receipts

* e2e: playwright can import esm only now

* app: handle already expired userop error

* wagmi: fixup types

* yarn lint after unit tests

* app: update sendtag checkout

This commit marks the first part of transitioning our Sendtag registration
process from Ethereum to USDC. It includes the following changes:

- Replace ETH pricing with USDC pricing for Sendtags
- Introduce new pricing structure and referral bonus system
- Update UI components to reflect new USDC pricing
- Refactor pricing logic into a separate module for better maintainability

New Pricing Structure (Registration Fee / Referral Bonus):
- 6+ characters: 7 USDC / 2 USDC
- 5 characters: 15 USDC / 4 USDC
- 4 characters: 30 USDC / 8 USDC
- 1-3 characters: 60 USDC / 16 USDC

Key changes:
1. Created new file 'app/data/sendtags.ts' to centralize pricing logic
2. Updated 'tagRouter' in 'api/src/routers/tag.ts' to use new pricing
3. Modified UI components to display USDC prices instead of ETH
4. Updated tests to reflect new USDC pricing

* supabase: sendtag checkout updates

- confirm_tags to use transfers to sendtag checkout contract
- update tag receipt activity
- updates tests

* e2e: update confirm tag

* update sendtag referrer for checkout

* e2e: update refer a tag

* app: show sendtag referral rewards activity

* clean up types

* update shovel config

* e2e: more playwright cleanup

* supabase sendtag checkout updates

* use sendtag_checkout_receipts for confirming tags

verify referrer and reward
updates sendtag checkout contract address

* supabase: remove sendtag checkout contract table

* supabase: update confirm_tags to use sendtag_checkout_receipts

* contracts: handle duplicate deploys on sendtag_checkout_receipts

* fixup activity spec

* playwright: cleanup home onboarded spec

* snapshot update

* e2e fixes

* lots of little tweaks and polish

* handle when not enough funds

* use sendtag for referrer

* rename fetchSendtagCheckoutTransfers to receipts

* fix referrer check logic

* simplify referrer check

* naming

* add assertions on checkout receipts

* more renaming

* add userop throwNiceError

* fix lints, cleanup, increase dbdev timeouts

* upgrade shovel ts config

* total price test

* add app/data/sendtags test

* little more cleanup

* invalidate queries

* fix lint error

Author: 0xBigBoss

.github/workflows/ci.yml

@@ -31,26 +31,6 @@ jobs:
           echo github.ref=${{ github.ref }}
           echo github.head_ref=${{ github.head_ref }}
 
-  lint:
-    runs-on: self-hosted
-    needs: [cache-deps]
-    env:
-      YARN_ENABLE_HARDENED_MODE: 0
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: recursive
-      - name: Setup Environment
-        uses: ./.github/actions/setup-env
-        env:
-          YARN_ENABLE_HARDENED_MODE: 0
-          SKIP_YARN_POST_INSTALL: 1
-      - name: Build
-        run: yarn build
-      - name: Lint
-        run: yarn lint
-
   unit-tests:
     name: Unit Tests
     runs-on: self-hosted
@@ -94,6 +74,8 @@ jobs:
         id: tilt-ci
         shell: bash
         run: tilt ci unit-tests --timeout=10m
+      - name: Lint
+        run: yarn lint
       - name: Tilt Down
         # always run tilt down if tilt ci started
         if: always() && steps.tilt-ci.outcome != 'skipped'

.snaplet/snaplet-client.d.ts

@@ -394,6 +394,27 @@ type Override = {
       event_id?: string;
     };
   }
+  sendtag_checkout_receipts?: {
+    name?: string;
+    fields?: {
+      id?: string;
+      event_id?: string;
+      chain_id?: string;
+      log_addr?: string;
+      block_time?: string;
+      tx_hash?: string;
+      sender?: string;
+      amount?: string;
+      referrer?: string;
+      reward?: string;
+      ig_name?: string;
+      src_name?: string;
+      block_num?: string;
+      tx_idx?: string;
+      log_idx?: string;
+      abi_idx?: string;
+    };
+  }
   tag_receipts?: {
     name?: string;
     fields?: {
@@ -715,6 +736,17 @@ export interface Fingerprint {
     logIdx?: FingerprintNumberField;
     abiIdx?: FingerprintNumberField;
   }
+  sendtagCheckoutReceipts?: {
+    id?: FingerprintNumberField;
+    chainId?: FingerprintNumberField;
+    blockTime?: FingerprintNumberField;
+    amount?: FingerprintNumberField;
+    reward?: FingerprintNumberField;
+    blockNum?: FingerprintNumberField;
+    txIdx?: FingerprintNumberField;
+    logIdx?: FingerprintNumberField;
+    abiIdx?: FingerprintNumberField;
+  }
   tagReceipts?: {
     id?: FingerprintNumberField;
     createdAt?: FingerprintDateField;

.snaplet/snaplet.d.ts

@@ -438,6 +438,23 @@ interface Table_public_send_token_transfers {
   log_idx: number;
   abi_idx: number;
 }
+interface Table_public_sendtag_checkout_receipts {
+  id: number;
+  chain_id: number;
+  log_addr: string;
+  block_time: number;
+  tx_hash: string;
+  sender: string;
+  amount: number;
+  referrer: string;
+  reward: number;
+  ig_name: string;
+  src_name: string;
+  block_num: number;
+  tx_idx: number;
+  log_idx: number;
+  abi_idx: number;
+}
 interface Table_auth_sessions {
   id: string;
   user_id: string;
@@ -619,6 +636,7 @@ interface Schema_public {
   send_liquidity_pools: Table_public_send_liquidity_pools;
   send_revenues_safe_receives: Table_public_send_revenues_safe_receives;
   send_token_transfers: Table_public_send_token_transfers;
+  sendtag_checkout_receipts: Table_public_sendtag_checkout_receipts;
   tag_receipts: Table_public_tag_receipts;
   tag_reservations: Table_public_tag_reservations;
   tags: Table_public_tags;

apps/distributor/package.json

@@ -29,7 +29,7 @@
     "viem": "^2.13.7"
   },
   "devDependencies": {
-    "@types/bun": "latest",
+    "@types/bun": "^1.1.6",
     "@types/express": "^4",
     "@types/supertest": "^2.0.16",
     "debug": "^4.3.5",

apps/workers/package.json

@@ -12,7 +12,7 @@
     "workflow": "node --import 'data:text/javascript,import { register } from \"node:module\"; import { pathToFileURL } from \"node:url\"; register(\"ts-node/esm\", pathToFileURL(\"./\"));' src/client.ts"
   },
   "devDependencies": {
-    "@types/bun": "latest",
+    "@types/bun": "^1.1.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.3"
   },

environment.d.ts

@@ -47,6 +47,9 @@ declare global {
    * if (__DEV__) console.log('Running in dev mode')
    */
   const __DEV__: boolean
+  interface Window {
+    ethereum: IWeb3Provider
+  }
 }
 
 export type {}

packages/api/src/routers/tag.ts

@@ -1,8 +1,14 @@
 import type { PostgrestError } from '@supabase/supabase-js'
 import { TRPCError } from '@trpc/server'
-import { getPrice } from 'app/features/account/sendtag/checkout/checkout-utils'
+import { reward, total } from 'app/data/sendtags'
+import {
+  fetchReferrer,
+  fetchSendtagCheckoutReceipts,
+} from 'app/features/account/sendtag/checkout/checkout-utils'
+import { assert } from 'app/utils/assert'
 import { hexToBytea } from 'app/utils/hexToBytea'
 import { supabaseAdmin } from 'app/utils/supabase/admin'
+import { throwIf } from 'app/utils/throwIf'
 import { byteaTxHash } from 'app/utils/zod'
 import debug from 'debug'
 import { withRetry } from 'viem'
@@ -23,7 +29,19 @@ export const tagRouter = createTRPCRouter({
     )
     .mutation(async ({ ctx: { supabase, referralCode }, input: { transaction: txHash } }) => {
       const { data: tags, error: tagsError } = await supabase.from('tags').select('*')
-
+      const { data: profile, error: profileError } = await supabase
+        .from('profiles')
+        .select('*')
+        .single()
+      // if profile error, return early
+      if (profileError || !profile) {
+        log('profile not found', profileError)
+        throw new TRPCError({
+          code: 'INTERNAL_SERVER_ERROR',
+          message: profileError.message || 'Profile not found',
+        })
+      }
+      // if tags error, return early
       if (tagsError) {
         if (tagsError.code === 'PGRST116') {
           log('no tags to confirm')
@@ -32,15 +50,38 @@ export const tagRouter = createTRPCRouter({
             message: 'No tags to confirm.',
           })
         }
+        log('tags error', tagsError)
         throw new TRPCError({
           code: 'INTERNAL_SERVER_ERROR',
           message: tagsError.message,
         })
       }
 
+      // if referral code is present and not the same as the profile, fetch the referrer profile
+      const referrerProfile = referralCode
+        ? await fetchReferrer({
+            supabase,
+            profile,
+            referralCode,
+          }).catch((e) => {
+            const error = e as unknown as PostgrestError
+            if (error.code === 'PGRST116') {
+              return null
+            }
+            throw new TRPCError({
+              code: 'INTERNAL_SERVER_ERROR',
+              message: error.message,
+            })
+          })
+        : null
+
       const pendingTags = tags.filter((t) => t.status === 'pending')
-      const ethAmount = getPrice(pendingTags)
+      const amountDue = total(pendingTags)
       const txBytea = byteaTxHash.safeParse(hexToBytea(txHash as `0x${string}`))
+      const rewardDue =
+        referrerProfile?.address && referrerProfile.tag // ensure referrer exists and has a tag
+          ? pendingTags.reduce((acc, t) => acc + reward(t.name.length), 0n)
+          : 0n
 
       if (!txBytea.success) {
         log('transaction hash required')
@@ -52,16 +93,12 @@ export const tagRouter = createTRPCRouter({
 
       const data = await withRetry(
         async () => {
-          const { data, error } = await supabase
-            .from('send_revenues_safe_receives')
-            .select('*')
+          const { data, error } = await fetchSendtagCheckoutReceipts(supabase)
             .eq('tx_hash', txBytea.data)
             .single()
-
-          if (error) {
-            throw error
-          }
-
+          throwIf(error)
+          assert(!!data, 'No checkout receipt found')
+          log('fetched checkout receipt', data)
           return data
         },
         {
@@ -91,33 +128,33 @@ export const tagRouter = createTRPCRouter({
         })
       })
 
-      const { event_id, sender: senderPgB16, v } = data
+      const { event_id, amount, referrer, reward: rewardSentStr } = data
+      const rewardSent = rewardSentStr ? BigInt(rewardSentStr) : 0n
 
-      if (!senderPgB16 || !v) {
-        log('no sender or v found', `txHash=${txHash}`)
-        throw new TRPCError({
-          code: 'BAD_REQUEST',
-          message: 'No sender or v found. Please try again.',
-        })
-      }
+      const invalidAmount = !amount || BigInt(amount) !== amountDue
+      const invalidReferrer =
+        (!referrer && rewardSent !== 0n) || // no referrer and reward is sent
+        (referrer && rewardSent !== rewardDue) // referrer and invalid reward
 
-      if (!v || BigInt(v) !== ethAmount) {
-        log('transaction is not a payment for tags or incorrect amount', `txHash=${txHash}`)
+      if (invalidAmount || invalidReferrer) {
+        log('transaction is not a payment for tags or incorrect amount', `txHash=${txHash}`, data)
         throw new TRPCError({
           code: 'BAD_REQUEST',
           message: 'Transaction is not a payment for tags or incorrect amount.',
         })
       }
 
+      log('confirming tags', `event_id=${event_id}`)
+
       // confirm all pending tags and save the transaction receipt
       const { error: confirmTagsErr } = await supabaseAdmin.rpc('confirm_tags', {
         tag_names: pendingTags.map((t) => t.name),
         event_id,
-        referral_code_input: referralCode ?? '',
+        referral_code_input: referrerProfile?.refcode ?? '',
       })
 
       if (confirmTagsErr) {
-        log('confirm tags error', confirmTagsErr)
+        console.error('confirm tags error', confirmTagsErr)
         throw new TRPCError({
           code: 'INTERNAL_SERVER_ERROR',
           message: confirmTagsErr.message,

packages/app/__mocks__/@my/wagmi/index.ts

@@ -40,6 +40,9 @@ const mockMyWagmi = {
   entryPointAddress: {
     845337: '0x0000000071727De22E5E9d8BAf0edAc6f37da032',
   },
+  sendtagCheckoutAddress: {
+    845337: '0xfC1e51BBae1C1Ee9e6Cc629ea0023329EA5023a6',
+  },
   sendVerifierAbi: [
     {
       type: 'function',
@@ -73,5 +76,6 @@ export const sendTokenAddress = mockMyWagmi.sendTokenAddress
 export const tokenPaymasterAddress = mockMyWagmi.tokenPaymasterAddress
 export const entryPointAddress = mockMyWagmi.entryPointAddress
 export const sendVerifierAbi = mockMyWagmi.sendVerifierAbi
+export const sendtagCheckoutAddress = mockMyWagmi.sendtagCheckoutAddress
 export const sendVerifierProxyAddress = mockMyWagmi.sendVerifierProxyAddress
 export default mockMyWagmi

packages/app/data/sendtags.test.ts

@@ -0,0 +1,30 @@
+import '@jest/globals'
+import { reward, total } from './sendtags'
+
+const decimals = 10n ** 6n
+
+const tags = [
+  { name: '1' }, // 60 USDC (16 USDC reward)
+  { name: '12' }, // 60 USDC (16 USDC reward)
+  { name: '123' }, // 60 USDC (16 USDC reward)
+  { name: '1234' }, // 30 USDC (8 USDC reward)
+  { name: '12345' }, // 15 USDC (4 USDC reward)
+  { name: '123456' }, // 7 USDC (2 USDC reward)
+  { name: '1234567' }, // 7 USDC (2 USDC reward)
+]
+
+const totalDue = (60n + 60n + 60n + 30n + 15n + 7n + 7n) * decimals
+
+const rewardDue = (16n + 16n + 16n + 8n + 4n + 2n + 2n) * decimals
+
+describe('Sendtag data', () => {
+  it('can calculate total correctly', () => {
+    expect(total(tags)).toEqual(totalDue)
+  })
+  it('can calculate reward correctly', () => {
+    const _reward = tags.reduce((acc, tag) => {
+      return acc + reward(tag.name.length)
+    }, 0n)
+    expect(_reward).toEqual(rewardDue)
+  })
+})