/beacon-sdk

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

Primary LanguageTypeScript

Beacon SDK

npm documentation build codecov 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.

Documentation

The documentation can be found here.

Example

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

client
  .requestPermissions()
  .then((permissions) => {
    console.log('got permissions', permissions)
  })
  .catch((error) => console.log(error))

Requirements

npm >= 6
NodeJS >= 10

Everything else gets installed automatically using npm install.

Clone and Run

$ git clone https://github.com/airgap-it/beacon-sdk.git
$ cd beacon-sdk
$ npm install
$ npm test