pinkdiamond1 / wallet-connect-sdk

A Wallet Connect SDK for ecosystem tools

WalletConnect SDK

A COZ WalletConnect 2.0 SDK for ecosystem tools. WcSdk is an auxiliary library built to help the usage of walletconnect with NEO 3 Wallets.

WalletConnect integration is a secure solution for signing transactions sent to a blockchain, such as are needed when creating Decentralized Applications that require the user's account authentication. This SDK comes in handy to help on such integration.

• Why do I need WalletConnect in my dApp?
• Usage example video
• How does it work?
• Installation and Setup Guide
• Using with React.js
• Using without React.js
• How to test my dApp?

Why do I need WalletConnect in my dApp?

Almost every dApp needs a user's authentication to send a signed transaction to the blockchain. From minting tokens to making a simple transfer, users must always sign their transactions whenever the client-side application needs to call a SmartContract method that requires the user's Account.

Signing a transaction means that, without a solution like WalletConnect's integration, the user would need to trust his privateKey to the dApp. For obvious reasons, outside of testing environments, this is a huge security issue, as the dApp could simply use it maliciously stealing funds or signing something not approved by the user.

From a security perspective, providing your key to an application is a HUGE risk. WalletConnect mitigates this risk by delegating all transaction signing operations to the user's wallet. Applications instead, given the ability to communicate directly with the wallet to request a user's signature.

WalletConnect is an established solution to tackle this issue, and it's already used by many dApps and users.

Usage example video

This example is showing Crypsydra dApp connecting with Aero Wallet

How does it work?

• The dApp shows a QRCode, so the user can use their wallet to establish a connection
  • It's an encrypted websocket connection between dApp and wallet, passing by a relay server
• Now, every time the dApp needs to call a SmartContract, instead of doing it by itself, it will ask the wallet to do so
  • It will send a JSON-RPC message with all the information it needs to send to the SmartContract
  • The wallet will ask for the user to approve this message
  • It will sign the transaction, make the call and respond back to the dApp with the response from the blockchain

Installation and Setup Guide

This repository contains multiple packages and from here on you need to choose your path. If you are planning to use it on a React.js application it's highly recommended using our WC React SDK that handles all state changes for you, but if you plan to use with a different technology we have all the same features on the WC Core SDK.

How to test my dApp?

This SDK uses WalletConnect 2.0 protocol and was designed to work on the NEO 3 blockchain. You will need a Wallet application that fits these requirements, we recommend Aero Web Wallet for testing or Neon Wallet for production.