README.md

Coinbase Wallet SDK

Coinbase Wallet SDK (formerly WalletLink) lets developers connect their dapps to Coinbase Wallet on both mobile web (for iOS and Android) and desktop:

• Mobile: Users can connect to your mobile web dapp through a deeplink to the dapp browser in Coinbase Wallet Mobile App.

• Desktop: Users can connect to your desktop app with a QR code in the Coinbase Wallet Mobile App or with the Coinbase Wallet Chrome Extension.

Wallet SDK is open-source and uses minimal dependencies for maximum security and no code bloat. Simply drop a few lines of code into your dapp and Wallet SDK takes care of the rest.

Getting started

• This readme contains brief instructions to get up and running.
• Visit our public developer docs for more detail, including samples for integrating Coinbase Wallet using libraries like web3-react, web3modal, Web3-Onboard, and wagmi.

Installing and Upgrading

The installation package for Coinbase Wallet SDK (formerly WalletLink) is now named @coinbase/wallet-sdk.

Installing Wallet SDK

Install Coinbase Wallet SDK with yarn or npm.

Yarn

1. Check available versions of Wallet SDK.

yarn info @coinbase/wallet-sdk versions

2. Install a specific version or the latest version.

#yarn add @coinbase/[email protected]
yarn add @coinbase/wallet-sdk

3. Check your installed version.

yarn list @coinbase/wallet-sdk

Npm

1. Check available versions of Wallet SDK.

npm view @coinbase/wallet-sdk versions

2. Install a specific version or the latest version.

#npm install @coinbase/[email protected]
npm install @coinbase/wallet-sdk

3. Check your installed version.

npm list @coinbase/wallet-sdk

Upgrading Wallet SDK

Upgrade Coinbase Wallet SDK with yarn or npm.

Yarn

1. Compare your installed version of Coinbase Wallet SDK with the latest available version.

yarn outdated @coinbase/wallet-sdk

2. Update Coinbase Wallet SDK to the latest.

yarn upgrade @coinbase/wallet-sdk --latest

Npm

1. Compare your installed version of Coinbase Wallet SDK with the latest available version.

npm outdated @coinbase/wallet-sdk

2. If necessary, update package.json with the latest major version.

{
  "dependencies": {
    "@coinbase/wallet-sdk": "^3.0.0"
  }
}

3. Update Coinbase Wallet SDK to the latest available version.

npm update @coinbase/wallet-sdk

Libraries using Coinbase Wallet SDK

• blocknative/onboard
• wagmi
• web3-react
• web3modal

Copyright © 2018-2022 Coinbase, Inc. <https://www.coinbase.com/>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Attributions

• Eth-json-rpc-filters under the ISC license
• Safe-event-emitter under the ISC license
• Json-rpc-engine under the ISC license
• Eth-rpc-errors under the MIT license
• Eth-block-tracker under the MIT license