jam.types.protocol.history module

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

Bases: Vector[Choice]

static decode_from(buffer: bytes | bytearray | memoryview, offset: int = 0) → Tuple[Vector[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

class jam.types.protocol.history.ReportedWorkPackage(hash: ByteArray32, exports_root: ByteArray32)[source]

Bases: Codable, JsonSerde

Reported work package structure.

hash: ByteArray32
exports_root: ByteArray32
__init__(hash: ByteArray32, exports_root: ByteArray32) → 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.history.BlockInfo(header_hash: ByteArray32, mmr: Mmr, state_root: ByteArray32, reported: List[ReportedWorkPackage])[source]

Bases: Codable, JsonSerde

Block information structure.

header_hash: ByteArray32
mmr: Mmr
state_root: ByteArray32
reported: List[ReportedWorkPackage]
__init__(header_hash: ByteArray32, mmr: Mmr, state_root: ByteArray32, reported: List[ReportedWorkPackage]) → 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.history.BlocksHistory(initial: Sequence[T] = [], codec: Codec[T] | None = None)[source]

Bases: Array[BlockInfo]

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