WalletLink is an open protocol that lets users connect their mobile wallets to your DApp.
With WalletLink, users can use your application in any desktop browser without installing an extension, and the secure tunnel established between your app and the mobile wallet with end-to-end encryption utilizing client-generated keys keeps all user activity private.
For DApp developers to integrate with WalletLink, all you need to do is drop a few lines of code into your application, and WalletLink will take care of the rest. WalletLink is open-source and uses minimal dependencies for maximum security and no code bloat.
# With Yarnyarn add walletlink# With NPMnpm install walletlink
The following instructions are in TypeScript,
annotations, for example
: string or
Upgrading from WalletLink 1.0 to 2.0
For most users, simply update the NPM package, and you should be good to go.
If you were using
ethereum.on("accountsChanged"), please remove it and obtain
addresses via EIP-1102
callbacks instead. It's removed to improve compatibility with the latest web3.js.
Dark mode theme (
darkMode) is now available as an option to WalletLink
Initializing WalletLink and a WalletLink-powered Web3 object
// TypeScript// Initialize WalletLink// Initialize a Web3 Provider object// Initialize a Web3 object
Use EIP-1102 to obtain authorization and get Ethereum accounts
Invoking EIP-1102 will show a QR code dialog if the user's mobile wallet is not already connected to your app. The following code should run in response to a user-initiated action such as clicking a button to ensure the pop up is not blocked by the browser.
// Use eth_RequestAccountsethereum.send'eth_requestAccounts'.then// Alternatively, you can use ethereum.enable()ethereum.enable.then
That's it! Once the authorization is obtained from the user, the Web3 object
web3) and the Web3 Provider (
ethereum) are ready to be used as per usual.
Disconnecting / De-establishing a link
To disconnect, call the instance method
disconnect() on the WalletLink object,
or the instance method
close() on the WalletLink Web3 Provider object. This
will de-establish the link, and require user to reconnect by scanning QR code
walletLink.disconnect// is the same as the following:ethereum.close
Copyright © 2018-2020 WalletLink.org <https://www.walletlink.org/> Copyright © 2018-2020 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.