Package Exports
- @web3-onboard/metamask
- @web3-onboard/metamask/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@web3-onboard/metamask) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@web3-onboard/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
Install
npm i @web3-onboard/metamask
If using this package with the @web3-onboard/injected-wallets module
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.
Options
// For a complete list of options check https://docs.metamask.io/wallet/how-to/connect/set-up-sdk/
interface MetaMaskSDKOptions {
dappMetadata: {
url?: string;
name?: string;
base64Icon?: string;
},
/**
* If MetaMask browser extension is detected, directly use it without prompting the user.
*/
extensionOnly?: boolean;
}Usage
import Onboard from '@web3-onboard/core'
import metamaskSDK from '@web3-onboard/metamask'
// initialize the module with options
const metamaskSDKWallet = metamaskSDK({options: {
extensionOnly: false,
dappMetadata: {
name: 'Demo Web3Onboard'
}
}})
const onboard = Onboard({
// ... other Onboard options
wallets: [
metamaskSDKWallet,
//... other wallets
// Make sure to pass in before or above the injected-wallets module
injectedWalletModule
]
})
const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)