togglePopups

How to call the API from an app

const snapId = `npm:@tuum-tech/identify`

const handleTogglePopupsAPI = async () => {
  const metamaskAddress = '0x2e5fF0267b678A0FAF9A9f5b0FBf7Ac9638B5b57'
  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: { method: 'togglePopups', params: { metamaskAddress } }
    }
  })
}

How the API is handled between the app and snap

What the API does

1. Retrieves the currently connected account and the blockchain network the user has selected on Metamask. If it's the first time, the account info is also saved in snap state.

2. Checks the current behavior for handling Metamask popups in snap state.

3. Enable/disable the Metamask popups.

4. Returns a value of type "boolean" for success/failure.

How the API works

https://github.com/tuum-tech/identify/blob/main/packages/snap/src/rpc/snap/togglePopups.ts

import { heading, text } from '@metamask/snaps-ui';
import { IdentitySnapParams, SnapDialogParams } from '../../interfaces';
import {
  generateCommonPanel,
  snapDialog,
  updatePopups,
} from '../../snap/dialog';

/**
 * Function to toggle popups.
 *
 * @param identitySnapParams - Identity snap params.
 */
export async function togglePopups(
  identitySnapParams: IdentitySnapParams,
): Promise<boolean> {
  const { origin, snap, state } = identitySnapParams;
  const { disablePopups } = state.snapConfig.dApp;

  const toggleTextToShow = disablePopups ? 'enable' : 'disable';
  const dialogParams: SnapDialogParams = {
    type: 'confirmation',
    content: await generateCommonPanel(origin, [
      heading('Toggle Popups'),
      text(`Would you like to ${toggleTextToShow} the popups?`),
    ]),
  };
  const result = await snapDialog(snap, dialogParams);
  if (result) {
    await updatePopups(snap, state);
    return true;
  }
  return false;
}

Live Demo on CodePen

Some things to keep in mind while interacting with the above demo

• If you're getting any errors with the live demo, make sure you go through the FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work

• Whenever there is a new version of the IdentifySnap, always make sure to first uninstall the old version of the snap from Metamask and only then try the above demo so it can install the latest version

To ease the integration of Identify Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Identify Snap. Check out the full source code at template application github repository.

You can also check out the API reference to learn how each API works.