@walletconnect/ethereum-provider NPM

@walletconnect/ethereum-provider

Ethereum Provider for WalletConnect Protocol.

Installation

npm i @walletconnect/ethereum-provider

Initialization

import { EthereumProvider } from "@walletconnect/ethereum-provider";

const provider = await EthereumProvider.init({
  projectId, // REQUIRED your projectId
  chains, // REQUIRED chain ids
  showQrModal, // REQUIRED set to "true" to use @walletconnect/modal,
  methods, // OPTIONAL ethereum methods
  events, // OPTIONAL ethereum events
  rpcMap, // OPTIONAL rpc urls for each chain
  metadata, // OPTIONAL metadata of your app
  storage, // OPTIONAL custom storage implementation
  storageOptions, // OPTIONAL storage config options
  qrModalOptions, // OPTIONAL - `undefined` by default
});

Display WalletConnectModal with QR code / Handle connection URI

// WalletConnectModal is disabled by default, enable it during init() to display a QR code modal
await provider.connect({
  chains, // OPTIONAL chain ids
  rpcMap, // OPTIONAL rpc urls
  pairingTopic, // OPTIONAL pairing topic
});
// or
await provider.enable();

// If you are not using WalletConnectModal,
// you can subscribe to the `display_uri` event and handle the URI yourself.
provider.on("display_uri", (uri: string) => {
  // ... custom logic
});

await provider.connect();
// or
await provider.enable();

Sending Requests

const result = await provider.request({ method: "eth_requestAccounts" });

// OR

provider.sendAsync({ method: "eth_requestAccounts" }, CallBackFunction);

Events

// chain changed
provider.on("chainChanged", handler);
// accounts changed
provider.on("accountsChanged", handler);
// session established
provider.on("connect", handler);
// session event - chainChanged/accountsChanged/custom events
provider.on("session_event", handler);
// connection uri
provider.on("display_uri", handler);
// session disconnect
provider.on("disconnect", handler);

Supported WalletConnectModal options (qrModalOptions)

Please reference up to date documentation for WalletConnectModal

wallet walletconnect

@walletconnect/jsonrpc-http-connection @walletconnect/jsonrpc-provider @walletconnect/jsonrpc-types @walletconnect/jsonrpc-utils @walletconnect/keyvaluestorage @walletconnect/modal @walletconnect/sign-client @walletconnect/types @walletconnect/universal-provider @walletconnect/utils events

zewide @banditbadgod/react @plgwagmi/connectors @cuonghx.gu-tech/gu-wallet-connector @slashauth/slashauth-react-beta @dodoex-io/widgets @infinitebrahmanuniverse/nolb-_wal @yozh-io/1inch-widget @omnivault/connector lit-js-sdk @everything-registry/sub-chunk-998 @subwallet_connect/ledger @subwallet_connect/ledger-polkadot @subwallet_connect/uauth @subwallet_connect/walletconnect web3modal-ethers-depity web3modal-ethers-deputy web3modal-web3-test chasm-cli @web3-double-react/walletconnect-connector wagmi-banksocial wagmi-bark wagmi-cb-beta-connectors wallet-ethers-next walletconnect-connect-v6 walletconnect-connector walletconnect-v2 walletconnect-v2-custom wammi web3-provider-test w3m-custom-qr web3react-a web3react-v8-ian web3modal-wagmi-custom web3modal-web3js wow-web3login sportsbet-apollo sportsbet-user-app testing-wagmi-connectors thirdweb vents-thirdweb-fix vic-payment-js voluptatumquae @disco3/walletconnect @dodoex/wallet-web3 @dodoex/extension-widgets @cocos-labs/web3modal-ethers5 @cryptogate/react-providers @crowdform/flex-connect-sdk @colligence/walletconnect-connector @colligence/walletconnectv2-connector @cxptek/web3client @darthgus/wagmi-connectors @boeschj/wallet-management @beland/connect @rsksmart/rlogin-walletconnect2-provider @rubiconstudio/auth ith-react-providers js-sdk-v3-test jxom-wagmi laudantiumsaepe connectors-deputy soulswap-wallet-management suku-connect-button tinnytest @artid/azwallet-kit @aprilsacil/wallet @ankr.com/provider @ankr.com/provider2 @ant-design/web3-ethereum @arianee/spkz-sdk @adnbsr/thirdweb @alexkeating/daohaus-connect-feature @alexkeating/lit-js-sdk @alexayan/web3modal-ethereum @alljoint-next/erc721aj @awwwoeey/wagmi @b-ee/web3-connect @bandit-network/sdk-react @biuauth/wallet-connect-v2-adapter @broxus/evm-connect @bytom-js/wagmi @centrifuge/centrifuge-react @chainlink/use-wallet @chainsafe/chainbridge-ui-core @chainsafe/sygma-ui-core @certhis/certhis-wallet @0xtfm/widget-ibc @0xsquid/widget @aarc-dev/wallet-auth @aarc-xyz/wallet-auth @injectivelabs/wallet-cosmostation @coinswap-libs/conn @debox-global/core @dcentralab/wallet-connect @dcentralab/web3-wallet-connector @dedo_ai/web3modal-wagmi @dedo_ai/web3modal-ethers @dedo_ai/web3modal-ethers5 @decent-org/wallet-provider

2.19.0-canary-sign-msgs-1

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

2.17.5-canary-7cb1381

6 months ago

2.18.0-rc-1

6 months ago

2.18.0-canary-ak-6

5 months ago

2.18.0-canary-tvf-1

5 months ago

2.17.5-canary-88adb04-2

6 months ago

6 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

2.17.5-canary-88adb04

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

2.17.1-canary-appkit.0

8 months ago

10 months ago

10 months ago

10 months ago

10 months ago

9 months ago

10 months ago

10 months ago

9 months ago

10 months ago

9 months ago

9 months ago

10 months ago

2.16.3-canary-d3b9bd78

10 months ago

2.15.1-canary-a3089b5

11 months ago

2.16.2-canary-tma-1

10 months ago

2.15.3-rc.0

10 months ago

2.15.2-canary-1165223df

10 months ago

2.15.2-canary-1165223df.1

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

10 months ago

10 months ago

10 months ago

11 months ago

10 months ago

11 months ago

2.15.2-canary-9bbce7c

10 months ago

10 months ago

10 months ago

11 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

2.14.0-canary-dc7556a22

12 months ago

2.14.0-canary-cff8cfe

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

2.13.3-canary-1041acb

1 year ago

2.13.3-canary-2faa1e4

12 months ago

2.13.3-canary-c1f48b78a

1 year ago

2.13.3-link-mode-0

1 year ago

2.13.3-canary-c180d26

1 year ago

2.13.3-canary-0583d68a9.1

1 year ago

2.13.3-canary-19083bdd

1 year ago

2.13.3-canary-0583d68a9

1 year ago

2.14.0

12 months ago

2.13.3-canary-a8df04214

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2.11.3-canary-0ff236b6

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2.11.2-canary-64d47a4

1 year ago

2.11.2-canary-039d1281

1 year ago

2.11.2-canary-d197bc2f4

1 year ago

2.11.2

1 year ago

2.11.1-canary-c93080663

1 year ago

2.11.2-canary-f2423662

1 year ago

2.11.2-canary-0dbb484

1 year ago

2.11.1-canary-a3dab047

1 year ago

2.11.1-canary-05fffe3

1 year ago

2.11.2-rc-ec7dcc

1 year ago

2.11.1-canary-c12eb47c

1 year ago

2.11.1-canary-a72001fd1

1 year ago

2.11.1-canary-0062c56

1 year ago

2.11.1-canary-1d8e1f841de

1 year ago

2.11.1

1 year ago

2.11.0-canary-fce34df1

1 year ago

2.11.0-canary-ws.0

1 year ago

2.11.0-canary-ws.1

1 year ago

2.11.0-canary-up-patch

1 year ago

2.11.0-canary-827451e9

1 year ago

2.11.0-canary-14ddb0a5

1 year ago

2.11.0-canary-e3096

1 year ago

2.11.0-canary-850106f

1 year ago

2.11.0-canary-3c05d1

1 year ago

2.11.0-canary-1d8d0db

1 year ago

2.11.0-canary-0ab57

1 year ago

2.11.0-canary-2c2fed

1 year ago

2.11.1-rc-7b41511

2 years ago

2.11.0-canary-f92166d

2 years ago

2.11.0-rc-338bee1

2 years ago

2.11.0

2 years ago

2.10.6-canary-3d4d866

2 years ago

2.10.6-canary-4b2d6169

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.9.2-canary-1ef842bf

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.10.2-canary.fd2778a

2 years ago

2.10.5-canary-98641be

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.10.0-canary-af1c2bee

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.10.4-canary-f2d9992b

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.10.4-canary-5bcf371

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.8.1-canary-9be2ce1a.1

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.8-canary-d09bb7e1

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.3-canary-b2de7950

2 years ago

2.4.5-6b0931e4

2 years ago

2.4.4-c454b368

2 years ago

2.4.4-canary-df6ed87b

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.0-canary-8c28464c

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2.0.0-b06cdf210e4bc53df9543c82fdeaec80dc6b00c1

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2.0.0-beta.102-6a30ee7.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago