Merge pull request #1386 from blocknative/docs_add_uauth

Add UAuth(unstoppable domains), Enkrypt, Mew-wallet & Mew deprecation notice

Author: gesquinca

docs/src/routes/docs/[...4]wallets/enkrypt.md

@@ -0,0 +1,42 @@
+# Enkrypt
+
+Wallet module for connecting Enkrypt wallet through web3-onboard
+
+### Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/enkrypt
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/enkrypt
+```
+
+  </TabPanel>
+</Tabs>
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import enrkypt from '@web3-onboard/enkrypt'
+
+const enrkyptModule = enrkypt()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    enrkyptModule
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```

docs/src/routes/docs/[...4]wallets/mew.md

@@ -1,5 +1,9 @@
 # Mew
 
+:::admonition type=warning
+_Wallet module for connecting Mew to web3-onboard is now deprecated. Please use [@web3-onboard/mew-wallet](./mew-wallet.md)_
+:::
+
 Wallet module for connecting Mew wallet to web3-onboard
 
 ## Install

docs/src/routes/docs/[...4]wallets/mewwallet.md

@@ -0,0 +1,42 @@
+# Mew Wallet
+
+Wallet module for connecting Mew wallet through web3-onboard
+
+### Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/mew-wallet
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/mew-wallet
+```
+
+  </TabPanel>
+</Tabs>
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import mewWallet from '@web3-onboard/mew-wallet'
+
+const mewWalletModule = mewWallet()
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    mewWalletModule
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```

docs/src/routes/docs/[...4]wallets/uauth.md

@@ -0,0 +1,94 @@
+# UAuth
+
+Wallet module for connecting Unstoppable Domains to web3-onboard
+
+### Install
+
+<Tabs values={['yarn', 'npm']}>
+<TabPanel value="yarn">
+
+```sh copy
+yarn add @web3-onboard/uauth
+```
+
+  </TabPanel>
+  <TabPanel value="npm">
+
+```sh copy
+npm install @web3-onboard/uauth
+```
+
+  </TabPanel>
+</Tabs>
+
+## Options
+
+Follow the [Login Client Congifuration Docs](https://docs.unstoppabledomains.com/login-with-unstoppable/login-integration-guides/login-client-configuration/) on the Unstoppable Domains website to get setup with your clientID and redirectUri.
+**Note:** The Redirection URI value(s) in the client configuration MUST exactly match the redirect_uri parameter value used in `UauthInitOptions`. More specifics can be found in the [Rules for Redirect URIs Docs](https://docs.unstoppabledomains.com/login-with-unstoppable/login-integration-guides/login-client-configuration/#rules-for-redirect-uris).
+
+```typescript
+type UauthInitOptions = {
+  clientID: string // required and will throw an error if not included: links dapp to Unstoppable Domains for customization
+  redirectUri: string // required and will throw an error if not included: used for pop-up and callback redirection
+  scope?: string // default = 'openid wallet'
+  shouldLoginWithRedirect?: boolean // if true, redirects to your callback page
+  bridge?: string // default = 'https://bridge.walletconnect.org'
+  qrcodeModalOptions?: {
+    mobileLinks: string[] // set the order and list of mobile linking wallets
+  }
+  connectFirstChainId?: boolean // if true, connects to the first network chain provided
+}
+```
+
+## Usage
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import uauthModule from '@web3-onboard/uauth'
+
+// initialize the module with options
+const uauth = uauthModule({
+  clientID: 'YOUR_CLIENT_ID',
+  redirectUri: 'YOUR_REDIRECT_URI',
+  scope?: 'YOUR_SCOPES',
+  shouldLoginWithRedirect?: false
+  bridge?: 'YOUR_CUSTOM_BRIDGE_SERVER',
+  qrcodeModalOptions?: {
+    mobileLinks: ['rainbow', 'metamask', 'argent', 'trust', 'imtoken', 'pillar']
+  },
+  connectFirstChainId?: true
+})
+
+// can also initialize with basic options...
+// const uauth = uauthModule({
+//  clientID: "YOUR_CLIENT_ID",
+//  redirectUri: "YOUR_REDIRECT_URI"
+// })
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    uauth
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
+
+### Accessing the UAuth configuration
+
+When Unstoppable Domains is connected the UAuth user instance is exposed.
+This can be used to get information related to the user scopes requested through the `UauthInitOptions`.
+
+```typescript
+const wallets$ = onboard.state.select('wallets').pipe(share())
+wallets$.subscribe((wallet) => {
+  const unstoppableUser = wallet.find((provider) => provider.label === 'Unstoppable')
+  if (unstoppableUser) {
+    // This will allow insight into the approved user details
+    console.log(unstoppableUser.instance.user)
+  }
+})
+```