@wharfkit/session - v4.0.1
    Preparing search index...

    Interface SessionKeyWalletInterface

    Interface for wallet plugins that support session keys. Implemented by SessionKeyWalletPlugin.

    interface SessionKeyWalletInterface {
        config: WalletPluginConfig;
        metadata: WalletPluginMetadata;
        translations?: LocaleDefinitions;
        get data(): WalletPluginData;
        set data(data: WalletPluginData): void;
        get id(): string;
        allActionsWhitelisted(actions: AnyAction[]): boolean;
        clone?(): WalletPlugin;
        getPermission(): Name;
        getPrimaryWallet(): WalletPlugin;
        getPublicKey(): string;
        login(context: LoginContext): Promise<WalletPluginLoginResponse>;
        logout?(context: LogoutContext): Promise<void>;
        retrievePublicKey?(chainId: Checksum256Type): Promise<PublicKey>;
        serialize(): WalletPluginData;
        sign(
            transaction: ResolvedSigningRequest,
            context: TransactContext,
        ): Promise<WalletPluginSignResponse>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    config metadata translations?
    data id
    allActionsWhitelisted clone? getPermission getPrimaryWallet getPublicKey login logout? retrievePublicKey? serialize sign
    config: WalletPluginConfig

    The [[SessionKit]] configuration parameters for this [[WalletPlugin]].

    metadata: WalletPluginMetadata

    The metadata for the [[WalletPlugin]] itself.

    translations?: LocaleDefinitions

    Any translations this plugin requires

    • get id(): string

      A URL friendly (lower case, no spaces, etc) ID for this plugin - Used in serialization

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods