Merge pull request #2247 from blocknative/release/2.26.2

Release 2.26.2 (docs)

Author: Adamj1232

.circleci/config.yml

@@ -255,6 +255,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/trust
     steps:
       - node-build-steps
+  build-okx:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/okx
+    steps:
+      - node-build-steps
   build-frontier:
     docker:
       - image: cimg/node:16.13.1
@@ -460,6 +466,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/passport
     steps:
       - node-build-steps
+  build-bloom:
+    docker:
+      - image: cimg/node:18.0.0
+    working_directory: ~/web3-onboard-monorepo/packages/bloom
+    steps:
+      - node-build-steps
 
   # Build staging/Alpha releases
   build-staging-core:
@@ -552,6 +564,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/trust
     steps:
       - node-staging-build-steps
+  build-staging-okx:
+    docker:
+      - image: cimg/node:16.13.1
+    working_directory: ~/web3-onboard-monorepo/packages/okx
+    steps:
+      - node-staging-build-steps
   build-staging-frontier:
     docker:
       - image: cimg/node:16.13.1
@@ -756,6 +774,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/passport
     steps:
       - node-staging-build-steps
+  build-staging-bloom:
+    docker:
+      - image: cimg/node:18.0.0
+    working_directory: ~/web3-onboard-monorepo/packages/bloom
+    steps:
+      - node-staging-build-steps
 
 workflows:
   version: 2
@@ -851,6 +875,12 @@ workflows:
           <<: *deploy_production_filters
       - build-staging-trust:
           <<: *deploy_staging_filters
+  okx:
+    jobs:
+      - build-okx:
+          <<: *deploy_production_filters
+      - build-staging-okx:
+          <<: *deploy_staging_filters
   frontier:
     jobs:
       - build-frontier:
@@ -1055,3 +1085,9 @@ workflows:
           <<: *deploy_production_filters
       - build-staging-passport:
           <<: *deploy_staging_filters
+  bloom:
+    jobs:
+      - build-bloom:
+          <<: *deploy_production_filters
+      - build-staging-bloom:
+          <<: *deploy_staging_filters

README.md

@@ -108,6 +108,7 @@ For full documentation, check out the README.md for each package or the [docs pa
 - [Arcana](packages/arcana-auth/README.md)
 - [Coinbase](packages/coinbase/README.md)
 - [Trust](packages/trust/README.md)
+- [OKX](packages/okx/README.md)
 - [WalletConnect](packages/walletconnect/README.md)
 - [Safe](packages/gnosis/README.md)
 - [Magic](packages/magic/README.md)

docs/package.json

@@ -12,8 +12,8 @@
     "format": "prettier --plugin-search-dir . --write .",
     "prepare": "svelte-kit sync",
     "test": "playwright test",
-    "w3o-latest-prod": "yarn add '@web3-onboard/core' '@web3-onboard/coinbase' '@web3-onboard/transaction-preview' '@web3-onboard/dcent' '@web3-onboard/frontier' '@web3-onboard/fortmatic' '@web3-onboard/frame' '@web3-onboard/gas' '@web3-onboard/gnosis' '@web3-onboard/keepkey' '@web3-onboard/keystone' '@web3-onboard/ledger' '@web3-onboard/infinity-wallet' '@web3-onboard/injected-wallets' '@web3-onboard/magic' '@web3-onboard/phantom' '@web3-onboard/portis' '@web3-onboard/sequence' '@web3-onboard/trezor' '@web3-onboard/trust' '@web3-onboard/torus' '@web3-onboard/taho' '@web3-onboard/web3auth' '@web3-onboard/walletconnect' '@web3-onboard/enkrypt' '@web3-onboard/mew-wallet' '@web3-onboard/xdefi' '@web3-onboard/uauth' '@web3-onboard/zeal' '@web3-onboard/cede-store' '@web3-onboard/blocto' '@web3-onboard/capsule' '@web3-onboard/particle-network' '@web3-onboard/metamask' '@web3-onboard/bitget' '@web3-onboard/arcana-auth' '@web3-onboard/venly'",
-    "w3o-latest-alpha": "yarn add '@web3-onboard/core@next' '@web3-onboard/coinbase@next' '@web3-onboard/transaction-preview@next' '@web3-onboard/dcent@next' '@web3-onboard/frontier@next' '@web3-onboard/fortmatic@next' '@web3-onboard/frame@next' '@web3-onboard/gas@next' '@web3-onboard/gnosis@next' '@web3-onboard/keepkey@next' '@web3-onboard/keystone@next' '@web3-onboard/ledger@next' '@web3-onboard/infinity-wallet@next' '@web3-onboard/injected-wallets@next' '@web3-onboard/magic@next' '@web3-onboard/phantom@next' '@web3-onboard/portis@next' '@web3-onboard/sequence@next' '@web3-onboard/trezor@next' '@web3-onboard/trust@next' '@web3-onboard/torus@next' '@web3-onboard/taho@next' '@web3-onboard/web3auth@next' '@web3-onboard/walletconnect@next' '@web3-onboard/enkrypt@next' '@web3-onboard/mew-wallet@next' '@web3-onboard/xdefi@next' '@web3-onboard/uauth@next' '@web3-onboard/zeal@next' '@web3-onboard/cede-store@next' '@web3-onboard/blocto@next' '@web3-onboard/capsule@next' '@web3-onboard/metamask@next' '@web3-onboard/bitget@next' '@web3-onboard/arcana-auth@next' '@web3-onboard/venly@next' '@web3-onboard/particle-network@next'"
+    "w3o-latest-prod": "yarn add '@web3-onboard/core' '@web3-onboard/coinbase' '@web3-onboard/transaction-preview' '@web3-onboard/dcent' '@web3-onboard/frontier' '@web3-onboard/fortmatic' '@web3-onboard/frame' '@web3-onboard/gas' '@web3-onboard/gnosis' '@web3-onboard/keepkey' '@web3-onboard/keystone' '@web3-onboard/ledger' '@web3-onboard/infinity-wallet' '@web3-onboard/injected-wallets' '@web3-onboard/magic' '@web3-onboard/phantom' '@web3-onboard/portis' '@web3-onboard/sequence' '@web3-onboard/trezor' '@web3-onboard/trust' '@web3-onboard/okx' '@web3-onboard/torus' '@web3-onboard/taho' '@web3-onboard/web3auth' '@web3-onboard/walletconnect' '@web3-onboard/enkrypt' '@web3-onboard/mew-wallet' '@web3-onboard/xdefi' '@web3-onboard/uauth' '@web3-onboard/zeal' '@web3-onboard/cede-store' '@web3-onboard/blocto' '@web3-onboard/capsule' '@web3-onboard/particle-network' '@web3-onboard/metamask' '@web3-onboard/bitget' '@web3-onboard/arcana-auth' '@web3-onboard/venly'",
+    "w3o-latest-alpha": "yarn add '@web3-onboard/core@next' '@web3-onboard/coinbase@next' '@web3-onboard/transaction-preview@next' '@web3-onboard/dcent@next' '@web3-onboard/frontier@next' '@web3-onboard/fortmatic@next' '@web3-onboard/frame@next' '@web3-onboard/gas@next' '@web3-onboard/gnosis@next' '@web3-onboard/keepkey@next' '@web3-onboard/keystone@next' '@web3-onboard/ledger@next' '@web3-onboard/infinity-wallet@next' '@web3-onboard/injected-wallets@next' '@web3-onboard/magic@next' '@web3-onboard/phantom@next' '@web3-onboard/portis@next' '@web3-onboard/sequence@next' '@web3-onboard/trezor@next' '@web3-onboard/trust@next' '@web3-onboard/okx@next' '@web3-onboard/torus@next' '@web3-onboard/taho@next' '@web3-onboard/web3auth@next' '@web3-onboard/walletconnect@next' '@web3-onboard/enkrypt@next' '@web3-onboard/mew-wallet@next' '@web3-onboard/xdefi@next' '@web3-onboard/uauth@next' '@web3-onboard/zeal@next' '@web3-onboard/cede-store@next' '@web3-onboard/blocto@next' '@web3-onboard/capsule@next' '@web3-onboard/metamask@next' '@web3-onboard/bitget@next' '@web3-onboard/arcana-auth@next' '@web3-onboard/venly@next' '@web3-onboard/particle-network@next'"
   },
   "devDependencies": {
     "@algolia/client-search": "^4.17.0",
@@ -72,6 +72,7 @@
     "@web3-onboard/magic": "^2.2.1",
     "@web3-onboard/metamask": "^2.1.1",
     "@web3-onboard/mew-wallet": "^2.1.1",
+    "@web3-onboard/okx": "2.0.0-alpha.1",
     "@web3-onboard/particle-network": "^2.1.1",
     "@web3-onboard/phantom": "^2.1.1",
     "@web3-onboard/portis": "^2.2.1",

docs/src/lib/services/onboard.js

@@ -51,6 +51,7 @@ const intiOnboard = async (theme) => {
   const { default: torusModule } = await import('@web3-onboard/torus')
   const { default: uauthModule } = await import('@web3-onboard/uauth')
   const { default: trustModule } = await import('@web3-onboard/trust')
+  const { default: okxModule } = await import('@web3-onboard/okx')
   const { default: xdefiModule } = await import('@web3-onboard/xdefi')
   const { default: cedeModule } = await import('@web3-onboard/cede-store')
   const { default: frameModule } = await import('@web3-onboard/frame')
@@ -93,6 +94,7 @@ const intiOnboard = async (theme) => {
   const taho = tahoModule()
   const torus = torusModule()
   const trust = trustModule()
+  const okx = okxModule()
   const xdefi = xdefiModule()
   const cede = cedeModule()
   const bitget = bitgetModule()
@@ -152,6 +154,7 @@ const intiOnboard = async (theme) => {
       ledger,
       trezor,
       trust,
+      okx,
       gnosis,
       taho,
       bitget,

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

@@ -193,6 +193,7 @@ We recommend you add the [Core Repo](../../modules/core.md#install) and consider
 - [Magic](../../wallets/magic.md#login-options)
 - [MetaMask](../../wallets/metamask.md#install)
 - [MEW](../../wallets/mewwallet.md#install)
+- [OKX](../../wallets/okx.md#install)
 - [Portis](../../wallets/portis.md#install)
 - [Web3Auth](../../wallets/web3auth.md#install)
 - [WalletConnect](../../wallets/walletconnect.md#install)

docs/src/routes/docs/[...4]wallets/[...19]metamask/+page.md

@@ -11,7 +11,7 @@ title: MetaMask
 ## Wallet module for connecting MetaMask Wallet SDK to web3-onboard
 
 The MetaMask Web3-Onboard module provides a reliable, secure, and seamless connection from your dapp to the MetaMask browser extension and MetaMask Mobile.
-See [MetaMask SDK Developer Docs](https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/)
+See [MetaMask SDK Developer Docs](https://docs.metamask.io/wallet/how-to/use-sdk/)
 
 <img src="{metaMaskSDKConnect}" alt="MetaMask SDK connect flow gif"/>
 

docs/src/routes/docs/[...4]wallets/[...33]web3auth/+page.md

@@ -35,10 +35,30 @@ For troubleshooting web3Auth errors, framework, polyfill, etc please see the [of
 ```typescript
 import Onboard from '@web3-onboard/core'
 import web3authModule from '@web3-onboard/web3auth'
+import { EthereumPrivateKeyProvider } from '@web3auth/ethereum-provider'
+import { CHAIN_NAMESPACES } from '@web3auth/base'
+
+const privateKeyProvider = new EthereumPrivateKeyProvider({
+  config: {
+    chainConfig: {
+      chainId: `0xAA36A7`,
+      rpcTarget: `https://rpc.sepolia.org/`,
+      chainNamespace: CHAIN_NAMESPACES.EIP155,
+      displayName: 'Sepolia',
+      blockExplorerUrl: 'https://sepolia.etherscan.io',
+      ticker: 'ETH',
+      tickerName: 'Ether',
+      logo: 'https://images.toruswallet.io/ethereum.svg'
+    }
+  }
+})
 
+// must access via http://localhost:8080 to be whitelisted
 const web3auth = web3authModule({
   clientId:
-    'DJuUOKvmNnlzy6ruVgeWYWIMKLRyYtjYa9Y10VCeJzWZcygDlrYLyXsBQjpJ2hxlBO9dnl8t9GmAC2qOP5vnIGo'
+    'BErDmyuxFPtpvM_Isiy8RHNWOWYvkAUehrgmO0rDoe5yr33ixt5s98eT_qePTyRsgpN7SVQwrEUMx7gON0jBDQI',
+  privateKeyProvider: privateKeyProvider,
+  web3AuthNetwork: 'sapphire_devnet'
 })
 
 const onboard = Onboard({
@@ -56,11 +76,15 @@ console.log(connectedWallets)
 ## Types
 
 ```typescript
+import type { Web3AuthOptions, ModalConfig } from '@web3auth/modal'
+import type { CustomChainConfig, OPENLOGIN_NETWORK_TYPE } from '@web3auth/base'
 type Web3AuthModuleOptions = Omit<Web3AuthOptions, 'chainConfig'> & {
   chainConfig?: Partial<CustomChainConfig> & Pick<CustomChainConfig, 'chainNamespace'>
-
   modalConfig?: Record<string, ModalConfig> | undefined
-
+  /**
+   * Web3Auth Network to use for the session & the issued idToken
+   */
+  web3AuthNetwork: OPENLOGIN_NETWORK_TYPE
   /**
    * @deprecated use web3Auth native Z-Index config through
    * uiConfig.modalZIndex

docs/src/routes/docs/[...4]wallets/[...37]bloom/+page.md

@@ -0,0 +1,116 @@
+---
+title: Bloom
+---
+
+# {$frontmatter.title}
+
+Wallet module for connecting Bloom to web3-onboard.
+
+## Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/bloom
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/bloom
+```
+
+  </TabPanel>
+</Tabs>
+
+
+```typescript
+type WalletConnectOptions = {
+  /**
+   * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com)
+   */
+  projectId: string
+  /**
+   * Defaults to `appMetadata.explore` that is supplied to the web3-onboard init
+   * Strongly recommended to provide atleast one URL as it is required by some wallets (i.e. MetaMask)
+   * To connect with walletconnect
+   */
+  dappUrl?: string
+  /**
+   * List of Required Chain(s) ID for wallets to support in number format (integer or hex)
+   * Defaults to [1] - Ethereum
+   */
+  requiredChains?: number[] | undefined
+  /**
+   * List of Optional Chain(s) ID for wallets to support in number format (integer or hex)
+   * Defaults to the chains provided within the web3-onboard init chain property
+   */
+  optionalChains?: number[] | undefined
+  /**
+   * Additional required methods to be added to the default list of ['eth_sendTransaction', 'personal_sign']
+   * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/advanced/providers/ethereum#required-and-optional-methods
+   */
+  additionalRequiredMethods?: string[] | undefined
+  /**
+   * Additional methods to be added to the default list of ['eth_sendTransaction',  'eth_signTransaction',  'personal_sign',  'eth_sign',  'eth_signTypedData',  'eth_signTypedData_v4']
+   * Passed methods to be included along with the defaults methods - see https://docs.walletconnect.com/2.0/web/walletConnectModal/options
+   */
+  additionalOptionalMethods?: string[] | undefined
+)
+```
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import bloomModule from '@web3-onboard/bloom'
+
+const wcInitOptions = {
+  /**
+   * Project ID associated with [WalletConnect account](https://cloud.walletconnect.com)
+   */
+  projectId: 'abc123...',
+  /**
+   * Chains required to be supported by all wallets connecting to your DApp
+   */
+  requiredChains: [1],
+  /**
+   * Chains required to be supported by all wallets connecting to your DApp
+   */
+  optionalChains: [42161, 8453, 10, 137, 56],
+  /**
+   * Defaults to `appMetadata.explore` that is supplied to the web3-onboard init
+   * Strongly recommended to provide atleast one URL as it is required by some wallets (i.e. MetaMask)
+   * To connect with WalletConnect
+   */
+  dappUrl: 'http://YourAwesomeDapp.com'
+}
+
+// initialize the module with options
+const bloom = bloomModule(wcInitOptions)
+
+// can also initialize with no options...
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    bloom
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+
+// Assuming only wallet connect is connected, index 0
+// `instance` will give insight into the WalletConnect info
+// such as namespaces, methods, chains, etc per wallet connected
+const { instance } = connectedWallets[0]
+
+console.log(connectedWallets)
+```
+
+## Build Environments
+
+For build env configurations and setups please see the Build Env section [here](/docs/modules/core#build-environments)

docs/src/routes/docs/[...4]wallets/[...37]okx/+page.md

@@ -0,0 +1,50 @@
+---
+title: OKX Wallet
+---
+
+# {$frontmatter.title}
+
+Wallet module for connecting OKX wallet through Web3 Onboard
+
+### Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/okx
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/okx
+```
+
+  </TabPanel>
+</Tabs>
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import okxWallet from '@web3-onboard/okx'
+
+const okx = okxWallet()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    okx
+    //... other wallets
+  ]
+})
+
+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)