Skip to main content

ISME Concept

This chapter will explain the basic concepts of the ISME SDK.

ISME DID​

ISME DID is the core concept in the ISME SDK, which represents the user's identity in the ISME network. The data in ISME is managed by the ISME DID. For operations such as data modification and deletion, the authorization and signature of the DID are required. The format of ISME DID is as follows:

did:nft3:didname

The didname part is a globally unique identifier, similar to the username in Web2, and the complete DID string is called the identifier in the ISME SDK, such as

did:nft3:bob

But the complete identifier is long and inconvenient to use, so each DID will have a more readable name, the format is as follows:

didname.isme

.isme is the identity suffix belong to ISME, similar to .eth of ENS. For example, the display name corresponding to did:nft3:bob is bob.isme

Multiple Chain Wallets​

ISME DID is designed to support multiple chains and multiple wallets, which means that you can bind wallet addresses on different chains such as Ethereum, Solana to the same ISME DID, and use any of the wallet addresses to sign and authorize can gain control over the bound DID. Currently, the chains and wallets already supported by the ISME SDK include:

  • Ethereum - Browser-embedded wallet, for example, MetaMask.
  • Solana - Solana Phantom wallet
  • Petra - Aptos Petra wallet

Data Model​

Using the ISME SDK, developers can publish their own data models, which are similar to tables in traditional databases. With data models, users can add, delete, modify and query the data without limitations, and the query operation is not restricted. However CRUD operations require authorization from the DID's signature to determine the ownership of the data.

Many data models are common in the Web3 application development markets. In order to involve more developers, the ISME SDK provides a built-in solution including some standard data models pre-built, offered with a convenient operation interface. The data models below are already included:

  • Profile - Personal infomation
  • Follow - Social media network
  • Social - Social media account

On-Chain Data​

Using the ISME SDK, querying the on-chain data associated with the ISME DID becomes much easier. The types supported currently are:

  • Token - token owned by the DID
  • Tx - transaction records of the DID
  • Poap - POAP records
  • Ens - ENS records
  • Timeline - timeline of the on-chain transaction
  • Opensea - the opensea asset of the DID

SDK Framework​

ISME SDK includes two core libraries, client and did-manager.

@ismelabs/client​

It is the underlying interface to communicate with the ISME Gateway. It is independent of specific development frameworks or platforms, and can run in Node.js or browsers.

@ismelabs/did-manager​

This front-end tool library is designed for browsers and React. It includes wallet connection, DID logic, registration and status management. It can easily integrate with various projects in the React ecosystem. We highly recommend it to development teams.