Class Provider

Summary

The base wallet provider class

Since

0.2.0

Hierarchy (view full)

Constructors

constructor

Properties

config isGrinderyWallet methods rpc storage

Methods

announceProvider emit injectProvider isConnected listenForRequestProviderEvents on removeListener request restorePairing restoreSession sendAsync switchChain

Constructors

constructor

Properties

Private config

config: WalletSDKConfig

isGrinderyWallet

isGrinderyWallet: boolean = true

Private methods

methods: Partial<ProviderMethods> = ...

Summary

The list of supported provider methods.

Private rpc

rpc: Rpc

Private storage

storage: SdkStorage = ...

Methods

Private announceProvider

emit

  • emit(event, ...data): Provider

  • Parameters

    • event: "accountsChanged" | "pair" | "connect" | "disconnect" | "chainChanged" | "message"

      Event name

    • Rest ...data: any[]

      Event data

    Returns Provider

    The instance of the class itself

    Summary

    Emits an event

Private injectProvider

isConnected

Private listenForRequestProviderEvents

on

  • on(event, callback): Provider

  • Parameters

    • event: "accountsChanged" | "pair" | "connect" | "disconnect" | "chainChanged" | "message"

      Event name

    • callback: Function

      Callback function

    Returns Provider

    The instance of the class itself

    Summary

    Adds a listener to the event

removeListener

  • removeListener(event, callback): Provider

  • Parameters

    • event: "accountsChanged" | "pair" | "connect" | "disconnect" | "chainChanged" | "message"

      Event name

    • callback: Function

      Callback function

    Returns Provider

    The instance of the class itself

    Summary

    Removes a listener from the event

request

Private restorePairing

  • restorePairing(): Promise<void>
  • Private

    Returns Promise<void>

    Summary

    Restores the pairing process if pairing token is stored in the local storage

Private restoreSession

  • restoreSession(): Promise<void>
  • Private

    Returns Promise<void>

    Summary

    Restores the session if session Id is stored in the local storage

sendAsync

  • sendAsync(args, callback): void

  • Parameters

    Returns void

    void

    Summary

    Sends a request to the provider (legacy)

    Deprecated

    Use request method instead

    Since

    0.5.4

Private switchChain

  • switchChain(chainId): Promise<null>

  • Parameters

    • chainId: any

      Chain id in hex format

    Returns Promise<null>

    Null on success

    Summary

    Switches the chain

    Since

    0.3.0

Settings

Member Visibility

Theme

On This Page

constructorconfigisGrinderyWalletmethodsrpcstorageannounceProvideremitinjectProviderisConnectedlistenForRequestProviderEventsonremoveListenerrequestrestorePairingrestoreSessionsendAsyncswitchChain