Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 2.24.16 (docs) #1993

Merged
merged 14 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ package-lock.json
.rpt2_cache
.vscode
yarn-error.log
.env
.env
Binary file added assets/metaMaskSDK-connect.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
"@docsearch/js": "^3.3.3",
"@iconify-json/ri": "^1.0.0",
"@sveltejs/adapter-static": "^2.0.2",
"@sveltejs/kit": "^1.5.0",
"@svelteness/kit-docs": "^1.1.3",
"@sveltejs/kit": "^1.27.2",
"@svelteness/kit-docs": "^1.1.5",
"@tailwindcss/typography": "^0.5.9",
"@types/animejs": "^3.1.7",
"@types/react": "^18.0.37",
Expand All @@ -45,14 +45,14 @@
"tslib": "^2.4.1",
"typescript": "^5.0.4",
"unplugin-icons": "^0.14.0",
"vite": "^4.3.9"
"vite": "^4.5.0"
},
"type": "module",
"dependencies": {
"@safe-global/safe-apps-provider": "^0.18.0",
"@safe-global/safe-apps-sdk": "^8.1.0",
"@web3-onboard/arcana-auth": "^2.0.0",
"@web3-onboard/bitget": "^2.0.0-alpha.1",
"@web3-onboard/bitget": "^2.0.0",
"@web3-onboard/blocto": "^2.0.0",
"@web3-onboard/cede-store": "^2.1.0",
"@web3-onboard/coinbase": "^2.2.5",
Expand All @@ -65,12 +65,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.6",
"@web3-onboard/injected-wallets": "^2.10.9",
"@web3-onboard/keepkey": "^2.3.7",
"@web3-onboard/keystone": "^2.3.7",
"@web3-onboard/ledger": "^2.5.1",
"@web3-onboard/magic": "^2.1.7",
"@web3-onboard/metamask": "^2.0.0-alpha.1",
"@web3-onboard/metamask": "^2.0.1",
"@web3-onboard/mew-wallet": "^2.0.4",
"@web3-onboard/phantom": "^2.0.3",
"@web3-onboard/portis": "^2.1.7",
Expand All @@ -82,7 +82,7 @@
"@web3-onboard/trust": "^2.0.4",
"@web3-onboard/uauth": "^2.1.1",
"@web3-onboard/venly": "^2.0.0",
"@web3-onboard/walletconnect": "^2.5.0-alpha.1",
"@web3-onboard/walletconnect": "^2.5.0",
"@web3-onboard/web3auth": "^2.2.3",
"@web3-onboard/xdefi": "^2.0.4",
"@web3-onboard/zeal": "^2.0.4",
Expand Down
Binary file added docs/src/lib/assets/metaMaskSDK-connect.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ We recommend you add the [Core Repo](../../modules/core.md#install) and consider
**SDK Wallets**

- [Arcana Auth](../../wallets/arcana.md#install)
- [Blocto](../../docs/wallets/blocto.md#install)
- [Blocto](../../wallets/blocto.md#install)
- [Coinbase](../../wallets/coinbase.md#install)
- [Fortmatic](../../wallets/fortmatic.md#install)
- [Frame](../../wallets/frame.md#install)
Expand Down
4 changes: 2 additions & 2 deletions docs/src/routes/docs/[...3]modules/[...4]solid/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ if (connectedWallet) {

### `init`

The `init` function initializes `web3-onboard` and makes it available to the `useOnboard()` composable. For references check out the [initialization docs for `@web3-onboard/core`](../core/README.md#initialization)
The `init` function initializes `web3-onboard` and makes it available to the `useOnboard()` composable. For references check out the [initialization docs for `@web3-onboard/core`](/docs/modules/core#initialization)

#### Example usage

Expand Down Expand Up @@ -126,7 +126,7 @@ const {

### `connectWallet`

Function to open the onboard modal and connect to a wallet provider. For reference check out the [connecting a wallet for `@web3-onboard/core`](../core/README.md#connecting-a-wallet)
Function to open the onboard modal and connect to a wallet provider. For reference check out the [connecting a wallet for `@web3-onboard/core`](/docs/modules/core#connecting-a-wallet)

#### Example usage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ const injected = injectedModule({
- MathWallet - _Desktop & Mobile_
- Gamestop - _Desktop_
- Bitkeep - _Desktop & Mobile_
- BitGet Wallet - _Desktop & Mobile_
- Sequence - _Desktop & Mobile_
- Core - _Desktop_
- Bitski - _Desktop & Mobile_
Expand Down
26 changes: 19 additions & 7 deletions docs/src/routes/docs/[...4]wallets/[...18]metamask/+page.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,23 @@
title: MetaMask
---

<script>
import metaMaskSDKConnect from '$lib/assets/metaMaskSDK-connect.gif'
</script>

# {$frontmatter.title}

## 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://github.com/MetaMask/metamask-sdk)

<img src="{metaMaskSDKConnect}" alt="MetaMask SDK connect flow gif"/>

:::admonition type=tip
When utilizing this package alongside the `@web3-onboard/injected-wallets` module, ensure to list this package prior to the initialized injected-wallets module within the wallets list of the Web3-Onboard init.

This order prioritizes the SDK when a MetaMask browser wallet is detected, allowing the SDK to take precedence.
:::

## Install
Expand All @@ -17,14 +27,14 @@ See [MetaMask SDK Developer Docs](https://github.com/MetaMask/metamask-sdk)
<TabPanel value="yarn">

```sh copy
yarn add @web3-onboard/metamask
yarn add @web3-onboard/core @web3-onboard/metamask
```

</TabPanel>
<TabPanel value="npm">

```sh copy
npm install @web3-onboard/metamask
npm install @web3-onboard/core @web3-onboard/metamask
```

</TabPanel>
Expand All @@ -36,14 +46,14 @@ npm install @web3-onboard/metamask
// For a complete list of options check https://github.com/MetaMask/metamask-sdk
interface MetaMaskSDKOptions {
dappMetadata: {
url?: string;
name?: string;
base64Icon?: string;
},
url?: string
name?: string
base64Icon?: string
}
/**
* If MetaMask browser extension is detected, directly use it without prompting the user.
*/
extensionOnly?: boolean;
extensionOnly?: boolean
}
```

Expand All @@ -66,6 +76,8 @@ const onboard = Onboard({
wallets: [
metamaskSDKWallet
//... other wallets
// Make sure to pass in before or above the injected-wallets module
injectedWalletModule
]
})

Expand Down
Loading
Loading