diff --git a/docs/src/lib/components/FeaturesSection.svelte b/docs/src/lib/components/FeaturesSection.svelte index 931cc0cca..a654bcef1 100644 --- a/docs/src/lib/components/FeaturesSection.svelte +++ b/docs/src/lib/components/FeaturesSection.svelte @@ -48,11 +48,11 @@ /> -Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain support to your project. With built-in modules for more than 35 unique hardware and software wallets, Web3-Onboard saves you time and headaches. +Web3 Onboard is the quickest and easiest way to add multi-wallet and multi-chain support to your project. With built-in modules for more than 80 unique hardware and software wallets, Web3 Onboard saves you time and headaches. ## Features @@ -24,17 +24,17 @@ Web3-Onboard is the quickest and easiest way to add multi-wallet and multi-chain - **Themable:** Powerful customization options for all your needs. Style Web3 Onboard to fit into your existing designs, or pick from our pre-made themes. -- **Unified Provider Interface:** All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085 and EIP-3326 specifications. Whether your user is using Ledger or Metamask the provider will operate identically. +- **Unified Provider Interface:** All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085, EIP-3326, and EIP-6963 specifications. Whether your user is using Ledger or Metamask, the provider will operate identically. -- **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. +- **Dynamic Imports:** Supporting multiple wallets in your app requires a lot of dependencies. Web3 Onboard dynamically imports a wallet and its dependencies only when the user selects it, so that minimal bandwidth is used. -- **Framework Agnostic:** Avoid framework lock in -- Web3-Onboard works with any framework and includes helper packages for vue & react. +- **Framework Agnostic:** Avoid framework lock in -- Web3 Onboard works with any framework and includes helper packages for vue & react. - **Notify:** Real-time transaction notifications for all transaction states for the connected wallet address(es). In-notification speedups & cancels for hardware wallet connections. ### Natively Supported EVM Chains -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). +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). - Ethereum - Arbitrum One @@ -52,13 +52,14 @@ web3-onboard supports ALL EVM networks. Supporting a new network is simply a mat - Moonriver - Sepolia - Base Goerli +- Degen - All other EVM networks -### Optional - Use an API key to fetch real time transaction data, balances & gas +### Optional - Use an API key to fetch real-time transaction data, balances & gas -Using a Blocknative API key with web3-onboard on the free plan will allow you to gain the benefits of Blocknative balance & transaction services. Blocknative has a free forever plan you can always use. +Using a Blocknative API key with Web3 Onboard on the free plan will allow you to gain the benefits of Blocknative balance & transaction services. Blocknative has a free forever plan you can always use. -This step is not required to use web3-onboard. You can skip to the [**Quickstart**](/docs/overview/introduction#quickstart) step below if you want to use web3-onboard without API services or if you already have a Blocknative account & API key. +This step is not required to use Web3 Onboard. You can skip to the [**Quickstart**](/docs/overview/introduction#quickstart) step below if you want to use Web3 Onboard without API services or if you already have a Blocknative account & API key. **Setup your Account** Go to the Account Dashboard at [https://explorer.blocknative.com/account](https://explorer.blocknative.com/account) and setup an account with an email address. You will receive an email to confirm your account. @@ -68,7 +69,7 @@ On the Account Dashboard at [https://explorer.blocknative.com/account](https://e ## Quickstart -Install the core Onboard library, the injected wallets module and optionally ethers.js to support browser extension and mobile wallets: +Install the core web3-onboard library, the injected wallets module, and optionally ethers.js to support browser extension and mobile wallets: @@ -87,7 +88,7 @@ npm i @web3-onboard/core @web3-onboard/injected-wallets ethers -You can find a link to web3-onboard's official NPM Documentation here: [@web3-onboard/core Official NPM Documentation](https://www.npmjs.com/package/@web3-onboard/core) +You can find a link to Web3 Onboard's official NPM Documentation here: [@web3-onboard/core Official NPM Documentation](https://www.npmjs.com/package/@web3-onboard/core) Then initialize in your app: @@ -171,9 +172,9 @@ if (wallets[0]) { ## Wallet Modules -Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your web3-onboard implementation. All modules can be accessed through the subpages of web3-onboard docs on the left. +Add other wallet modules such as Wallet Connect or Ledger to increase the support and functionality of your Web3 Onboard implementation. All modules can be accessed through the subpages of Web3 Onboard docs on the left. -We recommend you add the [Core Repo](../../modules/core.md#install) and consider adding the [Injected Wallets](../../wallets/injected.md#install) module to get connected with wallets like Metamask, Trust, Coinbase Wallet & more right away. +We recommend you add the [Core Repo](../../modules/core.md#install) and consider adding the [Injected Wallets](../../wallets/injected.md#install) module to get connected with wallets like Metamask, Trust, Coinbase Wallet, and more right away. [**Core Repo**](../../modules/core.md#install) @@ -211,7 +212,7 @@ We recommend you add the [Core Repo](../../modules/core.md#install) and consider ## Test out the demo app -Test out the current functionality of web3-onboard in a small browser demo: +Test out the current functionality of Web3 Onboard in a small browser demo: - Clone the repo: `git clone git@github.com:blocknative/web3-onboard.git` - Change it to the onboard directory: `cd web3-onboard` @@ -224,10 +225,10 @@ Test out the current functionality of web3-onboard in a small browser demo: Checkout our live demo using React at [https://reactdemo.blocknative.com/](https://reactdemo.blocknative.com/) -The demo is open source so you can see a sample implementation of web3-onboard: [https://github.com/blocknative/react-demo](https://github.com/blocknative/react-demo) +The demo is open source so you can see a sample implementation of Web3 Onboard: [https://github.com/blocknative/react-demo](https://github.com/blocknative/react-demo) ## More Examples -You can find starter examples from the web3 community here using web3-onboard: +You can find starter examples from the web3 community here using Web3 Onboard: - [eth-scaffold](https://github.com/scaffold-eth/scaffold-eth-examples/tree/bnc-onboard) diff --git a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md index c2988ccff..fa09901a3 100644 --- a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md +++ b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide/+page.md @@ -41,7 +41,7 @@ Example 2 : Bug fix within the `core` package - ## How can I add a new wallet? 💳 -To add a new wallet to the official Web3 Onboard packages and repo, create a [pull request](#pull-requests-🗂️). Web3 Onboard does not require a wallet to be a part of the main code, so a separate wallet module can be created without any changes to the Web3Onboard codebase. Your PR must include a detailed README for the package, keeping in mind that this README is the the first point of contact for dapp devs looking to implement your wallet. +To add a new wallet to the official Web3 Onboard packages and repo, create a [pull request](#pull-requests-🗂️). Web3 Onboard does not require a wallet to be a part of the main code, so a separate wallet module can be created without any changes to the Web3 Onboard codebase. Your PR must include a detailed README for the package, keeping in mind that this README is the the first point of contact for dapp developers looking to implement your wallet. Please also include updates to documentation in your PR. Refer to the [docs contributions section](#documentation-contributions-📄) and the PR template docs checklist. @@ -69,7 +69,7 @@ PRs for adding/updating a wallet should include a README (new or updated) for th [See here for an example of a docs pull request.](https://github.com/blocknative/web3-onboard/pull/1544/files) -We highly encourage the community to help us improve the web3-onboard docs! If you have any questions don't hesitate to reach out. +We highly encourage the community to help us improve the Web3 Onboard docs! If you have any questions don't hesitate to [reach out](https://discord.com/invite/KZaBVME). ## Feedback 💬 diff --git a/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md b/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md index 7c914e84e..030c8bd62 100644 --- a/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md +++ b/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide/+page.md @@ -4,11 +4,11 @@ title: 'Migration Guide from v1' # Migration Guide from onboard.js to web3-onboard -Follow the steps below to easily migrate from onboard.js to Web3-Onboard. +Follow the steps below to easily migrate from onboard.js to Web3 Onboard. ### Background -With Web3-Onboard, we’ve introduced significant architectural changes that provide a more robust and efficient web3 onboarding experience. While this upgrade may result in breaking changes, the improved overall experience makes it worthwhile. +With Web3 Onboard, we’ve introduced significant architectural changes that provide a more robust and efficient web3 onboarding experience. While this upgrade may result in breaking changes, the improved overall experience makes it worthwhile. ### Steps @@ -23,15 +23,15 @@ To help you get started quickly we’ve put together [a set of examples across m ### Package Upgrade - Modularization -This is the biggest change you might experience as an onboard.js user. With Web3-Onboard, we’ve separated all supported wallets into their modules, meaning you only need to integrate specific wallet modules you intend to support in your app. +This is the biggest change you might experience as an onboard.js user. With Web3 Onboard, we’ve separated all supported wallets into their modules, meaning you only need to integrate specific wallet modules you intend to support in your app. For example with Onboard, if you wanted to support only Metamask and Coinbase in your app, you had to install Onboard complete with all other wallets: `npm install bnc-onboard`. -With Web3-Onboard, you only need to install core along with the desired wallet modules: `npm i @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/coinbase` +With Web3 Onboard, you only need to install core along with the desired wallet modules: `npm i @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/coinbase` This change allows us to support many web3 wallets without affecting the overall library performance. ### Expansive Initialization Options -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. -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. +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. +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. ``` const onboard = Onboard({ @@ -56,19 +56,19 @@ Now, you only need to call the connectWallet API: `await onboard.connectWallet()` -Learn more about state changes tracked with the Onboard API [here](/docs/modules/core#state) and the exposed actions you can use to modify the state [here](/docs/modules/core#actions-to-modify-state). +Learn more about state changes tracked with the Web3 Onboard API [here](/docs/modules/core#state) and the exposed actions you can use to modify the state [here](/docs/modules/core#actions-to-modify-state). ### Framework Support -Although Onboard is still framework-agnostic, we’ve introduced a couple of framework-specific modules that are frequently asked for by our users. +Although Web3 Onboard is still framework-agnostic, we’ve introduced a couple of framework-specific modules that are frequently asked for by our users. -`@web3-onboard/react` - React Hooks to connect users to web3 dApps better. You can check out [a comprehensive React Hooks guide](https://www.blocknative.com/blog/react-hooks-ethereum) we've written on it. +`@web3-onboard/react` - React Hooks to connect users to web3 dapps better. You can check out [a comprehensive React Hooks guide](https://www.blocknative.com/blog/react-hooks-ethereum) we've written on it. -`@web3-onboard/vue` - A set of reusable functions for integrating Web3-Onboard into a Vue 3 project. This is also compatible with a Vue 2 + composition-api dApp. +`@web3-onboard/vue` - A set of reusable functions for integrating Web3 Onboard into a Vue 3 project. This is also compatible with a Vue 2 + composition-api dApp. ### CSS Customizations -We've also added more expansive custom CSS properties so you can style every part of your onboarding experience to match the overall experience of your dApp. To apply Web3-Onboard CSS customizations, you don't need to attach them to the `.bn-onboard-custom` class like before. Instead, you can simply place them in the `:root` CSS pseudo-class, as shown below: +We've also added more expansive custom CSS properties so you can style every part of your onboarding experience to match the overall experience of your dApp. To apply Web3 Onboard CSS customizations, you don't need to attach them to the `.bn-onboard-custom` class like before. Instead, you can simply place them in the `:root` CSS pseudo-class, as shown below: ``` :root { @@ -90,11 +90,11 @@ We've also added more expansive custom CSS properties so you can style every par } ``` -The full list of CSS variables for web3-onboard is available [here](/docs/modules/core#custom-styling). +The full list of CSS variables for Web3 Onboard is available [here](/docs/modules/core#custom-styling). ### Other Important Changes -There are also other notable infrastructural changes in Web3-Onboard: +There are also other notable infrastructural changes in Web3 Onboard: - Dynamic Imports of dependencies - Wallet Provider Standardization diff --git a/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md b/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md index b409ecd2f..5a76b1313 100644 --- a/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md +++ b/docs/src/routes/docs/[...2]getting-started/[...1]installation/+page.md @@ -4,11 +4,11 @@ title: Installation # {$frontmatter.title} -Get up and running with Web3-Onboard +Get up and running with Web3 Onboard ### Install -Install the core Onboard library and the injected wallets module to support browser extension and mobile wallets: +Install the core Web3 Onboard library and the injected wallets module to support browser extension and mobile wallets: diff --git a/docs/src/routes/docs/[...2]getting-started/[...2]theming/+page.md b/docs/src/routes/docs/[...2]getting-started/[...2]theming/+page.md index 5ee617f0d..1b5640804 100644 --- a/docs/src/routes/docs/[...2]getting-started/[...2]theming/+page.md +++ b/docs/src/routes/docs/[...2]getting-started/[...2]theming/+page.md @@ -8,7 +8,7 @@ To customize the color theme of web3-onboard and match it with your dapp, you ca ## Available Themes -To set the color theme of web3-onboard to one of the available native themes, import Onboard from `@web3-onboard/core` and pass the theme as a string to the `theme` init option. +To set the color theme of Web3 Onboard to one of the available native themes, import Web3 Onboard from `@web3-onboard/core` and pass the theme as a string to the `theme` init option. | theme | description | | --------- | --------------------------------------------------------------------------------- | @@ -32,7 +32,7 @@ const onboard = Onboard({ ## Variables -In the table below, you'll find a list of css variables that you can use to theme web3-onboard. +In the table below, you'll find a list of css variables that you can use to theme Web3 Onboard. | variable | description | | ---------------------- | ----------------- | @@ -47,7 +47,7 @@ In the table below, you'll find a list of css variables that you can use to them ## Custom Theme -To create a custom theme, you can define a `ThemingMap` object with CSS variables for different components of web3-onboard. Pass this object as the theme option. +To create a custom theme, you can define a `ThemingMap` object with CSS variables for different components of Web3 Onboard. Pass this object as the theme option. ```typescript copy import Onboard, { ThemingMap } from '@web3-onboard/core' @@ -71,7 +71,7 @@ const onboard = Onboard({ ## Dynamically Update Theme with API -**`updateTheme`** is an exposed API method for actively updating the theme of web3-onboard. The function accepts `Theme` types (see below). +**`updateTheme`** is an exposed API method for actively updating the theme of Web3 Onboard. The function accepts `Theme` types (see below). _If using the `@web3-onboard/react` package there is a hook exposed called `updateTheme`_ The function also accepts a custom built `ThemingMap` object that contains all or some of the theming variables @@ -122,7 +122,7 @@ export type ThemingMap = { ## Theming Tool -You can preview how web3-onboard will look on your site by using our [theming tool](/theming-tool) to customize the look and feel of web3-onboard. You can try different themes or create your own and preview the result by entering a URL or adding a screenshot. +You can preview how Web3 Onboard will look on your site by using our [theming tool](/theming-tool) to customize the look and feel of Web3 Onboard. You can try different themes or create your own and preview the result by entering a URL or adding a screenshot. To do this: diff --git a/docs/src/routes/docs/[...2]getting-started/[...3]custom-styling/+page.md b/docs/src/routes/docs/[...2]getting-started/[...3]custom-styling/+page.md index 91a074815..380d115e4 100644 --- a/docs/src/routes/docs/[...2]getting-started/[...3]custom-styling/+page.md +++ b/docs/src/routes/docs/[...2]getting-started/[...3]custom-styling/+page.md @@ -4,17 +4,17 @@ title: Custom Styling # {$frontmatter.title} -You can customize web3-onboard to match the look and feel of your dapp. web3-onboard exposes css variables for each of its UI components. +You can customize Web3 Onboard to match the look and feel of your dapp. Web3 Onboard exposes css variables for each of its UI components. -Interested in seeing how web3-onboard will look on your site? +Interested in seeing how Web3 Onboard will look on your site? [Try out our theming tool](/theming-tool) -It will allow you to customize the look and feel of web3-onboard, try different themes or create your own, and preview how web3-onboard will look on your site by entering a URL or adding a screenshot. +It will allow you to customize the look and feel of Web3 Onboard, try different themes or create your own, and preview how Web3 Onboard will look on your site by entering a URL or adding a screenshot. ## CSS custom properties (variables) -The Onboard styles can customized via [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). The following properties and their default properties can be customized by adding these variables to the `:root` in your CSS file: +The Web3 Onboard styles can be customized via [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). The following properties and their default properties can be customized by adding these variables to the `:root` in your CSS file: ```css :root { diff --git a/docs/src/routes/docs/[...3]modules/[...1]core/+page.md b/docs/src/routes/docs/[...3]modules/[...1]core/+page.md index ea2710599..0edaa8c3e 100644 --- a/docs/src/routes/docs/[...3]modules/[...1]core/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...1]core/+page.md @@ -15,7 +15,7 @@ title: Core # {$frontmatter.title} -This is the core package that contains all of the UI and logic to be able to seamlessly connect user's wallets to your app and track the state of those wallets. Onboard no longer contains any wallet specific code, so wallets need to be passed in upon initialization. +This is the core package that contains all of the UI and logic to be able to seamlessly connect user's wallets to your app and track the state of those wallets. Web3 Onboard no longer contains any wallet specific code, so wallets need to be passed in upon initialization. :::admonition type="tip" _note: Release 2.24.0 moves the default position of the account center from topRight to bottomRight. To reset your application to topRight, include the following when initializing onboard:_ @@ -101,7 +101,7 @@ Checkout our full library of quick start examples for connecting and interacting ## Initialization -Onboard needs to be initialized with an options object before the API can be used: +Web3 Onboard needs to be initialized with an options object before the API can be used: ```ts type InitOptions { @@ -142,6 +142,7 @@ type InitOptions { #### wallets An array of wallet modules that you would like to be presented to the user to select from when connecting a wallet. A wallet module is an abstraction that allows for easy interaction without needing to know the specifics of how that wallet works and are separate packages that can be included. + These modules are separate @web3-onboard packages such as `@web3-onboard/injected-wallets` or `@web3-onboard/ledger`. For a full list click [here](#all-wallet-modules). @@ -243,7 +244,7 @@ onboard.state.actions.updateAppMetadata({ #### connect -An object that allows for customizing the connect modal layout and behavior +An object that allows for customizing the connect modal layout and behavior: Web3-Onboard connect wallet modal @@ -344,9 +345,9 @@ Default Message- with no i18n override: #### theme -A string or an object that defines the color theme web3-onboard will render the components. +A string or an object that defines the color theme. Web3 Onboard will render the components. -Define a custom or predefined theme for Web3Onboard using either: +Define a custom or predefined theme for Web3 Onboard using either: ###### **Native themes available** @@ -378,11 +379,11 @@ type ThemingMap = { ``` :::admonition type=tip -Interested in seeing how web3-onboard will look on your site? +Interested in seeing how Web3 Onboard will look on your site? [Try out our theming tool](/theming-tool) or our in depth theming walkthrough [here](/docs/getting-started/theming) -It will allow you to customize the look and feel of web3-onboard, try different themes or create your own, and preview how web3-onboard will look on your site by entering a URL or adding a screenshot. +It will allow you to customize the look and feel of Web3 Onboard, try different themes or create your own, and preview how Web3 Onboard will look on your site by entering a URL or adding a screenshot. ::: --- @@ -450,7 +451,7 @@ type AccountCenterPosition = 'topRight' | 'bottomRight' | 'bottomLeft' | 'topLef #### containerElements -An object mapping for W3O components with the key being the DOM element to mount the specified component to. +An object mapping for Web3 Onboard components with the key being the DOM element to mount the specified component to. This defines the DOM container element for svelte to attach the component. **NOTE**: containerElement must be a DOM element with a styleSheet property attached and the element must be available on the DOM at the time of component mounting. @@ -477,7 +478,7 @@ type ContainerElements = { #### notify -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). +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). Transaction notifications image @@ -521,7 +522,7 @@ The `transactionHandler` is a callback that receives an object of type `Ethereum ##### **Styling Notify** -Notify automatically will match the [`theme`](#theme) defined in the web3-onboard config. 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. +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. ##### **Handling Notifications** @@ -539,7 +540,7 @@ unsubscribe() ##### **Notifications as Toast Messages** -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) +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) ```ts type NotifyOptions = { @@ -783,7 +784,7 @@ For examples of interacting with the wallet providers please see our demo projec ### Auto Selecting a Wallet A common UX pattern is to remember the last wallet that a user has previously connected by storing it in localStorage and then automatically selecting them for the user next time they visit your app. -You can enable this in your app by using the `autoConnectLastWallet` parameter when initializing and Onboard will take care of it: +You can enable this in your app by using the `autoConnectLastWallet` parameter when initializing and Web3 Onboard will take care of it: ```javascript const onboard = Onboard({ @@ -796,7 +797,7 @@ const onboard = Onboard({ ## Disconnecting a Wallet -A wallet can be disconnected, which will cleanup any background operations the wallet may be doing and will also remove it from the Onboard `wallets` array: +A wallet can be disconnected, which will cleanup any background operations the wallet may be doing and will also remove it from the Web3 Onboard `wallets` array: ```javascript copy // disconnect the first wallet in the wallets array @@ -808,10 +809,10 @@ The `disconnectWallet` method takes the `wallet.label` value and returns a `Prom ## State -Onboard currently keeps track of the following state: +Web3 Onboard currently keeps track of the following states: -- `wallets`: The wallets connected to Onboard -- `chains`: The chains that Onboard has been initialized with +- `wallets`: The wallets connected to Web3 Onboard +- `chains`: The chains that Web3 Onboard has been initialized with - `accountCenter`: The current state of the account center UI - `walletModules`: The wallet modules that are currently set and will be rendered in the wallet selection modal @@ -886,7 +887,7 @@ type WalletModule { ### Get Current State -The current state of Onboard can be accessed at any time using the `state.get()` method: +The current state of Web3 Onboard can be accessed at any time using the `state.get()` method: ```javascript copy const currentState = onboard.state.get() @@ -918,13 +919,13 @@ unsubscribe() ### Actions to Modify State -A limited subset of internal actions are exposed to update the Onboard state. +A limited subset of internal actions are exposed to update the Web3 Onboard state. --- #### **setWalletModules** -For updating the wallets that are displayed in the wallet selection modal. This can be used if the wallets you want to support is conditional on another user action within your app. The `setWalletModules` action is called with an updated array of wallets (the same wallets that are passed in on initialization) +For updating the wallets that are displayed in the wallet selection modal. This can be used if the wallets you want to support are conditional on another user action within your app. The `setWalletModules` action is called with an updated array of wallets (the same wallets that are passed in on initialization) ```typescript import Onboard from '@web3-onboard/core' @@ -963,7 +964,7 @@ onboard.state.actions.setWalletModules([ledger, trezor]) #### **updateTheme** -An exposed method for updating the [theme](#theme) of web3-onboard. The function accepts `Theme` types (see below) +An exposed method for updating the [theme](#theme) of Web3 Onboard. The function accepts `Theme` types (see below) The function also accepts a custom built `ThemingMap` object that contains all or some of the theming variables @@ -1017,7 +1018,7 @@ onboard.state.actions.updateBalances(['0xfdadfadsadsadsadasdsa', '0xfdsafdsfdsfd #### **setLocale** -Onboard will automatically detect the browser locale at runtime, but if you would like to update it manually you can call the `setLocale` function: +Web3 Onboard will automatically detect the browser locale at runtime, but if you would like to update it manually you can call the `setLocale` function: ```javascript onboard.state.actions.setLocal('fr_FR') @@ -1066,7 +1067,7 @@ onboard.state.actions.updateNotify({ Custom notifications image -Notify can be used to deliver custom DApp notifications by passing a `CustomNotification` object to the `customNotification` action. This will return an `UpdateNotification` type. +Notify can be used to deliver custom dapp notifications by passing a `CustomNotification` object to the `customNotification` action. This will return an `UpdateNotification` type. This `UpdateNotification` will return an `update` function that can be passed a new `CustomNotification` to update the existing notification. The `customNotification` method also returns a `dismiss` method that is called without any parameters to dismiss the notification. @@ -1147,7 +1148,7 @@ Notify can be used to deliver standard notifications along with preflight update Preflight event types include: -- `txRequest` : Alert user there is a transaction request awaiting confirmation by their wallet +- `txRequest` : Alert user that there is a transaction request awaiting confirmation by their wallet - `txAwaitingApproval` : A previous transaction is awaiting confirmation - `txConfirmReminder` : Reminder to confirm a transaction to continue - configurable with the `txApproveReminderTimeout` property; defaults to 15 seconds - `nsfFail` : The user has insufficient funds for transaction (requires `gasPrice`, `estimateGas`, `balance`, `txDetails.value`) @@ -1236,7 +1237,7 @@ onboard.state.actions.setPrimaryWallet(wallets[1], wallets[1].accounts[2].addres ## Setting the User's Chain/Network -When initializing Onboard you define a list of chains/networks that your app supports. If you would like to prompt the user to switch to one of those chains, you can use the `setChain` method on an initialized instance of Onboard: +When initializing Web3 Onboard, you define a list of chains/networks that your dapp supports. If you would like to prompt the user to switch to one of those chains, you can use the `setChain` method on an initialized instance of Web3 Onboard: ```typescript copy type SetChain = (options: SetChainOptions) => Promise @@ -1252,11 +1253,11 @@ type SetChainOptions = { const success = await onboard.setChain({ chainId: '0x89' }) ``` -The `setChain` methods takes an options object with a `chainId` property hex encoded string for the chain id to switch to. The chain id must be one of the chains that Onboard was initialized with. If the wallet supports programatically adding and switching the chain, then the user will be prompted to do so, if not, then a modal will be displayed indicating to the user that they need to switch chains to continue. The `setChain` method returns a promise that resolves when either the user has confirmed the chain switch, or has dismissed the modal and resolves with a boolean indicating if the switch network was successful or not. The `setChain` method will by default switch the first wallet (the most recently connected) in the `wallets` array. A specific wallet can be targeted by passing in the `wallet.label` in the options object as the `wallet` parameter. If a chain was instantiated without an rpcUrl, token, or label, add these options for wallets that require this information for adding a new chain. +The `setChain` methods takes an options object with a `chainId` property hex encoded string for the chain id to switch to. The chain id must be one of the chains that Web3 Onboard was initialized with. If the wallet supports programatically adding and switching the chain, then the user will be prompted to do so, if not, then a modal will be displayed indicating to the user that they need to switch chains to continue. The `setChain` method returns a promise that resolves when either the user has confirmed the chain switch, or has dismissed the modal and resolves with a boolean indicating if the switch network was successful or not. The `setChain` method will by default switch the first wallet (the most recently connected) in the `wallets` array. A specific wallet can be targeted by passing in the `wallet.label` in the options object as the `wallet` parameter. If a chain was instantiated without an rpcUrl, token, or label, add these options for wallets that require this information for adding a new chain. ## Custom Styling -The Onboard styles can be customized via [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). The following properties and their default properties can be customized by adding these variables to the `:root` in your CSS file: +The Web3 Onboard styles can be customized via [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). The following properties and their default properties can be customized by adding these variables to the `:root` in your CSS file: ```css :root { @@ -1545,7 +1546,7 @@ module.exports = { The above webpack 5 example can be used in the `craco.config.js` file at the root level in this case. -[React App Rewired](https://www.npmjs.com/package/react-app-rewired) is another option for working with Create React App DApps +[React App Rewired](https://www.npmjs.com/package/react-app-rewired) is another option for working with Create React App dapps Add the following dev dependencies: `npm i --save-dev rollup-plugin-polyfill-node webpack-bundle-analyzer assert buffer crypto-browserify stream-http https-browserify os-browserify process stream-browserify util path-browserify browserify-zlib` @@ -1778,14 +1779,14 @@ Add this to your `app.html` ##### Buffer polyfill -It seems some component or dependency requires Node's Buffer. To polyfill this, the simplest way I could find was to install the buffer package and include the following in web3-onboard.ts: +It seems some component or dependency requires Node's Buffer. To polyfill this, the simplest way is to install the buffer package and include the following in web3-onboard.ts: ```javascript import { Buffer } from 'buffer' globalThis.Buffer = Buffer ``` -See [this github issue](https://github.com/blocknative/web3-onboard/issues/1568#issuecomment-1463963462) for further troubleshooting +See [this github issue](https://github.com/blocknative/web3-onboard/issues/1568#issuecomment-1463963462) for further troubleshooting. ### Vite @@ -1871,7 +1872,7 @@ Checkout a boilerplate example for NextJS [here](https://github.com/blocknative/ :::admonition type=note -If you are seeing an error during builds when dynamically importing Web3Onboard in a NextJS v13 project, try upgrading to to the Canary beta release of NextJS where this issue is fixed. +If you are seeing an error during builds when dynamically importing Web3 Onboard in a NextJS v13 project, try upgrading to the Canary beta release of NextJS where this issue is fixed. ::: @@ -1879,9 +1880,9 @@ If you are seeing an error during builds when dynamically importing Web3Onboard ### npm and yarn -Web3-Onboard will work out of the box with `npm` and `yarn` support. +Web3 Onboard will work out of the box with `npm` and `yarn` support. ### pnpm -We have had issues reported when using `pnpm` as the package manager when working with web3-onboard. +We have had issues reported when using `pnpm` as the package manager when working with Web3 Onboard. As we work to understand this new manager more and the issues around it we recommend using `npm` or `yarn` for now. diff --git a/docs/src/routes/docs/[...3]modules/[...2]gas/+page.md b/docs/src/routes/docs/[...3]modules/[...2]gas/+page.md index bdd6edd32..104b9d1eb 100644 --- a/docs/src/routes/docs/[...3]modules/[...2]gas/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...2]gas/+page.md @@ -10,7 +10,7 @@ title: Gas A module for requesting streams or single requests of gas price estimates from the [Blocknative Gas Platform API](https://docs.blocknative.com/gas-platform). -Supports both Eth Mainnet and Polygon gas pricing. +Supports both Ethereum Mainnet and Polygon Mainnet gas pricing. @@ -82,7 +82,7 @@ const gasBlockPrices = await gas.get({ ## Usage with Web3-Onboard wallet Connect and Ethers.js -This example assumes you have already setup web3-onboard to connect wallets to your dapp. +This example assumes you have already setup Web3 Onboard to connect wallets to your dapp. For more information see [web3-onboard docs](/docs/modules/core#install). ```ts copy diff --git a/docs/src/routes/docs/[...3]modules/[...3]react/+page.md b/docs/src/routes/docs/[...3]modules/[...3]react/+page.md index 3b88bf1f1..9bee922bb 100644 --- a/docs/src/routes/docs/[...3]modules/[...3]react/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...3]react/+page.md @@ -4,7 +4,7 @@ title: React # {$frontmatter.title} -A collection of React hooks for implementing web3-onboard into a React project +A collection of React hooks for implementing Web3 Onboard into a React project ## Quickstart with Injected Wallets and Ethers Provider @@ -244,8 +244,8 @@ const [ ## `useNotifications` -This hook allows the dev to access all notifications if enabled, send custom notifications and update notify -**note** requires an API key be added to the initialization, enabled by default if API key exists +This hook allows the dev to access all notifications if enabled, send custom notifications, and update notify +**note** This requires an API key be added to the initialization, enabled by default if an API key exists For full Notification documentation please see [Notify section within the `@web3-onboard/core` docs](../../modules/core.md#initialization) ```typescript @@ -411,7 +411,7 @@ const sendTransactionWithPreFlightNotifications = async () => { ## `useWallets` -This hook allows you to track the state of all the currently connected wallets. +This hook allows you to track the state of all the currently connected wallets: ```typescript import { useWallets } from '@web3-onboard/react' @@ -423,7 +423,7 @@ const connectedWallets = useWallets() ## `useAccountCenter` -This hook allows you to track and update the state of the AccountCenter +This hook allows you to track and update the state of the Account Center: ```typescript import { useAccountCenter } from '@web3-onboard/react' @@ -450,7 +450,7 @@ const updateAccountCenter = useAccountCenter() ## `useSetLocale` -This hook allows you to set the locale of your application to allow language updates associated with the i18n config +This hook allows you to set the locale of your application to allow language updates associated with the i18n config: ```typescript import { useSetLocale } from '@web3-onboard/react' @@ -470,7 +470,7 @@ Many of the wallet modules require dependencies that are not normally included i Node built-ins are automatically bundled in v4 so that portion is handled automatically. -**web3auth** and **torus** will require a Babel to compile from es6 if not already supported. See config for Babel and Webpack4 as follows +**web3auth** and **torus** will require a Babel to compile from es6 if not already supported. See config for Babel and Webpack4 as follows: `npm i --save-dev @babel/cli @babel/core @babel/node @babel/plugin-proposal-nullish-coalescing-operator @babel/plugin-proposal-optional-chaining @babel/plugin-syntax-bigint @babel/register` **AND** @@ -602,7 +602,7 @@ Be sure to update the scripts in package.json: } ``` -[React App Rewired](https://www.npmjs.com/package/react-app-rewired) is another option for working with Create React App DApps +[React App Rewired](https://www.npmjs.com/package/react-app-rewired) is another option for working with Create React App dapps Add React App Rewired: diff --git a/docs/src/routes/docs/[...3]modules/[...5]transaction-preview/+page.md b/docs/src/routes/docs/[...3]modules/[...5]transaction-preview/+page.md index feca003c1..f465e47a3 100644 --- a/docs/src/routes/docs/[...3]modules/[...5]transaction-preview/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...5]transaction-preview/+page.md @@ -44,7 +44,7 @@ npm i @web3-onboard/core @web3-onboard/injected-wallets @web3-onboard/transactio Transaction Preview Flow gif -To use the Transaction Preview package with web3-onboard all a developer needs to do is initialize web3-onboard with their [Blocknative API key](https://onboard.blocknative.com/docs/overview/introduction#optional-use-an-api-key-to-fetch-real-time-transaction-data-balances-gas) and pass in the module as shown below. +To use the Transaction Preview package with Web3 Onboard all a developer needs to do is initialize web3-onboard with their [Blocknative API key](https://onboard.blocknative.com/docs/overview/introduction#optional-use-an-api-key-to-fetch-real-time-transaction-data-balances-gas) and pass in the module as shown below. ```typescript copy import Onboard from '@web3-onboard/core' @@ -84,10 +84,10 @@ const onboard = Onboard({ ### Standalone Usage -To use the Transaction Preview package without web3-onboard all a developer needs to do is: +To use the Transaction Preview package without Web3 Onboard all a developer needs to do is: - Execute the entry function from the `@web3-onboard/transaction-preview` package and optional params -- Run the returned `init` function with their [Blocknative API key](https://onboard.blocknative.com/docs/overview/introduction#optional-use-an-api-key-to-fetch-real-time-transaction-data-balances-gas), an initialized instance of their [Blocknative SDK](https://www.npmjs.com/package/bnc-sdk) and a containerElement string with the html ID of the target element to append the visualization to +- Run the returned `init` function with their [Blocknative API key](https://onboard.blocknative.com/docs/overview/introduction#optional-use-an-api-key-to-fetch-real-time-transaction-data-balances-gas), an initialized instance of their [Blocknative SDK](https://www.npmjs.com/package/bnc-sdk), and a containerElement string with the html ID of the target element to append the visualization to - Finally pass a transaction meant for a wallet provider (created using libraries like Ethers or Web3) With the above steps a UI will be rendered with the balance changes and gas used. diff --git a/docs/src/routes/docs/[...3]modules/[...6]unstoppable-resolution/+page.md b/docs/src/routes/docs/[...3]modules/[...6]unstoppable-resolution/+page.md index 17780b2f3..9e74364b6 100644 --- a/docs/src/routes/docs/[...3]modules/[...6]unstoppable-resolution/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...6]unstoppable-resolution/+page.md @@ -4,7 +4,7 @@ title: Unstoppable Domains Resolution # {$frontmatter.title} -A module to add Unstoppable Domain resolution to web3-onboard. +A module to add Unstoppable Domain resolution to Web3 Onboard. ### Install diff --git a/docs/src/routes/docs/[...3]modules/[...7]vue/+page.md b/docs/src/routes/docs/[...3]modules/[...7]vue/+page.md index bc02f8d86..df335698a 100644 --- a/docs/src/routes/docs/[...3]modules/[...7]vue/+page.md +++ b/docs/src/routes/docs/[...3]modules/[...7]vue/+page.md @@ -4,7 +4,7 @@ title: Vue # {$frontmatter.title} -A collection of composable functions for implementing web3-onboard in to a Vue project; compatible both with Vue 2 + composition-api and Vue 3 +A collection of composable functions for implementing Web3 Onboard into a Vue project; compatible both with Vue 2 + composition-api and Vue 3 ## Install @@ -121,7 +121,7 @@ const { wallets, connectWallet, disconnectConnectedWallet, connectedWallet } = u ### `connectWallet` -Function to open the onboard modal and connect to a wallet provider. For reference check out the [connecting a wallet for `@web3-onboard/core`](../../modules/core.md#connecting-a-wallet) +Function to open the Web3 Onboard modal and connect to a wallet provider. For reference check out the [connecting a wallet for `@web3-onboard/core`](../../modules/core.md#connecting-a-wallet) ### Example usage @@ -300,7 +300,7 @@ Function to set the chain of a wallet ### `settingChain` -Readonly boolean ref that tracks the status of setting the chain +Read-only boolean ref that tracks the status of setting the chain ### Example usage @@ -322,7 +322,7 @@ Readonly boolean ref that tracks the status of setting the chain ### `wallets` -Readonly ref that contains every wallet that has been connected +Read-only ref that contains every wallet that has been connected ### Example usage @@ -339,7 +339,7 @@ export default { ### `alreadyConnectedWallets` -Readonly ref that contains every wallet that user connected to in the past; useful to reconnect wallets automatically after a reload +Read-only ref that contains every wallet that user connected to in the past; useful to reconnect wallets automatically after a reload ### Example usage @@ -363,7 +363,7 @@ Readonly ref that contains every wallet that user connected to in the past; usef ### `lastConnectedTimestamp` -Readonly ref that contains the last time that the user connected a wallet in milliseconds +Read-only ref that contains the last time that the user connected a wallet in milliseconds ### Example usage @@ -391,7 +391,7 @@ Many of the wallet modules require dependencies that are not normally included i Node built-ins are automatically bundled in v4 so that portion is handled automatically. -**web3auth** and **torus** will require a Babel to compile from es6 if not already supported. See config for Babel and Webpack4 as follows +**web3auth** and **torus** will require a Babel to compile from es6 if not already supported. See config for Babel and Webpack4 as follows: `npm i --save-dev @babel/cli @babel/core @babel/node @babel/plugin-proposal-nullish-coalescing-operator @babel/plugin-proposal-optional-chaining @babel/plugin-syntax-bigint @babel/register` **AND** diff --git a/docs/src/routes/docs/[...4]wallets/[...12]gnosis/+page.md b/docs/src/routes/docs/[...4]wallets/[...12]gnosis/+page.md index c6a1cd5ee..81d9c083f 100644 --- a/docs/src/routes/docs/[...4]wallets/[...12]gnosis/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...12]gnosis/+page.md @@ -4,7 +4,7 @@ title: Safe # {$frontmatter.title} -Wallet module for connecting Safe to web3-onboard +Wallet module for connecting Safe to Web3 Onboard ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...13]infinitywallet/+page.md b/docs/src/routes/docs/[...4]wallets/[...13]infinitywallet/+page.md index 5498566c7..38981c4eb 100644 --- a/docs/src/routes/docs/[...4]wallets/[...13]infinitywallet/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...13]infinitywallet/+page.md @@ -6,7 +6,7 @@ title: Infinity Wallet ## Wallet module for connecting Infinity Wallet through web3-onboard -Infinity Wallet SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications. +Infinity Wallet SDK wallet module for connecting to Web3 Onboard. Web3 Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications. Checkout the official [Infinity Wallet page](https://infinitywallet.io/) for details. diff --git a/docs/src/routes/docs/[...4]wallets/[...14]injected/+page.md b/docs/src/routes/docs/[...4]wallets/[...14]injected/+page.md index de843ece0..4901782d7 100644 --- a/docs/src/routes/docs/[...4]wallets/[...14]injected/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...14]injected/+page.md @@ -4,13 +4,13 @@ title: Injected Wallets # {$frontmatter.title} -This module lets web3-onboard automatically detect Browser Injected Wallets such as Metamask or Coinbase Wallet. We recommend you install this module to get the most out of your w3o implementation. This module supports [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) and [recognizes many injected wallets natively](#injected-wallets-supported-natively) as well as supports all [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) compatible wallets. +This module lets Web3 Onboard automatically detect Browser Injected Wallets such as Metamask or Coinbase Wallet. We recommend you install this module to get the most out of your Web3 Onboard implementation. This module supports [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193), [recognizes many injected wallets natively](#injected-wallets-supported-natively), and supports all [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) compatible wallets. -Note: Make sure to install the core module before installing other modules to w3o. +Note: Make sure to install the core module before installing other modules to Web3 Onboard. ### Support all EIP-6963 Wallets out of the box -Web3-Onboard supports all [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) compatible wallets out of the box and will automatically recognizes any wallet which has integrated 6963 support. +Web3 Onboard supports all [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) compatible wallets out of the box and will automatically recognizes any wallet which has integrated 6963 support. ## Install @@ -151,7 +151,7 @@ type Platform = ## Adding Custom Injected Wallets -If there is an injected wallet that you would like to support in your app, but is not yet included in this repo, you can add a custom wallet module in the `custom` field: +If there is an injected wallet that you would like to support in your dapp, but is not yet included in this repo, you can add a custom wallet module in the `custom` field: ```typescript const equal = { @@ -220,8 +220,8 @@ const injected = injectedModule({ }) ``` -This can be set to an array top specify which unavailable injected wallets to show or set to true to display all unavailable injected wallets regardless of whether it has been detected in the window, happy days. -Then the issue of the order of wallets displayed becomes apparent when you have 21 injected wallets at the top of the wallets list. To solve this, all injected wallets are sorted **alphabetically** by default and there is an additional `sort` parameter which receives the final list of wallets and then returns the list to be rendered. This allows for example setting MetaMask and Coinbase first and then just the rest alphabetically: +This can be set to an array to specify which unavailable injected wallets to show, or set to true to display all unavailable injected wallets regardless of whether it has been detected in the window. +Then the issue of the order of wallets displayed becomes apparent when you have 21 injected wallets at the top of the wallets list. To solve this, all injected wallets are sorted **alphabetically** by default and there is an additional `sort` parameter which receives the final list of wallets and then returns the list to be rendered. This allows, for example, setting MetaMask and Coinbase first and then the rest are sorted alphabetically: ```javascript const injected = injectedModule({ @@ -248,7 +248,7 @@ const injected = injectedModule({ }) ``` -You may want to display all unavailable injected wallets, but filter out specific wallets based on their availability. For example I may want to display all unavailable wallets except when Binance and Bitski wallet is unavailable, then don't show them, but if they are available, then do show them. To do this, the filters value has been extended to have a new value: `'unavailable'`, as in; remove this wallet if it is unavailable, even though `displayUnavailable` wallets is set: +You may want to display all unavailable injected wallets, but filter out specific wallets based on their availability. For example, I may want to display all unavailable wallets except when Binance and Bitski wallet is unavailable, then don't show them, but if they are available, then do show them. To do this, the filters value has been extended to have a new value: `'unavailable'`, as in; remove this wallet if it is unavailable, even though `displayUnavailable` wallets is set: ```javascript const injected = injectedModule({ @@ -280,7 +280,7 @@ const injected = injectedModule({ }) ``` -If a wallet is selected, but is not available the default error message is: `Oops ${wallet.label} is unavailable! Please install` if a download link is available for that wallet. If there isn't a download link for that wallet the default is: `Please install or enable ${walletName} to continue`. You may want to customize that message, so there is the `walletUnavailableMessage` parameter which is a function that takes the wallet object that is unavailable and returns a string which is the message to display: +If a wallet is selected, but is not available, the default error message is: `Oops ${wallet.label} is unavailable! Please install` if a download link is available for that wallet. If there isn't a download link for that wallet the default is: `Please install or enable ${walletName} to continue`. You may want to customize that message, so there is the `walletUnavailableMessage` parameter which is a function that takes the wallet object that is unavailable and returns a string which is the message to display: ```javascript const injected = injectedModule({ diff --git a/docs/src/routes/docs/[...4]wallets/[...15]keepkey/+page.md b/docs/src/routes/docs/[...4]wallets/[...15]keepkey/+page.md index 68dafb1af..0b24f6309 100644 --- a/docs/src/routes/docs/[...4]wallets/[...15]keepkey/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...15]keepkey/+page.md @@ -4,7 +4,7 @@ title: Keepkey # {$frontmatter.title} -Wallet module for connecting KeepKey hardware wallets to web3-onboard +Wallet module for connecting KeepKey hardware wallets to Web3 Onboard. ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...16]keystone/+page.md b/docs/src/routes/docs/[...4]wallets/[...16]keystone/+page.md index 9ae0348ae..97be3032b 100644 --- a/docs/src/routes/docs/[...4]wallets/[...16]keystone/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...16]keystone/+page.md @@ -4,7 +4,7 @@ title: Keystone # {$frontmatter.title} -Wallet module for connecting Keystone hardware wallets to web3-onboard +Wallet module for connecting Keystone hardware wallets to Web3 Onboard. ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...17]ledger/+page.md b/docs/src/routes/docs/[...4]wallets/[...17]ledger/+page.md index 41de7ec78..d1b77249a 100644 --- a/docs/src/routes/docs/[...4]wallets/[...17]ledger/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...17]ledger/+page.md @@ -4,7 +4,7 @@ title: Ledger # {$frontmatter.title} -Wallet module for connecting Ledger hardware wallets to web3-onboard +Wallet module for connecting Ledger hardware wallets to Web3 Onboard. ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...18]magic/+page.md b/docs/src/routes/docs/[...4]wallets/[...18]magic/+page.md index e3e4a9b75..8dd28e593 100644 --- a/docs/src/routes/docs/[...4]wallets/[...18]magic/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...18]magic/+page.md @@ -4,12 +4,12 @@ title: Magic # {$frontmatter.title} -Wallet module for connecting Magic wallets to Onboard V2 +Wallet module for connecting Magic wallets to Web3 Onboard. ### Login options - **Email** - The Magic module comes with a built in email login modal that is customizable - in the same fashion that all other web3-onboard UI components are + in the same fashion that all other Web3 Onboard UI components are. :::admonition type=note @@ -72,7 +72,7 @@ console.log(connectedWallets) When a Magic wallet is connected the Magic instance is exposed. This can be used to get information such as user MetaData, update a user's email address or handle the user's token. -The user's email can be set in local storage and passed through the `MagicInitOptions` to avoid a user having to login again if they are returning to the DApp within the set user session time. +The user's email can be set in local storage and passed through the `MagicInitOptions` to avoid a user having to login again if they are returning to the dapp within the set user session time. Magic has a default time of 7 days and this can be configured through your Magic API Key settings. ```typescript @@ -91,7 +91,7 @@ For full documentation and examples please visit [Magic's official docs](https:/ ## Custom Styling -The Magic Wallet Login styles can customized via [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). The following properties and their default properties can be customized by adding these variables to the `:root` in your CSS file. If they are not specified they will fall back on the style variables prefixed with `--onboard` and beyond that to the styles developed by Blocknative: +The Magic Wallet Login styles can customized via [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). The following properties and their default properties can be customized by adding these variables to the `:root` in your CSS file. If they are not specified they will fall back on the style variables prefixed with `--onboard` and beyond that to the styles developed by Web3 Onboard: ```css :root { diff --git a/docs/src/routes/docs/[...4]wallets/[...1]arcana/+page.md b/docs/src/routes/docs/[...4]wallets/[...1]arcana/+page.md index d516948c3..3eb01c927 100644 --- a/docs/src/routes/docs/[...4]wallets/[...1]arcana/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...1]arcana/+page.md @@ -14,7 +14,7 @@ To enable the Arcana wallet in Web3 apps, developers must register and configure For details, see [Quick Start Guide](https://docs.arcana.network/auth-quick-start.html). ::: -[Web3-Onboard](https://onboard.blocknative.com/) is an open-source, framework-agnostic JavaScript library to onboard users to web3 apps. This package can be used to integrate [Arcana Wallet](https://docs.arcana.network/concepts/anwallet/index.html) support into Web3-Onboard's "Connect Wallet" modal. With this module, the Arcana wallet option will be shown for any app that integrates with the Arcana Auth SDK and uses it to onboard users. There is no need to download any browser extension. For more information on how to use the Arcana Wallet, please refer to the [Arcana Wallet User Guide](https://docs.arcana.network/user-guides/wallet-ui/index.html). +[Web3-Onboard](https://onboard.blocknative.com/) is an open-source, framework-agnostic JavaScript library to onboard users to web3 apps. This package can be used to integrate [Arcana Wallet](https://docs.arcana.network/concepts/anwallet/index.html) support into Web3 Onboard's "Connect Wallet" modal. With this module, the Arcana wallet option will be shown for any app that integrates with the Arcana Auth SDK and uses it to onboard users. There is no need to download any browser extension. For more information on how to use the Arcana Wallet, please refer to the [Arcana Wallet User Guide](https://docs.arcana.network/user-guides/wallet-ui/index.html). ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...20]mew/+page.md b/docs/src/routes/docs/[...4]wallets/[...20]mew/+page.md index e147d5156..e0706a648 100644 --- a/docs/src/routes/docs/[...4]wallets/[...20]mew/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...20]mew/+page.md @@ -5,10 +5,10 @@ title: Mew # {$frontmatter.title} :::admonition type=warning -_Wallet module for connecting Mew to web3-onboard is now deprecated. Please use [@web3-onboard/mew-wallet](../../wallets/mewwallet.md)_ +_Wallet module for connecting Mew to Web3 Onboard is now deprecated. Please use [@web3-onboard/mew-wallet](../../wallets/mewwallet.md)_ ::: -Wallet module for connecting Mew wallet to web3-onboard +Wallet module for connecting Mew wallet to Web3 Onboard ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...21]mewwallet/+page.md b/docs/src/routes/docs/[...4]wallets/[...21]mewwallet/+page.md index 544e6b6e8..73eb8c325 100644 --- a/docs/src/routes/docs/[...4]wallets/[...21]mewwallet/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...21]mewwallet/+page.md @@ -4,7 +4,7 @@ title: Mew Wallet # {$frontmatter.title} -Wallet module for connecting Mew wallet through web3-onboard +Wallet module for connecting Mew wallet through Web3 Onboard ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...23]phantom/+page.md b/docs/src/routes/docs/[...4]wallets/[...23]phantom/+page.md index fd71019fc..d32de0d41 100644 --- a/docs/src/routes/docs/[...4]wallets/[...23]phantom/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...23]phantom/+page.md @@ -5,10 +5,10 @@ title: Phantom # {$frontmatter.title} :::admonition type=warning -The module for connecting Phantom to web3-onboard is still in alpha testing and Phantom Eth mainnet coverage is not fully public yet but will be soon. Please visit the [Official Phantom Site](https://phantom.app/) for more details. +The module for connecting Phantom to Web3 Onboard is still in alpha testing and Phantom Eth mainnet coverage is not fully public yet but will be soon. Please visit the [Official Phantom Site](https://phantom.app/) for more details. ::: -[Web3-Onboard](https://onboard.blocknative.com/) is an open-source, framework-agnostic JavaScript library to onboard users to web3 apps. This package can be used to integrate [Phantom Wallet](https://phantom.app/) support into Web3-Onboard's "Connect Wallet" modal. With this module the Phantom option will be shown even if the extension is not installed on the users browser or used within the Phantom app. If selected the user will be taken to a download screen and prompted to create a Phantom wallet. For more information on Phantom, please refer to the [Phantom developer docs](https://docs.phantom.app/). +[Web3-Onboard](https://onboard.blocknative.com/) is an open-source, framework-agnostic JavaScript library to onboard users to web3 apps. This package can be used to integrate [Phantom Wallet](https://phantom.app/) support into Web3 Onboard's "Connect Wallet" modal. With this module the Phantom option will be shown even if the extension is not installed on the users browser or used within the Phantom app. If selected the user will be taken to a download screen and prompted to create a Phantom wallet. For more information on Phantom, please refer to the [Phantom developer docs](https://docs.phantom.app/). ### Install @@ -49,3 +49,7 @@ const onboard = Onboard({ const connectedWallets = await onboard.connectWallet() console.log(connectedWallets) ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...4]wallets/[...25]taho/+page.md b/docs/src/routes/docs/[...4]wallets/[...25]taho/+page.md index 731d959bd..7632e5a68 100644 --- a/docs/src/routes/docs/[...4]wallets/[...25]taho/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...25]taho/+page.md @@ -4,7 +4,7 @@ title: Taho (previously Tally Ho) # {$frontmatter.title} -## Wallet module for connecting Taho (wallet previously named Tally Ho) +Wallet module for connecting Taho (wallet previously named Tally Ho) to Web3 Onboard. See [Taho Developer Docs](https://docs.tally.cash/tally/developers/integrating-dapps) @@ -44,3 +44,7 @@ const onboard = Onboard({ const connectedWallets = await onboard.connectWallet() console.log(connectedWallets) ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...4]wallets/[...26]tallyho/+page.md b/docs/src/routes/docs/[...4]wallets/[...26]tallyho/+page.md index 3bc1b0cde..4ceead32d 100644 --- a/docs/src/routes/docs/[...4]wallets/[...26]tallyho/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...26]tallyho/+page.md @@ -5,7 +5,7 @@ title: Tally Ho # {$frontmatter.title} :::admonition type=warning -_Wallet module for connecting TallyHo to web3-onboard is now deprecated. Please use [@web3-onboard/taho](../../wallets/taho.md)_ +_Wallet module for connecting TallyHo to Web3 Onboard is now deprecated. Please use [@web3-onboard/taho](../../wallets/taho.md)_ ::: ## Wallet module for connecting TallyHo @@ -48,3 +48,7 @@ const onboard = Onboard({ const connectedWallets = await onboard.connectWallet() console.log(connectedWallets) ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...4]wallets/[...27]torus/+page.md b/docs/src/routes/docs/[...4]wallets/[...27]torus/+page.md index 97d361881..c197cdfea 100644 --- a/docs/src/routes/docs/[...4]wallets/[...27]torus/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...27]torus/+page.md @@ -4,7 +4,7 @@ title: Torus # {$frontmatter.title} -## Wallet module for connecting Torus wallet to web3-onboard +Wallet module for connecting Torus wallet to Web3 Onboard ### Install @@ -89,3 +89,7 @@ config.module.rules = [ } ] ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...4]wallets/[...28]trezor/+page.md b/docs/src/routes/docs/[...4]wallets/[...28]trezor/+page.md index 8b1e42176..ec8bafe11 100644 --- a/docs/src/routes/docs/[...4]wallets/[...28]trezor/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...28]trezor/+page.md @@ -4,7 +4,7 @@ title: Trezor # {$frontmatter.title} -Wallet module for connecting Trezor hardware wallets to web3-onboard +Wallet module for connecting Trezor hardware wallets to Web3 Onboard. ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...29]uauth/+page.md b/docs/src/routes/docs/[...4]wallets/[...29]uauth/+page.md index 36639a6c8..dea3c5f3d 100644 --- a/docs/src/routes/docs/[...4]wallets/[...29]uauth/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...29]uauth/+page.md @@ -4,7 +4,7 @@ title: UAuth # {$frontmatter.title} -Wallet module for connecting Unstoppable Domains to web3-onboard +Wallet module for connecting Unstoppable Domains to Web3 Onboard. ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...30]venly/+page.md b/docs/src/routes/docs/[...4]wallets/[...30]venly/+page.md index 934553122..ef9ef544a 100644 --- a/docs/src/routes/docs/[...4]wallets/[...30]venly/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...30]venly/+page.md @@ -1,6 +1,6 @@ # Venly -Wallet module for connecting Venly Wallet SDK to web3-onboard. Check out the [Venly Docs](https://docs.venly.io/) for more information. +Wallet module for connecting Venly Wallet SDK to Web3 Onboard. Check out the [Venly Docs](https://docs.venly.io/) for more information. ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...32]walletlink/+page.md b/docs/src/routes/docs/[...4]wallets/[...32]walletlink/+page.md index 009dffd73..6db33659c 100644 --- a/docs/src/routes/docs/[...4]wallets/[...32]walletlink/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...32]walletlink/+page.md @@ -5,7 +5,7 @@ title: Walletlink # {$frontmatter.title} :::admonition type=warning -_Wallet module for connecting WalletLink to web3-onboard is now deprecated. Please use [@web3-onboard/coinbase](../../wallets/coinbase.md)_ +_Wallet module for connecting WalletLink to Web3 Onboard is now deprecated. Please use [@web3-onboard/coinbase](../../wallets/coinbase.md)_ ::: ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...33]web3auth/+page.md b/docs/src/routes/docs/[...4]wallets/[...33]web3auth/+page.md index 2373d94b6..b86cafd9d 100644 --- a/docs/src/routes/docs/[...4]wallets/[...33]web3auth/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...33]web3auth/+page.md @@ -4,7 +4,7 @@ title: Web3auth # {$frontmatter.title} -Wallet module for connecting Web3auth to web3-onboard +Wallet module for connecting Web3auth to Web3 Onboard. ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...34]xdefi/+page.md b/docs/src/routes/docs/[...4]wallets/[...34]xdefi/+page.md index d462c6616..cd8993ace 100644 --- a/docs/src/routes/docs/[...4]wallets/[...34]xdefi/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...34]xdefi/+page.md @@ -4,7 +4,7 @@ title: XDEFI # {$frontmatter.title} -## Wallet module for connecting XDEFI to web3-onboard +Wallet module for connecting XDEFI to Web3 Onboard. See [XDEFI Wallet Developer Docs](https://sdk.xdefi.io/) @@ -47,3 +47,7 @@ const onboard = Onboard({ const connectedWallets = await onboard.connectWallet() console.log(connectedWallets) ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...4]wallets/[...35]zeal/+page.md b/docs/src/routes/docs/[...4]wallets/[...35]zeal/+page.md index d8cb7433b..2f4a1c1c7 100644 --- a/docs/src/routes/docs/[...4]wallets/[...35]zeal/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...35]zeal/+page.md @@ -4,11 +4,11 @@ title: Zeal # {$frontmatter.title} -## Wallet module for connecting Zeal to web3-onboard +Wallet module for connecting Zeal to Web3 Onboard. See [Zeal](https://www.zeal.app/) for details. -For any questions or issues related to integration with Zeal wallet do not hesitate to contact our builders via [hi@zeal.app](mailto:hi@zeal.app) OR ping us on twitter [@withzeal](https://twitter.com/withzeal) +For any questions or issues related to integration with Zeal wallet do not hesitate to contact our builders via [hi@zeal.app](mailto:hi@zeal.app) OR ping us on X [@withzeal](https://twitter.com/withzeal) ## Install @@ -49,3 +49,7 @@ const onboard = Onboard({ const connectedWallets = await onboard.connectWallet() console.log(connectedWallets) ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...4]wallets/[...4]blocto/+page.md b/docs/src/routes/docs/[...4]wallets/[...4]blocto/+page.md index bb598a2c1..f47413650 100644 --- a/docs/src/routes/docs/[...4]wallets/[...4]blocto/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...4]blocto/+page.md @@ -4,7 +4,7 @@ title: Blocto # {$frontmatter.title} -Wallet module for connecting Blocto SDK to web3-onboard. Check out the [Blocto Developer Docs](https://docs.blocto.app/blocto-sdk/javascript-sdk/evm-sdk) for more information. +Wallet module for connecting Blocto SDK to Web3 Onboard. Check out the [Blocto Developer Docs](https://docs.blocto.app/blocto-sdk/javascript-sdk/evm-sdk) for more information. ## Install @@ -54,7 +54,7 @@ For build env configurations and setups please see the Build Env section [here]( Node built-ins are automatically bundled in v4 so that portion is handled automatically. -**Blocto** support will require a Babel to compile from es6 if not already supported. See config for Babel and Webpack4 as follows +**Blocto** support will require a Babel to compile from es6 if not already supported. See config for Babel and Webpack4 as follows: `npm i --save-dev @babel/cli @babel/core @babel/node @babel/plugin-proposal-nullish-coalescing-operator @babel/plugin-proposal-optional-chaining @babel/plugin-syntax-bigint @babel/register` **AND** diff --git a/docs/src/routes/docs/[...4]wallets/[...6]coinbase/+page.md b/docs/src/routes/docs/[...4]wallets/[...6]coinbase/+page.md index 54b47a36c..2f6c36723 100644 --- a/docs/src/routes/docs/[...4]wallets/[...6]coinbase/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...6]coinbase/+page.md @@ -4,7 +4,7 @@ title: Coinbase # {$frontmatter.title} -Wallet module for connecting Coinbase Wallet SDK to web3-onboard. Check out the [Coinbase Wallet Developer Docs](https://docs.cloud.coinbase.com/wallet-sdk/docs) for more information. +Wallet module for connecting Coinbase Wallet SDK to Web3 Onboard. Check out the [Coinbase Wallet Developer Docs](https://docs.cloud.coinbase.com/wallet-sdk/docs) for more information. ## Install diff --git a/docs/src/routes/docs/[...4]wallets/[...7]dcent/+page.md b/docs/src/routes/docs/[...4]wallets/[...7]dcent/+page.md index 402f6db37..5221b4aef 100644 --- a/docs/src/routes/docs/[...4]wallets/[...7]dcent/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...7]dcent/+page.md @@ -4,7 +4,7 @@ title: Dcent # {$frontmatter.title} -## Wallet module for connecting D'CENT hardware wallets to web3-onboard +Wallet module for connecting D'CENT hardware wallets to Web3 Onboard. ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...8]enkrypt/+page.md b/docs/src/routes/docs/[...4]wallets/[...8]enkrypt/+page.md index e53e0e57c..0f3f9428b 100644 --- a/docs/src/routes/docs/[...4]wallets/[...8]enkrypt/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...8]enkrypt/+page.md @@ -4,7 +4,7 @@ title: Enkrypt # {$frontmatter.title} -Wallet module for connecting Enkrypt wallet through web3-onboard +Wallet module for connecting Enkrypt wallet through Web3 Onboard. ### Install diff --git a/docs/src/routes/docs/[...4]wallets/[...9]fortmatic/+page.md b/docs/src/routes/docs/[...4]wallets/[...9]fortmatic/+page.md index 6e951585e..f5b0a31be 100644 --- a/docs/src/routes/docs/[...4]wallets/[...9]fortmatic/+page.md +++ b/docs/src/routes/docs/[...4]wallets/[...9]fortmatic/+page.md @@ -4,7 +4,7 @@ title: Fortmatic # {$frontmatter.title} -Wallet module for connecting Fortmatic wallets to web3-onboard +Wallet module for connecting Fortmatic wallets to Web3 Onboard. ### Install diff --git a/docs/src/routes/docs/[...5]other/[...1]cede-store/+page.md b/docs/src/routes/docs/[...5]other/[...1]cede-store/+page.md index 8bfd6da81..7ed41fc57 100644 --- a/docs/src/routes/docs/[...5]other/[...1]cede-store/+page.md +++ b/docs/src/routes/docs/[...5]other/[...1]cede-store/+page.md @@ -4,7 +4,7 @@ title: cede.store # {$frontmatter.title} -CEX Wallet module for connecting cede.store through web3-onboard. Check out the [cede.store Wallet Developer Docs](https://docs.cede.store) for more information. +CEX Wallet module for connecting cede.store through Web3 Onboard. Check out the [cede.store Wallet Developer Docs](https://docs.cede.store) for more information. :::admonition type=warning Cede.store is not a traditional 1193 wallet, behavior is different in that there is no on-chain user address to interact with and there isn't a specific chain associated. @@ -94,3 +94,7 @@ await provider.request({ } }) ``` + +## Build Environments + +For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments) \ No newline at end of file diff --git a/docs/src/routes/docs/[...6]resources/[...1]resources/+page.md b/docs/src/routes/docs/[...6]resources/[...1]resources/+page.md index f138c0a28..f46be6c09 100644 --- a/docs/src/routes/docs/[...6]resources/[...1]resources/+page.md +++ b/docs/src/routes/docs/[...6]resources/[...1]resources/+page.md @@ -4,7 +4,7 @@ title: Resources # {$frontmatter.title} -Useful Videos, Blog Posts & Links for Web3-Onboard +Useful Videos, Blog Posts & Links for Web3 Onboard. ### Videos @@ -28,10 +28,6 @@ Useful Videos, Blog Posts & Links for Web3-Onboard [Curve](https://www.curve.fi) -[Mintgate](https://app.mintgate.io/login) - -[Spritz Finance](https://www.spritz.finance) - [Beefy Finance](https://app.beefy.com) [Alienworlds](https://alienworlds.io/) @@ -44,6 +40,8 @@ Useful Videos, Blog Posts & Links for Web3-Onboard [Merlin](https://merlin.valktech.io/) +[Mintgate](https://app.mintgate.io/login) + ### Other links more coming soon! diff --git a/docs/src/routes/docs/[...6]resources/[...2]troubleshooting/+page.md b/docs/src/routes/docs/[...6]resources/[...2]troubleshooting/+page.md index 5481bfe15..b25d0db56 100644 --- a/docs/src/routes/docs/[...6]resources/[...2]troubleshooting/+page.md +++ b/docs/src/routes/docs/[...6]resources/[...2]troubleshooting/+page.md @@ -6,7 +6,7 @@ title: Troubleshooting ## Where's My Wallet? (Injected/Browser Extension) -This is a common problem and as the web3 space grows as do the pains of decentralized teams trying to find solutions that there are not standards for… yet. +This is a common problem: as the web3 space grows so do the pains of decentralized teams trying to find solutions that there are not standards for… yet. ### 1. Disabled Browser Extension @@ -44,7 +44,7 @@ Disable that wallet, refresh the page and run the steps above again. ### 3. Brave browser default Web3 Wallet -Brave is a great browser and some of the best privacy, paid to view ads and even comes with a web3 wallet right off the bat! While this is all great it does come along with some challenges around web3 wallets. In the same vein as the issue noted above with conflicting wallets the built- in browser must be switched from the default wallet if you are wanting to use other browser based extension wallets such as MetaMask. +Brave is a great browser with some of the best privacy, paid to view ads, and even comes with a web3 wallet right off the bat! While this is great it does come with some challenges regarding web3 wallets. In the same vein as the issue noted above with conflicting wallets, the built-in browser must be switched from the default wallet if you are wanting to use other browser based extension wallets such as MetaMask. This can be done by: @@ -57,4 +57,4 @@ This can be done by: A desktop computer user may not see their browser-injected Ethereum-based web3 wallets if they are using an outdated browser or extension. MetaMask and other wallets may update their software frequently to address security concerns or to improve functionality. If a user is running an outdated version of their wallet extension or their browser, they may experience issues accessing their wallet. To address this issue, users should ensure that they are running the latest version of their browser and MetaMask extension. Users can check for updates by navigating to their browser's extension settings(on Chrome browser navigate to _chrome://extensions/_) and selecting “Update” at the top of the extensions window, through the extension store or updating through the wallet’s website. -If you are still having issues feel free to visit the [Blocknative web3-onboard discord channel](https://discord.gg/4qZUshUY) or tag us on twitter for further support. We are always happy to assist and love working in the wallet space! +If you are still having issues feel free to visit the [Blocknative Web3 Onboard discord channel](https://discord.gg/4qZUshUY) or tag us on twitter for further support. We are always happy to assist and love working with the wallet space! diff --git a/docs/src/routes/examples/[...1]connect-wallet/+page.md b/docs/src/routes/examples/[...1]connect-wallet/+page.md index 9e31ac428..f91790199 100644 --- a/docs/src/routes/examples/[...1]connect-wallet/+page.md +++ b/docs/src/routes/examples/[...1]connect-wallet/+page.md @@ -1,6 +1,6 @@ --- title: Connect Wallet Example -description: Learn how to connect a wallet to your dapp with Web3-Onboard. For this example, we are going to use the injected wallets module. +description: Learn how to connect a wallet to your dapp with Web3 Onboard. For this example, we are going to use the injected wallets module. ---