Release 2.25.6 (docs)

.circleci/config.yml

@@ -438,7 +438,7 @@ jobs:
       - node-build-steps
   build-capsule:
     docker:
-      - image: cimg/node:16.14.2
+      - image: cimg/node:18.18.2
     working_directory: ~/web3-onboard-monorepo/packages/capsule
     steps:
       - node-build-steps
@@ -722,7 +722,7 @@ jobs:
       - node-staging-build-steps
   build-staging-capsule:
     docker:
-      - image: cimg/node:16.14.2
+      - image: cimg/node:18.18.2
     working_directory: ~/web3-onboard-monorepo/packages/capsule
     steps:
       - node-staging-build-steps

docs/package.json

@@ -55,7 +55,7 @@
     "@web3-onboard/arcana-auth": "^2.0.0",
     "@web3-onboard/bitget": "^2.0.0",
     "@web3-onboard/blocto": "^2.0.0",
-    "@web3-onboard/capsule": "^2.0.1",
+    "@web3-onboard/capsule": "^2.0.2",
     "@web3-onboard/cede-store": "^2.2.0",
     "@web3-onboard/coinbase": "^2.2.7",
     "@web3-onboard/core": "^2.21.6",
@@ -72,7 +72,7 @@
     "@web3-onboard/keystone": "^2.3.7",
     "@web3-onboard/ledger": "^2.6.0",
     "@web3-onboard/magic": "^2.1.7",
-    "@web3-onboard/metamask": "^2.0.5",
+    "@web3-onboard/metamask": "^2.0.6",
     "@web3-onboard/mew-wallet": "^2.0.4",
     "@web3-onboard/phantom": "^2.0.3",
     "@web3-onboard/portis": "^2.1.7",

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

@@ -183,6 +183,7 @@ We recommend you add the [Core Repo](../../modules/core.md#install) and consider
 
 - [Arcana Auth](../../wallets/arcana.md#install)
 - [Blocto](../../wallets/blocto.md#install)
+- [Capsule](../../wallets/capsule.md#install)
 - [Coinbase](../../wallets/coinbase.md#install)
 - [Fortmatic](../../wallets/fortmatic.md#install)
 - [Frame](../../wallets/frame.md#install)

docs/src/routes/docs/[...4]wallets/[...5]capsule/+page.md

@@ -1,47 +1,65 @@
 # Capsule
 
-## Wallet module for connecting Capsule to web3-onboard
+## Wallet module for connecting Capsule Embedded Wallets to web3-onboard
 
-[Capsule](https://usecapsule.com/) is a signing solution that you can use to create secure embedded MPC wallets with just an email or social login that are recoverable, portable, and permissioned across different crypto applications, so your users don't need to create different signers or contract accounts for every app they use.
+[Capsule](https://usecapsule.com/) is a signing solution that you can use to create secure embedded MPC wallets to onboard your users with just an email or social login. Capsule wallets are recoverable, portable, and permissioned across different crypto applications, so your users don't need to create different signers or contract accounts for every app they use
 
-Adding the Capsule Module to web3onboard gives your users the ability to log in with Capsule wallets created elsewhere. You can also [request a Capsule API Key](https://form.typeform.com/to/hLaJeYJW) to allow users to easily create embedded wallets within web3onboard without any extra integration steps.
+If you'd like to use Capsule's full functionality within the web3onboard package without any extra integration steps, you can also [request a Capsule API Key](https://usecapsule.com/api) and use it with this package.
 
 To learn more, check out the [Capsule Developer Docs](https://docs.usecapsule.com/)
 
 ### Install
 
-`yarn add @web3-onboard/capsule`
+<Tabs values={['yarn', 'npm', 'pnpm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/capsule
+```
+
+</TabPanel>
+<TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/capsule
+```
+
+</TabPanel>
+<TabPanel value="pnpm">
+
+```sh copy
+pnpm install @web3-onboard/capsule
+```
+
+</TabPanel>
+</Tabs>
 
 ## Options
+For configuration options, check out the [Integration Guide Docs](https://docs.usecapsule.com/integration-guide)
 
 ```typescript
 type CapsuleInitOptions = {
-  environment: Environment
+  environment: string
+  apiKey: string
+  /** @optional capsule object opts */
+  constructorOpts?: ConstructorOpts
   appName: string
-  apiKey?: string
+  /** @optional capsule modal props */
+  modalProps?: CapsuleModalV2Props
 }
 ```
-
-`environment` - The environment to which you want to connect, either `Environment.DEVELOPMENT` for testnets and development only or `Environment.PRODUCTION` for production use.
-`appName` - Your Application's name - displayed in the modal when your users are prompted to log in.
-`apiKey` - Your Capsule API Key. Required for new user creation, but not required if you are only allowing users to log in. To get an API key, fill out [this form](https://form.typeform.com/to/hLaJeYJW).
-
 ## Usage
-
 ```typescript
 import Onboard from '@web3-onboard/core'
+import Capsule, { Environment } from '@usecapsule/react-sdk';
 import capsuleModule from '@web3-onboard/capsule'
 
-// initialize the module with options
-const capsule = capsuleModule()
-
-const onboard = Onboard({
-  // ... other Onboard options
-  wallets: [
-    capsule
-    //... other wallets
-  ]
-})
+// initialize capsule
+const capsule = new Capsule(
+  Environment.BETA,  // for production, use ENVIRONMENT.PROD
+  "YOUR_API_KEY"
+  { opts }    // find these at docs.usecapsule.com
+);
 
 const connectedWallets = await onboard.connectWallet()
 console.log(connectedWallets)