mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
62 lines
1.7 KiB
Python
62 lines
1.7 KiB
Python
from abc import (
|
|
ABC,
|
|
abstractmethod,
|
|
)
|
|
from collections.abc import (
|
|
Sequence,
|
|
)
|
|
|
|
from multiaddr import (
|
|
Multiaddr,
|
|
)
|
|
|
|
from .id import (
|
|
ID,
|
|
)
|
|
|
|
|
|
class IAddrBook(ABC):
|
|
@abstractmethod
|
|
def add_addr(self, peer_id: ID, addr: Multiaddr, ttl: int) -> None:
|
|
"""
|
|
Calls add_addrs(peer_id, [addr], ttl)
|
|
|
|
:param peer_id: the peer to add address for
|
|
:param addr: multiaddress of the peer
|
|
:param ttl: time-to-live for the address (after this time, address is no longer valid)
|
|
""" # noqa: E501
|
|
|
|
@abstractmethod
|
|
def add_addrs(self, peer_id: ID, addrs: Sequence[Multiaddr], ttl: int) -> None:
|
|
"""
|
|
Adds addresses for a given peer all with the same time-to-live. If one
|
|
of the addresses already exists for the peer and has a longer TTL, no
|
|
operation should take place. If one of the addresses exists with a
|
|
shorter TTL, extend the TTL to equal param ttl.
|
|
|
|
:param peer_id: the peer to add address for
|
|
:param addr: multiaddresses of the peer
|
|
:param ttl: time-to-live for the address (after this time, address is no longer valid
|
|
""" # noqa: E501
|
|
|
|
@abstractmethod
|
|
def addrs(self, peer_id: ID) -> list[Multiaddr]:
|
|
"""
|
|
:param peer_id: peer to get addresses of
|
|
:return: all known (and valid) addresses for the given peer
|
|
"""
|
|
|
|
@abstractmethod
|
|
def clear_addrs(self, peer_id: ID) -> None:
|
|
"""
|
|
Removes all previously stored addresses.
|
|
|
|
:param peer_id: peer to remove addresses of
|
|
"""
|
|
|
|
@abstractmethod
|
|
def peers_with_addrs(self) -> list[ID]:
|
|
"""
|
|
:return: all of the peer IDs stored with addresses
|
|
"""
|