index.d.ts 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. export default class Onboarding {
  2. static FORWARDER_MODE: {
  3. INJECT: "INJECT";
  4. OPEN_TAB: "OPEN_TAB";
  5. };
  6. private readonly forwarderOrigin;
  7. private readonly downloadUrl;
  8. private readonly forwarderMode;
  9. private state;
  10. constructor({ forwarderOrigin, forwarderMode, }?: {
  11. forwarderOrigin?: string | undefined;
  12. forwarderMode?: "INJECT" | undefined;
  13. });
  14. _onMessage(event: MessageEvent): Promise<void> | undefined;
  15. _onMessageUnknownStateError(state: never): never;
  16. _onMessageFromForwarder(event: MessageEvent): Promise<void>;
  17. /**
  18. * Starts onboarding by opening the MetaMask download page and the Onboarding forwarder
  19. */
  20. startOnboarding(): void;
  21. /**
  22. * Stops onboarding registration, including removing the injected forwarder (if any)
  23. *
  24. * Typically this function is not necessary, but it can be useful for cases where
  25. * onboarding completes before the forwarder has registered.
  26. */
  27. stopOnboarding(): void;
  28. _openForwarder(): void;
  29. _openDownloadPage(): void;
  30. /**
  31. * Checks whether the MetaMask extension is installed
  32. */
  33. static isMetaMaskInstalled(): boolean;
  34. static _register(): any;
  35. static _injectForwarder(forwarderOrigin: string): void;
  36. static _removeForwarder(): void;
  37. static _detectBrowser(): "FIREFOX" | "CHROME" | null;
  38. }