Skip to content

sgns::api::AuthorApi

#include <author_api.hpp>

Inherits from IComponent

Protected Types

Name
using base::Hash256 Hash256
using base::Buffer Buffer
using primitives::Extrinsic Extrinsic
using primitives::Subscriber Subscriber
using primitives::SubscriptionId SubscriptionId
using primitives::ExtrinsicKey ExtrinsicKey

Public Functions

Name
~AuthorApi() override =default
virtual outcome::result< Hash256 > submitExtrinsic(const Extrinsic & extrinsic) =0
Validates and sends an extrinsic to the transaction pool.
virtual outcome::result< std::vector< Extrinsic > > pendingExtrinsics() =0
virtual outcome::result< std::vector< Hash256 > > removeExtrinsic(const std::vector< ExtrinsicKey > & keys) =0

Additional inherited members

Public Functions inherited from IComponent

Name
virtual ~IComponent() =default
virtual std::string GetName() =0

Protected Types Documentation

using Hash256

using sgns::api::AuthorApi::Hash256 = base::Hash256;

using Buffer

using sgns::api::AuthorApi::Buffer = base::Buffer;

using Extrinsic

using sgns::api::AuthorApi::Extrinsic = primitives::Extrinsic;

using Subscriber

using sgns::api::AuthorApi::Subscriber = primitives::Subscriber;

using SubscriptionId

using sgns::api::AuthorApi::SubscriptionId = primitives::SubscriptionId;

using ExtrinsicKey

using sgns::api::AuthorApi::ExtrinsicKey = primitives::ExtrinsicKey;

Public Functions Documentation

function ~AuthorApi

~AuthorApi() override =default

function submitExtrinsic

virtual outcome::result< Hash256 > submitExtrinsic(
    const Extrinsic & extrinsic
) =0

Validates and sends an extrinsic to the transaction pool.

Parameters:

Return: Hash of the successfully validated extrinsic, or error if state is invalid or unknown.

function pendingExtrinsics

virtual outcome::result< std::vector< Extrinsic > > pendingExtrinsics() =0

Return: collection of pending extrinsics

function removeExtrinsic

virtual outcome::result< std::vector< Hash256 > > removeExtrinsic(
    const std::vector< ExtrinsicKey > & keys
) =0

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