DID Method Key

Library for generating and working with Ed25519VerificationKey2018 key pairs.

Installation

• Node.js 16.0+ is required.

To install locally (for development):

git clone  https://github.com/RadicalLedger/zedeid-did-method-key.git
cd zedeid-did-method-key

yarn install or npm install
yarn test or npm run test

Usage

Initializing and Generating Keys

Generate key method key pairs with getKeys method. It can be used to generate key pairs for given node (bip32).

import { BIP32Factory } from 'bip32';
import * as ecc from 'tiny-secp256k1';
import KeyMethod from 'zedeid-did-method-key';

const seed = 'your-seed';

const bip32 = BIP32Factory(ecc);
const masterNode = bip32.fromSeed(Buffer.from(seed, 'hex'));

const keyMethod = new KeyMethod();
const keys = await keyMethod.getKeys(masterNode);

console.log(keys);

Generating DID Documents

Generate did document with getDocument method.

const privateKey = 'your-private-key-as-hex-string';
const didDocument = await keyMethod.getDocument(privateKey);

console.log(didDocument);

Generate Verification Key

Generate verification key with createVerificationMethod method for a given seed.

const seed = 'your-seed-as-hex-string';
const includePrivateKey = true; // (optional) to include the private key in the verification method
const verificationKey = await keyMethod.createVerificationMethod(seed, includePrivateKey);

console.log(verificationKey);