Class WalletConnectCommunicationClient

constructor

• new WalletConnectCommunicationClient(
      wcOptions: { network: NetworkType; opts: Options },
      isLeader: Function,
  ): WalletConnectCommunicationClient

  Parameters

  • wcOptions: { network: NetworkType; opts: Options }
  • isLeader: Function

  Returns WalletConnectCommunicationClient

ReadonlydisconnectionEvents

signClient

storage

close

• close(): Promise<void>

  Returns Promise<void>

closeActiveSession

• closeActiveSession(account: string, notify?: boolean): Promise<void>

  Parameters

  • account: string
  • notify: boolean = true

  Returns Promise<void>

closeSignClient

• closeSignClient(): Promise<void>

  Returns Promise<void>

currentSession

• currentSession(): undefined | Struct

  Returns undefined | Struct

getAccountOrPK

• getAccountOrPK(): Promise<string>

  Returns Promise<string>

  Description

  Access the public key hash (or public key) of the active account

  Error

  ActiveAccountUnspecified thrown when there are multiple Tezos account in the session and none is set as the active one

getAccounts

• getAccounts(): string[]

  Returns string[]

  Description

  Return all connected accounts from the active session

  Error

  NotConnected if no active session

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

getNetworks

• getNetworks(): string[]

  Returns string[]

  Description

  Return all networks from the namespace of the active session

  Error

  NotConnected if no active session

getPairingRequestInfo

• getPairingRequestInfo(): Promise<ExtendedWalletConnectPairingRequest>

  Returns Promise<ExtendedWalletConnectPairingRequest>

init

• init(
      forceNewConnection?: boolean,
  ): Promise<undefined | { topic: string; uri: string }>

  Parameters

  • forceNewConnection: boolean = false

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

listenForChannelOpening

• listenForChannelOpening(
      messageCallback: (
          pairingResponse: ExtendedWalletConnectPairingResponse,
      ) => void,
  ): Promise<void>

  Parameters

  • messageCallback: (pairingResponse: ExtendedWalletConnectPairingResponse) => void

  Returns Promise<void>

listenForEncryptedMessage

• listenForEncryptedMessage(
      senderPublicKey: string,
      messageCallback: (message: string) => void,
  ): Promise<void>

  Parameters

  • senderPublicKey: string
  • messageCallback: (message: string) => void

  Returns Promise<void>

requestPermissions

• requestPermissions(message: PermissionRequest): Promise<void>

  Parameters

  • message: PermissionRequest

  Returns Promise<void>

sendMessage

• sendMessage(_message: string, _peer?: any): Promise<void>

  Parameters

  • _message: string
  • Optional_peer: any

  Returns Promise<void>

sendOperations

• sendOperations(operationRequest: 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

signPayload

• signPayload(signPayloadRequest: 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

unsubscribeFromEncryptedMessage

• unsubscribeFromEncryptedMessage(_senderPublicKey: string): Promise<void>

  Parameters

  • _senderPublicKey: string

  Returns Promise<void>

unsubscribeFromEncryptedMessages

• unsubscribeFromEncryptedMessages(): Promise<void>

  Returns Promise<void>

StaticgetInstance

• getInstance(
      wcOptions: { network: NetworkType; opts: Options },
      isLeader: Function,
  ): WalletConnectCommunicationClient

  Parameters

  • wcOptions: { network: NetworkType; opts: Options }
  • isLeader: Function

  Returns WalletConnectCommunicationClient