Class WalletClient

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.

Hierarchy

Constructors

constructor

Properties

_beaconId _isConnected _keyPair _transport accountManager analytics appMetadataManager appUrl? disconnect getPeerInfo handleResponse iconUrl? matrixNodes name pendingRequests permissionManager rateLimit rateLimitWindowInSeconds removePermissionsForPeers requestCounter respondToMessage sendAcknowledgeResponse storage

Accessors

beaconId connectionStatus isConnected keyPair ready transport

Methods

_connect addListener addPeer addRequestAndCheckIfRateLimited cleanup connect destroy getAccount getAccounts getAppMetadata getAppMetadataList getOwnAppMetadata getPeers getPermission getPermissions getRegisterPushChallenge init registerPush removeAccount removeAllAccounts removeAllAppMetadata removeAllPeers removeAllPermissions removeAppMetadata removePeer removePermission respond sendDisconnectToPeer setTransport

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 Readonly _isConnected

_isConnected: ExposedPromise<boolean, unknown>

Returns whether or not the transport is connected

Protected _keyPair

_keyPair: ExposedPromise<KeyPair, unknown>

The local keypair that is used for the communication encryption

Protected _transport

_transport: ExposedPromise<Transport<any, any, any>, unknown>

Protected Readonly accountManager

accountManager: AccountManager

Protected analytics

analytics: AnalyticsInterface

Private Readonly appMetadataManager

appMetadataManager: any

Optional Readonly appUrl

appUrl?: string

The URL of the dApp.

Private disconnect

disconnect: any

Private getPeerInfo

getPeerInfo: any

Protected handleResponse

handleResponse: ((_event, connectionInfo) => void)

Type declaration

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

Protected Readonly matrixNodes

matrixNodes: NodeDistributions

Readonly name

name: string

The name of the client

Private pendingRequests

pendingRequests: any

This array stores pending requests, meaning requests we received and have not yet handled / sent a response.

Private Readonly permissionManager

permissionManager: any

Protected Readonly rateLimit

rateLimit: number

How many requests can be sent after another

Protected Readonly rateLimitWindowInSeconds

rateLimitWindowInSeconds: number

The time window in seconds in which the "rateLimit" is checked

Private removePermissionsForPeers

removePermissionsForPeers: any

Protected requestCounter

requestCounter: number[]

Stores the times when requests have been made to determine if the rate limit has been reached

Private respondToMessage

respondToMessage: any

An internal method to send a BeaconMessage to the DApp

Param

Send a message back to the DApp

Private sendAcknowledgeResponse

sendAcknowledgeResponse: any

Send an acknowledge message back to the sender

Param

The message that was received

Protected storage

storage: Storage

Accessors

beaconId

  • get beaconId(): Promise<string>

  • Returns Promise<string>

connectionStatus

  • get connectionStatus(): TransportStatus

  • Returns the connection status of the Client

    Returns TransportStatus

isConnected

  • get isConnected(): Promise<boolean>

  • Returns Promise<boolean>

Protected keyPair

  • get keyPair(): Promise<KeyPair>

  • Returns Promise<KeyPair>

ready

  • get ready(): Promise<void>

  • Returns whether or not the transaport is ready

    Returns Promise<void>

Protected transport

  • get transport(): Promise<Transport<any, any, any>>

  • Returns Promise<Transport<any, any, any>>

Methods

_connect

  • _connect(): Promise<void>

  • The method will attempt to initiate a connection using the active transport.

    Returns Promise<void>

Protected addListener

  • Parameters

    Returns Promise<void>

addPeer

  • Add a new peer to the known peers

    Parameters

    • peer: PeerInfo

      The new peer to add

    • Optional sendPairingResponse: boolean

    Returns Promise<void>

addRequestAndCheckIfRateLimited

  • Add a new request (current timestamp) to the pending requests, remove old ones and check if we are above the limit

    Returns Promise<boolean>

Protected cleanup

  • Returns Promise<void>

connect

  • This method initiates a connection to the P2P network and registers a callback that will be called whenever a message is received.

    Parameters

    • newMessageCallback: ((message, connectionContext) => void)

      The callback that will be invoked for every message the transport receives.

    Returns Promise<void>

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>

getAccount

  • Return the account by ID

    Parameters

    • accountIdentifier: string

      The ID of an account

    Returns Promise<undefined | AccountInfo>

getAccounts

  • Return all locally known accounts

    Returns Promise<AccountInfo[]>

getAppMetadata

  • Parameters

    • senderId: string

    Returns Promise<undefined | AppMetadata>

getAppMetadataList

  • Returns Promise<AppMetadata[]>

getOwnAppMetadata

getPeers

  • Return all known peers

    Returns Promise<PeerInfo[]>

getPermission

  • Parameters

    • accountIdentifier: string

    Returns Promise<undefined | PermissionInfo>

getPermissions

  • Returns Promise<PermissionInfo[]>

getRegisterPushChallenge

  • Parameters

    • backendUrl: string
    • accountPublicKey: string
    • Optional oracleUrl: string

    Returns Promise<{
        challenge: {
            id: string;
            timestamp: string;
        };
        payloadToSign: string;
    }>

init

  • 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.

    Returns Promise<TransportType>

registerPush

  • Parameters

    • challenge: {
          id: string;
          timestamp: string;
      }
      • id: string
      • timestamp: string
    • signature: string
    • backendUrl: string
    • accountPublicKey: string
    • protocolIdentifier: string
    • deviceId: string
    • Optional oracleUrl: string

    Returns Promise<PushToken>

removeAccount

  • Remove the account by ID

    Parameters

    • accountIdentifier: string

      The ID of an account

    Returns Promise<void>

removeAllAccounts

  • Remove all locally stored accounts

    Returns Promise<void>

removeAllAppMetadata

  • Returns Promise<void>

removeAllPeers

  • Parameters

    • Optional sendDisconnectToPeers: boolean

    Returns Promise<void>

removeAllPermissions

  • Returns Promise<void>

removeAppMetadata

  • Parameters

    • senderId: string

    Returns Promise<void>

removePeer

  • Parameters

    Returns Promise<void>

removePermission

  • Parameters

    • accountIdentifier: string

    Returns Promise<void>

respond

  • This method sends a response for a specific request back to the DApp

    Parameters

    Returns Promise<void>

Protected sendDisconnectToPeer

  • Parameters

    Returns Promise<void>

Protected setTransport

  • A "setter" for when the transport needs to be changed.

    Parameters

    • Optional transport: Transport<any, any, any>

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc