Statistics (π)

Bases: StateComponent

Source code in pyjamaz/state/components.py

class Statistics(StateComponent):
    component_id = 13

    @log_execution_time
    def state_transition(
            self,
            extrinsic_guarantees: List[Guarantee],
            extrinsic_preimages: List[Preimage],
            extrinsic_assurances: List[Assurance],
            extrinsic_tickets: List[TicketEnvelope],
            pre_state_timeslot: TimeslotState,
            post_state_timeslot: TimeslotState,
            post_state_validator_pool: ValidatorPoolState,
            pre_state_statistics: StatisticsState,
            header: Header
    ) -> StatisticsOutput:
        """
        GP-0.7.2-eq:13.4,13.5,13.8,13.12 (π') | State transition function for the state's statistics.

        Parameters
        ----------
        extrinsic_guarantees: List[Guarantee]
            GP-0.7.2-eq:4.20 (bold_E_G)
        extrinsic_preimages: List[Preimage]
            GP-0.7.2-eq:4.20 (bold_E_P)
        extrinsic_assurances: List[Assurance]
            GP-0.7.2-eq:4.20 (bold_E_A)
        extrinsic_tickets: List[TicketEnvelope]
            GP-0.7.2-eq:4.20 (bold_E_T)
        pre_state_timeslot: TimeslotState
            GP-0.7.2-eq:4.20 (τ)
        post_state_timeslot: TimeslotState
            GP-0.7.2-eq:4.20 (τ')
        post_state_validator_pool: ValidatorPoolState
            GP-0.7.2-eq:4.20 (κ')
        pre_state_statistics: StatisticsState
            GP-0.7.2-eq:4.20 (π)
        header: Header
            GP-0.7.2-eq:4.20 (bold_H)

        Returns
        -------
        StatisticsOutput
            Output containing: Posterior state of StatisticsState (π')
        """
        # TODO: check input parameters: remove tau_prime and add bold_S

        post_state = deepcopy(pre_state_statistics)

        # GP-0.7.2-eq:13.4 | Shift statistics after epoch change
        if self.is_epoch_change(pre_state_timeslot.number, header.timeslot):
            post_state.vals_last = post_state.vals_current
            post_state.vals_current = [ActivityRecord(
                blocks=0,
                tickets=0,
                pre_images=0,
                pre_images_size=0,
                guarantees=0,
                assurances=0
            ) for _ in range(gp_const.VALIDATOR_COUNT)]

        # GP-0.7.2-eq:13.5 | Update validator stats
        post_state.vals_current[header.author_index].blocks += 1
        post_state.vals_current[header.author_index].tickets += len(extrinsic_tickets)
        post_state.vals_current[header.author_index].pre_images += len(extrinsic_preimages)
        post_state.vals_current[header.author_index].pre_images_size += sum([len(p.blob) for p in extrinsic_preimages])

        for assurance in extrinsic_assurances:
            post_state.vals_current[assurance.validator_index].assurances += 1

        for reporter in self.block_context.reporters:
            val_index = self.retrieve_validator_index(reporter, post_state_validator_pool)
            if val_index is not None:
                post_state.vals_current[val_index].guarantees += 1

        incoming_work_reports = [g.report for g in extrinsic_guarantees]

        # GP-0.7.2-eq:13.8 | Update core statistics
        for c in range(gp_const.CORE_COUNT):
            post_state.cores[c].update(
                core_index=c,
                incoming_work_reports=incoming_work_reports,
                available_work_reports=self.block_context.available_work_reports,
                extrinsic_assurances=extrinsic_assurances
            )

        post_state.services = {}

        # GP-0.7.2-eq:13.12 | Determine affected services
        services = [r.service_id for w in incoming_work_reports for r in w.results]
        services += [p.requester for p in extrinsic_preimages]
        services += self.block_context.accumulation_statistics.keys()

        # GP-0.7.2-eq:13.7 | Update service statistics
        for s in sorted(set(services)):
            activity_record = ServiceActivityRecord()
            for p in extrinsic_preimages:
                if p.requester == s:
                    activity_record.provided_count += 1
                    activity_record.provided_size += len(p.blob)

            for w in incoming_work_reports:
                for r in w.results:
                    if r.service_id == s:
                        activity_record.refinement_count += 1
                        activity_record.refinement_gas_used += r.refine_load.gas_used
                        activity_record.imports += r.refine_load.imports
                        activity_record.extrinsic_count += r.refine_load.extrinsic_count
                        activity_record.extrinsic_size += r.refine_load.extrinsic_size
                        activity_record.exports += r.refine_load.exports

            accumulation_stats = self.block_context.accumulation_statistics.get(s)
            if accumulation_stats:
                activity_record.accumulate_count += accumulation_stats.nr_work_reports_accumulated
                activity_record.accumulate_gas_used += accumulation_stats.total_gas_utilized

            post_state.services[s] = activity_record

        return StatisticsOutput(
            post_state=post_state
        )

    @staticmethod
    def retrieve_validator_index(ed25519_key: bytes, post_validator_pool: ValidatorPoolState) -> Optional[int]:
        for validator_index, validator_data in enumerate(post_validator_pool.validators):
            if validator_data.ed25519 == ed25519_key:
                return validator_index
        return None


    def retrieve_state(self) -> StatisticsState:
        value = self.retrieve()
        return StatisticsState.from_jam_bytes(JamBytes(value))

state_transition(extrinsic_guarantees: List[Guarantee], extrinsic_preimages: List[Preimage], extrinsic_assurances: List[Assurance], extrinsic_tickets: List[TicketEnvelope], pre_state_timeslot: TimeslotState, post_state_timeslot: TimeslotState, post_state_validator_pool: ValidatorPoolState, pre_state_statistics: StatisticsState, header: Header) -> StatisticsOutput

GP-0.7.2-eq:13.4,13.5,13.8,13.12 (π') | State transition function for the state's statistics.

Parameters:

Name	Type	Description	Default
extrinsic_guarantees	List[Guarantee]	GP-0.7.2-eq:4.20 (bold_E_G)	required
extrinsic_preimages	List[Preimage]	GP-0.7.2-eq:4.20 (bold_E_P)	required
extrinsic_assurances	List[Assurance]	GP-0.7.2-eq:4.20 (bold_E_A)	required
extrinsic_tickets	List[TicketEnvelope]	GP-0.7.2-eq:4.20 (bold_E_T)	required
pre_state_timeslot	TimeslotState	GP-0.7.2-eq:4.20 (τ)	required
post_state_timeslot	TimeslotState	GP-0.7.2-eq:4.20 (τ')	required
post_state_validator_pool	ValidatorPoolState	GP-0.7.2-eq:4.20 (κ')	required
pre_state_statistics	StatisticsState	GP-0.7.2-eq:4.20 (π)	required
header	Header	GP-0.7.2-eq:4.20 (bold_H)	required

Returns:

Type	Description
StatisticsOutput	Output containing: Posterior state of StatisticsState (π')

Source code in pyjamaz/state/components.py

@log_execution_time
def state_transition(
        self,
        extrinsic_guarantees: List[Guarantee],
        extrinsic_preimages: List[Preimage],
        extrinsic_assurances: List[Assurance],
        extrinsic_tickets: List[TicketEnvelope],
        pre_state_timeslot: TimeslotState,
        post_state_timeslot: TimeslotState,
        post_state_validator_pool: ValidatorPoolState,
        pre_state_statistics: StatisticsState,
        header: Header
) -> StatisticsOutput:
    """
    GP-0.7.2-eq:13.4,13.5,13.8,13.12 (π') | State transition function for the state's statistics.

    Parameters
    ----------
    extrinsic_guarantees: List[Guarantee]
        GP-0.7.2-eq:4.20 (bold_E_G)
    extrinsic_preimages: List[Preimage]
        GP-0.7.2-eq:4.20 (bold_E_P)
    extrinsic_assurances: List[Assurance]
        GP-0.7.2-eq:4.20 (bold_E_A)
    extrinsic_tickets: List[TicketEnvelope]
        GP-0.7.2-eq:4.20 (bold_E_T)
    pre_state_timeslot: TimeslotState
        GP-0.7.2-eq:4.20 (τ)
    post_state_timeslot: TimeslotState
        GP-0.7.2-eq:4.20 (τ')
    post_state_validator_pool: ValidatorPoolState
        GP-0.7.2-eq:4.20 (κ')
    pre_state_statistics: StatisticsState
        GP-0.7.2-eq:4.20 (π)
    header: Header
        GP-0.7.2-eq:4.20 (bold_H)

    Returns
    -------
    StatisticsOutput
        Output containing: Posterior state of StatisticsState (π')
    """
    # TODO: check input parameters: remove tau_prime and add bold_S

    post_state = deepcopy(pre_state_statistics)

    # GP-0.7.2-eq:13.4 | Shift statistics after epoch change
    if self.is_epoch_change(pre_state_timeslot.number, header.timeslot):
        post_state.vals_last = post_state.vals_current
        post_state.vals_current = [ActivityRecord(
            blocks=0,
            tickets=0,
            pre_images=0,
            pre_images_size=0,
            guarantees=0,
            assurances=0
        ) for _ in range(gp_const.VALIDATOR_COUNT)]

    # GP-0.7.2-eq:13.5 | Update validator stats
    post_state.vals_current[header.author_index].blocks += 1
    post_state.vals_current[header.author_index].tickets += len(extrinsic_tickets)
    post_state.vals_current[header.author_index].pre_images += len(extrinsic_preimages)
    post_state.vals_current[header.author_index].pre_images_size += sum([len(p.blob) for p in extrinsic_preimages])

    for assurance in extrinsic_assurances:
        post_state.vals_current[assurance.validator_index].assurances += 1

    for reporter in self.block_context.reporters:
        val_index = self.retrieve_validator_index(reporter, post_state_validator_pool)
        if val_index is not None:
            post_state.vals_current[val_index].guarantees += 1

    incoming_work_reports = [g.report for g in extrinsic_guarantees]

    # GP-0.7.2-eq:13.8 | Update core statistics
    for c in range(gp_const.CORE_COUNT):
        post_state.cores[c].update(
            core_index=c,
            incoming_work_reports=incoming_work_reports,
            available_work_reports=self.block_context.available_work_reports,
            extrinsic_assurances=extrinsic_assurances
        )

    post_state.services = {}

    # GP-0.7.2-eq:13.12 | Determine affected services
    services = [r.service_id for w in incoming_work_reports for r in w.results]
    services += [p.requester for p in extrinsic_preimages]
    services += self.block_context.accumulation_statistics.keys()

    # GP-0.7.2-eq:13.7 | Update service statistics
    for s in sorted(set(services)):
        activity_record = ServiceActivityRecord()
        for p in extrinsic_preimages:
            if p.requester == s:
                activity_record.provided_count += 1
                activity_record.provided_size += len(p.blob)

        for w in incoming_work_reports:
            for r in w.results:
                if r.service_id == s:
                    activity_record.refinement_count += 1
                    activity_record.refinement_gas_used += r.refine_load.gas_used
                    activity_record.imports += r.refine_load.imports
                    activity_record.extrinsic_count += r.refine_load.extrinsic_count
                    activity_record.extrinsic_size += r.refine_load.extrinsic_size
                    activity_record.exports += r.refine_load.exports

        accumulation_stats = self.block_context.accumulation_statistics.get(s)
        if accumulation_stats:
            activity_record.accumulate_count += accumulation_stats.nr_work_reports_accumulated
            activity_record.accumulate_gas_used += accumulation_stats.total_gas_utilized

        post_state.services[s] = activity_record

    return StatisticsOutput(
        post_state=post_state
    )