jam.types.extrinsics.guarantees module

Guarantee-related extrinsic types for the JAM protocol.

class jam.types.extrinsics.guarantees.ValidatorSignature(validator_index: U16, signature: ByteArray64)[source]

Bases: Codable, JsonSerde

Validator signature structure.

validator_index: U16
signature: ByteArray64
__init__(validator_index: U16, signature: ByteArray64) → 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.extrinsics.guarantees.ValidatorSignatures(initial: Sequence[T] = [], codec: Codec[T] | None = None)[source]

Bases: Vector[ValidatorSignature]

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.extrinsics.guarantees.ReportGuarantee(report: WorkReport, slot: U32, signatures: ValidatorSignatures)[source]

Bases: Codable, JsonSerde

Report guarantee structure.

report: WorkReport
slot: U32
signatures: ValidatorSignatures
__init__(report: WorkReport, slot: U32, signatures: ValidatorSignatures) → 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.extrinsics.guarantees.GuaranteesExtrinsic(initial: Sequence[T] = [], codec: Codec[T] | None = None)[source]

Bases: Vector[ReportGuarantee]

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