Class WalletConnectCommunicationClient

Internalapi

Hierarchy

CommunicationClient
- WalletConnectCommunicationClient

Index

Constructors

Properties

abortErrorBuilder acknowledgeRequest activeAccount activeListeners activeNetwork channelOpeningListeners checkWalletReadiness clearEvents clearState closePairings closeSessions closeSignClient disconnect disconnectionEvents eventHandlers fetchAccounts getPermittedMethods getPermittedNetwork getSession getSignClient getTezosNamespace getTezosRequiredNamespace getTopicFromSession isMobileOS isMobileSesion keyPair? messageIds notifyListeners notifyListenersWithPermissionResponse onPairingClosed onSessionClosed onStorageErrorHandler onStorageMessageHandler openSession permissionScopeParamsToNamespaces ping pingInterval refreshState session setDefaultAccountAndNetwork signClient storage subscribeToSessionEvents updateActiveAccount updateStorageWallet validateAccounts validateEvents validateMethods validateNetworkAndAccount validateReceivedNamespace wcOptions instance

Constructors

constructor

new WalletConnectCommunicationClient(wcOptions): WalletConnectCommunicationClient
Parameters
- wcOptions: {
  network: NetworkType;
  opts: Options;
  }
  - network: NetworkType
  - opts: Options
Returns WalletConnectCommunicationClient
Overrides CommunicationClient.constructor
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:38

Properties

`Private` abortErrorBuilder

abortErrorBuilder: any

`Private` acknowledgeRequest

acknowledgeRequest: any

`Private` activeAccount

activeAccount: any

`Protected` `Readonly` activeListeners

activeListeners: Map<string, ((message) => void)>

Type declaration

- (message): void
- Parameters
  - message: string
  Returns void

`Private` activeNetwork

activeNetwork: any

`Protected` `Readonly` channelOpeningListeners

channelOpeningListeners: Map<string, ((pairingResponse) => void)>

Type declaration

- (pairingResponse): void
- Parameters
  - pairingResponse: ExtendedWalletConnectPairingResponse
  Returns void

`Private` checkWalletReadiness

checkWalletReadiness: any

`Private` clearEvents

clearEvents: any

`Private` clearState

clearState: any

`Private` closePairings

closePairings: any

`Private` closeSessions

closeSessions: any

`Private` closeSignClient

closeSignClient: any

`Private` disconnect

disconnect: any

`Readonly` disconnectionEvents

disconnectionEvents: Set<string>

eventHandlers

eventHandlers: Map<ClientEvents, Function>

`Private` fetchAccounts

fetchAccounts: any

`Private` getPermittedMethods

getPermittedMethods: any

`Private` getPermittedNetwork

getPermittedNetwork: any

`Private` getSession

getSession: any

`Private` getSignClient

getSignClient: any

`Private` getTezosNamespace

getTezosNamespace: any

`Private` getTezosRequiredNamespace

getTezosRequiredNamespace: any

`Private` getTopicFromSession

getTopicFromSession: any

`Protected` isMobileOS

isMobileOS: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

`Private` isMobileSesion

isMobileSesion: any

`Protected` `Optional` `Readonly` keyPair

keyPair?: KeyPair

`Private` messageIds

messageIds: any

this queue stores each active message id [0] newest message [length - 1] oldest message

`Private` notifyListeners

notifyListeners: any

`Private` notifyListenersWithPermissionResponse

notifyListenersWithPermissionResponse: any

`Private` onPairingClosed

onPairingClosed: any

`Private` onSessionClosed

onSessionClosed: any

`Private` onStorageErrorHandler

onStorageErrorHandler: any

`Private` onStorageMessageHandler

onStorageMessageHandler: any

`Private` openSession

openSession: any

`Private` permissionScopeParamsToNamespaces

permissionScopeParamsToNamespaces: any

`Private` ping

ping: any

`Private` pingInterval

pingInterval: any

`Private` refreshState

refreshState: any

WC Sign client doesn't sync between intances, meaning that a dApp signClient instance state may differ from a wallet state

`Private` session

session: any

`Private` setDefaultAccountAndNetwork

setDefaultAccountAndNetwork: any

signClient

signClient: undefined | SignClient

storage

storage: WCStorage

`Private` subscribeToSessionEvents

subscribeToSessionEvents: any

`Private` updateActiveAccount

updateActiveAccount: any

`Private` updateStorageWallet

updateStorageWallet: any

Function used to fix appSwitching with web wallets when pairing through 'Other wallet flow'

Param

the newly created session

`Private` validateAccounts

validateAccounts: any

`Private` validateEvents

validateEvents: any

`Private` validateMethods

validateMethods: any

`Private` validateNetworkAndAccount

validateNetworkAndAccount: any

`Private` validateReceivedNamespace

validateReceivedNamespace: any

`Private` wcOptions

wcOptions: any

`Private` `Static` instance

instance: any

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:87

closeActiveSession

closeActiveSession(account, notify?): Promise<void>
Parameters
- account: string
- Optional notify: boolean
Returns Promise<void>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:103

`Protected` createCryptoBoxClient

createCryptoBoxClient(otherPublicKey, selfKeypair): Promise<SessionKeys>
Create a cryptobox client
Parameters
- otherPublicKey: string
- selfKeypair: KeyPair
Returns Promise<SessionKeys>
Inherited from CommunicationClient.createCryptoBoxClient
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:36

`Protected` createCryptoBoxServer

createCryptoBoxServer(otherPublicKey, selfKeypair): Promise<SessionKeys>
Create a cryptobox server
Parameters
- otherPublicKey: string
- selfKeypair: KeyPair
Returns Promise<SessionKeys>
Inherited from CommunicationClient.createCryptoBoxServer
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:29

currentSession

currentSession(): undefined | Struct
Returns undefined | Struct
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:126

`Protected` encryptMessageAsymmetric

encryptMessageAsymmetric(recipientPublicKey, message): Promise<string>
Encrypt a message for a specific publicKey (receiver, asymmetric)
Parameters
- recipientPublicKey: string
- message: string
Returns Promise<string>
Inherited from CommunicationClient.encryptMessageAsymmetric
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:43

getAccounts

getAccounts(): string[]
Returns string[]

Description
Return all connected accounts from the active session

Error
NotConnected if no active session
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:115

getActiveNetwork

getActiveNetwork(): string
Returns string

Description
Access the active network

Error
ActiveNetworkUnspecified thorwn when there are multiple Tezos networks in the session and none is set as the active one
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:109

getNetworks

getNetworks(): string[]
Returns string[]

Description
Return all networks from the namespace of the active session

Error
NotConnected if no active session
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:120

getPKH

getPKH(): Promise<string>
Returns Promise<string>

Description
Access the public key hash of the active account

Error
ActiveAccountUnspecified thrown when there are multiple Tezos account in the session and none is set as the active one
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:133

getPairingRequestInfo

getPairingRequestInfo(): Promise<ExtendedWalletConnectPairingRequest>
Returns Promise<ExtendedWalletConnectPairingRequest>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:94

getPublicKey

getPublicKey(): Promise<string>
Get the public key

Returns Promise<string>
Inherited from CommunicationClient.getPublicKey
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:18

getPublicKeyHash

getPublicKeyHash(): Promise<string>
get the public key hash

Returns Promise<string>
Inherited from CommunicationClient.getPublicKeyHash
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:22

init

init(forceNewConnection?): Promise<undefined | {
topic: string;
uri: string;
}>
Parameters
- Optional forceNewConnection: boolean
Returns Promise<undefined | {
topic: string;
uri: string;
}>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:83

listenForChannelOpening

listenForChannelOpening(messageCallback): Promise<void>
Parameters
- messageCallback: ((pairingResponse) => void)
  - - (pairingResponse): void
    - Parameters
      
      pairingResponse: ExtendedWalletConnectPairingResponse
      
      Returns void
Returns Promise<void>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:48

listenForEncryptedMessage

listenForEncryptedMessage(senderPublicKey, messageCallback): Promise<void>
Parameters
- senderPublicKey: string
- messageCallback: ((message) => void)
  - - (message): void
    - Parameters
      
      message: string
      
      Returns void
Returns Promise<void>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:47

requestPermissions

requestPermissions(message): Promise<void>
Parameters
- message: PermissionRequest
Returns Promise<void>
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:66

sendMessage

sendMessage(_message, _peer?): Promise<void>
Parameters
- _message: string
- Optional _peer: any
Returns Promise<void>
Overrides CommunicationClient.sendMessage
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:63

sendOperations

sendOperations(operationRequest): Promise<void>
Parameters
- operationRequest: OperationRequest
Returns Promise<void>

Description
Once the session is established, send Tezos operations to be approved, signed and inject by the wallet.

Error
MissingRequiredScope is thrown if permission to send operation was not granted
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:76

signPayload

signPayload(signPayloadRequest): Promise<void>
Parameters
- signPayloadRequest: SignPayloadRequest
Returns Promise<void>

Description
Once the session is establish, send payload to be approved and signed by the wallet.

Error
MissingRequiredScope is thrown if permission to sign payload was not granted
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:71

unsubscribeFromEncryptedMessage

unsubscribeFromEncryptedMessage(_senderPublicKey): Promise<void>
Parameters
- _senderPublicKey: string
Returns Promise<void>
Overrides CommunicationClient.unsubscribeFromEncryptedMessage
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:59

unsubscribeFromEncryptedMessages

unsubscribeFromEncryptedMessages(): Promise<void>
Returns Promise<void>
Overrides CommunicationClient.unsubscribeFromEncryptedMessages
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:58

`Static` getInstance

getInstance(wcOptions): WalletConnectCommunicationClient
Parameters
- wcOptions: {
  network: NetworkType;
  opts: Options;
  }
  - network: NetworkType
  - opts: Options
Returns WalletConnectCommunicationClient
- Defined in beacon-transport-walletconnect/dist/esm/communication-client/WalletConnectCommunicationClient.d.ts:42

Class WalletConnectCommunicationClient

Internalapi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

wcOptions: { network: NetworkType; opts: Options; }

network: NetworkType

opts: Options

Returns WalletConnectCommunicationClient

Properties

Private abortErrorBuilder

Private acknowledgeRequest

Private activeAccount

Protected Readonly activeListeners

Type declaration

Parameters

message: string

Returns void

Private activeNetwork

Protected Readonly channelOpeningListeners

Type declaration

Parameters

pairingResponse: ExtendedWalletConnectPairingResponse

Returns void

Private checkWalletReadiness

Private clearEvents

Private clearState

Private closePairings

Private closeSessions

Private closeSignClient

Private disconnect

Readonly disconnectionEvents

eventHandlers

Private fetchAccounts

Private getPermittedMethods

Private getPermittedNetwork

Private getSession

Private getSignClient

Private getTezosNamespace

Private getTezosRequiredNamespace

Private getTopicFromSession

Protected isMobileOS

Type declaration

Returns boolean

Private isMobileSesion

Protected Optional Readonly keyPair

Private messageIds

Private notifyListeners

Private notifyListenersWithPermissionResponse

Private onPairingClosed

Private onSessionClosed

Private onStorageErrorHandler

Private onStorageMessageHandler

Private openSession

Private permissionScopeParamsToNamespaces

Private ping

Private pingInterval

Private refreshState

Private session

Private setDefaultAccountAndNetwork

signClient

storage

Private subscribeToSessionEvents

Private updateActiveAccount

Private updateStorageWallet

Param

Private validateAccounts

Private validateEvents

Private validateMethods

Private validateNetworkAndAccount

Private validateReceivedNamespace

Private wcOptions

Private Static instance

Methods

close

wcOptions: {
network: NetworkType;
opts: Options;
}

`Private` abortErrorBuilder

`Private` acknowledgeRequest

`Private` activeAccount

`Protected` `Readonly` activeListeners

`Private` activeNetwork

`Protected` `Readonly` channelOpeningListeners

`Private` checkWalletReadiness

`Private` clearEvents

`Private` clearState

`Private` closePairings

`Private` closeSessions

`Private` closeSignClient

`Private` disconnect

`Readonly` disconnectionEvents

`Private` fetchAccounts

`Private` getPermittedMethods

`Private` getPermittedNetwork

`Private` getSession

`Private` getSignClient

`Private` getTezosNamespace

`Private` getTezosRequiredNamespace

`Private` getTopicFromSession

`Protected` isMobileOS

`Private` isMobileSesion

`Protected` `Optional` `Readonly` keyPair

`Private` messageIds

`Private` notifyListeners

`Private` notifyListenersWithPermissionResponse

`Private` onPairingClosed

`Private` onSessionClosed

`Private` onStorageErrorHandler

`Private` onStorageMessageHandler

`Private` openSession

`Private` permissionScopeParamsToNamespaces

`Private` ping

`Private` pingInterval

`Private` refreshState

`Private` session

`Private` setDefaultAccountAndNetwork

`Private` subscribeToSessionEvents

`Private` updateActiveAccount

`Private` updateStorageWallet

`Private` validateAccounts

`Private` validateEvents

`Private` validateMethods

`Private` validateNetworkAndAccount

`Private` validateReceivedNamespace

`Private` wcOptions

`Private` `Static` instance

`Optional` notify: boolean

`Protected` createCryptoBoxClient

`Protected` createCryptoBoxServer

`Protected` encryptMessageAsymmetric

`Optional` forceNewConnection: boolean

Returns Promise<undefined | {
topic: string;
uri: string;
}>