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

Remove TransactionPreview functionality, add console error if TP is added as an init prop #2266

Merged
merged 1 commit into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
395 changes: 2 additions & 393 deletions docs/src/routes/docs/[...3]modules/[...5]transaction-preview/+page.md

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@
"@typescript-eslint/parser": "^4.31.1",
"@web3-onboard/gas": "^2.1.5",
"@web3-onboard/wagmi": "2.0.0",
"@web3-onboard/transaction-preview": "^2.0.5",
"@web3-onboard/unstoppable-resolution": "^2.0.0",
"eslint": "^7.32.0",
"eslint-config-prettier": "^8.3.0",
Expand Down
1 change: 0 additions & 1 deletion packages/core/src/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ export let configuration: Configuration = {
initialWalletInit: [],
gas: undefined,
containerElements: { accountCenter: undefined, connectModal: undefined },
transactionPreview: undefined,
unstoppableResolution: undefined,
wagmi: undefined
}
Expand Down
21 changes: 2 additions & 19 deletions packages/core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ import {
updateChain,
updateWallet
} from './store/actions.js'
import type { PatchedEIP1193Provider } from '@web3-onboard/transaction-preview'
import { getBlocknativeSdk } from './services.js'
import type { WagmiModuleAPI } from '@web3-onboard/wagmi'
import { wagmiProviderMethods } from './provider'
Expand Down Expand Up @@ -241,32 +240,16 @@ function init(options: InitOptions): OnboardAPI {
apiKey,
initialWalletInit: wallets,
gas,
transactionPreview,
unstoppableResolution,
wagmi: wagmiApi
})

appMetadata && updateAppMetadata(appMetadata)

if (apiKey && transactionPreview) {
console.warn(
'Transaction Preview support is going to be sunset on July 1st 2024 and will no longer work after that date'
console.error(
'Transaction Preview support has been removed and is no longer supported within Web3-Onboard'
)
const getBnSDK = async () => {
const sdk = await getBlocknativeSdk()
if (!sdk) return
transactionPreview.init({
containerElement: '#w3o-transaction-preview-container',
sdk,
apiKey
})
wallets$.subscribe(wallets => {
wallets.forEach(({ provider }) => {
transactionPreview.patchProvider(provider as PatchedEIP1193Provider)
})
})
}
getBnSDK()
}

theme && updateTheme(theme)
Expand Down
10 changes: 6 additions & 4 deletions packages/core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import type {

import type gas from '@web3-onboard/gas'
import type unstoppableResolution from '@web3-onboard/unstoppable-resolution'
import type { TransactionPreviewAPI } from '@web3-onboard/transaction-preview'

import type en from './i18n/en.json'
import type { EthereumTransactionData, Network } from 'bnc-sdk'
Expand Down Expand Up @@ -71,9 +70,12 @@ export interface InitOptions {
*/
containerElements?: Partial<ContainerElements>
/**
* Transaction Preview module
* @deprecated Transaction Preview support has ended and Transaction Preview
* is no longer supported as part of Web3-Onboard.
* Please remove from your onboard config to avoid
* console errors and un-expected behavior
*/
transactionPreview?: TransactionPreviewAPI
transactionPreview?: unknown
/**
* Custom or predefined theme for Web3Onboard
* BuiltInThemes: ['default', 'dark', 'light', 'system']
Expand Down Expand Up @@ -204,7 +206,7 @@ export type Configuration = {
gas?: typeof gas
wagmi?: WagmiModuleAPI
containerElements?: ContainerElements
transactionPreview?: TransactionPreviewAPI
transactionPreview?: unknown
unstoppableResolution?: typeof unstoppableResolution
}

Expand Down
9 changes: 4 additions & 5 deletions packages/core/src/validation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -249,11 +249,10 @@ const initOptions = Joi.object({
wagmi: Joi.function(),
connect: connectModalOptions,
containerElements: containerElements,
transactionPreview: Joi.object({
patchProvider: Joi.function().required(),
init: Joi.function().required(),
previewTransaction: Joi.function()
}),
// transactionPreview is deprecated but is still allowed to
// avoid breaking dapps a console error is shown although
// transactionPreview functionality has been removed
transactionPreview: Joi.any(),
theme: theme,
disableFontDownload: Joi.boolean(),
unstoppableResolution: Joi.function()
Expand Down
28 changes: 0 additions & 28 deletions packages/core/src/views/Index.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -407,16 +407,6 @@
<SwitchChain />
{/if}

{#if !$accountCenter$.enabled && !$notify$.enabled}
<div
class="container flex flex-column fixed z-indexed"
style="top: 0; right: 0; {device.type === 'mobile'
? 'padding-bottom: 0;'
: ''} "
id="w3o-transaction-preview-container"
/>
{/if}

{#if displayAccountCenterNotifySameContainer}
<div
class="container flex flex-column fixed z-indexed"
Expand All @@ -440,19 +430,13 @@
{/if}
{/await}
{/if}
{#if $accountCenter$.position.includes('bottom')}
<div id="w3o-transaction-preview-container" style="margin-bottom: 8px;" />
{/if}
<div id="account-center-with-notify">
{#await accountCenterComponent then AccountCenter}
{#if AccountCenter}
<svelte:component this={AccountCenter} />
{/if}
{/await}
</div>
{#if $accountCenter$.position.includes('top')}
<div id="w3o-transaction-preview-container" style="margin-top: 8px;" />
{/if}
{#if $notify$.position.includes('top') && $accountCenter$.position.includes('top') && samePositionOrMobile}
{#await notifyComponent then Notify}
{#if Notify}
Expand All @@ -478,9 +462,6 @@
? 'padding-top:0;'
: ''} "
>
{#if $accountCenter$.position.includes('bottom')}
<div id="w3o-transaction-preview-container" style="margin-bottom: 8px;" />
{/if}
<div>
{#if $accountCenter$.enabled && $wallets$.length}
{#await accountCenterComponent then AccountCenter}
Expand All @@ -490,9 +471,6 @@
{/await}
{/if}
</div>
{#if $accountCenter$.position.includes('top')}
<div id="w3o-transaction-preview-container" style="margin-top: 8px;" />
{/if}
</div>
{/if}
{#if displayNotifySeparate}
Expand All @@ -506,9 +484,6 @@
? 'padding-top:0;'
: ''} "
>
{#if $notify$.position.includes('top')}
<div id="w3o-transaction-preview-container" />
{/if}
{#await notifyComponent then Notify}
{#if Notify}
<svelte:component
Expand All @@ -519,8 +494,5 @@
/>
{/if}
{/await}
{#if $notify$.position.includes('bottom')}
<div id="w3o-transaction-preview-container" />
{/if}
</div>
{/if}
2 changes: 1 addition & 1 deletion packages/demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"@web3-onboard/sequence": "^2.1.1",
"@web3-onboard/taho": "^2.1.1",
"@web3-onboard/torus": "^2.3.1",
"@web3-onboard/transaction-preview": "^2.1.1",
"@web3-onboard/transaction-preview": "^2.1.2-alpha.1",
"@web3-onboard/trezor": "^2.4.4",
"@web3-onboard/trust": "^2.1.1",
"@web3-onboard/uauth": "^2.2.1",
Expand Down
Loading
Loading