Skip to content

Releases: airgap-it/beacon-sdk

v2.2.6

29 Apr 11:04
v2.2.6
8d0dde3
Compare
Choose a tag to compare

2.2.6 (2021-04-29)

Fixes

  • ui: Ignore styling from parent page
  • types: Make operation request properties optional instead of omitting them

v2.2.5

28 Apr 12:23
v2.2.5
c30848b
Compare
Choose a tag to compare

2.2.5 (2021-04-26)

Fixes

  • p2p: Remove unknown rooms and retry on failure

v2.2.4

19 Apr 20:30
v2.2.4
f731121
Compare
Choose a tag to compare

Features

  • florencenet: Add Florencenet
  • p2p: Support federated matrix servers

Fixes

  • p2p: Fix timing issues during connection setup to improve reliability

v2.2.3

19 Apr 20:24
v2.2.3
3b5a0da
Compare
Choose a tag to compare

Fixes

  • UI: Make alert scrollable

v2.2.2

19 Apr 20:23
v2.2.2
9d610e0
Compare
Choose a tag to compare

Features

  • temple: Rename "Thanos" to "Temple"
  • kukai: Add edonet URL

Fixes

  • error: Fix removing of dom element that would result in an error

v2.2.1

08 Feb 13:18
v2.2.1
551ec84
Compare
Choose a tag to compare

Fixes

  • signing: The validation of the OPERATION and MICHELINE payloads is now correct
  • alert: The page no longer scrolls down when the alert opens
  • alert: Alert width fixed on mobile
  • toast: Toasts are now sticky to the top of the window, not the top of the page
  • toast: Toast height fixed on iOS
  • toast: If an acknowledge message is received after the response, it will be ignored
  • toast: The close button will now always be shown in the "awaiting" state
  • toast: Remove unnecessary "href" from link in error toast
  • toast: New toasts that are triggered while another one is being shown will now be handled correctly

v2.2.0

03 Feb 17:53
v2.2.0
917edda
Compare
Choose a tag to compare

2.2.0 (2021-02-03)

Features

  • UI Improvements: We changed the flow of the UI from the ground up. When a new message is sent from the dApp, the "request sent" toast now sticks to the top right of the page. It shows a loading animation and also includes the name (and logo) of the wallet where the request has been sent to. The toast will update whenever new information is received from the wallet (eg. request acknowledgement or response). Only the pairing information and details of errors will be displayed in a blocking alert. As always, all of these UI elements can be overwritten if dApp developers want to use their own UI.

  • UI Improvements: Default UI Elements in Beacon now use Shadow Dom. This will encapsulate the styling of the UI elements, so the styling of the page will no longer affect the styling of the beacon-sdk UI elements, and vice versa.

  • Dark Mode: The dApp developer can now choose between a "dark" and "light" color theme. This will change the look of both alerts and toasts.

  • Errors: The beacon-sdk now allows for RPC-Errors to be passed in the TRANSACTION_INVALID_ERROR response. Errors MUST be displayed in the wallet. This change does not change that. It simply allows dApps that expect certain errors to provide more insights into what went wrong. dApps are not required to display the details of an error, but they can choose to do so if it improves the user experience.

  • Debug: New debug methods have been introduced. To activate logs from the beacon-sdk during development, it is possible to call setDebugEnabled(true). This will enable logs throughout the beacon-sdk.

The beacon-sdk will now also listen to the beaconSdkDebugEnabled variable on the global window object. This will allow browser extensions (eg. Spire) to set the debug flag to true on production websites, which will help debugging on production dApps.

  • UI Elements: All default UI Elements / Event Handlers can be removed at once by setting the disableDefaultEvents flag in the DAppClientOptions to true. Keep in mind that this will also disable the Pairing Alert. If you want to keep the Pairing Alert, you will have to add those default handlers again. An example would be:
const client = new DAppClient({
  name: 'My Sample DApp',
  disableDefaultEvents: true, // Disable all events / UI. This also disables the pairing alert.
  eventHandlers: {
    // To keep the pairing alert, we have to add the following default event handlers back
    [BeaconEvent.PAIR_INIT]: {
      handler: defaultEventCallbacks.PAIR_INIT
    },
    [BeaconEvent.PAIR_SUCCESS]: {
      handler: defaultEventCallbacks.PAIR_SUCCESS
    }
  }
})
  • Alert: A click outside the alert will now dismiss the alert
  • Logs: Add warning logs when the QR code gets too big and when muliple Clients are created
  • SigningType: Add OPERATION and MICHELINE SigningTypes. The payload of the OPERATION type has to start with 03 and the MICHELINE type has to start with 05
  • Beacon Extension: The "Beacon Extension" has been renamed to "Spire".
  • dApp / Wallet metadata: The dApp and wallet metadata (name and icon) are now included in the pairing request / response

Fixes

  • Matrix Performace Improvements: Fixed a timing issue that lead to slower responses
  • DAppClient: setActiveAccount now updates and persists the active peer
  • Types: The type of matrixNodes was incorrect
  • Docs: Fixed a typo in link a docs link

v2.1.0

22 Jan 12:47
v2.1.0
7831cad
Compare
Choose a tag to compare
  • Add Edonet
  • Remove Carthagenet
  • Accessibility improvements to navigate in the pairing alert
  • New method on the DAppClient called clearActiveAccount(), which is just a wrapper for setActiveAccount()

v2.0.1

11 Jan 10:32
v2.0.1
d0eb04b
Compare
Choose a tag to compare
  • Add Galleon Desktop Wallet

Changelog

v2.0.0

08 Dec 09:31
v2.0.0
4fd7f85
Compare
Choose a tag to compare

Version 2 of the beacon-sdk brings many improvements, the most important ones being:

  • 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