Class SessionKeyManager

Manages an sr25519 account derived from a BIP39 mnemonic.

Param: options.store

KvStore instance (from @polkadot-apps/storage). Create with createKvStore({ prefix: "session-key" }) for namespaced persistence.

Param: options.name

Identifies this session key. Defaults to "default". Use different names to manage multiple independent session keys.

Example

const store = await createKvStore({ prefix: "session-key" });
const skm = new SessionKeyManager({ store });
const key = await skm.getOrCreate();

Index

Constructors

constructor

Methods

clear create fromMnemonic get getOrCreate

Constructors

constructor

new SessionKeyManager(
options: { name?: string; store: KvStore },
): SessionKeyManager
Parameters
- options: { name?: string; store: KvStore }
Returns SessionKeyManager
- Defined in session-key-manager.ts:26

Methods

clear

clear(): Promise<void>
Clear the stored mnemonic from the store.

Returns Promise<void>
- Defined in session-key-manager.ts:70

create

create(): Promise<SessionKeyInfo>
Create a new session key from a fresh mnemonic. Persists the mnemonic to the store.

Returns Promise<SessionKeyInfo>
- Defined in session-key-manager.ts:35

fromMnemonic

fromMnemonic(mnemonic: string): SessionKeyInfo
Derive a session key from an explicit mnemonic (no storage interaction).
Parameters
- mnemonic: string
Returns SessionKeyInfo
- Defined in session-key-manager.ts:63

get

get(): Promise<SessionKeyInfo | null>
Load an existing session key from the store. Returns null if no mnemonic is stored.

Returns Promise<SessionKeyInfo | null>
- Defined in session-key-manager.ts:45

getOrCreate

getOrCreate(): Promise<SessionKeyInfo>
Load existing or create a new session key.

Returns Promise<SessionKeyInfo>
- Defined in session-key-manager.ts:54

Class SessionKeyManager

Param: options.store

Param: options.name

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SessionKeyManager

Methods

clear

Returns Promise<void>

create

Returns Promise<SessionKeyInfo>

fromMnemonic

Parameters

Returns SessionKeyInfo

get

Returns Promise<SessionKeyInfo | null>

getOrCreate

Returns Promise<SessionKeyInfo>

Settings

On This Page