Skip to content

The beacon sdk allows developers of dApps and wallets on Tezos to implement the wallet interaction standard tzip-10.

License

Notifications You must be signed in to change notification settings

airgap-it/beacon-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8e91d90 · Sep 4, 2024
Nov 15, 2021
Aug 15, 2023
Apr 7, 2022
Feb 20, 2024
Oct 4, 2023
May 15, 2024
Sep 4, 2024
Apr 30, 2024
Nov 8, 2023
Nov 11, 2019
May 28, 2020
Apr 4, 2023
Oct 5, 2023
Feb 14, 2023
Dec 18, 2019
Dec 18, 2019
Nov 11, 2019
Mar 29, 2021
Feb 16, 2023
Oct 6, 2021
Sep 2, 2022
Sep 3, 2024
Aug 9, 2021
Oct 6, 2023
Sep 4, 2024
Aug 8, 2024
Mar 25, 2024
Jul 21, 2021
Nov 8, 2021
Aug 4, 2020
Jun 16, 2021
Oct 9, 2023
Oct 9, 2023
Oct 9, 2023
Oct 9, 2023
Feb 24, 2023

Repository files navigation

Beacon SDK

npm documentation GitHub Action Quality Gate Status code style: prettier

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.

Intro

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:

Documentation

The documentation can be found here, technical documentation can be found here.

Installation

npm i --save @airgap/beacon-sdk

Example DApp integration

import { DAppClient } from '@airgap/beacon-sdk'

const dAppClient = new DAppClient({ name: 'My Sample DApp' })

// Listen for all the active account changes
dAppClient.subscribeToEvent(BeaconEvent.ACTIVE_ACCOUNT_SET, async (account) => {
  // An active account has been set, update the dApp UI
  console.log(`${BeaconEvent.ACTIVE_ACCOUNT_SET} triggered: `, account)
})

try {
  console.log('Requesting permissions...')
  const permissions = await dAppClient.requestPermissions()
  console.log('Got permissions:', permissions.address)
} catch (error) {
  console.error('Got error:', error)
}

For a more complete example, take a look at the example-dapp.html file.

Example Wallet integration

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.

Adding a wallet to beacon-sdk

Please create a PR and add your wallet here.

For iOS wallets, the wallet needs to define a custom url scheme to support the same-device functionality.

Development

$ npm i
$ npm run build
$ npm run test

Once the SDK is built, you can open the dapp.html or wallet.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 navigate to the example folder and easily start one with python -m SimpleHTTPServer 8000 and then open the examples with http://localhost:8000/.

About

The beacon sdk allows developers of dApps and wallets on Tezos to implement the wallet interaction standard tzip-10.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages