Protected _beaconThe 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 Readonly _isReturns whether or not the transport is connected
Protected _keyThe local keypair that is used for the communication encryption
Protected _transportProtected Readonly accountProtected analyticsPrivate Readonly appOptional Readonly appThe URL of the dApp.
Protected handleOptional Readonly iconThe URL of the dApp Icon. This can be used to display the icon of the dApp on in the wallet
Protected Readonly matrixReadonly nameThe name of the client
Private pendingThis array stores pending requests, meaning requests we received and have not yet handled / sent a response.
Private Readonly permissionProtected Readonly rateHow many requests can be sent after another
Protected Readonly rateThe time window in seconds in which the "rateLimit" is checked
Protected requestStores the times when requests have been made to determine if the rate limit has been reached
Protected storageReturns the connection status of the Client
Protected keyReturns whether or not the transaport is ready
Protected transportProtected addAdd a new peer to the known peers
The new peer to add
Protected cleanupThis method initiates a connection to the P2P network and registers a callback that will be called whenever a message is received.
The callback that will be invoked for every message the transport receives.
Private disconnectReturn the account by ID
The ID of an account
Return all locally known accounts
Returns the metadata of this DApp
Private getThis method initializes the client. It will check if the connection should be established to a browser extension or if the P2P transport should be used.
Private removeThis method sends a response for a specific request back to the DApp
The BeaconResponseMessage that will be sent back to the DApp
Private respondAn internal method to send a BeaconMessage to the DApp
Send a message back to the DApp
Private sendSend an acknowledge message back to the sender
Protected sendProtected setA "setter" for when the transport needs to be changed.
Optional transport: Transport<any, any, any>Generated using TypeDoc
Publicapi
The WalletClient has to be used in the wallet. It handles all the logic related to connecting to beacon-compatible dapps and handling/responding to requests.