Kagome
Polkadot Runtime Engine in C++17
Public Member Functions | List of all members
kagome::runtime::SessionKeysApi Class Referenceabstract

#include <session_keys_api.hpp>

Inheritance diagram for kagome::runtime::SessionKeysApi:
Collaboration diagram for kagome::runtime::SessionKeysApi:

Public Member Functions

virtual ~SessionKeysApi ()=default
 
virtual outcome::result< common::Buffer > generate_session_keys (const primitives::BlockHash &block_hash, std::optional< common::Buffer > seed)=0
 Generate a set of session keys with optionally using the given seed. The keys should be stored within the keystore exposed via runtime externalities. More...
 
virtual outcome::result< std::vector< std::pair< crypto::KeyTypeId, common::Buffer > > > decode_session_keys (const primitives::BlockHash &block_hash, common::BufferConstRef encoded) const =0
 Decode the given public session keys. More...
 

Detailed Description

Definition at line 19 of file session_keys_api.hpp.

Constructor & Destructor Documentation

virtual kagome::runtime::SessionKeysApi::~SessionKeysApi ( )
virtualdefault

Member Function Documentation

virtual outcome::result< std::vector<std::pair<crypto::KeyTypeId, common::Buffer> > > kagome::runtime::SessionKeysApi::decode_session_keys ( const primitives::BlockHash &  block_hash,
common::BufferConstRef  encoded 
) const
pure virtual

Decode the given public session keys.

Returns
the list of public raw public keys + key type.

Implemented in kagome::runtime::SessionKeysApiImpl.

virtual outcome::result<common::Buffer> kagome::runtime::SessionKeysApi::generate_session_keys ( const primitives::BlockHash &  block_hash,
std::optional< common::Buffer >  seed 
)
pure virtual

Generate a set of session keys with optionally using the given seed. The keys should be stored within the keystore exposed via runtime externalities.

Parameters
seed- optional seed, which needs to be a valid utf8 string.
Returns
the concatenated SCALE encoded public keys.

Implemented in kagome::runtime::SessionKeysApiImpl.

The documentation for this class was generated from the following file: