diff --git a/lerna.json b/lerna.json index 62cda1c29..da8f99636 100644 --- a/lerna.json +++ b/lerna.json @@ -1,4 +1,6 @@ { - "packages": ["packages/*"], - "version": "3.1.0" + "packages": [ + "packages/*" + ], + "version": "3.1.1" } diff --git a/packages/beacon-blockchain-substrate/README.md b/packages/beacon-blockchain-substrate/README.md index e750f875f..05ae4c987 100644 --- a/packages/beacon-blockchain-substrate/README.md +++ b/packages/beacon-blockchain-substrate/README.md @@ -1,11 +1,23 @@ # `@airgap/beacon-blockchain-substrate` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) + +## Introduction + +This package adds support for `substrate` based blockchains. It can be used in combination with the `@airgap/beacon-dapp` or `@airgap/beacon-wallet` packages. ## Usage ``` -const beaconProtocolSubstrate = require('@airgap/beacon-blockchain-substrate'); +import { DAppClient } from '@airga/beacon-dapp' +import { SubstrateBlockchain } from '@airga/beacon-blockchain-substrate' -// TODO: DEMONSTRATE API +const client = new DAppClient({ + name: 'Example DApp', +}) + +const substrateBlockchain = new SubstrateBlockchain() +client.addBlockchain(substrateBlockchain) ``` + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-blockchain-substrate/package.json b/packages/beacon-blockchain-substrate/package.json index 462ec3041..13bae442a 100644 --- a/packages/beacon-blockchain-substrate/package.json +++ b/packages/beacon-blockchain-substrate/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-blockchain-substrate", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,7 +34,7 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-ui": "^3.1.0" + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-ui": "^3.1.1" } } diff --git a/packages/beacon-blockchain-tezos-sapling/README.md b/packages/beacon-blockchain-tezos-sapling/README.md index dab4fc9e6..626c5ef60 100644 --- a/packages/beacon-blockchain-tezos-sapling/README.md +++ b/packages/beacon-blockchain-tezos-sapling/README.md @@ -1,11 +1,23 @@ # `@airgap/beacon-blockchain-tezos-sapling` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) + +## Introduction + +This package adds support for `tezos-sapling`, the sapling integration on the Tezos blockchain. It can be used in combination with the `@airgap/beacon-dapp` or `@airgap/beacon-wallet` packages. ## Usage ``` -const beaconProtocolTezosSapling = require('@airgap/beacon-blockchain-tezos-sapling'); +import { DAppClient } from '@airga/beacon-dapp' +import { TezosSaplingBlockchain } from '@airga/beacon-blockchain-tezos-sapling' -// TODO: DEMONSTRATE API +const client = new DAppClient({ + name: 'Example DApp', +}) + +const tezosSaplingBlockchain = new TezosSaplingBlockchain() +client.addBlockchain(tezosSaplingBlockchain) ``` + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-blockchain-tezos-sapling/package.json b/packages/beacon-blockchain-tezos-sapling/package.json index 68b540629..8adbc6d31 100644 --- a/packages/beacon-blockchain-tezos-sapling/package.json +++ b/packages/beacon-blockchain-tezos-sapling/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-blockchain-tezos-sapling", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,7 +34,7 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-ui": "^3.1.0" + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-ui": "^3.1.1" } } diff --git a/packages/beacon-blockchain-tezos/README.md b/packages/beacon-blockchain-tezos/README.md index 7da18fe15..6789965f9 100644 --- a/packages/beacon-blockchain-tezos/README.md +++ b/packages/beacon-blockchain-tezos/README.md @@ -1,11 +1,23 @@ # `@airgap/beacon-blockchain-tezos` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) + +## Introduction + +This package adds support for the `tezos` blockchain. It can be used in combination with the `@airgap/beacon-dapp` or `@airgap/beacon-wallet` packages. ## Usage ``` -const beaconProtocolTezos = require('@airgap/beacon-blockchain-tezos'); +import { DAppClient } from '@airga/beacon-dapp' +import { TezosBlockchain } from '@airga/beacon-blockchain-tezos' -// TODO: DEMONSTRATE API +const client = new DAppClient({ + name: 'Example DApp', +}) + +const tezosBlockchain = new TezosBlockchain() +client.addBlockchain(tezosBlockchain) ``` + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-blockchain-tezos/package.json b/packages/beacon-blockchain-tezos/package.json index 2dcff5a2c..01c5f9f5b 100644 --- a/packages/beacon-blockchain-tezos/package.json +++ b/packages/beacon-blockchain-tezos/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-blockchain-tezos", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,7 +34,7 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-ui": "^3.1.0" + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-ui": "^3.1.1" } } diff --git a/packages/beacon-core/README.md b/packages/beacon-core/README.md index 6bfa91feb..c83a6ced1 100644 --- a/packages/beacon-core/README.md +++ b/packages/beacon-core/README.md @@ -1,11 +1,11 @@ # `@airgap/beacon-core` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) -## Usage +## Introduction -``` -const beaconCore = require('@airgap/beacon-core'); +This package contains internal methods that are used by both the dApp and wallet client. -// TODO: DEMONSTRATE API -``` +Unless you need to import types from this package, you probably don't need to add it to your project. + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-core/package.json b/packages/beacon-core/package.json index 63a846151..7236b0425 100644 --- a/packages/beacon-core/package.json +++ b/packages/beacon-core/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-core", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,8 +34,8 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-utils": "^3.1.0", + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-utils": "^3.1.1", "@types/libsodium-wrappers": "0.7.9", "bs58check": "2.1.2", "libsodium-wrappers": "0.7.9" diff --git a/packages/beacon-core/src/clients/client/Client.ts b/packages/beacon-core/src/clients/client/Client.ts index 7567a0e87..b058667ec 100644 --- a/packages/beacon-core/src/clients/client/Client.ts +++ b/packages/beacon-core/src/clients/client/Client.ts @@ -15,7 +15,6 @@ import { import { Serializer, Transport } from '../..' import { BeaconClient } from '../beacon-client/BeaconClient' import { AccountManager } from '../../managers/AccountManager' -import { BEACON_VERSION } from '../../constants' import { getSenderId } from '../../utils/get-sender-id' import { Logger } from '../../utils/Logger' import { ClientOptions } from './ClientOptions' @@ -215,7 +214,7 @@ export abstract class Client extends BeaconClient { protected async sendDisconnectToPeer(peer: PeerInfo, transport?: Transport): Promise { const request: DisconnectMessage = { id: await generateGUID(), - version: BEACON_VERSION, + version: peer.version, senderId: await getSenderId(await this.beaconId), type: BeaconMessageType.Disconnect } diff --git a/packages/beacon-core/src/constants.ts b/packages/beacon-core/src/constants.ts index c23eb0f5e..ab9e85363 100644 --- a/packages/beacon-core/src/constants.ts +++ b/packages/beacon-core/src/constants.ts @@ -1,2 +1,2 @@ -export const SDK_VERSION: string = '3.1.0' +export const SDK_VERSION: string = '3.1.1' export const BEACON_VERSION: string = '3' diff --git a/packages/beacon-core/src/transports/clients/MessageBasedClient.ts b/packages/beacon-core/src/transports/clients/MessageBasedClient.ts index 9c8e147fa..706c73096 100644 --- a/packages/beacon-core/src/transports/clients/MessageBasedClient.ts +++ b/packages/beacon-core/src/transports/clients/MessageBasedClient.ts @@ -59,7 +59,7 @@ export abstract class MessageBasedClient extends CommunicationClient { id: request.id, type: 'postmessage-pairing-response', name: this.name, - version: BEACON_VERSION, + version: request.version, publicKey: await this.getPublicKey() } } diff --git a/packages/beacon-dapp/README.md b/packages/beacon-dapp/README.md index af3b3b1a1..6deec9ce7 100644 --- a/packages/beacon-dapp/README.md +++ b/packages/beacon-dapp/README.md @@ -1,11 +1,17 @@ # `@airgap/beacon-dapp` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) + +## Introduction + +Use this package on your dApp to instanciate a `DAppClient` object and communicate to wallets. ## Usage ``` -const beaconDapp = require('@airgap/beacon-dapp'); +import { DAppClient } from '@airgap/beacon-dapp' -// TODO: DEMONSTRATE API +const dAppClient = new DAppClient({ name: "Beacon Docs" }); ``` + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-dapp/package.json b/packages/beacon-dapp/package.json index 47b5aa16c..372dd8707 100644 --- a/packages/beacon-dapp/package.json +++ b/packages/beacon-dapp/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-dapp", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -35,10 +35,10 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-core": "^3.1.0", - "@airgap/beacon-transport-matrix": "^3.1.0", - "@airgap/beacon-transport-postmessage": "^3.1.0", - "@airgap/beacon-ui": "^3.1.0", + "@airgap/beacon-core": "^3.1.1", + "@airgap/beacon-transport-matrix": "^3.1.1", + "@airgap/beacon-transport-postmessage": "^3.1.1", + "@airgap/beacon-ui": "^3.1.1", "qrcode-generator": "1.4.4" } } diff --git a/packages/beacon-dapp/src/dapp-client/DAppClient.ts b/packages/beacon-dapp/src/dapp-client/DAppClient.ts index f9ac94bf3..6ed633549 100644 --- a/packages/beacon-dapp/src/dapp-client/DAppClient.ts +++ b/packages/beacon-dapp/src/dapp-client/DAppClient.ts @@ -72,7 +72,6 @@ import { LocalStorage, getAccountIdentifier, getSenderId, - BEACON_VERSION, Logger } from '@airgap/beacon-core' import { getAddressFromPublicKey, ExposedPromise, generateGUID } from '@airgap/beacon-utils' @@ -1477,7 +1476,7 @@ export class DAppClient extends Client { const request: BeaconMessageWrapper = { id: messageId, - version: BEACON_VERSION, + version: '3', senderId: await getSenderId(await this.beaconId), message: requestInput } diff --git a/packages/beacon-sdk/README.md b/packages/beacon-sdk/README.md index 98e17222e..4f03a727f 100644 --- a/packages/beacon-sdk/README.md +++ b/packages/beacon-sdk/README.md @@ -1,11 +1,93 @@ -# `@airgap/beacon-sdk` +# Beacon SDK -> TODO: description +[![npm](https://img.shields.io/npm/v/@airgap/beacon-sdk.svg?colorB=brightgreen)](https://www.npmjs.com/package/@airgap/beacon-sdk) +[![documentation](https://img.shields.io/badge/documentation-online-brightgreen.svg)](https://airgap-it.github.io/beacon-sdk/) +[![GitHub Action](https://github.com/airgap-it/beacon-sdk/workflows/Build%2C%20Test%20and%20Analyze/badge.svg)](https://github.com/airgap-it/beacon-sdk/actions?query=workflow%3A%22Build%2C+Test+and+Analyze%22+branch%3Amain) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=airgap-it_beacon-sdk&metric=alert_status)](https://sonarcloud.io/dashboard?id=airgap-it_beacon-sdk) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) -## Usage +> Connect Wallets with dApps on Tezos +[Beacon](https://walletbeacon.io) is the implementation of the wallet interaction standard [tzip-10](https://gitlab.com/tzip/tzip/blob/master/proposals/tzip-10/tzip-10.md) 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](https://github.com/ecadlabs/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: + +- [Beacon Android SDK (Kotlin)](https://github.com/airgap-it/beacon-android-sdk) +- [Beacon iOS SDK (Swift)](https://github.com/airgap-it/beacon-ios-sdk) + +## Documentation + +The documentation can be found [here](https://docs.walletbeacon.io/), technical documentation can be found [here](https://typedocs.walletbeacon.io/). + +## Installation + +``` +npm i --save @airgap/beacon-sdk +``` + +## Example DApp integration + +```ts +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)) ``` -const beaconSdk = require('@airgap/beacon-sdk'); -// TODO: DEMONSTRATE API +For a more complete example, take a look at the `example-dapp.html` file. + +## Example Wallet integration + +```ts +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](https://github.com/airgap-it/beacon-sdk/blob/master/scripts/generate-wallet-list.ts). + +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 `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`. diff --git a/packages/beacon-sdk/package.json b/packages/beacon-sdk/package.json index dbc4960b9..713bbb1d8 100644 --- a/packages/beacon-sdk/package.json +++ b/packages/beacon-sdk/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-sdk", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -35,15 +35,15 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-blockchain-substrate": "^3.1.0", - "@airgap/beacon-blockchain-tezos": "^3.1.0", - "@airgap/beacon-core": "^3.1.0", - "@airgap/beacon-dapp": "^3.1.0", - "@airgap/beacon-transport-matrix": "^3.1.0", - "@airgap/beacon-transport-postmessage": "^3.1.0", - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-ui": "^3.1.0", - "@airgap/beacon-utils": "^3.1.0", - "@airgap/beacon-wallet": "^3.1.0" + "@airgap/beacon-blockchain-substrate": "^3.1.1", + "@airgap/beacon-blockchain-tezos": "^3.1.1", + "@airgap/beacon-core": "^3.1.1", + "@airgap/beacon-dapp": "^3.1.1", + "@airgap/beacon-transport-matrix": "^3.1.1", + "@airgap/beacon-transport-postmessage": "^3.1.1", + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-ui": "^3.1.1", + "@airgap/beacon-utils": "^3.1.1", + "@airgap/beacon-wallet": "^3.1.1" } } diff --git a/packages/beacon-transport-matrix/README.md b/packages/beacon-transport-matrix/README.md index 4e047f53f..602a3dbf7 100644 --- a/packages/beacon-transport-matrix/README.md +++ b/packages/beacon-transport-matrix/README.md @@ -1,11 +1,11 @@ # `@airgap/beacon-transport-matrix` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) -## Usage +## Introduction -``` -const beaconTransportMatrix = require('@airgap/beacon-transport-matrix'); +This package contains methods to facilitate communication over the Beacon network, a decentralised P2P network that is based on the matrix protocol. -// TODO: DEMONSTRATE API -``` +Unless you need to import types from this package, you probably don't need to add it to your project. + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-transport-matrix/package.json b/packages/beacon-transport-matrix/package.json index e57da53ed..09871740f 100644 --- a/packages/beacon-transport-matrix/package.json +++ b/packages/beacon-transport-matrix/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-transport-matrix", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,8 +34,8 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-core": "^3.1.0", - "@airgap/beacon-utils": "^3.1.0", + "@airgap/beacon-core": "^3.1.1", + "@airgap/beacon-utils": "^3.1.1", "axios": "0.24.0" } } diff --git a/packages/beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts b/packages/beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts index 4b0b9667f..b7a06a60a 100644 --- a/packages/beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts +++ b/packages/beacon-transport-matrix/src/communication-client/P2PCommunicationClient.ts @@ -113,7 +113,7 @@ export class P2PCommunicationClient extends CommunicationClient { id: request.id, type: 'p2p-pairing-response', name: this.name, - version: BEACON_VERSION, + version: request.version, publicKey: await this.getPublicKey(), relayServer: await this.getRelayServer() } diff --git a/packages/beacon-transport-postmessage/README.md b/packages/beacon-transport-postmessage/README.md index 3472ef4a9..508cfad64 100644 --- a/packages/beacon-transport-postmessage/README.md +++ b/packages/beacon-transport-postmessage/README.md @@ -1,11 +1,11 @@ # `@airgap/beacon-transport-postmessage` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) -## Usage +## Introduction -``` -const beaconTransportPostmessage = require('@airgap/beacon-transport-postmessage'); +This package contains methods to facilitate communication over the postmessage interface of the browser to talk to browser extensions. -// TODO: DEMONSTRATE API -``` +Unless you need to import types from this package, you probably don't need to add it to your project. + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-transport-postmessage/package.json b/packages/beacon-transport-postmessage/package.json index f59cd1e96..dd5c68d65 100644 --- a/packages/beacon-transport-postmessage/package.json +++ b/packages/beacon-transport-postmessage/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-transport-postmessage", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,9 +34,9 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-core": "^3.1.0", - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-utils": "^3.1.0", + "@airgap/beacon-core": "^3.1.1", + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-utils": "^3.1.1", "@types/libsodium-wrappers": "0.7.9", "libsodium-wrappers": "0.7.9" } diff --git a/packages/beacon-types/README.md b/packages/beacon-types/README.md index d5d5d4ebd..90567e790 100644 --- a/packages/beacon-types/README.md +++ b/packages/beacon-types/README.md @@ -1,11 +1,11 @@ # `@airgap/beacon-types` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) -## Usage +## Introduction -``` -const beaconTypes = require('@airgap/beacon-types'); +This package contains types that are used throughout the SDK. -// TODO: DEMONSTRATE API -``` +Unless you need to import types from this package, you probably don't need to add it to your project. + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-types/package.json b/packages/beacon-types/package.json index d1207193f..c66c2ab60 100644 --- a/packages/beacon-types/package.json +++ b/packages/beacon-types/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-types", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", diff --git a/packages/beacon-ui/README.md b/packages/beacon-ui/README.md index 057045278..19468e5df 100644 --- a/packages/beacon-ui/README.md +++ b/packages/beacon-ui/README.md @@ -1,11 +1,11 @@ # `@airgap/beacon-ui` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) -## Usage +## Introduction -``` -const beaconUi = require('@airgap/beacon-ui'); +This package contains the UI part (alerts and toasts) of the `beacon-sdk`. -// TODO: DEMONSTRATE API -``` +Unless you need to import types from this package, you probably don't need to add it to your project. + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-ui/package.json b/packages/beacon-ui/package.json index 3ce44d840..e82c81e0a 100644 --- a/packages/beacon-ui/package.json +++ b/packages/beacon-ui/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-ui", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -34,9 +34,9 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-core": "^3.1.0", - "@airgap/beacon-transport-postmessage": "^3.1.0", - "@airgap/beacon-types": "^3.1.0", - "@airgap/beacon-utils": "^3.1.0" + "@airgap/beacon-core": "^3.1.1", + "@airgap/beacon-transport-postmessage": "^3.1.1", + "@airgap/beacon-types": "^3.1.1", + "@airgap/beacon-utils": "^3.1.1" } } diff --git a/packages/beacon-utils/README.md b/packages/beacon-utils/README.md index 3bd93c4f0..242860dfd 100644 --- a/packages/beacon-utils/README.md +++ b/packages/beacon-utils/README.md @@ -1,11 +1,11 @@ # `@airgap/beacon-utils` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) -## Usage +## Introduction -``` -const beaconUtils = require('@airgap/beacon-utils'); +This package contains utility functions that are used throughout the `beacon-sdk`. -// TODO: DEMONSTRATE API -``` +Unless you need to import types from this package, you probably don't need to add it to your project. + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-utils/package.json b/packages/beacon-utils/package.json index 139ec187e..bcf6e426c 100644 --- a/packages/beacon-utils/package.json +++ b/packages/beacon-utils/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-utils", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", diff --git a/packages/beacon-wallet/README.md b/packages/beacon-wallet/README.md index b0dc107fa..934a5dc76 100644 --- a/packages/beacon-wallet/README.md +++ b/packages/beacon-wallet/README.md @@ -1,11 +1,17 @@ # `@airgap/beacon-wallet` -> TODO: description +This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk) + +## Introduction + +Use this package in your wallet to instanciate a `WalletClient` object and communicate to dApps. ## Usage ``` -const beaconWallet = require('@airgap/beacon-wallet'); +import { WalletClient } from '@airgap/beacon-wallet' -// TODO: DEMONSTRATE API +const walletClient = new WalletClient({ name: "Example Wallet" }); ``` + +Check our documentation for more information. [Documentation](https://docs.walletbeacon.io) diff --git a/packages/beacon-wallet/package.json b/packages/beacon-wallet/package.json index c505cff22..37ea7775c 100644 --- a/packages/beacon-wallet/package.json +++ b/packages/beacon-wallet/package.json @@ -1,6 +1,6 @@ { "name": "@airgap/beacon-wallet", - "version": "3.1.0", + "version": "3.1.1", "description": "> TODO: description", "author": "Andreas Gassmann ", "homepage": "https://walletbeacon.io", @@ -35,8 +35,8 @@ "url": "https://github.com/airgap-it/beacon-sdk/issues" }, "dependencies": { - "@airgap/beacon-core": "^3.1.0", - "@airgap/beacon-transport-matrix": "^3.1.0", - "@airgap/beacon-transport-postmessage": "^3.1.0" + "@airgap/beacon-core": "^3.1.1", + "@airgap/beacon-transport-matrix": "^3.1.1", + "@airgap/beacon-transport-postmessage": "^3.1.1" } } diff --git a/packages/beacon-wallet/src/interceptors/OutgoingResponseInterceptor.ts b/packages/beacon-wallet/src/interceptors/OutgoingResponseInterceptor.ts index 67db5fdfe..491a565e7 100644 --- a/packages/beacon-wallet/src/interceptors/OutgoingResponseInterceptor.ts +++ b/packages/beacon-wallet/src/interceptors/OutgoingResponseInterceptor.ts @@ -1,6 +1,5 @@ import { AppMetadataManager, - BEACON_VERSION, getAccountIdentifier, Logger, PermissionManager @@ -144,7 +143,7 @@ export class OutgoingResponseInterceptor { case BeaconMessageType.Error: { const response: ErrorResponse = { type: message.type, - version: BEACON_VERSION, + version: '2', senderId, id: message.id, errorType: message.errorType @@ -169,7 +168,7 @@ export class OutgoingResponseInterceptor { case BeaconMessageType.Acknowledge: { const response: AcknowledgeResponse = { type: message.type, - version: BEACON_VERSION, + version: '2', senderId, id: message.id } @@ -179,7 +178,7 @@ export class OutgoingResponseInterceptor { case BeaconMessageType.PermissionResponse: { const response: PermissionResponse = { senderId, - version: BEACON_VERSION, + version: '2', appMetadata: ownAppMetadata, ...message } @@ -213,7 +212,7 @@ export class OutgoingResponseInterceptor { { const response: OperationResponse = { senderId, - version: BEACON_VERSION, + version: '2', ...message } interceptorCallback(response) @@ -223,7 +222,7 @@ export class OutgoingResponseInterceptor { { const response: SignPayloadResponse = { senderId, - version: BEACON_VERSION, + version: '2', ...message } interceptorCallback(response) @@ -244,7 +243,7 @@ export class OutgoingResponseInterceptor { { const response: BroadcastResponse = { senderId, - version: BEACON_VERSION, + version: '2', ...message } interceptorCallback(response)