AbstractProtected_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_keyThe local keypair that is used for the communication encryption
Protected_transportProtected ReadonlyaccountProtectedanalyticsOptional ReadonlyappThe URL of the dApp.
ProtectedhandleOptional ReadonlyiconThe URL of the dApp Icon. This can be used to display the icon of the dApp on in the wallet
Protected ReadonlymatrixReadonlynameThe name of the client
Protected ReadonlyrateHow many requests can be sent after another
Protected ReadonlyrateThe time window in seconds in which the "rateLimit" is checked
ProtectedrequestStores the times when requests have been made to determine if the rate limit has been reached
ProtectedstorageReturns the connection status of the Client
ProtectedkeyReturns whether or not the transaport is ready
ProtectedtransportProtectedaddAdd a new request (current timestamp) to the pending requests, remove old ones and check if we are above the limit
ProtectedcleanupThis resets the SDK. After using this method, this instance is no longer usable. You will have to instanciate a new client.
Return the account by ID
The ID of an account
Return all locally known accounts
Returns the metadata of this DApp
Return all known peers
This 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.
A transport that can be provided by the user
ProtectedinitSDKThis method initializes the SDK by setting some values in the storage and generating a keypair.
Remove the account by ID
The ID of an account
Remove all locally stored accounts
ProtectedsendProtectedsetA "setter" for when the transport needs to be changed.
Optionaltransport: Transport<any, any, any>
Internalapi
This abstract class handles the a big part of the logic that is shared between the dapp and wallet client. For example, it selects and manages the transport and accounts.