Class WalletConnectTransport<T, K>

Internalapi

Type Parameters

T extends WalletConnectPairingRequest | ExtendedWalletConnectPairingResponse
K extends TRANSPORT_WALLETCONNECT_PEERS_DAPP

Hierarchy

Transport<T, K, WalletConnectCommunicationClient>
- WalletConnectTransport

Constructors

constructor

new WalletConnectTransport<T, K>(name, _keyPair, storage, storageKey, wcOptions): WalletConnectTransport<T, K>
Type Parameters
- T extends ExtendedWalletConnectPairingResponse | WalletConnectPairingRequest
- K extends TRANSPORT_WALLETCONNECT_PEERS_DAPP
Parameters
- name: string
- _keyPair: KeyPair
- storage: Storage
- storageKey: K
- wcOptions: {
  network: NetworkType;
  opts: Options;
  }
  - network: NetworkType
  - opts: Options
Returns WalletConnectTransport<T, K>
Overrides Transport.constructor
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:14

Properties

`Protected` _isConnected

_isConnected: TransportStatus

The status of the transport

`Protected` client

client: WalletConnectCommunicationClient

The client handling the encryption/decryption of messages

`Protected` `Readonly` name

name: string

The name of the app

`Protected` `Optional` newPeerListener

newPeerListener?: ((peer) => void)

Type declaration

- (peer): void
- The listener that will be invoked when a new peer is connected
  Parameters
  - peer: T
  Returns void

`Protected` `Readonly` peerManager

peerManager: PeerManager<K>

`Readonly` type

type: TransportType

The type of the transport

`Private` wcOptions

wcOptions: any

Accessors

connectionStatus

get connectionStatus(): TransportStatus
Return the status of the connection

Returns TransportStatus
Inherited from Transport.connectionStatus
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:40

Methods

addListener

addListener(listener): Promise<void>
Add a listener to be called when a new message is received
Parameters
- listener: ((message, connectionInfo) => void)
  
  The listener that will be registered
  - - (message, connectionInfo): void
    - Parameters
      
      message: unknown
      
      connectionInfo: ConnectionContext
      
      Returns void
Returns Promise<void>
Inherited from Transport.addListener
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:66

addPeer

addPeer(newPeer, _sendPairingResponse?): Promise<void>
Parameters
- newPeer: T
- Optional _sendPairingResponse: boolean
Returns Promise<void>
Inherited from Transport.addPeer
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:74

connect

connect(): Promise<void>
Connect the transport

Returns Promise<void>
Overrides Transport.connect
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:19

disconnect

disconnect(): Promise<void>
Disconnect the transport

Returns Promise<void>
Overrides Transport.disconnect
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:30

doClientCleanup

doClientCleanup(): Promise<void>
Returns Promise<void>
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:32

forceUpdate

forceUpdate(type): void
Forcefully updates any DApps running on the same session Typical use case: localStorage changes to reflect to indexDB
Parameters
- type: string
  
  the message type
Returns void
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:28

getPairingRequestInfo

getPairingRequestInfo(): Promise<any>
Returns Promise<any>
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:33

getPeers

getPeers(): Promise<T[]>
Returns Promise<T[]>
Overrides Transport.getPeers
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:29

hasPairings

hasPairings(): Promise<boolean>
Returns Promise<boolean>
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:21

hasSessions

hasSessions(): Promise<boolean>
Returns Promise<boolean>
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:22

listen

listen(publicKey): Promise<void>
Parameters
- publicKey: string
Returns Promise<void>
Overrides Transport.listen
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:34

`Protected` notifyListeners

notifyListeners(message, connectionInfo): Promise<void>
Notify the listeners when a new message comes in
Parameters
- message: unknown
  
  Message
- connectionInfo: ConnectionContext
  
  Context info about the connection
Returns Promise<void>
Inherited from Transport.notifyListeners
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:83

removeAllPeers

removeAllPeers(): Promise<void>
Returns Promise<void>
Inherited from Transport.removeAllPeers
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:76

removeListener

removeListener(listener): Promise<void>
Remove a listener
Parameters
- listener: ((message, connectionInfo) => void)
  - - (message, connectionInfo): void
    - Parameters
      
      message: string
      
      connectionInfo: ConnectionContext
      
      Returns void
Returns Promise<void>
Inherited from Transport.removeListener
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:72

removePeer

removePeer(peerToBeRemoved): Promise<void>
Parameters
- peerToBeRemoved: T
Returns Promise<void>
Inherited from Transport.removePeer
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:75

send

send(message, peer?): Promise<void>
Send a message through the transport
Parameters
- message: string
  
  The message to send
- Optional peer: PeerInfo
Returns Promise<void>
Inherited from Transport.send
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:60

setEventHandler

setEventHandler(event, fun): void
Parameters
- event: ClientEvents
- fun: Function
Returns void
Inherited from Transport.setEventHandler
- Defined in mavlet-core/dist/esm/transports/Transport.d.ts:32

startOpenChannelListener

startOpenChannelListener(): Promise<void>
Returns Promise<void>
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:31

wasDisconnectedByWallet

wasDisconnectedByWallet(): boolean
Returns boolean
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:20

`Static` isAvailable

isAvailable(): Promise<boolean>
Returns a promise that resolves to true if the transport is available, false if it is not

Returns Promise<boolean>
Overrides Transport.isAvailable
- Defined in mavlet-transport-walletconnect/dist/esm/WalletConnectTransport.d.ts:18

Class WalletConnectTransport<T, K>

Internalapi

Type Parameters

T extends WalletConnectPairingRequest | ExtendedWalletConnectPairingResponse

K extends TRANSPORT_WALLETCONNECT_PEERS_DAPP

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ExtendedWalletConnectPairingResponse | WalletConnectPairingRequest

K extends TRANSPORT_WALLETCONNECT_PEERS_DAPP

Parameters

name: string

_keyPair: KeyPair

storage: Storage

storageKey: K

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

network: NetworkType

opts: Options

Returns WalletConnectTransport<T, K>

Properties

Protected _isConnected

Protected client

Protected Readonly name

Protected Optional newPeerListener

Type declaration

Parameters

peer: T

Returns void

Protected Readonly peerManager

Readonly type

Private wcOptions

Accessors

connectionStatus

Returns TransportStatus

Methods

addListener

Parameters

listener: ((message, connectionInfo) => void)

Parameters

message: unknown

connectionInfo: ConnectionContext

Returns void

Returns Promise<void>

addPeer

Parameters

newPeer: T

Optional _sendPairingResponse: boolean

Returns Promise<void>

connect

Returns Promise<void>

disconnect

Returns Promise<void>

doClientCleanup

Returns Promise<void>

forceUpdate

Parameters

type: string

Returns void

getPairingRequestInfo

Returns Promise<any>

getPeers

Returns Promise<T[]>

hasPairings

Returns Promise<boolean>

hasSessions

Returns Promise<boolean>

listen

Parameters

publicKey: string

Returns Promise<void>

Protected notifyListeners

Parameters

message: unknown

connectionInfo: ConnectionContext

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

`Protected` _isConnected

`Protected` client

`Protected` `Readonly` name

`Protected` `Optional` newPeerListener

`Protected` `Readonly` peerManager

`Readonly` type

`Private` wcOptions

`Optional` _sendPairingResponse: boolean

`Protected` notifyListeners

`Optional` peer: PeerInfo

`Static` isAvailable