resolveDID

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 metamaskAddress = '0x2e5fF0267b678A0FAF9A9f5b0FBf7Ac9638B5b57'
const params = {
  metamaskAddress,
  /* 
    Note that the 'did' parameter is optional. If did is not passed, 
    Identify Snap will assume that you want to resolve the DID of the currently
    connected account. This means this API can be used to resolve your own DID
    or another DID that does not belong to you.
  */
  // did: did,
  /* 
    Uncomment the below line if you want to connect to a non-metamask account
  */
  // ...externalAccountParams
}

const handleAccountInfoAPI = async () => {
  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'resolveDID',
        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. Returns the DID document based on the did method that's currently selected.

Some example responses:

For an evm account 0x30F08B41491E9620d9Ba0f8F8a09a807752bBF3A on Ethereum network:

{
    "didDocumentMetadata": {},
    "didResolutionMetadata": {
        "contentType": "application/did+ld+json"
    },
    "didDocument": {
        "@context": [
            "https://www.w3.org/ns/did/v1",
            {
                "blockchainAccountId": "https://w3id.org/security#blockchainAccountId",
                "EcdsaSecp256k1RecoveryMethod2020": "https://identity.foundation/EcdsaSecp256k1RecoverySignature2020#EcdsaSecp256k1RecoveryMethod2020"
            }
        ],
        "id": "did:pkh:eip155:1:0x30f08b41491e9620d9ba0f8f8a09a807752bbf3a",
        "verificationMethod": [
            {
                "id": "did:pkh:eip155:1:0x30f08b41491e9620d9ba0f8f8a09a807752bbf3a#blockchainAccountId",
                "type": "EcdsaSecp256k1RecoveryMethod2020",
                "controller": "did:pkh:eip155:1:0x30f08b41491e9620d9ba0f8f8a09a807752bbf3a",
                "blockchainAccountId": "eip155:1:0x30f08b41491e9620d9ba0f8f8a09a807752bbf3a"
            }
        ],
        "authentication": [
            "did:pkh:eip155:1:0x30f08b41491e9620d9ba0f8f8a09a807752bbf3a#blockchainAccountId"
        ],
        "assertionMethod": [
            "did:pkh:eip155:1:0x30f08b41491e9620d9ba0f8f8a09a807752bbf3a#blockchainAccountId"
        ]
    }
}

How the API works

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

import { DIDResolutionResult } from '@veramo/core';
import { IdentitySnapParams } from '../../interfaces';
import { getVeramoAgent } from '../../veramo/agent';

/**
 * Resolve DID.
 *
 * @param identitySnapParams - Identity snap params.
 * @param didUrl - DID url.
 */
export async function resolveDID(
  identitySnapParams: IdentitySnapParams,
  didUrl?: string,
): Promise<DIDResolutionResult | null> {
  const { state, account } = identitySnapParams;

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

  let did = didUrl;
  // GET DID if not exists
  if (!did) {
    did = account.identifier.did;
  }
  return await agent.resolveDid({
    didUrl: did,
  });
}

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.