Pairing
Pairing =
object
Connection state and actions consumed by WalletModal.
Use useProviderPairing() for a Konekt provider or useWagmiPairing() for wagmi instead of
building this object by hand.
Properties
Section titled “Properties”chains?
Section titled “chains?”
optionalchains?: readonlystring[]
CAIP-2 chain IDs known by the binding. The modal’s chains prop overrides them.
connected
Section titled “connected”connected:
boolean
Whether a wallet is currently connected.
connectLocal
Section titled “connectLocal”connectLocal: (
wallet) =>void
Connects one of the local wallets.
Parameters
Section titled “Parameters”wallet
Section titled “wallet”Returns
Section titled “Returns”void
error?
Section titled “error?”
optionalerror?:string
Human-readable pairing error to display in the modal.
local: readonly
LocalWallet[]
Wallets already available through registered browser connectors.
projectId?
Section titled “projectId?”
optionalprojectId?:string
WalletConnect Cloud project ID the modal uses for Wallet Explorer listings. The pairing hooks read it from the Konekt provider or connector, so the modal never needs it separately.
reset: () =>
void
Clears connection errors before a new modal flow.
Returns
Section titled “Returns”void
start: (
onUri) => () =>void
Starts WalletConnect pairing and reports its URI. The returned teardown cancels or detaches it.
Parameters
Section titled “Parameters”(uri) => void
Returns
Section titled “Returns”() => void