deep-stack/wallet-connect-web-examples
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4453aff1f2
wallet-connect-web-examples/wallets/react-wallet-v2
History
Ben Kremer e4fdfc6337 chore(deps): updates canonical dapp/wallet to @walletconnect/*@2.2.0
2023-01-06 11:00:55 +01:00
..
public feat: adds Elrond support (#67) 2022-10-31 11:21:33 +01:00
src Revert "Refactor/fix readme typo (#99)" 2023-01-05 18:22:17 +01:00
.env.local.example Revert "Refactor/fix readme typo (#99)" 2023-01-05 18:22:17 +01:00
.eslintrc.json Set up dev tooling 2022-02-03 11:24:35 +02:00
.gitignore Beta 100 (#27) 2022-05-30 11:46:15 +02:00
.prettierrc.json Set up dev tooling 2022-02-03 11:24:35 +02:00
next-env.d.ts scope wallet examples under one folder 2022-02-03 11:14:39 +02:00
next.config.js feat: adds Elrond support (#67) 2022-10-31 11:21:33 +01:00
package.json chore(deps): updates canonical dapp/wallet to @walletconnect/*@2.2.0 2023-01-06 11:00:55 +01:00
README.md docs(readme): tweaks readmes to point out wallet sign v1+v2 support 2022-11-09 16:42:53 +01:00
tsconfig.json Add pairing logic 2022-02-07 15:24:15 +02:00
yarn.lock chore(deps): updates canonical dapp/wallet to @walletconnect/*@2.2.0 2023-01-06 11:00:55 +01:00

README.md

Wallet Example (React, Typescript, Ethers, NextJS, Cosmos)

This example aims to demonstrate basic and advanced use cases enabled by WalletConnect's Sign SDK.

The wallet implements Sign v1 and v2 side-by-side, to serve as a reference for wallet developers aiming to support both major versions for backwards compatibility. All files containing code for the legacy v1 implementation are prefixed with Legacy....

Please only use this for reference and development purposes, otherwise you are at risk of losing your funds.

Useful links

🔗 Live wallet app - https://react-wallet.walletconnect.com
🔗 Live dapp - https://react-app.walletconnect.com
📚 WalletConnect docs - https://docs.walletconnect.com/2.0

Getting started

Example is built atop of NextJS in order to abstract complexity of setting up bundlers, routing etc. So there are few steps you need to follow in order to set everything up

  1. Go to WalletConnect Cloud and obtain a project id

  2. Add your project details in WalletConnectUtil.ts file

  3. Install dependencies yarn install or npm install

  4. Setup your environment variables

cp .env.local.example .env.local

Your .env.local now contains the following environment variables:

  1. Run yarn dev or npm run dev to start local development

Navigating through example

  1. Initial setup and initializations happen in _app.ts file
  2. WalletConnect client, ethers and cosmos wallets are initialized in useInitialization.ts hook
  3. Subscription and handling of WalletConnect events happens in useWalletConnectEventsManager.ts hook, that opens related Modal views and passes them all necessary data
  4. Modal views are responsible for data display and handling approval or rejection actions
  5. Upon approval or rejection, modals pass the request data to RequestHandlerUtil.ts that performs all necessary work based on the request method and returns formated json rpc result data that can be then used for WalletConnect client responses

Preview of wallet and dapp examples in action

https://user-images.githubusercontent.com/3154053/156764521-3492c232-7a93-47ba-88bd-2cee3f8366d4.mp4