Release 2.25.0 (docs)

.circleci/config.yml

@@ -205,7 +205,7 @@ jobs:
       - node-build-steps
   build-keepkey:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:16.20.2
     working_directory: ~/web3-onboard-monorepo/packages/keepkey
     steps:
       - node-build-steps
@@ -217,7 +217,7 @@ jobs:
       - node-build-steps
   build-ledger:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:18.0.0
     working_directory: ~/web3-onboard-monorepo/packages/ledger
     steps:
       - node-build-steps
@@ -247,7 +247,7 @@ jobs:
       - node-build-steps
   build-trezor:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:18.19.1
     working_directory: ~/web3-onboard-monorepo/packages/trezor
     steps:
       - node-build-steps
@@ -427,7 +427,7 @@ jobs:
       - node-build-steps
   build-metamask:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:18.19.1
     working_directory: ~/web3-onboard-monorepo/packages/metamask
     steps:
       - node-build-steps
@@ -443,8 +443,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/capsule
     steps:
       - node-build-steps
-
-
+  build-particle:
+    docker:
+      - image: cimg/node:18.0.0
+    working_directory: ~/web3-onboard-monorepo/packages/particle-network
+    steps:
+      - node-build-steps
 
   # Build staging/Alpha releases
   build-staging-core:
@@ -485,7 +489,7 @@ jobs:
       - node-staging-build-steps
   build-staging-keepkey:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:16.20.2
     working_directory: ~/web3-onboard-monorepo/packages/keepkey
     steps:
       - node-staging-build-steps
@@ -497,7 +501,7 @@ jobs:
       - node-staging-build-steps
   build-staging-ledger:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:18.0.0
     working_directory: ~/web3-onboard-monorepo/packages/ledger
     steps:
       - node-staging-build-steps
@@ -527,7 +531,7 @@ jobs:
       - node-staging-build-steps
   build-staging-trezor:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:18.19.1
     working_directory: ~/web3-onboard-monorepo/packages/trezor
     steps:
       - node-staging-build-steps
@@ -707,7 +711,7 @@ jobs:
       - node-staging-build-steps
   build-staging-metamask:
     docker:
-      - image: cimg/node:16.13.1
+      - image: cimg/node:18.19.1
     working_directory: ~/web3-onboard-monorepo/packages/metamask
     steps:
       - node-staging-build-steps
@@ -723,6 +727,12 @@ jobs:
     working_directory: ~/web3-onboard-monorepo/packages/capsule
     steps:
       - node-staging-build-steps
+  build-staging-particle:
+    docker:
+      - image: cimg/node:18.0.0
+    working_directory: ~/web3-onboard-monorepo/packages/particle-network
+    steps:
+      - node-build-steps
 
 workflows:
   version: 2
@@ -1002,4 +1012,10 @@ workflows:
       - build-capsule:
           <<: *deploy_production_filters
       - build-staging-capsule:
-          <<: *deploy_staging_filters
+          <<: *deploy_staging_filters
+  particle:
+    jobs:
+      - build-particle:
+          <<: *deploy_production_filters
+      - build-staging-particle:
+          <<: *deploy_staging_filters

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

@@ -19,7 +19,7 @@ jobs:
       - name: Setup Nodejs and yarn
         uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "18.19.1"
           cache: yarn
 
       - name: Install dependencies

README.md

@@ -125,6 +125,7 @@ For full documentation, check out the README.md for each package or the [docs pa
 - [Infinity Wallet](packages/infinity-wallet/README.md)
 - [Frame](packages/frame/README.md)
 - [Blocto](packages/blocto/README.md)
+- [Particle Network](packages/particle-network/README.md)
 
 **Hardware Wallets**
 

docs/package.json

@@ -57,8 +57,8 @@
     "@web3-onboard/blocto": "^2.0.0",
     "@web3-onboard/capsule": "^2.0.1",
     "@web3-onboard/cede-store": "^2.2.0",
-    "@web3-onboard/coinbase": "^2.2.5",
-    "@web3-onboard/core": "^2.21.2",
+    "@web3-onboard/coinbase": "^2.2.7",
+    "@web3-onboard/core": "^2.21.3",
     "@web3-onboard/dcent": "^2.2.7",
     "@web3-onboard/enkrypt": "^2.0.4",
     "@web3-onboard/fortmatic": "^2.0.19",
@@ -67,12 +67,12 @@
     "@web3-onboard/gas": "^2.1.8",
     "@web3-onboard/gnosis": "^2.1.10",
     "@web3-onboard/infinity-wallet": "^2.0.4",
-    "@web3-onboard/injected-wallets": "^2.10.9",
+    "@web3-onboard/injected-wallets": "^2.10.12",
     "@web3-onboard/keepkey": "^2.3.7",
     "@web3-onboard/keystone": "^2.3.7",
-    "@web3-onboard/ledger": "^2.5.1",
+    "@web3-onboard/ledger": "^2.6.0",
     "@web3-onboard/magic": "^2.1.7",
-    "@web3-onboard/metamask": "^2.0.2",
+    "@web3-onboard/metamask": "^2.0.3",
     "@web3-onboard/mew-wallet": "^2.0.4",
     "@web3-onboard/phantom": "^2.0.3",
     "@web3-onboard/portis": "^2.1.7",
@@ -84,10 +84,11 @@
     "@web3-onboard/trust": "^2.0.4",
     "@web3-onboard/uauth": "^2.1.1",
     "@web3-onboard/venly": "^2.0.0",
-    "@web3-onboard/walletconnect": "^2.5.2",
+    "@web3-onboard/walletconnect": "^2.5.4",
     "@web3-onboard/web3auth": "^2.2.3",
     "@web3-onboard/xdefi": "^2.0.4",
     "@web3-onboard/zeal": "^2.0.4",
+    "@web3-onboard/particle-network": "^2.0.0",
     "animejs": "^3.2.1",
     "bnc-sdk": "^4.6.6",
     "ethers": "^5.7.0",

docs/src/lib/services/onboard.js

@@ -59,6 +59,7 @@ const intiOnboard = async (theme) => {
   const { default: venlyModule } = await import('@web3-onboard/venly')
   const { default: bitgetModule } = await import('@web3-onboard/bitget')
   const { default: capsuleModule, Environment } = await import('@web3-onboard/capsule')
+  const { default: particleAuthModule } = await import('@web3-onboard/particle-network')
   const INFURA_ID = '8b60d52405694345a99bcb82e722e0af'
 
   const injected = injectedModule()
@@ -67,11 +68,13 @@ const intiOnboard = async (theme) => {
     clientID: 'xar_test_c9c3bc702eb13255c58dab0e74cfa859711c13cb'
   })
   const coinbase = coinbaseModule()
-  const metamask = metamaskModule({options: {
-    dappMetadata: {
-      name: 'Web3Onboard',
+  const metamask = metamaskModule({
+    options: {
+      dappMetadata: {
+        name: 'Web3Onboard'
+      }
     }
-  }})
+  })
   const dcent = dcentModule()
   const walletConnect = walletConnectModule({
     projectId: 'f6bd6e2911b56f5ac3bc8b2d0e2d7ad5',
@@ -133,6 +136,12 @@ const intiOnboard = async (theme) => {
     apiKey: '992bbd9146d5de8ad0419f141d9a7ca7'
   })
 
+  const particle = particleAuthModule({
+    projectId: 'b385ccf0-73c3-485a-9941-159b7855b806',
+    clientKey: 'cSTLqhvONB5j588Wz6E5WJLMPrHeUlGbymf1DFhO',
+    appId: 'b1f0239a-edb0-41f9-b0f5-ab780bb02a9e'
+  })
+
   return Onboard({
     connect: { autoConnectAllPreviousWallet: true },
     wallets: [
@@ -163,7 +172,10 @@ const intiOnboard = async (theme) => {
       frame,
       infinityWallet,
       blocto,
+      capsule,
+      particle
       // capsule
+
       // venly
     ],
     chains: [

docs/src/routes/docs/[...4]wallets/[...14]injected/+page.md

@@ -4,7 +4,7 @@ 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).
+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 [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) and recognizes any wallet that has implemented 6963 support.
 
 Note: Make sure to install the core module before installing other modules to w3o.
 
@@ -189,6 +189,19 @@ const onboard = Onboard({
 })
 ```
 
+### This module supports any injected wallet that has implemented support for [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963)
+
+This can be disabled by passing in `disable6963Support` as true within the injected module init object.
+
+```ts
+const injected = injectedModule({ disable6963Support: true })
+
+const onboard = Onboard({
+  wallets: [injected],
+  ...
+})
+```
+
 ## Display Unavailable Wallets
 
 You may want to display injected wallets that are not currently available to the user and you can use the `displayUnavailable` option to do that:
@@ -334,7 +347,7 @@ const injected = injectedModule({
 - TP - _Mobile_
 - 1inch - _Mobile_
 - Tokenary - _Mobile_
-- Rabby - _Desktop_
+- Rabby - _Desktop & Mobile_
 - MathWallet - _Desktop & Mobile_
 - Bitkeep - _Desktop & Mobile_
 - BitGet Wallet - _Desktop & Mobile_
@@ -357,6 +370,7 @@ const injected = injectedModule({
 - Coin98 Wallet - _Desktop & Mobile_
 - SubWallet - _Desktop & Mobile_
 - Kayros - _Desktop_
+- Lif3Wallet - _Mobile_
 
 ## Build Environments
 

docs/src/routes/docs/[...4]wallets/[...22]particlenetwork/+page.md

@@ -0,0 +1,94 @@
+---
+title: Particle Network
+---
+
+# {$frontmatter.title}
+
+Wallet module for connecting Particle Network to web3-onboard
+
+## Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/particle-network
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/particle-network
+```
+
+  </TabPanel>
+</Tabs>
+
+## Options
+
+See the [Particle Network Docs](https://docs.particle.network/developers/auth-service/sdks/web) for the extensive list of options.
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import particleModule from '@web3-onboard/particle-network'
+
+const particle = particleModule({
+  projectId: 'YOUR PROJECT ID',
+  clientKey: 'YOUR CLIENT KEY',
+  appId: 'YOUR APP ID'
+  // Can also add wallet object + preferredAuthType for further customization
+})
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    particle
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
+
+## Types
+
+```typescript
+/**
+ * Enumerates the supported authentication types.
+ */
+type AuthTypes = 'email' | 'phone' | 'google' | 'apple' | 'twitter' | 'facebook' | 'microsoft' | 'linkedin' | 'github' | 'twitch' | 'discord';
+
+/**
+ * Interface that describes the preferred authentication type.
+ * @property {AuthTypes} type - The preferred type of authentication.
+ * @property {boolean} setAsDisplay - Indicates whether the type should be displayed within the UI.
+ */
+interface PreferredAuthType {
+  type: AuthTypes;
+  setAsDisplay: boolean;
+}
+
+/**
+ * Options for initializing the Particle Auth module.
+ * @property {string} projectId - Particle Network project ID.
+ * @property {string} clientKey - Particle Network client key.
+ * @property {string} appId - Particle Network application ID.
+ * @property {string} [chainName] - (Optional) Specifies the name of the blockchain. Handled automatically if left blank.
+ * @property {number} [chainId] - (Optional) Specifies the blockchain's numeric ID. Handled automatically if left blank.
+ * @property {object} [wallet] - (Optional) Configuration for the wallet.
+ * @property {AuthTypes | PreferredAuthType} [preferredAuthType] - (Optional) Specifies the preferred type of authentication.
+ */
+interface ParticleAuthModuleOptions {
+  projectId: string;
+  clientKey: string;
+  appId: string;
+  chainName?: string;
+  chainId?: number;
+  wallet?: object;
+  preferredAuthType?: AuthTypes | PreferredAuthType;
+}
+```

docs/src/routes/docs/[...4]wallets/[...6]coinbase/+page.md

@@ -29,7 +29,12 @@ npm install @web3-onboard/coinbase
 
 ```typescript
 type CoinbaseWalletOptions = {
-  darkMode: boolean // default = false
+  /** @optional Use dark theme */
+  darkMode?: boolean
+  /** @optional whether to connect mobile web app via WalletLink, defaults to false */
+  enableMobileWalletLink?: boolean
+  /** @optional whether or not to reload dapp automatically after disconnect, defaults to true */
+  reloadOnDisconnect?: boolean
 }
 ```