sgns::runtime::dummy::FinalityApiDummy¶

#include <finality_api_dummy.hpp>

Inherits from sgns::runtime::FinalityApi

Public Functions¶

	Name
	~FinalityApiDummy() override =default
	FinalityApiDummy(std::shared_ptr< application::KeyStorage > key_storage)
virtual outcome::result< boost::optional< ScheduledChange > >	pending_change(const Digest & digest) override 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) override 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) override calls Finality_authorities runtime api function

Additional inherited members¶

Protected Types inherited from sgns::runtime::FinalityApi

	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 inherited from sgns::runtime::FinalityApi

	Name
virtual	~FinalityApi() =default

Detailed Description¶

class sgns::runtime::dummy::FinalityApiDummy;

Dummy implementation of the finality api. Should not be used in production. Instead of using runtime to get authorities, just returns current authority

Public Functions Documentation¶

function ~FinalityApiDummy¶

~FinalityApiDummy() override =default

function FinalityApiDummy¶

explicit FinalityApiDummy(
    std::shared_ptr< application::KeyStorage > key_storage
)

function pending_change¶

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

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

Reimplements: sgns::runtime::FinalityApi::pending_change

function forced_change¶

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

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

Reimplements: sgns::runtime::FinalityApi::forced_change

function authorities¶

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

calls Finality_authorities runtime api function

Return: collection of current finality authorities with their weights

Reimplements: sgns::runtime::FinalityApi::authorities

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