switchMethod

How to call the API from an app

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

const handleSwitchMethodAPI = async () => {
  const metamaskAddress = '0x2e5fF0267b678A0FAF9A9f5b0FBf7Ac9638B5b57'
  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'switchDIDMethod',
        params: {
          metamaskAddress,
          didMethod: 'did:pkh'
        }
      }
    }
  })
}

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. Switch to using a different did method. Note that this value is saved within Metamask Snap state for each account so you can use different did methods for different accounts. We currently only support did:pkh method but there are plans to support more DID methods in the future at which point this API will make more sense. If you would like us to add a support for a DID method that you would like, feel free to let us know at [e-mail]

How the API works

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

import { divider, heading, text } from '@metamask/snaps-ui';
import { IdentitySnapParams, SnapDialogParams } from '../../interfaces';
import { generateCommonPanel, snapDialog } from '../../snap/dialog';
import { getAccountStateByCoinType, updateSnapState } from '../../snap/state';
import { availableMethods, isValidMethod } from '../../types/constants';

/**
 * Function to switch method.
 *
 * @param identitySnapParams - Identity snap params.
 * @param didMethod - DID method.
 */
export async function switchDIDMethod(
  identitySnapParams: IdentitySnapParams,
  didMethod: string,
): Promise<boolean> {
  const { snap, state, account } = identitySnapParams;

  const accountState = await getAccountStateByCoinType(
    state,
    account.evmAddress,
  );
  const method = accountState.accountConfig.identity.didMethod;
  if (!isValidMethod(didMethod)) {
    console.error(
      `did method '${didMethod}' not supported. Supported methods are: ${availableMethods}`,
    );
    throw new Error(
      `did method ${didMethod}'not supported. Supported methods are: ${availableMethods}`,
    );
  }

  if (method !== didMethod) {
    const dialogParams: SnapDialogParams = {
      type: 'confirmation',
      content: await generateCommonPanel(origin, [
        heading('Switch to a different DID method to use'),
        text('Would you like to change did method to the following?'),
        divider(),
        text(`Current DID method: ${method}\nNew DID method: ${didMethod}`),
      ]),
    };

    if (await snapDialog(snap, dialogParams)) {
      accountState.accountConfig.identity.didMethod = didMethod;
      await updateSnapState(snap, state);
      return true;
    }

    return false;
  }
  return true;
}

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.