Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: public transaction notes #4693

Open
wants to merge 18 commits into
base: dev
Choose a base branch
from
Open

Feat: public transaction notes #4693

wants to merge 18 commits into from

Conversation

katspaugh
Copy link
Member

@katspaugh katspaugh commented Dec 19, 2024

What it solves

Resolves SW-700

This PR adds the ability to add a public note when creating a transaction. It's sent to the backend in the previously unused origin.name field as JSON.

The feature is behind a feature flag called TX_NOTES.

Adding a note

Screenshot 2024-12-27 at 12 19 49

Displaying a note

Screenshot 2024-12-27 at 12 18 22

How to test

  • Create a transaction
  • Attach a note
  • Submit the tx
  • Open a tx with a note in the queue
  • Confirm a tx with a note (it should not be editable!)

Copy link

github-actions bot commented Dec 19, 2024

Copy link

github-actions bot commented Dec 19, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
74.02% (-0.07% 🔻)
14584/19704
🔴 Branches
51.57% (-0.06% 🔻)
3470/6729
🔴 Functions
57% (-0.07% 🔻)
2063/3619
🟡 Lines
75.56% (-0.07% 🔻)
13229/17509
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🔴
... / TxNote.tsx
28% 0% 0% 31.82%
🔴
... / TxNoteForm.tsx
57.14% 50% 50% 53.85%
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / SignOrExecuteForm.tsx
90.91% (-2.15% 🔻)
86.11% (-2.29% 🔻)
42.86% (-7.14% 🔻)
90.41% (-2.24% 🔻)
🟢
... / useTxPendingStatuses.ts
77.5% (-0.83% 🔻)
64.06% (-1.56% 🔻)
68.18%
86.41% (-0.97% 🔻)

Test suite run success

1752 tests passing in 237 suites.

Report generated by 🧪jest coverage report action from 96a1684

Copy link

github-actions bot commented Dec 19, 2024

📦 Next.js Bundle Analysis for @safe-global/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 1 MB (🟡 +16.31 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Thirty-one Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/ 508 B (🟢 -2 B) 1.01 MB
/address-book 23.21 KB (🟡 +142 B) 1.03 MB
/apps 35.8 KB (🟡 +2.08 KB) 1.04 MB
/apps/custom 33.87 KB (🟡 +2.08 KB) 1.04 MB
/apps/open 55.57 KB (🟡 +1.96 KB) 1.06 MB
/balances 29.88 KB (🟡 +176 B) 1.03 MB
/balances/nfts 9.52 KB (🟢 -24 B) 1.01 MB
/bridge 2.56 KB (🟡 +2 B) 1.01 MB
/cookie 8.77 KB (🟡 +1 B) 1.01 MB
/home 61.38 KB (🟡 +2.12 KB) 1.06 MB
/new-safe/advanced-create 26.38 KB (🟢 -70 B) 1.03 MB
/new-safe/create 25.52 KB (🟢 -71 B) 1.03 MB
/privacy 14.57 KB (🟡 +2 B) 1.02 MB
/settings/appearance 2.25 KB (🟡 +2 B) 1.01 MB
/settings/environment-variables 3.27 KB (🟢 -1 B) 1.01 MB
/settings/modules 4.06 KB (🟡 +1 B) 1.01 MB
/settings/notifications 21 KB (🟢 -324 B) 1.03 MB
/settings/safe-apps 20.35 KB (🟡 +2.08 KB) 1.02 MB
/settings/security 2.34 KB (🟡 +1 B) 1.01 MB
/settings/setup 30.82 KB (🟡 +92 B) 1.03 MB
/share/safe-app 7.56 KB (🟢 -5 B) 1.01 MB
/stake 618 B (🟢 -1 B) 1.01 MB
/swap 761 B (🟡 +1 B) 1.01 MB
/terms 12.93 KB (🟡 +1 B) 1.02 MB
/transactions 99.47 KB (🟡 +2.9 KB) 1.1 MB
/transactions/history 99.43 KB (🟡 +2.9 KB) 1.1 MB
/transactions/messages 60.26 KB (🟡 +1.96 KB) 1.06 MB
/transactions/msg 56.51 KB (🟡 +1.96 KB) 1.06 MB
/transactions/queue 49.37 KB (🟡 +1.97 KB) 1.05 MB
/transactions/tx 48.73 KB (🟡 +1.96 KB) 1.05 MB
/welcome/accounts 409 B (🟡 +2 B) 1.01 MB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

Copy link

github-actions bot commented Dec 27, 2024

Coverage report for apps/web

St.
Category Percentage Covered / Total
🟡 Statements
74.13% (+0.02% 🔼)
14632/19738
🔴 Branches
51.71% (+0.01% 🔼)
3488/6745
🔴 Functions
57.09% (-0.04% 🔻)
2070/3626
🟡 Lines
75.68% (+0.02% 🔼)
13274/17540
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🟢
... / index.tsx
87.5% 100% 100% 100%
🟢
... / featureToggled.tsx
100% 75% 100% 100%
🟡
... / TxNote.tsx
55.56% 0% 0% 62.5%
🟢
... / TxNoteForm.tsx
100% 0% 0% 100%
🔴
... / TxNoteInput.tsx
46.15% 100% 0% 50%
🟢
... / encodeTxNote.ts
100% 100% 100% 100%
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / SignOrExecuteForm.tsx
91.57% (-1.49% 🔻)
86.67% (-1.74% 🔻)
50%
91.14% (-1.51% 🔻)

Test suite run success

1762 tests passing in 239 suites.

Report generated by 🧪jest coverage report action from 589e82e

@katspaugh katspaugh changed the title PoC: public transaction notes Feat: public transaction notes Dec 27, 2024
@katspaugh katspaugh marked this pull request as ready for review December 30, 2024 11:45
Copy link

Public transacnotes

@francovenica
Copy link
Contributor

@katspaugh The deployment has failed. Can you try again?

@katspaugh
Copy link
Member Author

@francovenica fixed! ✅

@francovenica
Copy link
Contributor

Issue:

When a tx is just signed and then executed by another owner, the "Note" field shows up again.

  • With ownerA create a tx with a note
  • With ownerB try to execute it
  • The note field is visible during execution

The filed should not show up or show as a read only input

@francovenica
Copy link
Contributor

francovenica commented Jan 7, 2025

Issue:

Notes created by "proposers" don't show in the tx. I'm not sure if it is possible since the user is just proposing the tx so it's only in the backend.

If is possible the note added by the proposer should show in the tx.
If it is not possible (because of the nature of the type of user) then we should remove the field when a tx is just proposed with no signature

@katspaugh
Copy link
Member Author

Fixed both, thank you. ✅
Notes now work for proposers too.

@francovenica
Copy link
Contributor

francovenica commented Jan 7, 2025

New issue I just noticed

Tx cannot be "Added to a batch". I tried in dev with the same type of tx and it is possible there, so it seems is only the changes done here that are causing this.

Could the note field make it impossible to add to a batch?
If the issues is the notes, maybe just allow "noteless" tx to be added to a batch

image

EDIT:
The "Add to batch" button is enabled as you enter into the tx form, but as soon as you write something in the notes it disables it. Even if you delete the comment the button won't re-enable

If you use the add to batch button by avoiding the notes completely, it saves it in the tx batch just fine, but the tx view shows a "no tx data found"
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: QA in progress
Development

Successfully merging this pull request may close these issues.

3 participants