Interface DidKeyCreateOptions<TKms>

Defines the set of options available when creating a new Decentralized Identifier (DID) with the 'did:key' method.

Either the algorithm or verificationMethods option can be specified, but not both.

• A new key will be generated using the algorithm identifier specified in either the algorithm property or the verificationMethods object's algorithm property.
• If verificationMethods is given, it must contain exactly one entry since DID Key only supports a single verification method.
• If neither is given, the default is to generate a new Ed25519 key.

Example

 * // By default, when no options are given, a new Ed25519 key will be generated.
const did = await DidKey.create();

// The algorithm to use for key generation can be specified as a top-level option.
const did = await DidKey.create({
  options: { algorithm = 'secp256k1' }
});

// Or, alternatively as a property of the verification method.
const did = await DidKey.create({
  options: {
    verificationMethods: [{ algorithm = 'secp256k1' }]
  }
});

// DID Creation with a KMS
const keyManager = new LocalKeyManager();
const did = await DidKey.create({ keyManager });

// DID Resolution
const resolutionResult = await DidKey.resolve({ did: did.uri });

// Signature Operations
const signer = await did.getSigner();
const signature = await signer.sign({ data: new TextEncoder().encode('Message') });
const isValid = await signer.verify({ data: new TextEncoder().encode('Message'), signature });

// Import / Export

// Export a BearerDid object to the PortableDid format.
const portableDid = await did.export();

// Reconstruct a BearerDid object from a PortableDid
const did = await DidKey.import(portableDid);
Copy