sgns::runtime::FinalityApi

interface for Finality runtime functions

#include <finality_api.hpp>

Inherited by sgns::runtime::binaryen::FinalityApiImpl, sgns::runtime::dummy::FinalityApiDummy

Protected Types

	Name
using primitives::Digest	Digest
using primitives::ScheduledChange	ScheduledChange
using primitives::BlockNumber	BlockNumber
using primitives::SessionKey	SessionKey
using primitives::Authority	WeightedAuthority
using primitives::ForcedChange	ForcedChange
using primitives::BlockId	BlockId

Public Functions

	Name
virtual	~FinalityApi() =default
virtual outcome::result< boost::optional< ScheduledChange > >	pending_change(const Digest & digest) =0 calls Finality_pending_change runtime api function, which checks a digest for pending changes.
virtual outcome::result< boost::optional< ForcedChange > >	forced_change(const Digest & digest) =0 calls Finality_forced_change runtime api function which checks a digest for forced changes
virtual outcome::result< primitives::AuthorityList >	authorities(const primitives::BlockId & block_id) =0 calls Finality_authorities runtime api function

Protected Types Documentation

using Digest

using sgns::runtime::FinalityApi::Digest = primitives::Digest;

using ScheduledChange

using sgns::runtime::FinalityApi::ScheduledChange = primitives::ScheduledChange;

using BlockNumber

using sgns::runtime::FinalityApi::BlockNumber = primitives::BlockNumber;

using SessionKey

using sgns::runtime::FinalityApi::SessionKey = primitives::SessionKey;

using WeightedAuthority

using sgns::runtime::FinalityApi::WeightedAuthority = primitives::Authority;

using ForcedChange

using sgns::runtime::FinalityApi::ForcedChange = primitives::ForcedChange;

using BlockId

using sgns::runtime::FinalityApi::BlockId = primitives::BlockId;

Public Functions Documentation

function ~FinalityApi

virtual ~FinalityApi() =default

function pending_change

virtual outcome::result< boost::optional< ScheduledChange > > pending_change(
    const Digest & digest
) =0

calls Finality_pending_change runtime api function, which checks a digest for pending changes.

Parameters:

• digest digest to check

Return: nullopt if there are no pending changes, scheduled change item if exists or error if error occured

Reimplemented by: sgns::runtime::binaryen::FinalityApiImpl::pending_change, sgns::runtime::dummy::FinalityApiDummy::pending_change

function forced_change

virtual outcome::result< boost::optional< ForcedChange > > forced_change(
    const Digest & digest
) =0

calls Finality_forced_change runtime api function which checks a digest for forced changes

Parameters:

• digest digest to check

Return: nullopt if no forced changes, forced change item if exists or error if error occured

Reimplemented by: sgns::runtime::binaryen::FinalityApiImpl::forced_change, sgns::runtime::dummy::FinalityApiDummy::forced_change

function authorities

virtual outcome::result< primitives::AuthorityList > authorities(
    const primitives::BlockId & block_id
) =0

calls Finality_authorities runtime api function

Return: collection of current finality authorities with their weights

Reimplemented by: sgns::runtime::binaryen::FinalityApiImpl::authorities, sgns::runtime::dummy::FinalityApiDummy::authorities

---

Updated on 2026-03-04 at 13:10:43 -0800