Serialized DID - peaq

The SDK can generate a serialized DID Document. The chain does not store the full DID Document object, it stores the serialized document in hexadecimal. Use this when you want to send the document on-chain yourself. For what goes into the document, see Custom Document Fields.

generateDidDocument(options)

Parameter	Type	EVM	Substrate	Description
address	`string`	Required	Required	Used for the id and controller fields in the generated DID Document.
chainType	`ChainType`	Optional	Optional	Defines the expected type of address to be passed. H160 for EVM and SS58 for Substrate. Defaults to SS58.
customDocumentFields	`customDocumentFields`	Optional	Optional	Used to set specific fields of the DID Document. If none is set, an empty document will be generated with id and controller set.

With chainType: EVM, the static call does not accept verifications (it throws Type must be either Ed25519VerificationKey2020 or Sr25519VerificationKey2020). To include an EcdsaSecp256k1RecoveryMethod2020 verification, use sdk.did.create() on an EVM SDK instance.

import { Sdk } from "@peaq-network/sdk";

// evm address example
const address = '0x9Eeab1aCcb1A701aEfAB00F3b8a275a39646641C';

// possible example of custom document fields a DePIN could create
const customFields = {
    services: [{
      id: "#ipfs",
      type: "machineData",
      serviceEndpoint: "https://ipfs.io/ipfs/QmYwAPJzv5CZsnAzt8auVTLv3jE9n1Tz8exzhTHtVMJd3t"
    }]
}

const result = await Sdk.generateDidDocument({
    address: address,
    chainType: Sdk.ChainType.EVM,
    customDocumentFields: customFields
});

// result object of generated DID Document for the value stored on chain
{
  value: '0a336469643a706561713a30783945656162316143636231413730316145664142303046336238613237356133393634363634314312336469643a706561713a3078394565616231614363623141373031614566414230304633623861323735613339363436363431432a590a052369706673120b6d616368696e65446174611a4368747470733a2f2f697066732e696f2f697066732f516d597741504a7a7635435a736e417a7438617556544c76336a45396e31547a3865787a68544874564d4a643374'
}

⌘I