deleteAllVCs

How to call the API from an app

Identify Snap connects to your currently connected Metamask account by default. To learn how apps can connect to Identify Snap using a non-metamask(external) account, refer to this documentation.

Then, depending on whether you're trying to connect to a metamask account or a non-metamask account, you can call the snap API in the following way:

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

const options = {
  // If you want to remove the VCs from multiple stores, you can pass an
  // array like so:
  // store: ['snap', 'googleDrive']
  store: ['snap']
}

const metamaskAddress = '0x2e5fF0267b678A0FAF9A9f5b0FBf7Ac9638B5b57'
const params = {
  metamaskAddress,
  options
  /* 
    Uncomment the below line if you want to connect to a non-metamask account
  */
  // ...externalAccountParams
}

const handleDeleteAllVCsAPI = async () => {
  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'deleteAllVCs',
        params: params
      }
    }
  })
}

Notes:

• There is no need to pass in options if you want to store the VC in the Metamask snap state as this is the default behavior however, for storing it in googleDrive, you will need to specify via this parameter. In order to use googleDrive , you first need to first configure your google account.

• If you want to remove the same VC from multiple stores, you can pass in an array for options.store.

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. Removes all the Verifiable Credentials(VCs).

3. Returns the result.

Some example responses:

[
  {
    "removed": true,
    "store": "snap"
  }
]

How the API works

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

import { IdentitySnapParams, SnapDialogParams } from '../../interfaces';
import {
  ClearOptions,
  IDataManagerClearArgs,
  IDataManagerClearResult,
  IDataManagerQueryResult,
} from '../../plugins/veramo/verifiable-creds-manager';
import { generateVCPanel, snapDialog } from '../../snap/dialog';
import { getAccountStateByCoinType } from '../../snap/state';
import { getVeramoAgent } from '../../veramo/agent';

/**
 * Function to delete all VCs.
 *
 * @param identitySnapParams - Identity snap params.
 * @param vcRequestParams - VC request params.
 */
export async function deleteAllVCs(
  identitySnapParams: IdentitySnapParams,
  vcRequestParams: IDataManagerClearArgs,
): Promise<IDataManagerClearResult[] | null> {
  const { origin, snap, state, account } = identitySnapParams;
  const { options } = vcRequestParams || {};
  const { store = 'snap' } = options || {};
  const optionsFiltered = { store } as ClearOptions;

  // Get Veramo agent
  const agent = await getVeramoAgent(snap, state);

  const accountState = await getAccountStateByCoinType(
    state,
    account.evmAddress,
  );
  const vcsToBeRemoved = (await agent.queryVC({
    filter: undefined,
    options: optionsFiltered,
    accessToken: accountState.accountConfig.identity.googleUserInfo.accessToken,
  })) as IDataManagerQueryResult[];

  const header = 'Delete all Verifiable Credentials';
  const prompt = `Are you sure you want to remove all your VCs from the store '${store}'?`;
  const description = `Note that this action cannot be reversed and you will need to recreate your VCs if you go through with it. Number of VCs to be removed is ${vcsToBeRemoved.length.toString()}`;
  const dialogParams: SnapDialogParams = {
    type: 'confirmation',
    content: await generateVCPanel(
      origin,
      header,
      prompt,
      description,
      vcsToBeRemoved,
    ),
  };

  if (await snapDialog(snap, dialogParams)) {
    // Remove all the Verifiable Credentials from the store
    return await agent.clearVCs({
      options: optionsFiltered,
      accessToken:
        accountState.accountConfig.identity.googleUserInfo.accessToken,
    });
  }
  throw new Error('User rejected');
}

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.