Retrieve DID of a metamask account

Overview

To learn about how accounts works within Identify Snap, refer to the Snap Account documentation.

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.

In this tutorial, we are going to retrieve DID info when we want to connect to our Metamask account.

How to call the API from an app

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

const metamaskAddress = '0x2e5fF0267b678A0FAF9A9f5b0FBf7Ac9638B5b57'
const params = { metamaskAddress }

const retrieveDIDOfMetamaskAccount = async () => {
  await window.ethereum.request({
    method: `wallet_snap_${snapId}`,
    params: {
      method: 'getAccountInfo',
      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 of the metamask account.

Some example responses:

For an evm account 0x2e5ff0267b678a0faf9a9f5b0fbf7ac9638b5b57on Ethereum network:

{
  "evmAddress": "0x2e5ff0267b678a0faf9a9f5b0fbf7ac9638b5b57",
  "did": "did:pkh:eip155:1:0x2e5ff0267b678a0faf9a9f5b0fbf7ac9638b5b57",
  "publicKey": "0x02f4426975e267d5db6d3fdd2fbcfdce2224dbd902ec2eea14553a9547e73abcf3",
  "method": "did:pkh"
}

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.

Last updated