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

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from
Draft

Feat: public transaction notes #4693

wants to merge 5 commits into from

Conversation

katspaugh
Copy link
Member

@katspaugh katspaugh commented Dec 19, 2024

What it solves

This PR hijacks the origin.name field in proposed transactions to attach a custom note to a tx. To avoid collisions with actual Safe App names used for this purpose, the note is encoded as JSON.

The note is then retrieved from the tx-service's origin field and JSON-parsed.

Adding a note:
Screenshot 2024-12-27 at 12 19 49

Displaying a note:
Screenshot 2024-12-27 at 12 18 22

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 (🟡 +15.41 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-two 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 MB
/address-book 23.07 KB (🟡 +4 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.74 KB (🟡 +37 B) 1.03 MB
/balances/nfts 9.52 KB (🟢 -24 B) 1.01 MB
/bridge 2.56 KB (🟡 +1 B) 1.01 MB
/cookie 8.77 KB (🟡 +1 B) 1.01 MB
/home 61.38 KB (🟡 +2.13 KB) 1.06 MB
/new-safe/advanced-create 26.39 KB (🟢 -68 B) 1.03 MB
/new-safe/create 25.52 KB (🟢 -67 B) 1.03 MB
/new-safe/load 6.08 KB (🟢 -5 B) 1.01 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.02 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.69 KB (🟢 -46 B) 1.03 MB
/share/safe-app 7.56 KB (🟢 -5 B) 1.01 MB
/stake 618 B (🟢 -1 B) 1 MB
/swap 759 B (🟢 -1 B) 1 MB
/terms 12.93 KB (🟡 +1 B) 1.02 MB
/transactions 98.65 KB (🟡 +2.08 KB) 1.1 MB
/transactions/history 98.61 KB (🟡 +2.08 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 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.1% (-0.01% 🔻)
14607/19712
🔴 Branches
51.66% (-0.05% 🔻)
3479/6734
🔴 Functions
57.07% (-0.04% 🔻)
2067/3622
🟡 Lines
75.64% (-0.01% 🔻)
13250/17517
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🟡
... / TxNote.tsx
74.07% 70% 75% 75%
🟢
... / TxNoteForm.tsx
83.33% 100% 33.33% 81.82%
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / safe-migrations.ts
97.44% (-0.13% 🔻)
88.89% (+1.39% 🔼)
100%
97.3% (-0.14% 🔻)
🟢
... / SignOrExecuteForm.tsx
90.59% (-2.47% 🔻)
84.21% (-4.2% 🔻)
50%
90.12% (-2.52% 🔻)
🟡
... / index.tsx
61.54% (-21.79% 🔻)
0% (-66.67% 🔻)
0% (-66.67% 🔻)
66.67% (-21.57% 🔻)

Test suite run success

1752 tests passing in 237 suites.

Report generated by 🧪jest coverage report action from ffb0f9e

@katspaugh katspaugh changed the title PoC: public transaction notes Feat: public transaction notes Dec 27, 2024
Comment on lines +17 to +20
const [data] = useAsync(() => {
if (!safeTxHash || !txService) return
return fetch(`${txService}/api/v1/multisig-transactions/${safeTxHash}`).then((res) => res.json())
}, [safeTxHash, txService])
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be replaced by safe-global/safe-client-gateway#2223

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

Successfully merging this pull request may close these issues.

1 participant