feat: integrate with divvy protocol #6492

kathaypacific · 2025-02-12T09:17:11Z

Description

This PR integrates the divvy protocol into the transaction flows:

the registration transaction is calculated and added to the prepared transactions the user will send so that the network fee quoted to the user can include the registration transaction
the registration transaction is sent first, before the rest of the prepared transactions

Test plan

the registration is completed with the user's first transaction
on wallet restore, the registration is not done again
the transaction flows continue to work without any user facing changes

Related issues

Fixes RET-1318

Backwards compatibility

Y

Network scalability

If a new NetworkId and/or Network are added in the future, the changes in this PR will:

Continue to work without code changes, OR trigger a compilation error (guaranteeing we find it when a new network is added)

codecov · 2025-02-12T09:25:23Z

Codecov Report

Attention: Patch coverage is 96.73913% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.07%. Comparing base (6ecfc3c) to head (36215b0).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/divviProtocol/registerReferral.ts	95.71%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6492      +/-   ##
==========================================
+ Coverage   89.04%   89.07%   +0.02%     
==========================================
  Files         732      732              
  Lines       31847    31932      +85     
  Branches     5818     6154     +336     
==========================================
+ Hits        28358    28443      +85     
  Misses       3442     3442              
  Partials       47       47

Files with missing lines	Coverage Δ
src/app/actions.ts	`94.52% <ø> (+2.73%)`	⬆️
src/app/reducers.ts	`26.50% <ø> (ø)`
src/app/selectors.ts	`96.29% <100.00%> (+0.14%)`	⬆️
src/config.ts	`96.39% <100.00%> (+0.06%)`	⬆️
src/divviProtocol/abi/Registry.ts	`100.00% <ø> (ø)`
src/divviProtocol/constants.ts	`100.00% <100.00%> (ø)`
src/viem/index.ts	`100.00% <100.00%> (ø)`
src/viem/prepareTransactions.ts	`99.10% <100.00%> (+0.01%)`	⬆️
src/viem/saga.ts	`96.49% <100.00%> (+0.65%)`	⬆️
src/divviProtocol/registerReferral.ts	`94.87% <95.71%> (+24.87%)`	⬆️

... and 1 file with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ecfc3c...36215b0. Read the comment docs.

jeanregisser

Awesome! 🚀

I like that this saves complexity for builders!

Like we discussed, I'm just slightly sad that they need to know about this extra transaction if they access the returned prepared transactions. But I don't have a good alternative 🤷 🤔

jeanregisser · 2025-02-12T14:02:41Z

src/divviProtocol/registerReferral.ts

@@ -22,3 +35,153 @@ export function isRegistrationTransaction(tx: TransactionRequest | SerializableT
    return false
  }
 }
+
+export async function createRegistrationTransactions({


nit: to make it more explicit about what it does

Suggested change

export async function createRegistrationTransactions({

export async function createRegistrationTransactionsIfNeeded({

jeanregisser · 2025-02-12T14:06:40Z

src/viem/prepareTransactions.test.ts

@@ -139,6 +142,57 @@ describe('prepareTransactions module', () => {
  }
  const mockPublicClient = {} as unknown as jest.Mocked<(typeof publicClient)[Network.Celo]>
  describe('prepareTransactions function', () => {
+    it('adds divvi registration transactions to the prepared transactions if there are any', async () => {


Suggested change

it('adds divvi registration transactions to the prepared transactions if there are any', async () => {

it('adds divvi registration transactions to the prepared transactions if needed', async () => {

jeanregisser · 2025-02-12T14:15:52Z

src/viem/saga.ts

+    nonce = yield* call(
+      sendPreparedRegistrationTransactions,
+      preparedRegistrationTransactions,
+      networkId,
+      wallet,
+      nonce
+    )


I think this shouldn't be waiting for registration TX receipt internally.
Otherwise it degrades the UX, especially on networks with longer block times.

Can we spawn the wait in sendPreparedRegistrationTransactions instead?

jeanregisser · 2025-02-12T14:18:38Z

src/viem/saga.test.ts

+const mockSendPreparedRegistrationTransactions = jest.fn()
+jest.mock('src/divviProtocol/registerReferral', () => ({
+  ...jest.requireActual('src/divviProtocol/registerReferral'),
+  sendPreparedRegistrationTransactions: (...args: any[]) =>
+    mockSendPreparedRegistrationTransactions(...args),
+}))


nit: this pattern is a bit nicer for type-safety

Suggested change

const mockSendPreparedRegistrationTransactions = jest.fn()

jest.mock('src/divviProtocol/registerReferral', () => ({

...jest.requireActual('src/divviProtocol/registerReferral'),

sendPreparedRegistrationTransactions: (...args: any[]) =>

mockSendPreparedRegistrationTransactions(...args),

}))

import { sendPreparedRegistrationTransactions } from 'src/divviProtocol/registerReferral'

jest.mock('src/divviProtocol/registerReferral', () => ({

...jest.requireActual('src/divviProtocol/registerReferral'),

sendPreparedRegistrationTransactions: jest.fn()

}))

const mockSendPreparedRegistrationTransactions = jest.mocked(sendPreparedRegistrationTransactions)

i actually did try this pattern before and lost a bunch of time trying to fix the the typescript error Argument of type 'number' is not assignable to parameter of type 'never'. when i try to do mockSendPreparedRegistrationTransactions.mockResolvedValue(11). and now i realise, it's a generator function and i don't need to mock it like this at all 🤦🏻‍♀️ i've updated this test to provide mocks via .provide

jeanregisser

Already approved with a suggestion.

jeanregisser · 2025-02-12T17:25:32Z

src/divviProtocol/registerReferral.ts

+      Logger.error(
+        `${TAG}/sendPreparedRegistrationTransactions`,
+        `Failed to send or parse prepared registration transaction`,
+        error
+      )


maybe we wanna let this bubble up?
so we don't send the other transactions if we're not able to submit the TX for registering?
reducing the chance to have unattributed transactions

jeanregisser

🚢 🚀

kathaypacific added 5 commits February 11, 2025 15:54

chore: add redux params

de4243d

fix: type

0c90d29

fix: knip

dcbf216

fix: ensure transaction sagas can handle registration transactions

58c1886

feat: integrate with divvy protocol

cbbc09a

kathaypacific added 18 commits February 12, 2025 10:27

chore: rename registrations variable

d3984dd

fix: type safe protocol ids

1b50b25

Merge branch 'kathy/fl-integration-1' into kathy/fl-integration-2

7c13a3c

fix: add try catch

883b938

fix: root schema

bb9564e

Merge branch 'kathy/fl-integration-1' into kathy/fl-integration-2

b887a35

Merge branch 'kathy/fl-integration-2' into kathy/fl-integration-3

eb22bcd

fix: rename

47e2a1d

fix: lint

ae376ff

chore: add first tests

e1627e9

Merge branch 'main' into kathy/fl-integration-2

87e2ff0

chore: add extra test

0761450

Merge branch 'kathy/fl-integration-2' into kathy/fl-integration-3

dd13d96

chore: add more tests

41707f0

fix: nonce

e8c969e

fix: test title

c7663f4

chore: add test

77397ce

chore: test

80f271b

kathaypacific marked this pull request as ready for review February 12, 2025 12:35

jeanregisser reviewed Feb 12, 2025

View reviewed changes

fix: comments

9fa65f9

Base automatically changed from kathy/fl-integration-2 to main February 12, 2025 16:31

kathaypacific added 2 commits February 12, 2025 17:33

Merge branch 'main' into kathy/fl-integration-3

56ae601

chore: spawn tx watcher

b26e9e6

jeanregisser approved these changes Feb 12, 2025

View reviewed changes

kathaypacific added 6 commits February 17, 2025 18:21

refactor: single referral tx

9ff81a3

Merge branch 'main' into kathy/fl-integration-3

da27367

fix: make it work with only one transaction

655c798

fix: some tests

d8de889

fix: more tests

22996d6

fix: tests

15ddd07

jeanregisser approved these changes Feb 18, 2025

View reviewed changes

kathaypacific added 2 commits February 19, 2025 09:02

chore: update contract address

29ffa92

chore: add one more test

36215b0

kathaypacific enabled auto-merge February 19, 2025 08:11

kathaypacific disabled auto-merge February 19, 2025 08:16

kathaypacific added this pull request to the merge queue Feb 19, 2025

Merged via the queue into main with commit 5fba34e Feb 19, 2025
15 checks passed

kathaypacific deleted the kathy/fl-integration-3 branch February 19, 2025 09:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: integrate with divvy protocol #6492

feat: integrate with divvy protocol #6492

kathaypacific commented Feb 12, 2025 •

edited

Loading

codecov bot commented Feb 12, 2025 •

edited

Loading

jeanregisser left a comment

jeanregisser Feb 12, 2025

jeanregisser Feb 12, 2025

jeanregisser Feb 12, 2025

jeanregisser Feb 12, 2025

kathaypacific Feb 12, 2025

jeanregisser left a comment

jeanregisser Feb 12, 2025

jeanregisser left a comment

	export async function createRegistrationTransactions({
	export async function createRegistrationTransactionsIfNeeded({

	it('adds divvi registration transactions to the prepared transactions if there are any', async () => {
	it('adds divvi registration transactions to the prepared transactions if needed', async () => {

feat: integrate with divvy protocol #6492

feat: integrate with divvy protocol #6492

Conversation

kathaypacific commented Feb 12, 2025 • edited Loading

Description

Test plan

Related issues

Backwards compatibility

Network scalability

codecov bot commented Feb 12, 2025 • edited Loading

Codecov Report

jeanregisser left a comment

Choose a reason for hiding this comment

jeanregisser Feb 12, 2025

Choose a reason for hiding this comment

jeanregisser Feb 12, 2025

Choose a reason for hiding this comment

jeanregisser Feb 12, 2025

Choose a reason for hiding this comment

jeanregisser Feb 12, 2025

Choose a reason for hiding this comment

kathaypacific Feb 12, 2025

Choose a reason for hiding this comment

jeanregisser left a comment

Choose a reason for hiding this comment

jeanregisser Feb 12, 2025

Choose a reason for hiding this comment

jeanregisser left a comment

Choose a reason for hiding this comment

kathaypacific commented Feb 12, 2025 •

edited

Loading

codecov bot commented Feb 12, 2025 •

edited

Loading