Class WalletPluginMetaMask

Hierarchy

AbstractWalletPlugin
- WalletPluginMetaMask

Implements

WalletPlugin

Index

Constructors

Properties

_data config id installedSnap isFlask metadata provider setupPageUrl snapOrigin translations?

Accessors

Methods

clone initialize invokeSnap login metamaskLogin metamaskSign request requestSnap retrievePublicKey serialize setSnap sign

Constructors

constructor

new WalletPluginMetaMask(
walletPluginMetaMaskConfig?: WalletPluginMetaMaskConfig,
): WalletPluginMetaMask
Parameters
- OptionalwalletPluginMetaMaskConfig: WalletPluginMetaMaskConfig
Returns WalletPluginMetaMask
Overrides AbstractWalletPlugin.constructor
- Defined in wallet-plugin-metamask/src/index.ts:57

Properties

_data

_data: WalletPluginData

`Readonly`config

config: WalletPluginConfig = ...

id

id: string = 'wallet-plugin-metamask'

installedSnap

installedSnap: Snap | null = null

isFlask

isFlask: boolean = false

`Readonly`metadata

metadata: WalletPluginMetadata = ...

provider

provider: MetaMaskInpageProvider | null = null

setupPageUrl

setupPageUrl: string

snapOrigin

snapOrigin: string

`Optional`translations

translations?: LocaleDefinitions

Any translations this plugin requires

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

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

initialize

initialize(context?: LoginContext): Promise<void>
Parameters
- Optionalcontext: LoginContext
Returns Promise<void>
- Defined in wallet-plugin-metamask/src/index.ts:143

invokeSnap

invokeSnap(
__namedParameters: InvokeSnapParams,
id?: string,
): Promise<Partial<unknown> | null>
Parameters
- __namedParameters: InvokeSnapParams
- Optionalid: string
Returns Promise<Partial<unknown> | null>
- Defined in wallet-plugin-metamask/src/index.ts:200

login(context: LoginContext): Cancelable<WalletPluginLoginResponse>
Parameters
- context: LoginContext
Returns Cancelable<WalletPluginLoginResponse>
Implementation of WalletPlugin.login

Overrides AbstractWalletPlugin.login
- Defined in wallet-plugin-metamask/src/index.ts:64

metamaskLogin

metamaskLogin(context: LoginContext): Promise<WalletPluginLoginResponse>
Parameters
- context: LoginContext
Returns Promise<WalletPluginLoginResponse>
- Defined in wallet-plugin-metamask/src/index.ts:71

metamaskSign

metamaskSign(
resolved: ResolvedSigningRequest,
): Promise<WalletPluginSignResponse>
Parameters
- resolved: ResolvedSigningRequest
Returns Promise<WalletPluginSignResponse>
- Defined in wallet-plugin-metamask/src/index.ts:101

request

request(
__namedParameters: { method: any; params: any },
): Promise<Partial<unknown> | null>
Parameters
- __namedParameters: { method: any; params: any }
Returns Promise<Partial<unknown> | null>
- Defined in wallet-plugin-metamask/src/index.ts:131

requestSnap

requestSnap(id?: string, version?: string): Promise<void>
Parameters
- Optionalid: string
- Optionalversion: string
Returns Promise<void>
- Defined in wallet-plugin-metamask/src/index.ts:189

retrievePublicKey

retrievePublicKey(chainId: Checksum256Type): Promise<PublicKey>
Requests a public key from the wallet plugin.
Parameters
- chainId: Checksum256Type
Returns Promise<PublicKey>
Implementation of WalletPlugin.retrievePublicKey
- Defined in wallet-plugin-metamask/src/index.ts:118

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

setSnap

setSnap(): Promise<void>
Returns Promise<void>
- Defined in wallet-plugin-metamask/src/index.ts:181

sign

sign(resolved: ResolvedSigningRequest): Cancelable<WalletPluginSignResponse>
Parameters
- resolved: ResolvedSigningRequest
Returns Cancelable<WalletPluginSignResponse>
Implementation of WalletPlugin.sign

Overrides AbstractWalletPlugin.sign
- Defined in wallet-plugin-metamask/src/index.ts:94