History

renovate[bot] 280c42a0a8 fix(deps): update dependency @multiversx/sdk-core to v12.15.0 (#329 ) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>		2023-12-01 10:30:51 +01:00
..
public	feat: UI update (#295 )	2023-09-26 15:01:41 +03:00
src	feat: shows session expiry datetime instead of just date (#313 )	2023-10-18 15:39:21 +03:00
.env.local.example	feat: adds Kadena support (#70 )	2023-07-14 12:29:17 +02: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	fix(deps): update dependency @multiversx/sdk-core to v12.15.0 (#329 )	2023-12-01 10:30:51 +01:00
README.md	feat(e2e): adds more tags (#260 )	2023-08-02 10:18:51 +02:00
tsconfig.json	refactor(dapp-v2): splits requested methods between required/optional (#196 )	2023-06-28 09:51:13 +02:00
yarn.lock	fix(deps): update dependency @multiversx/sdk-core to v12.15.0 (#329 )	2023-12-01 10:30:51 +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

Go to WalletConnect Cloud and obtain a project id
Add your project details in WalletConnectUtil.ts file
Install dependencies yarn install or npm install
Setup your environment variables

cp .env.local.example .env.local

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

NEXT_PUBLIC_PROJECT_ID (placeholder) - You can generate your own ProjectId at https://cloud.walletconnect.com
NEXT_PUBLIC_RELAY_URL (already set)

Run yarn dev or npm run dev to start local development

Navigating through example

Initial setup and initializations happen in _app.ts file
WalletConnect client, ethers and cosmos wallets are initialized in useInitialization.ts hook
Subscription and handling of WalletConnect events happens in useWalletConnectEventsManager.ts hook, that opens related Modal views and passes them all necessary data
Modal views are responsible for data display and handling approval or rejection actions
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

DOM Tags

This section is a key of the DOM elements used for internal E2E testing Accessible with data-testid

Key	Description
`accounts`	Accounts page
`sessions`	Sessions page
`wc-connect`	WC Connect page
`pairings`	Pairings page
`settings`	Settings Page

WC Connect Page

url: /walletconnect

Key	Description
`uri-input`	Uri textbox
`uri-connect-button`	Uri connect button
`qrcode-button`	Use qrcode button

Sessions Page

url: /session

Key	Description
`session-card`	Session cards can be accessed by topic
`session-icon`	Icon used on session card
`session-text`	Text listed on session card
`session-link`	Link listed on session card

Session Details Page

url: /session?topic=

Key	Description
`session-card-${chain}`	Session chain info card
`session-delete-button`	Session delete button
`session-ping-button`	Session ping button
`session-emit-button`	Session emit button
`session-update-button`	Session update button

Pairing Page

url: /pairings

Key	Description
`pairing-${topic}`	Pairing cards can be accessed by topic
`pairing-text-${topic}`	Pairing card text in label
`pairing-url-${topic}`	Pairing card link in label
`pairing-delete-${topic}`	Delete pairing by topic

Accounts Page

url: /

Key	Description
`account-picker`	Account drop down selector
`chain-card-${chain id}`	Chain card by chain id
`chain-switch-button-${chain id}`	Chain switch button
`chain-switch-button-${chain id}`	Chain copy button

Settings Page

url: /settings

Key	Description
`settings-toggle-testnets`	Toggle testnet support on/off
`settings-region-select`	Select relayer region

Session Proposal View

Key	Description
`session-approve-button`	Session approve button
`session-reject-button`	Session reject button
`session-info-card-text`	Session text info in header
`session-info-card-url`	Session info url in header
`session-info-card-verify`	Session info verify api in header
`session-proposal-card-req-{chain}`	Session card for each required chain
`session-proposal-card-opt-{chain}`	Session card for each optional chain
`account-select-card-${req/opt}-${index}`	Account selection checkbox by account index
`account-select-text-${req/opt}-${index}`	Account selection text by account index

Sign Request View

Key	Description
`request-details-chain`	List of chains in the request
`request-details-relay-protocol`	Protocol used for request
`request-methods`	Methods requested
`request-button-reject`	Reject button
`request-button-approve`	Approve button