Provider

An EIP-1193-compatible provider backed by a WalletConnect v2 session.

Application code should call Provider.init; tests that need an isolated or injected instance should call Provider.create.

Example

import { Provider } from "konekt";
import { ethereumMainnet } from "konekt/eip155";

const provider = await Provider.init({
  projectId,
  metadata,
  chains: [ethereumMainnet],
});

provider.on("display_uri", showPairingUri);
await provider.connect();

Constructors

Constructor

new Provider(opts, deps?): Provider

Constructs a provider synchronously.

Prefer Provider.init in applications and Provider.create in tests because those methods perform asynchronous seed loading and session restoration.

Parameters

opts

CreateProviderOptions

deps?

ProviderDeps = {}

Returns

Provider

Properties

isWalletConnect

readonly isWalletConnect: true

Allows provider consumers to identify this as a WalletConnect-backed provider.

projectId

readonly projectId: string

The WalletConnect Cloud project ID this provider was configured with.

Accessors

accountsByChain

Get Signature

get accountsByChain(): Record<string, string[]>

Approved addresses grouped by CAIP-2 chain ID across all namespaces in the current session.

Example

{ "eip155:1": ["0x…"], "cosmos:cosmoshub-4": ["cosmos1…"] }

Returns

Record<string, string[]>

chains

Get Signature

get chains(): readonly Chain[]

The configured chains this provider proposes, flattened into one list.

This is configuration, not proof that the wallet approved every chain. Read session to inspect the approved namespaces.

Returns

readonly Chain[]

connected

Get Signature

get connected(): boolean

Whether the provider currently has an approved session.

Returns

boolean

session

Get Signature

get session(): Session | undefined

The approved session, or undefined before connection and after disconnection.

Returns

Session | undefined

uri

Get Signature

get uri(): string | undefined

The temporary pairing URI for the current proposal, when one exists.

Returns

string | undefined

Methods

connect()

connect(__namedParameters?): Promise<Session>

Proposes a WalletConnect session and waits for the wallet to approve or reject it.

Listen for display_uri before calling this method. Pass an AbortSignal so closing the pairing UI can cancel the attempt. If a feature rejects the settled session, this method disconnects it before rejecting.

Parameters

__namedParameters?

signal?

AbortSignal

Returns

Promise<Session>

The approved WalletConnect session.

disconnect()

disconnect(): Promise<void>

Ends the current session, clears adapter and feature state, and emits disconnect.

Returns

Promise<void>

enable()

enable(): Promise<string[]>

Legacy EIP-1193 shortcut that connects if needed and returns the approved EVM accounts.

New code can call connect and then read the EVM adapter’s accounts property.

Returns

Promise<string[]>

off()

off<K>(e, fn): void

Removes a listener previously passed to on or once.

Type Parameters

K

K extends keyof ProviderEvents

Parameters

e

K

fn

(p) => void

Returns

void

on()

on<K>(e, fn): void

Adds an event listener that runs every time the event is emitted.

Type Parameters

K

K extends keyof ProviderEvents

Parameters

e

K

fn

(p) => void

Returns

void

once()

once<K>(e, fn): void

Adds an event listener that removes itself after its first call.

Type Parameters

K

K extends keyof ProviderEvents

Parameters

e

K

fn

(p) => void

Returns

void

removeListener()

removeListener<K>(e, fn): void

Alias for off, provided for EIP-1193 and Node-style event compatibility.

Type Parameters

K

K extends keyof ProviderEvents

Parameters

e

K

fn

(p) => void

Returns

void

request()

request(__namedParameters, chainId?): Promise<{ } | null>

Sends an EIP-1193 request through the adapter that supports its method.

The optional chainId is a configured CAIP-2 ID such as "eip155:8453". It targets this call only and does not change the active chain. Wallet methods require a connected session; EVM JSON-RPC reads require a read transport on the selected chain.

Parameters

__namedParameters

RequestArguments

chainId?

string

Returns

Promise<{ } | null>

Throws

ProviderRpcError with code 4100 when a wallet method has no session, 4200 when the method or read transport is unsupported, or -32602 for malformed parameters.

create()

static create<C>(opts, deps?): Promise<Provider & ChainExtensions<C>>

Creates an independent provider, primarily for tests.

Pass deps to replace the relay, session, seed, or storage. Supplying deps.session keeps the provider offline and does not open a real relay socket.

Type Parameters

C

C extends readonly ChainInput[]

Parameters

opts

CreateProviderOptions<C>

deps?

ProviderDeps = {}

Returns

Promise<Provider & ChainExtensions<C>>

A new provider, extended with properties supplied by the configured adapters.

init()

static init<C>(opts): Promise<Provider & ChainExtensions<C>>

Creates or returns the application-wide provider.

The first call fixes the provider options; later calls return the same promise. Konekt uses the default relay and persistent browser storage unless the options override them. Register display_uri and request_sent listeners before starting work that emits those events.

Type Parameters

C

C extends readonly ChainInput[]

Parameters

opts

CreateProviderOptions<C>

Returns

Promise<Provider & ChainExtensions<C>>

The shared provider, extended with properties supplied by the configured adapters.