Class PeerManager<T>

Internalapi

The PeerManager provides CRUD functionality for peer entities and persists them to the provided storage.

Type Parameters

T extends
    | TRANSPORT_P2P_PEERS_DAPP
    | TRANSPORT_P2P_PEERS_WALLET
    | TRANSPORT_POSTMESSAGE_PEERS_DAPP
    | TRANSPORT_POSTMESSAGE_PEERS_WALLET
    | TRANSPORT_WALLETCONNECT_PEERS_DAPP

Index

Constructors

Methods

addPeer getPeer getPeers hasPeer removeAllPeers removePeer removePeers

Constructors

constructor

new PeerManager<
    T extends
        | TRANSPORT_P2P_PEERS_DAPP
        | TRANSPORT_P2P_PEERS_WALLET
        | TRANSPORT_POSTMESSAGE_PEERS_DAPP
        | TRANSPORT_POSTMESSAGE_PEERS_WALLET
        | TRANSPORT_WALLETCONNECT_PEERS_DAPP,
>(
    storage: Storage,
    key: T,
): PeerManager<T>
Type Parameters
- T extends
      | TRANSPORT_P2P_PEERS_DAPP
      | TRANSPORT_P2P_PEERS_WALLET
      | TRANSPORT_POSTMESSAGE_PEERS_DAPP
      | TRANSPORT_POSTMESSAGE_PEERS_WALLET
      | TRANSPORT_WALLETCONNECT_PEERS_DAPP
Parameters
- storage: Storage
- key: T
Returns PeerManager<T>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:10

Methods

addPeer

addPeer(peerInfo: ArrayElem<StorageKeyReturnType[T]>): Promise<void>
Parameters
- peerInfo: ArrayElem<StorageKeyReturnType[T]>
Returns Promise<void>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:14

getPeer

getPeer(
publicKey: string,
): Promise<undefined | ArrayElem<StorageKeyReturnType[T]>>
Parameters
- publicKey: string
Returns Promise<undefined | ArrayElem<StorageKeyReturnType[T]>>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:13

getPeers

getPeers(): Promise<StorageKeyReturnType[T]>
Returns Promise<StorageKeyReturnType[T]>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:12

hasPeer

hasPeer(publicKey: string): Promise<boolean>
Parameters
- publicKey: string
Returns Promise<boolean>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:11

removeAllPeers

removeAllPeers(): Promise<void>
Returns Promise<void>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:17

removePeer

removePeer(publicKey: string): Promise<void>
Parameters
- publicKey: string
Returns Promise<void>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:15

removePeers

removePeers(publicKeys: string[]): Promise<void>
Parameters
- publicKeys: string[]
Returns Promise<void>
- Defined in beacon-core/dist/esm/managers/PeerManager.d.ts:16