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

Refactor(Tx decoding): use transaction preview endpoint #4783

Merged
merged 9 commits into from
Jan 20, 2025
Merged

Conversation

katspaugh
Copy link
Member

@katspaugh katspaugh commented Jan 15, 2025

What it solves

The old confirmation-view endpoint was deprecated but there's a new, better, transaction-preview endpoint.

This endpoint returns almost the same response as TransactionDetails and allows us to stop proposing new transactions just to decode them.

How to test it

Test the creation of different types of transactions:

  • Send ETH
  • Send tokens
  • Settings changes
  • Multisends
  • Safe App txs
  • Safe L2 migration
  • Safe upgrade

A known regression in MigrateToL2 that cannot be fixed with the current approach:

  • No custom decoding when creating an L2 migration
  • Decoding will work only for confirmations of an existing tx

Depends on this PR: safe-global/safe-gateway-typescript-sdk#209

Copy link

github-actions bot commented Jan 15, 2025

@katspaugh katspaugh requested a review from iamacook January 15, 2025 16:52
Copy link

github-actions bot commented Jan 15, 2025

Coverage report for apps/web

St.
Category Percentage Covered / Total
🟡 Statements
77.48% (-0.06% 🔻)
13875/17909
🔴 Branches
56.79% (-0.36% 🔻)
3491/6147
🟡 Functions
62.83% (-0.1% 🔻)
2088/3323
🟡 Lines
78.91% (-0.05% 🔻)
12520/15867
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🟢
... / useTxPreview.ts
84.62% 55.56% 100% 81.82%
🟢
... / useTxDetails.ts
90% 100% 100% 87.5%
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / hooks.ts
81.2% (+0.75% 🔼)
72.97% (+0.88% 🔼)
66.67% (-3.33% 🔻)
81.31% (+0.48% 🔼)
🟢
... / index.tsx
100%
86.11% (-3.68% 🔻)
100% 100%
🟡
... / index.tsx
62.5% (-12.5% 🔻)
10% (-25% 🔻)
33.33% (-16.67% 🔻)
63.89% (-11.11% 🔻)
🔴
... / SafeTxProvider.tsx
27.91% (-0.66% 🔻)
0% 36.36%
28.21% (-0.74% 🔻)
🟡
... / index.tsx
57.14% (-21.43% 🔻)
0% (-60% 🔻)
0% (-100% 🔻)
61.54% (-15.38% 🔻)
🟡
... / index.tsx
78.13% (+1.65% 🔼)
8.33% (-2.19% 🔻)
100%
77.42% (+1.66% 🔼)
🟢
... / useTxPendingStatuses.ts
77.5% (-0.83% 🔻)
64.06% (-1.56% 🔻)
68.18%
86.41% (-0.97% 🔻)
🟢
... / tokenTransferParams.ts
92.59% (-3.7% 🔻)
80% 80% 95.83%

Test suite run success

1786 tests passing in 241 suites.

Report generated by 🧪jest coverage report action from d71b02f

Copy link

github-actions bot commented Jan 15, 2025

📦 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.06 MB (🟡 +68.99 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
/ 509 B (🟢 -1 B) 1.06 MB
/address-book 23.21 KB (🟡 +143 B) 1.08 MB
/apps 35.97 KB (🟡 +2.25 KB) 1.09 MB
/apps/custom 34.03 KB (🟡 +2.25 KB) 1.09 MB
/apps/open 55.56 KB (🟡 +1.95 KB) 1.11 MB
/balances 30.01 KB (🟡 +314 B) 1.09 MB
/balances/nfts 9.52 KB (🟢 -23 B) 1.07 MB
/bridge 2.55 KB (🟢 -5 B) 1.06 MB
/cookie 8.77 KB (🟡 +1 B) 1.06 MB
/home 61.54 KB (🟡 +2.28 KB) 1.12 MB
/licenses 2.46 KB (🟢 -1 B) 1.06 MB
/new-safe/advanced-create 26.38 KB (🟢 -72 B) 1.08 MB
/new-safe/create 25.53 KB (🟢 -64 B) 1.08 MB
/privacy 14.57 KB (🟡 +2 B) 1.07 MB
/settings/appearance 2.25 KB (🟡 +1 B) 1.06 MB
/settings/cookies 1.87 KB (🟡 +1 B) 1.06 MB
/settings/modules 4.06 KB (🟡 +3 B) 1.06 MB
/settings/notifications 6.34 KB (🟢 -14.98 KB) 1.06 MB
/settings/safe-apps 20.35 KB (🟡 +2.08 KB) 1.08 MB
/settings/security 2.34 KB (🟡 +2 B) 1.06 MB
/settings/setup 30.97 KB (🟡 +246 B) 1.09 MB
/share/safe-app 7.55 KB (🟢 -8 B) 1.06 MB
/stake 617 B (🟢 -2 B) 1.06 MB
/swap 763 B (🟡 +3 B) 1.06 MB
/terms 12.93 KB (🟡 +1 B) 1.07 MB
/transactions 99.45 KB (🟡 +2.88 KB) 1.15 MB
/transactions/history 99.41 KB (🟡 +2.88 KB) 1.15 MB
/transactions/messages 60.25 KB (🟡 +1.95 KB) 1.12 MB
/transactions/msg 56.5 KB (🟡 +1.95 KB) 1.11 MB
/transactions/queue 49.36 KB (🟡 +1.96 KB) 1.1 MB
/transactions/tx 48.71 KB (🟡 +1.95 KB) 1.1 MB
/welcome/accounts 408 B (🟡 +1 B) 1.06 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.

@katspaugh katspaugh marked this pull request as ready for review January 16, 2025 08:27
@@ -18,6 +18,8 @@ interface Props {
toInfo?: AddressEx
}

const INTERACTED_WITH = 'Interacted with:'
Copy link
Member

Choose a reason for hiding this comment

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

Nit: this component is often used in the transaction flow meaning that it isn't yet executed so I think present tense makes more sense.

Copy link
Member Author

Choose a reason for hiding this comment

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

True, will restore it.

@@ -122,7 +94,7 @@ const DecodedTx = ({
</>
)}

{txDetails && !showDecodedData && !isCreation ? (
Copy link
Member

Choose a reason for hiding this comment

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

For other reviewers: this change confused me at first but the creation transaction renders fine.

Copy link
Member Author

@katspaugh katspaugh Jan 16, 2025

Choose a reason for hiding this comment

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

Yes, this change is not obvious. Before, isCreation was true if there are no signatures in txDetails. Because there was always txDetails even before signing. But now, there's no txDetails when creating a tx.

@francovenica
Copy link
Contributor

When migrating a safe to L2 Blockaid takes it as a possible threat. Is this avoidable?

To test this create a safe in ETH using advanced-create, so is a 1.3.0 safe, then use the "add network" to redeploy that address into polygon, activate that polygon safe and lastly try to add an owner to that safe.

image

@katspaugh
Copy link
Member Author

@francovenica fixed the "unsupported base contract" warning.

@francovenica
Copy link
Contributor

Note: the issue of blockaid is acutally also in dev, so is not an issue.
I was able to see that the error message "This safe account was created with..." was removed

LGTM

Question: This PR has the tx notes for safes 1/x. Will this be cherry piecked out before merging? or will merged with it?

@katspaugh
Copy link
Member Author

@francovenica tx notes now work for 1/X safes thanks to this PR.

@katspaugh katspaugh merged commit bebed8f into dev Jan 20, 2025
15 checks passed
@katspaugh katspaugh deleted the tx-preview branch January 20, 2025 08:02
@github-actions github-actions bot locked and limited conversation to collaborators Jan 20, 2025
@katspaugh katspaugh added this to the 1.50.0 milestone Jan 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants