Skip to content

Latest commit

 

History

History
128 lines (86 loc) · 3.86 KB

README.md

File metadata and controls

128 lines (86 loc) · 3.86 KB
Raw

Polygon DID Method

The polygon DID method library uses Ethereum based addresses as fully functional DID’s or Decentralized identifiers, on the Polygon network. The following allows one to create a key Pair based and facilitates its storage on the registry smart contract, deployed on Polygon chain. Third party users can use this to create polygon DID identities. It allows the controller to perform actions like resolve, update and delete by encapsulating polygonDID registry and PolygonDID resolver. The DID identifier allows the controller to resolve DID document for usage in different scenarios.

Example of polygon DID document resolved using PolygonDIDResolver:

{
  "@context": "https://w3id.org/did/v1",
  "id": "did:polygon:0x794b781493AeD65b9ceBD680716fec257e118993",
  "verificationMethod": [
    {
      "id": "did:polygon:0x794b781493AeD65b9ceBD680716fec257e118993",
      "type": "EcdsaSecp256k1VerificationKey2019",
      "controller": ["did:polygon:0x794b781493AeD65b9ceBD680716fec257e118993"],
      "publicKeyBase58": "7Lnm1ZnseKDkH1baAb1opREfAU4MPY7zCdUDSrWSm9NxNTQmy4neU9brFUYnEcyy7CwFKjD11ikyP9J8cf6zEaAKrEzzp"
    }
  ]
}

DID Method or DID schema

The DID method is a specific implementation of a DID scheme that will be identified by method name. For this case the method name is “polygon”, and the identifier is an Ethereum address.

The DID for Polygon looks like:

On Polygon mainnet

did:polygon:0xdce5306fb5f9ba6797546dcd2e11eb5c5201bfeb

On Polygon testnet

did:polygon:testnet:0xdce5306fb5f9ba6797546dcd2e11eb5c5201bfeb

DID On-Chain

Every DID on chain has the same structure, defined as:

Where,

  • controller : the address of the person who creates and manages the DID
  • created : holds the timestamp of the block when DID was created
  • updated : initially holds the timestamp of when the DID was created, but is updated if the controller updates the DID on chain, and
  • doc : holds the entire DID document in form of string.

DID Operations

Create

Creating a createKeyPair refers to generation of a DID uri, based on a newly generated wallet.

import { createKeyPair } from 'polygon-did-registrar'
const keys = await createKeyPair(network)

The function returns address, privateKey, publicKeyBase58, did

Register

Register of DID is done by logging the transaction on the polygon-register smart contract, by invoking

import { create } from 'polygon-did-registrar'
const txHash = await create(did, didDoc)

The function returns a txnHash and DID and didDoc on successful execution.

Update

The DID controller requests for the update functionality, if the controller wishes to edit the did doc store on the ledger using :

import { update } from 'polygon-did-registrar'
const txHash = await update(did, didDoc)

Add Resource

Add DID-linked resource for the DID-Doc.

import { addResource } from 'polygon-did-registrar'
const txHash = await addResource(did, resourcePayload)

The function returns a txhash, DID, and resourceId on successful execution.

Update Resource

Update DID-linked resource for the DID-Doc.

import { updateResource } from 'polygon-did-registrar'
const txHash = await updateResource(did, resourceId, resourcePayload)

The function returns a txhash, DID, and resourceId on successful execution.

Fetch Resource

Get a DID-linked resource for a specific DID.

import { getResourceByDidAndResourceId } from 'polygon-did-registrar'
const txHash = await getResourceByDidAndResourceId(did, resourceId)

The function returns DID-linked resource and DID uri on successful execution.

Fetch all Resources

Get all DID-linked resources for a specific DID.

import { getResourcesByDid } from 'polygon-did-registrar'
const txHash = await getResourcesByDid(did)

The function returns the list of DID-linked resources and DID on successful execution.