jackjdleslie/walletconnect-docs

WalletConnect Documentation

WalletConnect v1.0.0-beta

Introduction

WalletConnect is an open protocol to communicate securely between Wallets and Dapps (Web3 Apps). The protocol establishes a remote connection between two apps and/or devices using a Bridge server to relay payloads. These payloads are symmetrically encrypted through a shared key between the two peers. The connection is initiated by one peer displaying a QR Code or deep link with a standard WalletConnect URI and is established when the counter-party approves this connection request. It also includes an optional Push server to allow Native applications to notify the user of incoming payloads for establishes connections.

Getting Started

Currently the WalletConnect protocol has references implementations written in Typescript for the Client SDK (browser/react-native), the Bridge Server and the Push server.

To quickly setup for your Dapp or Wallet, go to Quick Start for code examples.

To read in more detail about the WalletConnect protocol, go to Technical Specification

Additionally you can also consult the API references for Client SDK, Bridge Server and Push Server

Useful Links

Test Wallet: test.walletconnect.org (Source code)

Example Dapp: example.walletconnect.org (Source code)

Community

Share your experience, contribute or ask questions with the WalletConnect Community

• Github: https://github.walletconnect.org
• Forum: https://discuss.walletconnect.org
• Discord: https://discord.walletconnect.org
• Telegram: https://telegram.walletconnect.org
• Twitter: https://twitter.walletconnect.org