@web3-onboard/wagmi
v2.0.1
Published
Module to configure, connect and return web3-onboard wallets as wagmi wallets and wagmi-config to be used with wagmi-core methods
Downloads
937
Readme
@web3-onboard/wagmi
A module for connecting wallets using WAGMI which returns a WAGMI config object to be used with @wagmi/core functions.
Install
NPM
npm i @web3-onboard/wagmi
Yarn
yarn add @web3-onboard/wagmi
Usage
This example assumes you have already setup web3-onboard to connect wallets to your dapp. For more information see web3-onboard docs.
wagmiConnector
and Connectors
wagmiConnector
is a property returned as part of the wallet state object and can be used to interact with
the WAGMI API returned from this module or an external WAGMI instance. Please see examples below...
import Onboard from '@web3-onboard/core'
import injectedModule from '@web3-onboard/injected-wallets'
import wagmi from '@web3-onboard/wagmi'
import {
sendTransaction as wagmiSendTransaction,
switchChain,
disconnect,
getConnectors
} from '@web3-onboard/wagmi'
import { parseEther, isHex, fromHex } from 'viem'
const injected = injectedModule()
const onboard = Onboard({
// This javascript object is unordered meaning props do not require a certain order
wagmi,
wallets: [injected],
chains: [
{
id: '0x1',
token: 'ETH',
label: 'Ethereum',
rpcUrl: 'https://mainnet.infura.io/v3/17c1e1500e384acfb6a72c5d2e67742e'
}
]
// ... other Onboard options
})
const sendTransaction = async () => {
// current primary wallet - as multiple wallets can connect this value is the currently active
const [activeWallet] = onboard.state.get().wallets
const { wagmiConnector } = activeWallet
const wagmiConfig = onboard.state.get().wagmiConfig
const result = await wagmiSendTransaction(wagmiConfig, {
to: toAddress,
// desired connector to send txn from
connector: wagmiConnector,
value: parseEther('0.001')
})
console.log(result)
}
async function signMessage(chainId) {
// current primary wallet - as multiple wallets can connect this value is the currently active
const [activeWallet] = onboard.state.get().wallets
const wagmiConfig = onboard.state.get().wagmiConfig
await wagmiSignMessage(wagmiConfig, {
message: 'This is my message to you',
connector: activeWallet.wagmiConnector
})
}
async function disconnectWallet() {
const wagmiConfig = onboard.state.get().wagmiConfig
const [activeWallet] = onboard.state.get().wallets
const { wagmiConnector } = activeWallet
disconnect(wagmiConfig, { connector: wagmiConnector })
}