Class WalletPluginWebAuthenticator

Hierarchy

AbstractWalletPlugin
- WalletPluginWebAuthenticator

Implements

WalletPlugin

Index

Constructors

Properties

_data config metadata translations

Accessors

Methods

clone getChainUrl login serialize sign

Constructors

constructor

new WalletPluginWebAuthenticator(
options: WebAuthenticatorOptions,
): WalletPluginWebAuthenticator
Parameters
- options: WebAuthenticatorOptions
Returns WalletPluginWebAuthenticator
Overrides AbstractWalletPlugin.constructor
- Defined in wallet-plugin-web-authenticator/src/index.ts:61

Properties

_data

_data: WalletPluginData

`Readonly`config

config: WalletPluginConfig = ...

The logic configuration for the wallet plugin.

`Readonly`metadata

metadata: WalletPluginMetadata = ...

The metadata for the wallet plugin to be displayed in the user interface.

translations

translations: { en: any; ko: any; "zh-Hans": any; "zh-Hant": any } = defaultTranslations

The translations for this plugin

Accessors

data

get data(): WalletPluginData
A method to return the data that needs to persist for the plguin - Used in serialization

Returns WalletPluginData
Implementation of WalletPlugin.data

Inherited from AbstractWalletPlugin.data
- Defined in session/lib/session.d.ts:584
set data(data: WalletPluginData): void
A method to return the data that needs to persist for the plguin - Used in serialization
Parameters
- data: WalletPluginData
Returns void
Implementation of WalletPlugin.data

Inherited from AbstractWalletPlugin.data
- Defined in session/lib/session.d.ts:585

id

get id(): string
Unique identifier for this wallet plugin

Returns string
Implementation of WalletPlugin.id

Overrides AbstractWalletPlugin.id
- Defined in wallet-plugin-web-authenticator/src/index.ts:95

Methods

clone

clone(): WalletPlugin
Shallow copy with fresh data and metadata; every other field must be safe to share.

Returns WalletPlugin
Implementation of WalletPlugin.clone

Inherited from AbstractWalletPlugin.clone
- Defined in session/lib/session.d.ts:588

getChainUrl

getChainUrl(context: LoginContext | TransactContext): string
Parameters
- context: LoginContext | TransactContext
Returns string
- Defined in wallet-plugin-web-authenticator/src/index.ts:104

login(context: LoginContext): Promise<WalletPluginLoginResponse>
Performs login by opening the web authenticator in a popup
Parameters
- context: LoginContext
Returns Promise<WalletPluginLoginResponse>
Implementation of WalletPlugin.login

Overrides AbstractWalletPlugin.login
- Defined in wallet-plugin-web-authenticator/src/index.ts:216

serialize

serialize(): SerializedWalletPlugin
Serialize the [[WalletPlugin]] ID and data into a plain object.

Returns SerializedWalletPlugin
Implementation of WalletPlugin.serialize

Inherited from AbstractWalletPlugin.serialize
- Defined in session/lib/session.d.ts:586

sign

sign(
resolved: ResolvedSigningRequest,
context: TransactContext,
): Promise<WalletPluginSignResponse>
Signs a transaction by opening the web authenticator in a popup
Parameters
- resolved: ResolvedSigningRequest
- context: TransactContext
Returns Promise<WalletPluginSignResponse>
Implementation of WalletPlugin.sign

Overrides AbstractWalletPlugin.sign
- Defined in wallet-plugin-web-authenticator/src/index.ts:279