Trait sp_session::SessionKeys

pub trait SessionKeys<Block: BlockT>: Core<Block> {
    fn generate_session_keys(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        seed: Option<Vec<u8>>
    ) -> Result<Vec<u8>, ApiError> { ... }
    fn generate_session_keys_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext,
        seed: Option<Vec<u8>>
    ) -> Result<Vec<u8>, ApiError> { ... }
    fn decode_session_keys(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        encoded: Vec<u8>
    ) -> Result<Option<Vec<(Vec<u8>, KeyTypeId)>>, ApiError> { ... }
    fn decode_session_keys_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext,
        encoded: Vec<u8>
    ) -> Result<Option<Vec<(Vec<u8>, KeyTypeId)>>, ApiError> { ... }
}

Session keys runtime api.

Provided Methods

fn generate_session_keys(
    &self,
    __runtime_api_at_param__: &BlockId<Block>,
    seed: Option<Vec<u8>>
) -> Result<Vec<u8>, ApiError>

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

The seed needs to be a valid utf8 string.

Returns the concatenated SCALE encoded public keys.

Examples found in repository

src/lib.rs (line 128)

pub fn generate_initial_session_keys<Block, T>(
	client: std::sync::Arc<T>,
	at: Block::Hash,
	seeds: Vec<String>,
) -> Result<(), sp_api::ApiError>
where
	Block: BlockT,
	T: ProvideRuntimeApi<Block>,
	T::Api: SessionKeys<Block>,
{
	if seeds.is_empty() {
		return Ok(())
	}

	let runtime_api = client.runtime_api();

	for seed in seeds {
		runtime_api.generate_session_keys(&BlockId::Hash(at), Some(seed.as_bytes().to_vec()))?;
	}

	Ok(())
}

fn generate_session_keys_with_context(
    &self,
    __runtime_api_at_param__: &BlockId<Block>,
    context: ExecutionContext,
    seed: Option<Vec<u8>>
) -> Result<Vec<u8>, ApiError>

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

The seed needs to be a valid utf8 string.

Returns the concatenated SCALE encoded public keys.

fn decode_session_keys(
    &self,
    __runtime_api_at_param__: &BlockId<Block>,
    encoded: Vec<u8>
) -> Result<Option<Vec<(Vec<u8>, KeyTypeId)>>, ApiError>

Decode the given public session keys.

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

fn decode_session_keys_with_context(
    &self,
    __runtime_api_at_param__: &BlockId<Block>,
    context: ExecutionContext,
    encoded: Vec<u8>
) -> Result<Option<Vec<(Vec<u8>, KeyTypeId)>>, ApiError>

Decode the given public session keys.

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

Trait Implementations

impl<Block: BlockT> RuntimeApiInfo for dyn SessionKeys<Block>

const ID: [u8; 8] = _

The identifier of the runtime api.

const VERSION: u32 = 1u32

The version of the runtime api.

Implementors