Documentation
    Preparing search index...

    Class WalletConnectCommunicationClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    activeListeners channelOpeningListeners disconnectionEvents eventHandlers isMobileOS keyPair? signClient storage

    Methods

    close closeActiveSession closeSignClient createCryptoBoxClient createCryptoBoxServer currentSession encryptMessageAsymmetric getAccountOrPK getAccounts getActiveNetwork getNetworks getPairingRequestInfo getPublicKey getPublicKeyHash init listenForChannelOpening listenForEncryptedMessage requestPermissions sendMessage sendOperations signPayload unsubscribeFromEncryptedMessage unsubscribeFromEncryptedMessages getInstance

    Constructors

    Properties

    activeListeners: Map<string, (message: string) => void>
    channelOpeningListeners: Map<
        string,
        (pairingResponse: ExtendedWalletConnectPairingResponse) => void,
    >
    disconnectionEvents: Set<string>
    eventHandlers: Map<ClientEvents, Function>
    isMobileOS: () => boolean
    keyPair?: KeyPair
    signClient: undefined | SignClient
    storage: WCStorage

    Methods

    • Returns Promise<void>

    • Parameters

      • account: string
      • Optionalnotify: boolean

      Returns Promise<void>

    • Returns Promise<void>

    • Create a cryptobox client

      Parameters

      • otherPublicKey: string
      • selfKeypair: KeyPair

      Returns Promise<SessionKeys>

    • Create a cryptobox server

      Parameters

      • otherPublicKey: string
      • selfKeypair: KeyPair

      Returns Promise<SessionKeys>

    • Returns undefined | Struct

    • Encrypt a message for a specific publicKey (receiver, asymmetric)

      Parameters

      • recipientPublicKey: string
      • message: string

      Returns Promise<string>

    • Returns Promise<string>

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

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

    • Returns string[]

      Return all connected accounts from the active session

      NotConnected if no active session

    • Returns string

      Access the active network

      ActiveNetworkUnspecified thorwn when there are multiple Tezos networks in the session and none is set as the active one

    • Returns string[]

      Return all networks from the namespace of the active session

      NotConnected if no active session

    • Get the public key

      Returns Promise<string>

    • get the public key hash

      Returns Promise<string>

    • Parameters

      • OptionalforceNewConnection: boolean

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

    • Parameters

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • _message: string
      • Optional_peer: any

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

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

      MissingRequiredScope is thrown if permission to send operation was not granted

    • Parameters

      Returns Promise<void>

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

      MissingRequiredScope is thrown if permission to sign payload was not granted

    • Parameters

      • _senderPublicKey: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods