You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,6 @@
8
8
-**Multiple Wallets and Accounts Connection**: Allow your users to connect multiple wallets and multiple accounts within each wallet at the same time to your app.
9
9
-**Multiple Chain Support**: Allow users to switch between chains/networks with ease.
10
10
-**Account Center**: A persistent interface to manage wallet connections and networks, with a minimal version for mobile
11
-
-**Notify**: Real-time transaction notifications for the connected wallet addresses for all transaction states
12
11
-**Wallet Provider Standardization**: All wallet modules expose a provider that is patched to be compliant with the [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193), [EIP-1102](https://eips.ethereum.org/EIPS/eip-1102), [EIP-3085](https://eips.ethereum.org/EIPS/eip-3085) and [EIP-3326](https://ethereum-magicians.org/t/eip-3326-wallet-switchethereumchain/5471) specifications.
13
12
-**Dynamic Imports**: Supporting multiple wallets in your app requires a lot of dependencies. Onboard dynamically imports a wallet and its dependencies only when the user selects it, so that minimal bandwidth is used.
subtitle={'Preview transactions to see net-balance changes and gas spent'}
105
-
text={'Reduce transaction anxiety by allowing users to easily preview expected net-balance changes for their connected wallets before authorizing transactions.'}
Copy file name to clipboardExpand all lines: docs/src/routes/docs/[...1]overview/[...1]introduction/+page.md
-2Lines changed: 0 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -30,8 +30,6 @@ Web3 Onboard is the quickest and easiest way to add multi-wallet and multi-chain
30
30
31
31
-**Framework Agnostic:** Avoid framework lock in -- Web3 Onboard works with any framework and includes helper packages for vue & react.
32
32
33
-
-**Notify:** Real-time transaction notifications for all transaction states for the connected wallet address(es). In-notification speedups & cancels for hardware wallet connections.
34
-
35
33
### Natively Supported EVM Chains
36
34
37
35
Web3 Onboard supports all EVM networks. Supporting a new network is simply a matter of adding its details in the Chains section upon initialization. For more information see [initialization options](../../modules/core.md#initialization).
Copy file name to clipboardExpand all lines: docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ This change allows us to support many web3 wallets without affecting the overall
30
30
31
31
### Expansive Initialization Options
32
32
33
-
We’ve made initialization simpler while introducing more powerful options like [Account Center](https://www.blocknative.com/blog/multichain-and-multiwallet-account-management-on-your-dapp-with-account-center)and Notify in Web3 Onboard.
33
+
We’ve made initialization simpler while introducing more powerful options like [Account Center](https://www.blocknative.com/blog/multichain-and-multiwallet-account-management-on-your-dapp-with-account-center) in Web3 Onboard.
34
34
Web3 Onboard now requires two compulsory initial setup options: `wallets` (Wallet modules, as shown above, to be initialized and added to wallet selection modal) and `chains` (EVM networks your app should work with). You can also pass multiple wallets and chains.
Copy file name to clipboardExpand all lines: docs/src/routes/docs/[...3]modules/[...1]core/+page.md
+1-96Lines changed: 1 addition & 96 deletions
Original file line number
Diff line number
Diff line change
@@ -534,22 +534,17 @@ type ContainerElements = {
534
534
535
535
#### notify
536
536
537
-
Notify is a feature that provides transaction notifications for all connected wallets on the current blockchain. This document will provide you with an overview of Notify and guide you through the process of integrating it into your decentralized application (dapp).
537
+
Notify is a feature that provides DApps with the ability to send custom messages to the client. This document will provide you with an overview of Notify and guide you through the process of integrating it into your decentralized application (dapp). Check out the [customNotifications API docs for examples and code snippets](#customnotification).
To enable transaction notifications and updates simply add your Blocknative `apiKey`([sign up for free](https://explorer.blocknative.com/account)) to the web3-onboard configurations as the value to the `apiKey` prop and thats it!
542
-
Transaction notifications will be shown for all transactions occurring on supported chains for all of the users connected wallets.
543
-
When switching chains, the previous chain listeners remain active for 60 seconds to allow the capture and report of any remaining transactions that may be in flight.
544
-
545
541
Notifications are by default positioned in the same location as the Account Center (if enabled) or can be positioned separately using the `position` property.
| `enabled` | boolean | Indicates whether transaction notifications will be displayed |
552
-
| `transactionHandler` | function | Optional callback for customizations of notifications |
553
548
| `position` | CommonPositions | Position of the notification on the screen |
554
549
555
550
##### **Position Options**
@@ -561,10 +556,6 @@ Notifications are by default positioned in the same location as the Account Cent
561
556
562
557
Both `desktop` and `mobile` configurations are of type `Notify`.
563
558
564
-
###### **Transaction Handler**
565
-
566
-
The `transactionHandler` is a callback that receives an object of type `EthereumTransactionData`. Based on the data received, the handler can return a custom `Notification` object or a boolean value (false to disable the notification for the current event or undefined for a default notification).
567
-
568
559
##### **Customizing Notification**
569
560
570
561
| Property | Type | Description |
@@ -580,24 +571,6 @@ The `transactionHandler` is a callback that receives an object of type `Ethereum
580
571
581
572
Notify automatically will match the [`theme`](#theme) defined in the web3-onboard configuration. It can also be styled using the [exposed css variables provided below](#custom-styling). These variables allow for maximum customization with base styling variables setting the global theme (e.g., `--onboard-grey-600`) and more precise component-level styling variables available (`--notify-onboard-grey-600`). The latter takes precedence if defined.
582
573
583
-
##### **Handling Notifications**
584
-
585
-
If notifications are enabled, they can be fielded and handled through the onboard app state as seen in the example below - although this is not required for notifications to display:
The Notifications messages can also be used to send fully customized dapp toast messages and updated. Check out the [customNotifications API docs for examples and code snippets](#customnotification)
600
-
601
574
```ts
602
575
typeNotifyOptions= {
603
576
desktop:Notify
@@ -1210,74 +1183,6 @@ The `customNotification` method also returns a `dismiss` method that is called w
1210
1183
1211
1184
---
1212
1185
1213
-
#### **preflightNotifications**
1214
-
1215
-
Notify can be used to deliver standard notifications along with preflight updates by passing a `PreflightNotificationsOptions` object to the `preflightNotifications` API action.
-`txRequest` : Alert user that there is a transaction request awaiting confirmation by their wallet
1222
-
-`txAwaitingApproval` : A previous transaction is awaiting confirmation
1223
-
-`txConfirmReminder` : Reminder to confirm a transaction to continue - configurable with the `txApproveReminderTimeout` property; defaults to 15 seconds
1224
-
-`nsfFail` : The user has insufficient funds for transaction (requires `gasPrice`, `estimateGas`, `balance`, `txDetails.value`)
1225
-
-`txError` : General transaction error (requires `sendTransaction`)
1226
-
-`txSendFail` : The user rejected the transaction (requires `sendTransaction`)
1227
-
-`txUnderpriced` : The gas price for the transaction is too low (requires `sendTransaction`)
1228
-
1229
-
This API call will return a promise that resolves to the transaction hash (if `sendTransaction` resolves the transaction hash and is successful), the internal notification id (if no `sendTransaction` function is provided) or return nothing if an error occurs or `sendTransaction` is not provided or doesn't resolve to a string.
1230
-
1231
-
Example:
1232
-
1233
-
```typescript copy
1234
-
const balanceValue =Object.values(balance)[0]
1235
-
// if using ethers v6 this is:
1236
-
// ethersProvider = new ethers.BrowserProvider(wallet.provider, 'any')
txApproveReminderTimeout?:number// defaults to 15 seconds if not specified
1276
-
}
1277
-
```
1278
-
1279
-
---
1280
-
1281
1186
#### **updateAccountCenter**
1282
1187
1283
1188
If you need to update your Account Center configuration after initialization, you can call the `updateAccountCenter` function with the new configuration
Copy file name to clipboardExpand all lines: docs/src/routes/docs/[...3]modules/[...3]react/+page.md
-16Lines changed: 0 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -303,7 +303,6 @@ async function signMessage(chainId) {
303
303
## useNotifications
304
304
305
305
This hook allows the dev to access all notifications if enabled, send custom notifications, and update notify <enable/disable & update transactionHandler function>
306
-
**note** This requires an API key be added to the initialization, enabled by default if an API key exists
307
306
For full Notification documentation please see [Notify section within the `@web3-onboard/core` docs](../../modules/core.md#initialization)
0 commit comments