mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-12 16:10:57 +00:00
Feat/587-circuit-relay (#611)
* feat: implemented setup of circuit relay and test cases * chore: remove test files to be rewritten * added 1 test suite for protocol * added 1 test suite for discovery * fixed protocol timeouts and message types to handle reservations and stream operations. * Resolved merge conflict in libp2p/tools/utils.py by combining timeout approach with retry mechanism * fix: linting issues * docs: updated documentation with circuit-relay * chore: added enums, improved typing, security and examples * fix: created proper __init__ file to ensure importability * fix: replace transport_opt with listen_addrs in examples, fixed typing and improved code * fix type checking issues across relay module and test suite * regenerated circuit_pb2 file protobuf version 3 * fixed circuit relay example and moved imports to top in test_security_multistream * chore: moved imports to the top * chore: fixed linting of test_circuit_v2_transport.py --------- Co-authored-by: Manu Sheel Gupta <manusheel.edu@gmail.com>
This commit is contained in:
Soham Bhoir
16
libp2p/relay/circuit_v2/pb/__init__.py
Normal file
16
libp2p/relay/circuit_v2/pb/__init__.py
Normal file
@ -0,0 +1,16 @@
|
||||
"""
|
||||
Protocol buffer package for circuit_v2.
|
||||
|
||||
Contains generated protobuf code for circuit_v2 relay protocol.
|
||||
"""
|
||||
|
||||
# Import the classes to be accessible directly from the package
|
||||
from .circuit_pb2 import (
|
||||
HopMessage,
|
||||
Limit,
|
||||
Reservation,
|
||||
Status,
|
||||
StopMessage,
|
||||
)
|
||||
|
||||
__all__ = ["HopMessage", "Limit", "Reservation", "Status", "StopMessage"]
|
||||
55
libp2p/relay/circuit_v2/pb/circuit.proto
Normal file
55
libp2p/relay/circuit_v2/pb/circuit.proto
Normal file
@ -0,0 +1,55 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package circuit.pb.v2;
|
||||
|
||||
// Circuit v2 message types
|
||||
message HopMessage {
|
||||
enum Type {
|
||||
RESERVE = 0;
|
||||
CONNECT = 1;
|
||||
STATUS = 2;
|
||||
}
|
||||
|
||||
Type type = 1;
|
||||
bytes peer = 2;
|
||||
Reservation reservation = 3;
|
||||
Limit limit = 4;
|
||||
Status status = 5;
|
||||
}
|
||||
|
||||
message StopMessage {
|
||||
enum Type {
|
||||
CONNECT = 0;
|
||||
STATUS = 1;
|
||||
}
|
||||
|
||||
Type type = 1;
|
||||
bytes peer = 2;
|
||||
Status status = 3;
|
||||
}
|
||||
|
||||
message Reservation {
|
||||
bytes voucher = 1;
|
||||
bytes signature = 2;
|
||||
int64 expire = 3;
|
||||
}
|
||||
|
||||
message Limit {
|
||||
int64 duration = 1;
|
||||
int64 data = 2;
|
||||
}
|
||||
|
||||
message Status {
|
||||
enum Code {
|
||||
OK = 0;
|
||||
RESERVATION_REFUSED = 100;
|
||||
RESOURCE_LIMIT_EXCEEDED = 101;
|
||||
PERMISSION_DENIED = 102;
|
||||
CONNECTION_FAILED = 200;
|
||||
DIAL_REFUSED = 201;
|
||||
STOP_FAILED = 300;
|
||||
MALFORMED_MESSAGE = 400;
|
||||
}
|
||||
Code code = 1;
|
||||
string message = 2;
|
||||
}
|
||||
37
libp2p/relay/circuit_v2/pb/circuit_pb2.py
Normal file
37
libp2p/relay/circuit_v2/pb/circuit_pb2.py
Normal file
@ -0,0 +1,37 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# NO CHECKED-IN PROTOBUF GENCODE
|
||||
# source: libp2p/relay/circuit_v2/pb/circuit.proto
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf.internal import builder as _builder
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n(libp2p/relay/circuit_v2/pb/circuit.proto\x12\rcircuit.pb.v2\"\xf3\x01\n\nHopMessage\x12,\n\x04type\x18\x01 \x01(\x0e\x32\x1e.circuit.pb.v2.HopMessage.Type\x12\x0c\n\x04peer\x18\x02 \x01(\x0c\x12/\n\x0breservation\x18\x03 \x01(\x0b\x32\x1a.circuit.pb.v2.Reservation\x12#\n\x05limit\x18\x04 \x01(\x0b\x32\x14.circuit.pb.v2.Limit\x12%\n\x06status\x18\x05 \x01(\x0b\x32\x15.circuit.pb.v2.Status\",\n\x04Type\x12\x0b\n\x07RESERVE\x10\x00\x12\x0b\n\x07\x43ONNECT\x10\x01\x12\n\n\x06STATUS\x10\x02\"\x92\x01\n\x0bStopMessage\x12-\n\x04type\x18\x01 \x01(\x0e\x32\x1f.circuit.pb.v2.StopMessage.Type\x12\x0c\n\x04peer\x18\x02 \x01(\x0c\x12%\n\x06status\x18\x03 \x01(\x0b\x32\x15.circuit.pb.v2.Status\"\x1f\n\x04Type\x12\x0b\n\x07\x43ONNECT\x10\x00\x12\n\n\x06STATUS\x10\x01\"A\n\x0bReservation\x12\x0f\n\x07voucher\x18\x01 \x01(\x0c\x12\x11\n\tsignature\x18\x02 \x01(\x0c\x12\x0e\n\x06\x65xpire\x18\x03 \x01(\x03\"\'\n\x05Limit\x12\x10\n\x08\x64uration\x18\x01 \x01(\x03\x12\x0c\n\x04\x64\x61ta\x18\x02 \x01(\x03\"\xf6\x01\n\x06Status\x12(\n\x04\x63ode\x18\x01 \x01(\x0e\x32\x1a.circuit.pb.v2.Status.Code\x12\x0f\n\x07message\x18\x02 \x01(\t\"\xb0\x01\n\x04\x43ode\x12\x06\n\x02OK\x10\x00\x12\x17\n\x13RESERVATION_REFUSED\x10\x64\x12\x1b\n\x17RESOURCE_LIMIT_EXCEEDED\x10\x65\x12\x15\n\x11PERMISSION_DENIED\x10\x66\x12\x16\n\x11\x43ONNECTION_FAILED\x10\xc8\x01\x12\x11\n\x0c\x44IAL_REFUSED\x10\xc9\x01\x12\x10\n\x0bSTOP_FAILED\x10\xac\x02\x12\x16\n\x11MALFORMED_MESSAGE\x10\x90\x03\x62\x06proto3')
|
||||
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'libp2p.relay.circuit_v2.pb.circuit_pb2', globals())
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
DESCRIPTOR._options = None
|
||||
_HOPMESSAGE._serialized_start=60
|
||||
_HOPMESSAGE._serialized_end=303
|
||||
_HOPMESSAGE_TYPE._serialized_start=259
|
||||
_HOPMESSAGE_TYPE._serialized_end=303
|
||||
_STOPMESSAGE._serialized_start=306
|
||||
_STOPMESSAGE._serialized_end=452
|
||||
_STOPMESSAGE_TYPE._serialized_start=421
|
||||
_STOPMESSAGE_TYPE._serialized_end=452
|
||||
_RESERVATION._serialized_start=454
|
||||
_RESERVATION._serialized_end=519
|
||||
_LIMIT._serialized_start=521
|
||||
_LIMIT._serialized_end=560
|
||||
_STATUS._serialized_start=563
|
||||
_STATUS._serialized_end=809
|
||||
_STATUS_CODE._serialized_start=633
|
||||
_STATUS_CODE._serialized_end=809
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
184
libp2p/relay/circuit_v2/pb/circuit_pb2.pyi
Normal file
184
libp2p/relay/circuit_v2/pb/circuit_pb2.pyi
Normal file
@ -0,0 +1,184 @@
|
||||
"""
|
||||
@generated by mypy-protobuf. Do not edit manually!
|
||||
isort:skip_file
|
||||
"""
|
||||
|
||||
import builtins
|
||||
import google.protobuf.descriptor
|
||||
import google.protobuf.internal.enum_type_wrapper
|
||||
import google.protobuf.message
|
||||
import sys
|
||||
import typing
|
||||
|
||||
if sys.version_info >= (3, 10):
|
||||
import typing as typing_extensions
|
||||
else:
|
||||
import typing_extensions
|
||||
|
||||
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
|
||||
|
||||
@typing.final
|
||||
class HopMessage(google.protobuf.message.Message):
|
||||
"""Circuit v2 message types"""
|
||||
|
||||
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
||||
|
||||
class _Type:
|
||||
ValueType = typing.NewType("ValueType", builtins.int)
|
||||
V: typing_extensions.TypeAlias = ValueType
|
||||
|
||||
class _TypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[HopMessage._Type.ValueType], builtins.type):
|
||||
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
||||
RESERVE: HopMessage._Type.ValueType # 0
|
||||
CONNECT: HopMessage._Type.ValueType # 1
|
||||
STATUS: HopMessage._Type.ValueType # 2
|
||||
|
||||
class Type(_Type, metaclass=_TypeEnumTypeWrapper): ...
|
||||
RESERVE: HopMessage.Type.ValueType # 0
|
||||
CONNECT: HopMessage.Type.ValueType # 1
|
||||
STATUS: HopMessage.Type.ValueType # 2
|
||||
|
||||
TYPE_FIELD_NUMBER: builtins.int
|
||||
PEER_FIELD_NUMBER: builtins.int
|
||||
RESERVATION_FIELD_NUMBER: builtins.int
|
||||
LIMIT_FIELD_NUMBER: builtins.int
|
||||
STATUS_FIELD_NUMBER: builtins.int
|
||||
type: global___HopMessage.Type.ValueType
|
||||
peer: builtins.bytes
|
||||
@property
|
||||
def reservation(self) -> global___Reservation: ...
|
||||
@property
|
||||
def limit(self) -> global___Limit: ...
|
||||
@property
|
||||
def status(self) -> global___Status: ...
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
type: global___HopMessage.Type.ValueType = ...,
|
||||
peer: builtins.bytes = ...,
|
||||
reservation: global___Reservation | None = ...,
|
||||
limit: global___Limit | None = ...,
|
||||
status: global___Status | None = ...,
|
||||
) -> None: ...
|
||||
def HasField(self, field_name: typing.Literal["limit", b"limit", "reservation", b"reservation", "status", b"status"]) -> builtins.bool: ...
|
||||
def ClearField(self, field_name: typing.Literal["limit", b"limit", "peer", b"peer", "reservation", b"reservation", "status", b"status", "type", b"type"]) -> None: ...
|
||||
|
||||
global___HopMessage = HopMessage
|
||||
|
||||
@typing.final
|
||||
class StopMessage(google.protobuf.message.Message):
|
||||
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
||||
|
||||
class _Type:
|
||||
ValueType = typing.NewType("ValueType", builtins.int)
|
||||
V: typing_extensions.TypeAlias = ValueType
|
||||
|
||||
class _TypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[StopMessage._Type.ValueType], builtins.type):
|
||||
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
||||
CONNECT: StopMessage._Type.ValueType # 0
|
||||
STATUS: StopMessage._Type.ValueType # 1
|
||||
|
||||
class Type(_Type, metaclass=_TypeEnumTypeWrapper): ...
|
||||
CONNECT: StopMessage.Type.ValueType # 0
|
||||
STATUS: StopMessage.Type.ValueType # 1
|
||||
|
||||
TYPE_FIELD_NUMBER: builtins.int
|
||||
PEER_FIELD_NUMBER: builtins.int
|
||||
STATUS_FIELD_NUMBER: builtins.int
|
||||
type: global___StopMessage.Type.ValueType
|
||||
peer: builtins.bytes
|
||||
@property
|
||||
def status(self) -> global___Status: ...
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
type: global___StopMessage.Type.ValueType = ...,
|
||||
peer: builtins.bytes = ...,
|
||||
status: global___Status | None = ...,
|
||||
) -> None: ...
|
||||
def HasField(self, field_name: typing.Literal["status", b"status"]) -> builtins.bool: ...
|
||||
def ClearField(self, field_name: typing.Literal["peer", b"peer", "status", b"status", "type", b"type"]) -> None: ...
|
||||
|
||||
global___StopMessage = StopMessage
|
||||
|
||||
@typing.final
|
||||
class Reservation(google.protobuf.message.Message):
|
||||
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
||||
|
||||
VOUCHER_FIELD_NUMBER: builtins.int
|
||||
SIGNATURE_FIELD_NUMBER: builtins.int
|
||||
EXPIRE_FIELD_NUMBER: builtins.int
|
||||
voucher: builtins.bytes
|
||||
signature: builtins.bytes
|
||||
expire: builtins.int
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
voucher: builtins.bytes = ...,
|
||||
signature: builtins.bytes = ...,
|
||||
expire: builtins.int = ...,
|
||||
) -> None: ...
|
||||
def ClearField(self, field_name: typing.Literal["expire", b"expire", "signature", b"signature", "voucher", b"voucher"]) -> None: ...
|
||||
|
||||
global___Reservation = Reservation
|
||||
|
||||
@typing.final
|
||||
class Limit(google.protobuf.message.Message):
|
||||
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
||||
|
||||
DURATION_FIELD_NUMBER: builtins.int
|
||||
DATA_FIELD_NUMBER: builtins.int
|
||||
duration: builtins.int
|
||||
data: builtins.int
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
duration: builtins.int = ...,
|
||||
data: builtins.int = ...,
|
||||
) -> None: ...
|
||||
def ClearField(self, field_name: typing.Literal["data", b"data", "duration", b"duration"]) -> None: ...
|
||||
|
||||
global___Limit = Limit
|
||||
|
||||
@typing.final
|
||||
class Status(google.protobuf.message.Message):
|
||||
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
||||
|
||||
class _Code:
|
||||
ValueType = typing.NewType("ValueType", builtins.int)
|
||||
V: typing_extensions.TypeAlias = ValueType
|
||||
|
||||
class _CodeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[Status._Code.ValueType], builtins.type):
|
||||
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
||||
OK: Status._Code.ValueType # 0
|
||||
RESERVATION_REFUSED: Status._Code.ValueType # 100
|
||||
RESOURCE_LIMIT_EXCEEDED: Status._Code.ValueType # 101
|
||||
PERMISSION_DENIED: Status._Code.ValueType # 102
|
||||
CONNECTION_FAILED: Status._Code.ValueType # 200
|
||||
DIAL_REFUSED: Status._Code.ValueType # 201
|
||||
STOP_FAILED: Status._Code.ValueType # 300
|
||||
MALFORMED_MESSAGE: Status._Code.ValueType # 400
|
||||
|
||||
class Code(_Code, metaclass=_CodeEnumTypeWrapper): ...
|
||||
OK: Status.Code.ValueType # 0
|
||||
RESERVATION_REFUSED: Status.Code.ValueType # 100
|
||||
RESOURCE_LIMIT_EXCEEDED: Status.Code.ValueType # 101
|
||||
PERMISSION_DENIED: Status.Code.ValueType # 102
|
||||
CONNECTION_FAILED: Status.Code.ValueType # 200
|
||||
DIAL_REFUSED: Status.Code.ValueType # 201
|
||||
STOP_FAILED: Status.Code.ValueType # 300
|
||||
MALFORMED_MESSAGE: Status.Code.ValueType # 400
|
||||
|
||||
CODE_FIELD_NUMBER: builtins.int
|
||||
MESSAGE_FIELD_NUMBER: builtins.int
|
||||
code: global___Status.Code.ValueType
|
||||
message: builtins.str
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
code: global___Status.Code.ValueType = ...,
|
||||
message: builtins.str = ...,
|
||||
) -> None: ...
|
||||
def ClearField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> None: ...
|
||||
|
||||
global___Status = Status
|
||||
Reference in New Issue
Block a user