jam.types.protocol.validators module

class jam.types.protocol.validators.ValidatorArray(initial: Sequence[T] = [], codec: Codec[T] | None = None)[source]

Bases: Array[ByteArray32]

static decode_from(buffer: bytes | bytearray | memoryview, offset: int = 0) → Tuple[Any, int]

Decode from buffer. Must be implemented by subclasses or added via decorator.

Parameters:

  • buffer – Buffer to decode from

  • offset – Starting position in buffer

Returns:

  • The decoded value

  • Number of bytes read

Return type:

Tuple containing

class jam.types.protocol.validators.ValidatorMetadata(value: int | bool | bytes | str | bytearray | memoryview | Sequence)[source]

Bases: ByteArray128

Validator metadata structure.

class jam.types.protocol.validators.ValidatorData(bandersnatch: ByteArray32, ed25519: ByteArray32, bls: ByteArray144, metadata: ValidatorMetadata)[source]

Bases: Codable, JsonSerde

Validator data structure.

bandersnatch: ByteArray32
ed25519: ByteArray32
bls: ByteArray144
metadata: ValidatorMetadata
__init__(bandersnatch: ByteArray32, ed25519: ByteArray32, bls: ByteArray144, metadata: ValidatorMetadata) → None

Initialize the Codable.

Parameters:

  • codec – Optional codec to use for encoding/decoding

  • enc_sequence – Optional function that returns sequence of fields to encode

static decode_from(buffer: bytes | bytearray | memoryview, offset: int = 0) → Tuple[T, int]

Decode from buffer. Must be implemented by subclasses or added via decorator.

Parameters:

  • buffer – Buffer to decode from

  • offset – Starting position in buffer

Returns:

  • The decoded value

  • Number of bytes read

Return type:

Tuple containing

encode_into(buffer: bytearray, offset: int = 0) → int

Encode into provided buffer.

encode_size() → int

Calculate number of bytes needed to encode.

class jam.types.protocol.validators.ValidatorsData(initial: Sequence[T] = [], codec: Codec[T] | None = None)[source]

Bases: Array[ValidatorData]

static decode_from(buffer: bytes | bytearray | memoryview, offset: int = 0) → Tuple[Any, int]

Decode from buffer. Must be implemented by subclasses or added via decorator.

Parameters:

  • buffer – Buffer to decode from

  • offset – Starting position in buffer

Returns:

  • The decoded value

  • Number of bytes read

Return type:

Tuple containing