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

fix(Swaps): deprecate executedSurplusFee #4763

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

Conversation

iamacook
Copy link
Member

@iamacook iamacook commented Jan 13, 2025

What it solves

Deprecation of executedSurplusFee, adding executedFee and executedFeeToken

How this PR fixes it

This moves from referencing executedSurplusFee to executedFee and rendering the fee token from executedFeeToken.

How to test it

Observe no error/difference when opening the confirmation view/transaction details of a swap/TWAP.

Checklist

  • I've tested the branch on mobile 📱
  • I've documented how it affects the analytics (if at all) 📊
  • I've written a unit/e2e test for it (if applicable) 🧑‍💻

@iamacook iamacook self-assigned this Jan 13, 2025
Copy link

Copy link

Coverage (56%)
File% Stmts% Branch% Funcs% LinesUncovered Line #s
All files55.5649.8149.6556.04 
src0000 
   react-app-env.d.ts0000 
src/components/Alert10091.66100100 
   Alert.tsx10091.6610010055
   index.ts0000 
src/components/Badge87.587.510087.5 
   Badge.tsx85.7187.510085.7149
   index.ts0000 
   theme.ts100100100100 
src/components/BlurredIdenticonBackground0000 
   BlurredIdenticonBackground.tsx000014–51
   index.tsx0000 
src/components/ChainsDisplay10084.61100100 
   ChainsDisplay.tsx10084.6110010015–18
   index.ts0000 
src/components/Container10075100100 
   Container.tsx1007510010032
   index.ts0000 
src/components/CopyButton010000 
   CopyButton.tsx0100005–10
   index.ts0000 
src/components/DataRow100100100100 
   DataRow.tsx100100100100 
   index.ts0000 
src/components/Dropdown88.46607088 
   Dropdown.tsx81.256057.1481.2555, 63, 128
   index.ts0000 
   sheetComponents.tsx100100100100 
src/components/EthAddress0000 
   ETHAddress.tsx000011–12
   index.ts0000 
src/components/Fiat100100100100 
   Fiat.tsx100100100100 
   index.ts0000 
src/components/Identicon100100100100 
   Identicon.tsx100100100100 
   index.ts0000 
src/components/InnerShadow100100100100 
   InnerShadow.tsx100100100100 
   index.ts0000 
src/components/Logo100100100100 
   Logo.tsx100100100100 
   index.ts0000 
src/components/SafeButton100100100100 
   SafeButton.tsx100100100100 
   index.ts0000 
src/components/SafeFontIcon87.585.7110087.5 
   SafeFontIcon.tsx87.585.7110087.528
   index.ts0000 
src/components/SafeListItem10066.66100100 
   SafeListItem.tsx10066.6610010074–88
   index.tsx0000 
src/components/SafeTab250026.31 
   SafeTab.tsx44.44100044.4413–25
   SafeTabBar.tsx9.09001018–38
   index.tsx0000 
   types.ts0000 
src/components/StatusBanners/PendingTransactions10050100100 
   PendingTransactions.tsx1005010010017
   index.tsx0000 
src/components/Tab0000 
   TabNameContext.tsx00003–10
src/components/Title100100100100 
   LargeHeaderTitle.tsx100100100100 
   NavBarTitle.tsx100100100100 
   index.ts0000 
src/components/TxInfo23.84.545023.8 
   TxInfo.tsx23.84.545023.845–96, 100
   index.tsx0000 
src/components/navigation100100100100 
   TabBarIcon.tsx100100100100 
   index.ts0000 
src/components/transactions-list/Card/AccountCard10075100100 
   AccountCard.tsx1007510010052
   index.ts0000 
src/components/transactions-list/Card/AssetsCard100100100100 
   AssetsCard.tsx100100100100 
   index.tsx0000 
src/components/transactions-list/Card/TxBatchCard100100100100 
   TxBatchCard.tsx100100100100 
   index.tsx0000 
src/components/transactions-list/Card/TxConflictingCard010000 
   TxConflictingCard.tsx01000013–31
   index.tsx0000 
src/components/transactions-list/Card/TxContractInteractionCard100100100100 
   TxContractInteractionCard.tsx100100100100 
   index.tsx0000 
src/components/transactions-list/Card/TxCreationCard100100100100 
   TxCreationCard.tsx100100100100 
   index.ts0000 
src/components/transactions-list/Card/TxGroupedCard90.9757590.9 
   TxGroupedCard.tsx90.9757590.957
   index.tsx0000 
src/components/transactions-list/Card/TxRejectionCard100100100100 
   TxRejectionCard.tsx100100100100 
   index.tsx0000 
src/components/transactions-list/Card/TxSafeAppCard100100100100 
   TxSafeAppCard.tsx100100100100 
   index.tsx0000 
src/components/transactions-list/Card/TxSettingsCard10050100100 
   TxSettingsCard.tsx1005010010017
   index.tsx0000 
src/components/transactions-list/Card/TxSwapCard100100100100 
   TxSwapCard.tsx100100100100 
   index.tsx0000 
src/components/transactions-list/Card/TxTokenCard88.8880.5510088.88 
   TxTokenCard.tsx88.8880.5510088.8840, 70
   index.tsx0000 
src/config44.4483.33044.44 
   constants.ts10083.3310010015
   ethers.ts01000010–38
src/features/Assets010000 
   Assets.container.tsx0100009–21
   index.tsx0000 
   styles.ts010010003
src/features/Assets/components/AccountItem91.6668.7510090.9 
   AccountItem.tsx91.6668.7510090.924
   index.ts0000 
src/features/Assets/components/AccountItem/hooks5002553.84 
   useEditAccountItem.ts5002553.8415–29
src/features/Assets/components/AssetsHeader0000 
   AssetsHeader.container.tsx0100006–13
   AssetsHeader.tsx000015
   index.tsx0000 
   styles.ts010010003
src/features/Assets/components/Balance0000 
   Balance.container.tsx01000014–36
   Balance.tsx000025–42
   ChainItems.tsx000017–28
   index.tsx0000 
src/features/Assets/components/Fallback10075100100 
   Fallback.tsx1007510010012
   index.ts0000 
src/features/Assets/components/MyAccounts88.2310066.66100 
   MyAccounts.container.tsx100100100100 
   MyAccountsFooter.tsx71.4210033.33100 
   index.ts0000 
src/features/Assets/components/MyAccounts/hooks43.7533.335044.82 
   useMyAccountsService.ts100100100100 
   useMyAccountsSortable.ts000012–38
src/features/Assets/components/NFTs10081.81100100 
   NFTItem.tsx100501001008
   NFTs.container.tsx10088.8810010026
   index.tsx0000 
src/features/Assets/components/Navbar0000 
   Navbar.tsx000018–66
   index.tsx0000 
src/features/Assets/components/NoFunds100100100100 
   EmptyToken.tsx100100100100 
   NoFunds.tsx100100100100 
   index.ts0000 
src/features/Assets/components/Tokens100100100100 
   Tokens.container.tsx100100100100 
   index.tsx0000 
src/features/Notifications010000 
   Notifications.container.tsx0100004–5
   index.tsx0000 
src/features/Onboarding100100100100 
   Onboarding.container.tsx100100100100 
   index.ts0000 
src/features/Onboarding/components/OnboardingCarousel9510087.595 
   CarouselFeedback.tsx100100100100 
   CarouselItem.tsx100100100100 
   OnboardingCarousel.tsx83.331008083.3318
   index.ts0000 
   items.tsx100100100100 
src/features/Onboarding/components/OnboardingHeader100100100100 
   OnboardingHeader.tsx100100100100 
   index.ts0000 
src/features/Onboarding/components/ParticlesLogo100100100100 
   ParticlesLogo.tsx100100100100 
   index.ts0000 
src/features/PendingTx0000 
   PendingTx.container.tsx0100006–8
   index.tsx0000 
   utils.tsx000021–133
src/features/PendingTx/components/PendingTxList0000 
   PendingTxList.container.tsx000033–63
   index.ts0000 
src/features/Settings0000 
   Settings.container.tsx00007–14
   Settings.tsx000020–137
   index.tsx0000 
src/features/Settings/components/AppSettings010000 
   AppSettings.container.tsx0100007–20
   AppSettings.tsx01000010–11
   index.ts0000 
src/features/Settings/components/IdenticonWithBadge10050100100 
   IdenticonWithBadge.tsx1005010010021–22
   index.ts0000 
src/features/Settings/components/Navbar0000 
   Navbar.tsx01000010–27
   SettingsButton.tsx0100006–15
   SettingsMenu.tsx000017–81
   index.ts0000 
src/features/Signers010000 
   Signers.container.tsx0100003–4
   index.tsx0000 
src/features/TxHistory0000 
   TxHistory.container.tsx000011–37
   index.tsx0000 
   utils.tsx000018–58
src/features/TxHistory/components/TxHistoryList0000 
   TxHistoryList.tsx000018–32
   index.ts0000 
src/hooks/useCopyAndDispatchToast100100100100 
   index.ts100100100100 
src/hooks/useInfiniteScroll75508073.33 
   index.ts0000 
   useInfiniteScroll.ts75508073.3330–35
src/hooks/usePendingTxs0000 
   index.ts000015–40
src/hooks/useSign805010080 
   index.ts0000 
   useSign.ts80501008034, 43, 55, 62, 67
src/hooks/useTransactionType91.6679.1610091.66 
   index.tsx91.6679.1610091.66116–124
src/navigation0000 
   useScrollableHeader.tsx000022–47
src/services/exceptions88.8810010088.88 
   utils.ts88.8810010088.8814
src/store66.665040.966.66 
   activeSafeSlice.ts751005071.4219–22
   constants.ts100100100100 
   index.ts91.665010091.6644
   myAccountsSlice.ts83.33100508013
   safesSlice.ts37.510012.538.4638–48, 57–58
   storage.ts251000258–17
   txHistorySlice.ts100100100100 
src/store/chains68.421004075 
   index.ts68.42100407517, 30–33
src/store/hooks100100100100 
   index.ts100100100100 
src/theme100100100100 
   navigation.ts100100100100 
   tamagui.config.ts100100100100 
   tokens.ts100100100100 
src/theme/helpers10081.81100100 
   utils.ts10081.8110010037, 41
src/theme/palettes100100100100 
   darkPalette.ts100100100100 
   lightPalette.ts100100100100 
src/theme/provider59.0927.776059.09 
   font.tsx90501009034
   safeTheme.tsx10037.510010019–34
   toastProvider.tsx000010–29
src/utils75.6547.9172.0975.7 
   date.ts9666.6685.7110031, 35–39
   formatters.ts908010088.889
   gateway.ts100100100100 
   transaction-guards.ts79.24606880.7650–56, 66, 98, 102, 116, 120
   transactions.tsx00004–29

Copy link

github-actions bot commented Jan 13, 2025

Coverage report for apps/web

St.
Category Percentage Covered / Total
🟡 Statements
77.47% (-0% 🔻)
13874/17908
🔴 Branches
56.78% (-0.01% 🔻)
3490/6146
🟡 Functions 62.83% 2088/3323
🟡 Lines
78.9% (-0% 🔻)
12519/15866
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟡
... / index.tsx
72.73% (-4.55% 🔻)
75% (-25% 🔻)
60%
71.43% (-4.76% 🔻)

Test suite run success

1786 tests passing in 241 suites.

Report generated by 🧪jest coverage report action from 1df1483

Copy link

📦 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.

@iamacook iamacook requested a review from compojoom January 20, 2025 16:28
@iamacook iamacook marked this pull request as ready for review January 20, 2025 16:28
Copy link
Contributor

@compojoom compojoom left a comment

Choose a reason for hiding this comment

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

awesome 👍
I can't wait for the day we get rid of the typescript-sdk types :)

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.

2 participants