Class BeaconClientAbstract

Internalapi

The beacon client is an abstract client that handles everything that is shared between all other clients. Specifically, it handles managing the beaconId and and the local keypair.

Hierarchy

Constructors

constructor

Properties

_beaconId _keyPair analytics appUrl? iconUrl? initSDK loadOrCreateBeaconSecret name removeBeaconEntriesFromStorage storage

Accessors

beaconId keyPair

Methods

destroy

Constructors

constructor

Properties

Protected _beaconId

_beaconId: ExposedPromise<string, unknown>

The beaconId is a public key that is used to identify one specific application (dapp or wallet). This is used inside a message to specify the sender, for example.

Protected _keyPair

_keyPair: ExposedPromise<KeyPair, unknown>

The local keypair that is used for the communication encryption

Protected analytics

analytics: AnalyticsInterface

Optional Readonly appUrl

appUrl?: string

The URL of the dApp.

Optional Readonly iconUrl

iconUrl?: string

The URL of the dApp Icon. This can be used to display the icon of the dApp on in the wallet

Private initSDK

initSDK: any

This method initializes the SDK by setting some values in the storage and generating a keypair.

Private loadOrCreateBeaconSecret

loadOrCreateBeaconSecret: any

This method tries to load the seed from storage, if it doesn't exist, a new one will be created and persisted.

Readonly name

name: string

The name of the client

Private removeBeaconEntriesFromStorage

removeBeaconEntriesFromStorage: any

Removes all beacon values from the storage.

Protected storage

storage: Storage

Accessors

beaconId

  • get beaconId(): Promise<string>

  • Returns Promise<string>

Protected keyPair

  • get keyPair(): Promise<KeyPair>

  • Returns Promise<KeyPair>

Methods

destroy

  • This resets the SDK. After using this method, this instance is no longer usable. You will have to instanciate a new client.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc