Merge pull request #1503 from blocknative/update/consolidate-branches

Update branch paths and targets for `develop`, `main` and `docs` branches - (main)

Author: Adamj1232

.circleci/config.yml

@@ -18,12 +18,12 @@ aliases:
   - &deploy_production_filters
     filters:
       branches:
-        only: v2-web3-onboard
+        only: main
 
   - &deploy_staging_filters
     filters:
       branches:
-        only: v2-web3-onboard-develop
+        only: develop
 
   - &test_package_version_for_alpha_tag_break_false
     run:

.github/workflows/docs.yml

@@ -4,7 +4,7 @@ name: Deploy documentation to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["docs-main"]
+    branches: ["docs"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

.github/workflows/pr-status-checks.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
   pull_request:
     branches:
-      - v2-web3-onboard-develop
+      - develop
 
 jobs:
   checks:

README.md

@@ -121,7 +121,7 @@ If you would like to test out the current functionality of V2 in a small browser
 
 - Clone the repo: `git clone git@github.com:blocknative/onboard.git`
 - Change in to the onboard directory: `cd onboard`
-- Checkout the V2 feature branch: `git checkout v2-web3-onboard`
+- Checkout the V2 feature branch: `git checkout main`
 - Install the dependencies: `yarn` (if running a M1 mac - `yarn install-m1-mac`)
 - Run all packages in dev mode: `yarn dev`
 - To view the demo app in the browser after running the above steps navigate to [http://localhost:8080](http://localhost:8080)

docs/README.md

@@ -22,4 +22,4 @@ Run `yarn build` and confirm no errors present from the proposed changes.
 
 Confirm vercel build within PR builds without error and check instance deployment for accuracy.
 
-PR should target branch the main develop branch - [v2-web3-onboard-develop](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop).
+PR should target branch the main develop branch - [develop](https://github.com/blocknative/web3-onboard/tree/develop).

docs/src/lib/components/ConnectWalletButton.svelte

@@ -19,9 +19,13 @@
 
   onMount(async () => {
     if (!onboard) {
-      onboard = await getOnboard()
+      if (document.location.href.includes('theming-tool')) {
+        onboard = await getOnboard('default')
+      } else {
+        onboard = await getOnboard('system')
+      }
     }
-    const sub = onboard.state.select('wallets').subscribe((wallets) => {
+    onboard.state.select('wallets').subscribe((wallets) => {
       connectedWallets = wallets
       buttonText = wallets.length ? 'Disconnect' : (buttonText = 'Connect')
     })

docs/src/lib/components/Footer.svelte

@@ -11,7 +11,7 @@
 
   let text = {
     license: 'Released under the MIT License.',
-    copyright: '© 2022 Blocknative. All Rights Reserved.'
+    copyright: '© 2023 Blocknative. All Rights Reserved.'
   }
 </script>
 

docs/src/lib/components/ThemeCustomizer.svelte

@@ -1,84 +1,25 @@
 <script>
-  import Onboard from '@web3-onboard/core'
-  import injectedModule from '@web3-onboard/injected-wallets'
+  import getOnboard from '$lib/services/onboard'
 
   import { share } from 'rxjs/operators'
   import { onMount } from 'svelte'
 
-  const INFURA_ID = '8b60d52405694345a99bcb82e722e0af'
-  const injected = injectedModule()
-
-  const onboard = Onboard({
-    wallets: [injected],
-    chains: [
-      {
-        id: '0x1',
-        token: 'ETH',
-        label: 'Ethereum Mainnet',
-        rpcUrl: `https://mainnet.infura.io/v3/${INFURA_ID}`
-      },
-      {
-        id: '0x5',
-        token: 'ETH',
-        label: 'Ethereum Goerli Testnet',
-        rpcUrl: `https://goerli.infura.io/v3/${INFURA_ID}`
-      },
-      {
-        id: '0x13881',
-        token: 'MATIC',
-        label: 'Polygon - Mumbai',
-        rpcUrl: 'https://matic-mumbai.chainstacklabs.com	'
-      },
-      {
-        id: '0x38',
-        token: 'BNB',
-        label: 'Binance',
-        rpcUrl: 'https://bsc-dataseed.binance.org/'
-      },
-      {
-        id: 137,
-        token: 'MATIC',
-        label: 'Polygon',
-        rpcUrl: 'https://matic-mainnet.chainstacklabs.com'
-      },
-      {
-        id: 10,
-        token: 'OETH',
-        label: 'Optimism',
-        rpcUrl: 'https://mainnet.optimism.io'
-      },
-      {
-        id: 42161,
-        token: 'ARB-ETH',
-        label: 'Arbitrum',
-        rpcUrl: 'https://rpc.ankr.com/arbitrum'
-      }
-    ],
-    appMetadata: {
-      name: 'Documentation',
-      description: 'Example showcasing how to connect a wallet.',
-      recommendedInjectedWallets: [
-        { name: 'MetaMask', url: 'https://metamask.io' },
-        { name: 'Coinbase', url: 'https://wallet.coinbase.com/' }
-      ]
-    },
-    accountCenter: {
-      desktop: { enabled: true },
-      mobile: { enabled: true }
-    },
-    theme: 'system'
-  })
+  let onboard
+  let wallets$
 
   const themes = ['system', 'default', 'light', 'dark', 'custom']
-  let selectedTheme = 'system'
-
-  // Subscribe to wallet updates
-  const wallets$ = onboard.state.select('wallets').pipe(share())
+  let selectedTheme = 'custom'
 
   let webURL = ''
   let iframeUsed = false
   let hideDirections = false
 
+  const loadOnboard = async () => {
+    onboard = await getOnboard('default')
+    onboard.state.actions.updateTheme('default')
+    wallets$ = onboard.state.select('wallets').pipe(share())
+  }
+
   const isValidUrl = (urlString) => {
     try {
       return Boolean(new URL(urlString))
@@ -112,7 +53,8 @@
     if (onboardCloseBtnVisible) onboardCloseBtnVisible?.click()
   }
 
-  const handleConnectWalletBtn = () => {
+  const handleConnectWalletBtn = async () => {
+    if (!onboard) await loadOnboard()
     !!$wallets$ && $wallets$.length
       ? onboard.disconnectWallet({ label: $wallets$[0].label })
       : onboard.connectWallet()
@@ -234,6 +176,8 @@
   }
 
   onMount(async () => {
+    await loadOnboard()
+    await onboard.state.actions.updateTheme('default')
     handleImageDrop()
   })
 </script>

docs/src/lib/services/onboard.js

@@ -1,12 +1,13 @@
-import bnIcon from '$lib/components/icons/bnWhiteBackground.js'
 let onboard
-const getOnboard = async () => {
+const getOnboard = async (passedTheme) => {
   if (!onboard) {
     const key = 'svelteness::color-scheme'
     const scheme = localStorage[key]
-    let theme = scheme || 'system'
+    let theme = passedTheme || scheme || 'system'
     onboard = await intiOnboard(theme)
     classMutationListener()
+  } else {
+    await onboard.state.actions.updateTheme(passedTheme)
   }
   return onboard
 }
@@ -173,7 +174,6 @@ const intiOnboard = async (theme) => {
     ],
     appMetadata: {
       name: 'Documentation',
-      icon: bnIcon,
       description: 'Example showcasing how to connect a wallet.',
       recommendedInjectedWallets: [
         { name: 'MetaMask', url: 'https://metamask.io' },

docs/src/routes/docs/[...1]overview/[...1]introduction.md

@@ -169,7 +169,7 @@ 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`
-- Checkout the main web3-onboard branch: `git checkout v2-web3-onboard`
+- Checkout the main web3-onboard branch: `git checkout main`
 - Install the dependencies: `yarn` (if running a M1 mac - `yarn install-m1-mac`)
 - Run all packages in dev mode: `yarn dev`
 - [View demo app in the browser](http://localhost:8080/)

docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md

@@ -26,7 +26,7 @@ After making changes within a web3-onboard package you will want to bump the ver
 We use both semantic and `alpha` versioning for publishing and testing packages prior to official release.  This means if you do not see an `-alpha.x` tag on the version of the package you made changes in you will need to not only bump the version but also add an alpha flag followed by an alpha version number starting at 1 (ex. `-alpha.1`).
 
 Example : Adding a new injected wallet to the `injected` package -
-[Injected Package.json](https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/injected/package.json#L3) changes : `"version": "2.2.4",` --> `"version": "2.3.0-alpha.1",`
+[Injected Package.json](https://github.com/blocknative/web3-onboard/blob/develop/packages/injected/package.json#L3) changes : `"version": "2.2.4",` --> `"version": "2.3.0-alpha.1",`
 
 Example 2 : Bug fix within the `core` package -
 [Core package.json](https://github.com/blocknative/web3-onboard/blob/8531a73d69365f7d584320f1c4b97a5d90f1c34e/packages/core/package.json#L3) changes: `"version": "2.9.1-alpha.1",` --> `"version": "2.9.1-alpha.2",`
@@ -44,7 +44,7 @@ If you cannot write the code yourself to add a new wallet, then go ahead and cre
 
 ### Documentation contributions
 
-In order to contribute to the docs, you'll have to create a PR on the [v2-web3-onboard-develop branch](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop). If you contribute code, you should definitely document it appropriately. We highly encourage the community to improve web3-onboard docs, if you have any questions don't hesitate to reach out.
+In order to contribute to the docs, you'll have to create a PR on the [develop branch](https://github.com/blocknative/web3-onboard/tree/develop). If you contribute code, you should definitely document it appropriately. We highly encourage the community to improve web3-onboard docs, if you have any questions don't hesitate to reach out.
 
 ## Feedback
 

docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide.md

@@ -18,7 +18,7 @@ If you have bnc-onboard installed, you will need to install web3-onboard instead
 3. Make use of our API actions like `await onboard.connectWallet()` to allow a user to connect their wallets.
 
 For a full code overview of the upgrade process using the React Hooks package please see [this PR](https://github.com/blocknative/react-demo/pull/160/files) with special attention to the `App.js` and `services.js` files.
-To help you get started quickly we’ve put together [a set of examples across multiple frameworks that includes the above-mentioned steps](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop/examples).
+To help you get started quickly we’ve put together [a set of examples across multiple frameworks that includes the above-mentioned steps](https://github.com/blocknative/web3-onboard/tree/develop/examples).
 
 ### Package Upgrade - Modularization
 

docs/src/routes/docs/[...3]modules/core.md

@@ -53,13 +53,13 @@ npm install @web3-onboard/coinbase @web3-onboard/fortmatic @web3-onboard/gnosis
 Checkout our full library of quick start examples for connecting and interacting with EVM based wallets
 
 - **[React](https://github.com/blocknative/react-demo)**
-- **[Nextjs 13](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs-13)**
-- **[Nextjs](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs)**
-- **[Svelte](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/packages/demo)**
-- **[SvelteKit](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-sveltekit)**
-- **[Vite/React](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vite-react)**
-- **[Vue](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs)**
-- **[Vue2](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs-v2)**
+- **[Nextjs 13](https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs-13)**
+- **[Nextjs](https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs)**
+- **[Svelte](https://github.com/blocknative/web3-onboard/tree/main/packages/demo)**
+- **[SvelteKit](https://github.com/blocknative/web3-onboard/tree/main/examples/with-sveltekit)**
+- **[Vite/React](https://github.com/blocknative/web3-onboard/tree/main/examples/with-vite-react)**
+- **[Vue](https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs)**
+- **[Vue2](https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs-v2)**
 
 ## Initialization
 
@@ -178,7 +178,7 @@ type Locale = string // eg 'en', 'es'
 type i18nOptions = Record<Locale, i18n>
 ```
 
-To see a list of all of the text values that can be internationalized or replaced, check out the [default en file](https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/core/src/i18n/en.json).
+To see a list of all of the text values that can be internationalized or replaced, check out the [default en file](https://github.com/blocknative/web3-onboard/blob/develop/packages/core/src/i18n/en.json).
 Onboard is using the [ICU syntax](https://formatjs.io/docs/core-concepts/icu-syntax/) for formatting under the hood.
 
 **`theme`**
@@ -258,7 +258,7 @@ Currently notifications are positioned in the same location as the account cente
 The `transactionHandler` can react off any property of the Ethereum TransactionData returned to the callback from the event (see console.log in example init). In turn, it can return a Custom `Notification` object to define the verbiage, styling, or add functionality:
 
 - `Notification.message` - to completely customize the message shown
-- `Notification.eventCode` - handle codes in your own way - see codes here under the notify prop [default en file here](https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/core/src/i18n/en.json)
+- `Notification.eventCode` - handle codes in your own way - see codes here under the notify prop [default en file here](https://github.com/blocknative/web3-onboard/blob/develop/packages/core/src/i18n/en.json)
 - `Notification.type` - icon type displayed (see `NotificationType` below for options)
 - `Notification.autoDismiss` - time (in ms) after which the notification will be dismissed. If set to `0` the notification will remain on screen until the user dismisses the notification, refreshes the page or navigates away from the site with the notifications
 - `Notification.link` - add link to the transaction hash. For instance, a link to the transaction on etherscan

packages/core/README.md

@@ -1,5 +1,5 @@
 <a href="https://onboard.blocknative.com/">
-  <img alt="Web3-Onboard UI Components" src="https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/core.svg?raw=true" />
+  <img alt="Web3-Onboard UI Components" src="https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg?raw=true" />
 </a>
 
 # @web3-onboard/core
@@ -11,13 +11,13 @@ This is the core package that contains all of the UI and logic to be able to sea
 Checkout our full library of quick start examples for connecting and interacting with EVM based wallets
 
 - **[React](https://github.com/blocknative/react-demo)**
-- **[Nextjs 13](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs-13)**
-- **[Nextjs](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs)**
-- **[Svelte](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/packages/demo)**
-- **[SvelteKit](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-sveltekit)**
-- **[Vite/React](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vite-react)**
-- **[Vue](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs)**
-- **[Vue2](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs-v2)**
+- **[Nextjs 13](https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs-13)**
+- **[Nextjs](https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs)**
+- **[Svelte](https://github.com/blocknative/web3-onboard/tree/main/packages/demo)**
+- **[SvelteKit](https://github.com/blocknative/web3-onboard/tree/main/examples/with-sveltekit)**
+- **[Vite/React](https://github.com/blocknative/web3-onboard/tree/main/examples/with-vite-react)**
+- **[Vue](https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs)**
+- **[Vue2](https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs-v2)**
 
 ## Installation
 

packages/react/README.md

@@ -1,5 +1,5 @@
 <a href="https://onboard.blocknative.com/">
-  <img alt="Web3-Onboard UI Components" src="https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/core.svg?raw=true" />
+  <img alt="Web3-Onboard UI Components" src="https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg?raw=true" />
 </a>
 
 # @web3-onboard/react

packages/transaction-preview/README.md

@@ -1,7 +1,7 @@
 # @web3-onboard/transaction-preview
 
 ## A modular UI for previewing a single or set of unsigned Ethereum transactions.
-![Transaction Preview Flow](https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/transaction-preview.gif?raw=true "Transaction Preview Flow")
+![Transaction Preview Flow](https://github.com/blocknative/web3-onboard/blob/develop/assets/transaction-preview.gif?raw=true "Transaction Preview Flow")
 
 #### Full Transaction Preview package documentation available [here](https://onboard.blocknative.com/docs/packages/transaction-preview)
 

packages/vue/README.md

@@ -1,5 +1,5 @@
 <a href="https://onboard.blocknative.com/">
-  <img alt="Web3-Onboard UI Components" src="https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/core.svg?raw=true" />
+  <img alt="Web3-Onboard UI Components" src="https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg?raw=true" />
 </a>
 
 # @web3-onboard/vue