syncGoogleVCs

How to call the API from an app

Before you can call this API, you will need to first configure your google account.

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 metamaskAddress = '0x2e5fF0267b678A0FAF9A9f5b0FBf7Ac9638B5b57'
const params = {
  metamaskAddress,
  /* 
    Uncomment the below line if you want to connect to a non-metamask account
  */
  // ...externalAccountParams
}

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

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. Retrieves the VCs from google drive

3. Retrieves the VCs from the local Metamask snap state

4. Compare the VCs from both stores and figure out what VCs are missing in snap state that are present in google drive and what VCs are missing in google drive that are present in snap state

5. Import the missing VCs from google drive onto Metamask snap state

6. Export the missing VCs from Metamask snap state onto google drive

Some example responses:

true

How the API works

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

import {
  Account,
  IdentitySnapParams,
  IdentitySnapState,
  SnapDialogParams,
} from '../../interfaces';
import { verifyToken } from '../../plugins/veramo/google-drive-data-store';
import {
  IDataManagerQueryResult,
  IDataManagerSaveResult,
  ISaveVC,
  QueryOptions,
  SaveOptions,
} from '../../plugins/veramo/verifiable-creds-manager';
import { generateVCPanel, snapDialog } from '../../snap/dialog';
import { getAccountStateByCoinType } from '../../snap/state';
import { Agent, getVeramoAgent } from '../../veramo/agent';

/**
 * Function to sync Google VCs with snap.
 *
 * @param identitySnapParams - Identity snap params.
 */
export async function syncGoogleVCs(
  identitySnapParams: IdentitySnapParams,
): Promise<boolean> {
  const { origin, state, account } = identitySnapParams;

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

    const accountState = await getAccountStateByCoinType(
      state,
      account.evmAddress,
    );
    const gUserEmail = await verifyToken(
      accountState.accountConfig.identity.googleUserInfo.accessToken,
    );

    const options: QueryOptions = { store: 'snap', returnStore: true };
    // Get VCs from the snap state storage
    const snapVCs = (await agent.queryVC({
      filter: undefined,
      options,
    })) as IDataManagerQueryResult[];
    // Get VCs from google drive storage
    options.store = 'googleDrive';
    const googleVCs = (await agent.queryVC({
      filter: undefined,
      options,
      accessToken:
        accountState.accountConfig.identity.googleUserInfo.accessToken,
    })) as IDataManagerQueryResult[];
    /* googleVCs = googleVCs.filter(
    (vc) =>
      (vc.data as VerifiableCredential).credentialSubject.id?.split(':')[4] ===
      account.evmAddress, // Note that we're only doing this because this is a did:pkh VC. We need to handle other VCs differently
  ); */

    const snapVCIds = snapVCs.map((vc) => vc.metadata.id);
    const googleVCIds = googleVCs.map((vc) => vc.metadata.id);

    const vcsNotInSnap = googleVCs.filter(
      (vc) => !snapVCIds.includes(vc.metadata.id),
    );
    console.log('vcsNotInSnap: ', JSON.stringify(vcsNotInSnap, null, 4));

    const vcsNotInGDrive = snapVCs.filter(
      (vc) => !googleVCIds.includes(vc.metadata.id),
    );
    console.log('vcsNotInGDrive: ', JSON.stringify(vcsNotInGDrive, null, 4));

    const header = 'Sync Verifiable Credentials';
    let vcsNotInSnapSync = true;
    if (vcsNotInSnap.length > 0) {
      vcsNotInSnapSync = await handleSync(
        state,
        account,
        agent,
        origin,
        `${header} - Import VCs from Google drive: ${gUserEmail}`,
        'Would you like to sync VCs in Google drive with Metamask snap?',
        'This action will import the VCs that are in Google drive to the Metamask snap',
        vcsNotInSnap,
        'snap',
      );
    }
    let vcsNotInGDriveSync = true;
    if (vcsNotInGDrive.length > 0) {
      vcsNotInGDriveSync = await handleSync(
        state,
        account,
        agent,
        origin,
        `${header} - Export VCs to Google drive: ${gUserEmail}`,
        'Would you like to sync VCs in Metamask snap with Google drive?',
        'This action will export the VCs that are in Metamask snap to Google drive',
        vcsNotInGDrive,
        'googleDrive',
      );
    }

    if (vcsNotInSnapSync && vcsNotInGDriveSync) {
      return true;
    }
  } catch (error) {
    console.error(
      'Could not sync Verifiable Credentials between the Metamask snap and Google Drive properly. Please try again',
      JSON.stringify(error, null, 4),
    );
    throw error;
  }

  console.log(
    'Could not sync Verifiable Credentials between the Metamask snap and Google drive properly. Please try again',
  );
  throw new Error(
    'Could not sync Verifiable Credentials between the Metamask snap and Google drive properly. Please try again',
  );
}

/**
 * Function to handle the snap dialog and import/export each VC.
 *
 * @param state - Identity state.
 * @param account - Currently connected account.
 * @param agent - Veramo.
 * @param origin - The origin of where the call is being made from.
 * @param header - Header text of the metamask dialog box(eg. 'Retrieve Verifiable Credentials').
 * @param prompt - Prompt text of the metamask dialog box(eg. 'Are you sure you want to send VCs to the dApp?').
 * @param description - Description text of the metamask dialog box(eg. 'Some dApps are less secure than others and could save data from VCs against your will. Be careful where you send your private VCs! Number of VCs submitted is 2').
 * @param vcs - The Verifiable Credentials to show on the metamask dialog box.
 * @param store - The snap store to use(snap or googleDrive).
 */
async function handleSync(
  state: IdentitySnapState,
  account: Account,
  agent: Agent,
  origin: string,
  header: string,
  prompt: string,
  description: string,
  vcs: IDataManagerQueryResult[],
  store: string,
): Promise<boolean> {
  const dialogParams: SnapDialogParams = {
    type: 'confirmation',
    content: await generateVCPanel(origin, header, prompt, description, vcs),
  };
  if (await snapDialog(snap, dialogParams)) {
    const options = {
      store,
    } as SaveOptions;
    const accountState = await getAccountStateByCoinType(
      state,
      account.evmAddress,
    );
    const data = vcs.map((x) => {
      return { vc: x.data, id: x.metadata.id } as ISaveVC;
    }) as ISaveVC[];
    const result: IDataManagerSaveResult[] = await agent.saveVC({
      data,
      options,
      accessToken:
        accountState.accountConfig.identity.googleUserInfo.accessToken,
    });
    if (!(result.length > 0 && result[0].id !== '')) {
      console.log('Could not sync the vc: ', JSON.stringify(data, null, 4));
      return false;
    }
    return true;
  }
  console.log('User rejected the sync operation');
  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.