Connect Wallets with dApps on Tezos
Beacon is the implementation of the wallet interaction standard tzip-10 which describes the connnection of a dApp with a wallet.
The beacon-sdk simplifies and abstracts the communication between dApps and wallets over different transport layers.
Developers that plan to develop complex smart contract interactions can use Taquito with the BeaconWallet, which uses this SDK under the hood, but provides helpful methods to interact with contracts.
Besides this Typescript SDK, we also provide SDKs for native iOS and Android Wallets:
The documentation can be found here.
npm i --save @airgap/beacon-sdk
Beacon SDK v2 introduces some some breaking changes from a developer perspective, most of the changes are internal, specifically in the communication protocol between dApps and Extensions/Wallets. All major Wallets that support Beacon (tzip-10) have been updated to support both v1 and v2 DApps.
We highly encourage developers to upgrade to v2. Besides stability improvements, the most notable new features are:
- Support for multiple browser extensions (eg. Thanos and Beacon Extension)
- Support for mobile, browser and desktop Wallets
- Mobile support via Deeplinking
- Secure and encrypted communication between DApp and Browser Extension
const client = new DAppClient({ name: 'My Sample DApp' })
client
.requestPermissions() // Send a permission request and automatically show UI to the user to select his favorite wallet
.then((permissions) => {
// Account that has been shared by the wallet
console.log('got permissions', permissions)
})
.catch((error) => console.log(error))For a more complete example, take a look at the example-dapp.html file.
const client = new WalletClient({ name: 'My Wallet' })
await client.init() // Establish P2P connection
client
.connect(async (message) => {
// Example: Handle PermissionRequest. A wallet should handle all request types
if (message.type === BeaconMessageType.PermissionRequest) {
// Show a UI to the user where he can confirm sharing an account with the DApp
const response: PermissionResponseInput = {
type: BeaconMessageType.PermissionResponse,
network: message.network, // Use the same network that the user requested
scopes: [PermissionScope.OPERATION_REQUEST], // Ignore the scopes that have been requested and instead give only operation permissions
id: message.id,
publicKey: 'tezos public key'
}
// Send response back to DApp
await client.respond(response)
}
})
.catch((error) => console.error('connect error', error))For a more complete example, take a look at the example-wallet.html file.
$ npm i
$ npm run build
$ npm run test
Once the SDK is built, you can open the example-dapp.html file in your browser and try out the basic functionality. To support browser extensions as well, the file should be viewed over a webserver. You can easily start one with python -m SimpleHTTPServer 8000 and then open the file with http://localhost:8000/example-dapp.html.