Introduction

The Web3Wallet SDK allows you to easily connect your Web3 wallet with dapps. It provides a simple and intuitive interface for dapps to request actions such as signing transactions and interacting with smart contracts on the blockchain. The SDK is designed to work with any blockchain, making it easy to support multiple chains without the need for separate integration code.

Features

Some of the key features of the Web3Wallet SDK include:

• Sign API: Allows dapps to request that the user sign a transaction or message.
• Auth API: Allows dapps to verify wallet address ownership through a single signature request, realizing login in one action.
• Chain agnostic: The Web3Wallet SDK is designed to work with any blockchain, so you can easily support multiple chains without having to write separate integration code.

Getting Started

To get started with the Web3Wallet SDK, choose the programming language you'll be using to build your project. The SDK is available in JavaScript, Swift, Kotlin, Flutter, and C# so you can choose the language that best fits your development needs.

Installation

Web

Install the Web3Wallet SDK using npm or yarn.

npm

npm install @walletconnect/web3wallet

Yarn

yarn add @walletconnect/web3wallet

Bun

bun add @walletconnect/web3wallet

pnpm

pnpm add @walletconnect/web3wallet

iOS

WalletConnect SDK is available via Swift Package Manager or Cocoapods.

SwiftPackageManager

You can add a WalletConnect SDK to your project with Swift Package Manager. In order to do that:

1. Open XCode
2. Go to File -> Add Packages
3. Paste the repo GitHub URL: https://github.com/WalletConnect/WalletConnectSwiftV2
4. Tap Add Package
5. Select WalletConnect check mark

Cocoapods

1. Update Cocoapods spec repos. Type in terminal pod repo update
2. Initialize Podfile if needed with pod init
3. Add pod to your Podfile:

pod 'WalletConnectSwiftV2'

4. Install pods with pod install

If you encounter any problems during package installation, you can specify the exact path to the repository

pod 'WalletConnectSwiftV2', :git => 'https://github.com/WalletConnect/WalletConnectSwiftV2.git', :tag => '1.0.5'

Android

Add the jitpack.io Maven repository to your root/build.gradle.kts file. For example:

allprojects {
 repositories {
    mavenCentral()
    maven { url "https://jitpack.io" }
 }
}

In app/build.gradle.kts add the web3wallet package and its dependencies:

implementation("com.walletconnect:android-core:release_version")
implementation("com.walletconnect:web3wallet:release_version")

Flutter

flutter pub add walletconnect_flutter_v2

info

Depending on your platform, you will have to add different permissions to get the package to work.

MacOS

Add the following to your DebugProfile.entitlements and Release.entitlements files so that it can connect to the WebSocket server.

<key>com.apple.security.network.client</key>
<true/>

React Native

Install the Web3Wallet SDK package.

npm

npm install @walletconnect/web3wallet @walletconnect/react-native-compat

Yarn

yarn add @walletconnect/web3wallet @walletconnect/react-native-compat

Bun

bun add @walletconnect/web3wallet @walletconnect/react-native-compat

pnpm

pnpm add @walletconnect/web3wallet @walletconnect/react-native-compat

Additionally add these extra packages to help with async storage, polyfills and the instance of ethers.

npm

npm install @react-native-async-storage/async-storage @react-native-community/netinfo react-native-get-random-values fast-text-encoding @ethersproject/shims ethers@5.7.2 @json-rpc-tools/utils

Yarn

yarn add @react-native-async-storage/async-storage @react-native-community/netinfo react-native-get-random-values fast-text-encoding @ethersproject/shims ethers@5.7.2 @json-rpc-tools/utils

Bun

bun add @react-native-async-storage/async-storage @react-native-community/netinfo react-native-get-random-values fast-text-encoding @ethersproject/shims ethers@5.7.2 @json-rpc-tools/utils

pnpm

pnpm add @react-native-async-storage/async-storage @react-native-community/netinfo react-native-get-random-values fast-text-encoding @ethersproject/shims ethers@5.7.2 @json-rpc-tools/utils

For those using Typescript, we recommend adding these dev dependencies:

npm

npm install --save-dev @walletconnect/jsonrpc-types

Yarn

yarn add --dev @walletconnect/jsonrpc-types

Bun

bun add --save-dev @walletconnect/jsonrpc-types

pnpm

pnpm add --save-dev @walletconnect/jsonrpc-types

C#

Install the WalletConnect client package via Nuget.

dotnet add package WalletConnect.Web3Wallet

Next Steps

Now that you've installed Web3Wallet SDK, you're ready to start integrating it. The next section will walk you through the process of setting up your project to use the SDK.