Interface WalletPlugin

config

metadata

Optionaltranslations

data

• get data(): WalletPluginData

  A method to return the data that needs to persist for the plguin - Used in serialization

  Returns WalletPluginData

• set data(data: WalletPluginData): void

  Parameters

  • data: WalletPluginData

  Returns void

id

• get id(): string

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

  Returns string

Optionalclone

• clone?(): WalletPlugin

  Return a copy of this [[WalletPlugin]] with its own session data.

  Returns WalletPlugin

login

• login(context: LoginContext): Promise<WalletPluginLoginResponse>

  Request the [[WalletPlugin]] to log in a user and return a [[WalletPluginLoginResponse]].

  Parameters

  • context: LoginContext

    The [[LoginContext]] for the [[WalletPlugin]] to use.

  Returns Promise<WalletPluginLoginResponse>

Optionallogout

• logout?(context: LogoutContext): Promise<void>

  Optional method that is used to signal to the wallet plugin to logout the user.

  Parameters

  • context: LogoutContext

  Returns Promise<void>

  A promise that resolves when the wallet plugin logout process is complete.

  Throws

  An error if the logout could not happen.

OptionalretrievePublicKey

• retrievePublicKey?(chainId: Checksum256Type): Promise<PublicKey>

  Requests a public key from the wallet plugin.

  Parameters

  • chainId: Checksum256Type

  Returns Promise<PublicKey>

serialize

• serialize(): WalletPluginData

  Serialize the [[WalletPlugin]] ID and data into a plain object.

  Returns WalletPluginData

sign

• sign(
      transaction: ResolvedSigningRequest,
      context: TransactContext,
  ): Promise<WalletPluginSignResponse>

  Requests the [[WalletPlugin]] to sign a transaction and return a [[WalletPluginSignResponse]]]

  Parameters

  • transaction: ResolvedSigningRequest

    The transaction to sign.

  • context: TransactContext

    The [[TransactContext]] for the [[WalletPlugin]] to use.

  Returns Promise<WalletPluginSignResponse>