Relays

class cometa.pool_params.relays.Relays(ptr)

Bases: object

Represents a collection of relays for a Cardano stake pool.

This class provides a list-like interface for managing pool relays, supporting iteration, indexing, and standard list operations.

__init__(ptr)

Return type:

None

__enter__()

Return type:

Relays

__exit__(exc_type, exc_val, exc_tb)

Return type:

None

__repr__()

Return repr(self).

Return type:

str

__len__()

Return type:

int

__getitem__(index: int) → Relay

__getitem__(index: slice) → List[Relay]

__iter__()

Return type:

Iterator[Relay]

__contains__(item)

Parameters:

item (object)

Return type:

bool

classmethod new()

Creates a new empty Relays collection.

Returns:

A new empty Relays instance.

Raises:

CardanoError – If creation fails.

Return type:

Relays

classmethod from_cbor(reader)

Deserializes a Relays collection from CBOR data.

Parameters:

reader (CborReader) – A CborReader positioned at the relays data.

Returns:

A new Relays deserialized from the CBOR data.

Raises:

CardanoError – If deserialization fails.

Return type:

Relays

to_cbor(writer)

Serializes the relays collection to CBOR format.

Parameters:

writer (CborWriter) – A CborWriter to write the serialized data to.

Raises:

CardanoError – If serialization fails.

Return type:

None

add(relay)

Adds a relay to the collection.

Parameters:

relay (Relay | SingleHostAddrRelay | SingleHostNameRelay | MultiHostNameRelay) – The relay to add. Can be a Relay or any specific relay type.

Raises:

CardanoError – If adding fails.

Return type:

None

append(relay)

Appends a relay to the collection (alias for add).

Parameters:

relay (Relay | SingleHostAddrRelay | SingleHostNameRelay | MultiHostNameRelay) – The relay to append. Can be a Relay or any specific relay type.

Raises:

CardanoError – If appending fails.

Return type:

None

extend(relays)

Extends the collection with relays from another collection or list.

Parameters:

relays (Relays | List[Relay | SingleHostAddrRelay | SingleHostNameRelay | MultiHostNameRelay]) – Another Relays collection or a list of relay-like objects.

Raises:

CardanoError – If extending fails.

Return type:

None

to_cip116_json(writer)

Serializes this relays collection to CIP-116 compliant JSON.

Parameters:

writer (JsonWriter) – The JsonWriter to write the JSON to.

Raises:

CardanoError – If serialization fails.

Return type:

None