@enbox/dwn-sdk-js 0.0.6 → 0.0.8

package/dist/esm/tests/utils/test-data-generator.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import * as cbor from '@ipld/dag-cbor';
 import { CID } from 'multiformats/cid';
 import { DataStream } from '../../src/utils/data-stream.js';
@@ -34,6 +25,22 @@ import { X25519 } from '@enbox/crypto';
 import { ContentEncryptionAlgorithm, Encryption } from '../../src/utils/encryption.js';
 import { DwnInterfaceName, DwnMethodName } from '../../src/enums/dwn-interface-method.js';
 import { HdKey, KeyDerivationScheme } from '../../src/utils/hd-key.js';
+/**
+ * Protocol definition that matches the defaults used by `TestDataGenerator.generateRecordsWrite()`:
+ * `protocol: 'http://test-protocol.xyz'`, `protocolPath: 'testRecord'`.
+ *
+ * Install via `TestDataGenerator.installDefaultTestProtocol(dwn, persona)`.
+ */
+export const defaultTestProtocolDefinition = {
+    protocol: 'http://test-protocol.xyz',
+    published: false,
+    types: {
+        testRecord: {}
+    },
+    structure: {
+        testRecord: {}
+    }
+};
 /**
  * Utility class for generating data for testing.
  */
@@ -41,143 +48,146 @@ export class TestDataGenerator {
     /**
      * Generates a persona.
      */
-    static generatePersona(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            // generate DID if not given
-            let did = input === null || input === void 0 ? void 0 : input.did;
-            if (!did) {
-                const didSuffix = TestDataGenerator.randomString(32);
-                did = `did:example:${didSuffix}`;
-            }
-            // generate persona key ID if not given
-            const keyIdSuffix = TestDataGenerator.randomString(10);
-            const keyId = (_a = input === null || input === void 0 ? void 0 : input.keyId) !== null && _a !== void 0 ? _a : `${did}#${keyIdSuffix}`;
-            // generate persona signing key pair if not given (secp256k1 for ES256K signatures)
-            const keyPair = (_b = input === null || input === void 0 ? void 0 : input.keyPair) !== null && _b !== void 0 ? _b : yield Secp256k1.generateKeyPair();
-            // generate persona encryption key pair if not given (X25519 for ECDH-ES key agreement)
-            let encryptionKeyPair = input === null || input === void 0 ? void 0 : input.encryptionKeyPair;
-            if (!encryptionKeyPair) {
-                const encPrivateKey = yield X25519.generateKey();
-                const encPublicKey = yield X25519.getPublicKey({ key: encPrivateKey });
-                encryptionKeyPair = {
-                    publicJwk: encPublicKey,
-                    privateJwk: encPrivateKey,
-                };
-            }
-            const persona = {
-                did,
-                keyId,
-                keyPair,
-                encryptionKeyPair,
-                signer: new PrivateKeySigner({
-                    privateJwk: keyPair.privateJwk,
-                    algorithm: keyPair.privateJwk.alg,
-                    keyId: `${did}#${keyId}`,
-                })
+    static async generatePersona(input) {
+        // generate DID if not given
+        let did = input?.did;
+        if (!did) {
+            const didSuffix = TestDataGenerator.randomString(32);
+            did = `did:example:${didSuffix}`;
+        }
+        // generate persona key ID if not given
+        const keyIdSuffix = TestDataGenerator.randomString(10);
+        const keyId = input?.keyId ?? `${did}#${keyIdSuffix}`;
+        // generate persona signing key pair if not given (secp256k1 for ES256K signatures)
+        const keyPair = input?.keyPair ?? await Secp256k1.generateKeyPair();
+        // generate persona encryption key pair if not given (X25519 for ECDH-ES key agreement)
+        let encryptionKeyPair = input?.encryptionKeyPair;
+        if (!encryptionKeyPair) {
+            const encPrivateKey = await X25519.generateKey();
+            const encPublicKey = await X25519.getPublicKey({ key: encPrivateKey });
+            encryptionKeyPair = {
+                publicJwk: encPublicKey,
+                privateJwk: encPrivateKey,
             };
-            return persona;
+        }
+        const persona = {
+            did,
+            keyId,
+            keyPair,
+            encryptionKeyPair,
+            signer: new PrivateKeySigner({
+                privateJwk: keyPair.privateJwk,
+                algorithm: keyPair.privateJwk.alg,
+                keyId: `${did}#${keyId}`,
+            })
+        };
+        return persona;
+    }
+    /**
+     * Installs the default test protocol (`http://test-protocol.xyz` with `testRecord` type)
+     * on the given DWN for the given persona. Call this before processing any RecordsWrite
+     * created with `generateRecordsWrite()` that uses the default protocol.
+     */
+    static async installDefaultTestProtocol(dwn, persona) {
+        const protocolsConfigure = await ProtocolsConfigure.create({
+            definition: defaultTestProtocolDefinition,
+            signer: Jws.createSigner(persona),
         });
+        const reply = await dwn.processMessage(persona.did, protocolsConfigure.message);
+        if (reply.status.code !== 202) {
+            throw new Error(`Failed to install default test protocol: ${reply.status.code} ${reply.status.detail}`);
+        }
     }
     /**
      * Generates a ProtocolsConfigure message for testing.
      * Optional parameters are generated if not given.
      * Implementation currently uses `ProtocolsConfigure.create()`.
      */
-    static generateProtocolsConfigure(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generatePersona();
-            // generate protocol types and  definition if not given
-            let definition = input === null || input === void 0 ? void 0 : input.protocolDefinition;
-            if (!definition) {
-                const generatedLabel = 'record' + TestDataGenerator.randomString(10);
-                definition = {
-                    protocol: TestDataGenerator.randomString(20),
-                    published: (_b = input === null || input === void 0 ? void 0 : input.published) !== null && _b !== void 0 ? _b : false,
-                    types: {},
-                    structure: {}
-                };
-                definition.types[generatedLabel] = {
-                    schema: `test-object`,
-                    dataFormats: ['text/plain']
-                };
-                definition.structure[generatedLabel] = {};
-            }
-            const signer = Jws.createSigner(author);
-            const options = {
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                definition,
-                signer,
-                permissionGrantId: input === null || input === void 0 ? void 0 : input.permissionGrantId,
-                delegatedGrant: input === null || input === void 0 ? void 0 : input.delegatedGrant
+    static async generateProtocolsConfigure(input) {
+        const author = input?.author ?? await TestDataGenerator.generatePersona();
+        // generate protocol types and  definition if not given
+        let definition = input?.protocolDefinition;
+        if (!definition) {
+            const generatedLabel = 'record' + TestDataGenerator.randomString(10);
+            definition = {
+                protocol: TestDataGenerator.randomString(20),
+                published: input?.published ?? false,
+                types: {},
+                structure: {}
             };
-            const protocolsConfigure = yield ProtocolsConfigure.create(options);
-            return {
-                author,
-                message: protocolsConfigure.message,
-                protocolsConfigure
+            definition.types[generatedLabel] = {
+                schema: `test-object`,
+                dataFormats: ['text/plain']
             };
-        });
+            definition.structure[generatedLabel] = {};
+        }
+        const signer = Jws.createSigner(author);
+        const options = {
+            messageTimestamp: input?.messageTimestamp,
+            definition,
+            signer,
+            permissionGrantId: input?.permissionGrantId,
+            delegatedGrant: input?.delegatedGrant
+        };
+        const protocolsConfigure = await ProtocolsConfigure.create(options);
+        return {
+            author,
+            message: protocolsConfigure.message,
+            protocolsConfigure
+        };
     }
     ;
     /**
      * Generates a ProtocolsQuery message for testing.
      */
-    static generateProtocolsQuery(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            // generate author persona if not given
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generatePersona();
-            const signer = Jws.createSigner(author);
-            const options = {
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                filter: input === null || input === void 0 ? void 0 : input.filter,
-                signer,
-                permissionGrantId: input === null || input === void 0 ? void 0 : input.permissionGrantId,
-            };
-            removeUndefinedProperties(options);
-            const protocolsQuery = yield ProtocolsQuery.create(options);
-            return {
-                author,
-                message: protocolsQuery.message,
-                protocolsQuery
-            };
-        });
+    static async generateProtocolsQuery(input) {
+        // generate author persona if not given
+        const author = input?.author ?? await TestDataGenerator.generatePersona();
+        const signer = Jws.createSigner(author);
+        const options = {
+            messageTimestamp: input?.messageTimestamp,
+            filter: input?.filter,
+            signer,
+            permissionGrantId: input?.permissionGrantId,
+        };
+        removeUndefinedProperties(options);
+        const protocolsQuery = await ProtocolsQuery.create(options);
+        return {
+            author,
+            message: protocolsQuery.message,
+            protocolsQuery
+        };
     }
     ;
-    static generateGrantCreate(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f;
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generatePersona();
-            const grantedToPersona = (_b = input === null || input === void 0 ? void 0 : input.grantedTo) !== null && _b !== void 0 ? _b : yield TestDataGenerator.generatePersona();
-            const dateExpires = (_c = input === null || input === void 0 ? void 0 : input.dateExpires) !== null && _c !== void 0 ? _c : Time.createOffsetTimestamp({ seconds: 10 });
-            const scope = (_d = input === null || input === void 0 ? void 0 : input.scope) !== null && _d !== void 0 ? _d : {
-                interface: DwnInterfaceName.Messages,
-                method: DwnMethodName.Read
-            };
-            const signer = Jws.createSigner(author);
-            const grantedTo = grantedToPersona.did;
-            const options = {
-                signer,
-                grantedTo,
-                dateExpires,
-                scope,
-                description: (_e = input === null || input === void 0 ? void 0 : input.description) !== null && _e !== void 0 ? _e : TestDataGenerator.randomString(10),
-                delegated: (_f = input === null || input === void 0 ? void 0 : input.delegated) !== null && _f !== void 0 ? _f : false,
-                requestId: input === null || input === void 0 ? void 0 : input.requestId,
-                conditions: input === null || input === void 0 ? void 0 : input.conditions,
-            };
-            const grant = yield PermissionsProtocol.createGrant(options);
-            const dataStream = DataStream.fromBytes(grant.permissionGrantBytes);
-            return {
-                dataStream,
-                recordsWrite: grant.recordsWrite,
-                dataBytes: grant.permissionGrantBytes,
-                message: grant.recordsWrite.message,
-                dataEncodedMessage: grant.dataEncodedMessage
-            };
-        });
+    static async generateGrantCreate(input) {
+        const author = input?.author ?? await TestDataGenerator.generatePersona();
+        const grantedToPersona = input?.grantedTo ?? await TestDataGenerator.generatePersona();
+        const dateExpires = input?.dateExpires ?? Time.createOffsetTimestamp({ seconds: 10 });
+        const scope = input?.scope ?? {
+            interface: DwnInterfaceName.Messages,
+            method: DwnMethodName.Read
+        };
+        const signer = Jws.createSigner(author);
+        const grantedTo = grantedToPersona.did;
+        const options = {
+            signer,
+            grantedTo,
+            dateExpires,
+            scope,
+            description: input?.description ?? TestDataGenerator.randomString(10),
+            delegated: input?.delegated ?? false,
+            requestId: input?.requestId,
+            conditions: input?.conditions,
+        };
+        const grant = await PermissionsProtocol.createGrant(options);
+        const dataStream = DataStream.fromBytes(grant.permissionGrantBytes);
+        return {
+            dataStream,
+            recordsWrite: grant.recordsWrite,
+            dataBytes: grant.permissionGrantBytes,
+            message: grant.recordsWrite.message,
+            dataEncodedMessage: grant.dataEncodedMessage
+        };
     }
     ;
     /**
@@ -190,54 +200,51 @@ export class TestDataGenerator {
      * @param input.signer MessageSigner of the message. Generated if not given.
      * @param input.schema Schema of the message. Randomly generated if not given.
      */
-    static generateRecordsWrite(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e;
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generatePersona();
-            const signer = Jws.createSigner(author);
-            const attestationSigners = Jws.createSigners((_b = input === null || input === void 0 ? void 0 : input.attesters) !== null && _b !== void 0 ? _b : []);
-            const dataCid = input === null || input === void 0 ? void 0 : input.dataCid;
-            const dataSize = input === null || input === void 0 ? void 0 : input.dataSize;
-            let dataBytes;
-            let dataStream;
-            if (dataCid === undefined && dataSize === undefined) {
-                dataBytes = (_c = input === null || input === void 0 ? void 0 : input.data) !== null && _c !== void 0 ? _c : TestDataGenerator.randomBytes(32);
-                dataStream = DataStream.fromBytes(dataBytes);
-            }
-            const options = {
-                recipient: input === null || input === void 0 ? void 0 : input.recipient,
-                protocol: input === null || input === void 0 ? void 0 : input.protocol,
-                protocolPath: input === null || input === void 0 ? void 0 : input.protocolPath,
-                protocolRole: input === null || input === void 0 ? void 0 : input.protocolRole,
-                schema: (_d = input === null || input === void 0 ? void 0 : input.schema) !== null && _d !== void 0 ? _d : `http://${TestDataGenerator.randomString(20)}`,
-                tags: input === null || input === void 0 ? void 0 : input.tags,
-                recordId: input === null || input === void 0 ? void 0 : input.recordId,
-                parentContextId: input === null || input === void 0 ? void 0 : input.parentContextId,
-                published: input === null || input === void 0 ? void 0 : input.published,
-                dataFormat: (_e = input === null || input === void 0 ? void 0 : input.dataFormat) !== null && _e !== void 0 ? _e : 'application/json',
-                dateCreated: input === null || input === void 0 ? void 0 : input.dateCreated,
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                datePublished: input === null || input === void 0 ? void 0 : input.datePublished,
-                data: dataBytes,
-                dataCid,
-                dataSize,
-                signer,
-                attestationSigners,
-                encryptionInput: input === null || input === void 0 ? void 0 : input.encryptionInput,
-                permissionGrantId: input === null || input === void 0 ? void 0 : input.permissionGrantId,
-            };
-            const recordsWrite = yield RecordsWrite.create(options);
-            const message = recordsWrite.message;
-            return {
-                author,
-                message,
-                dataCid,
-                dataSize,
-                dataBytes,
-                dataStream,
-                recordsWrite
-            };
-        });
+    static async generateRecordsWrite(input) {
+        const author = input?.author ?? await TestDataGenerator.generatePersona();
+        const signer = Jws.createSigner(author);
+        const attestationSigners = Jws.createSigners(input?.attesters ?? []);
+        const dataCid = input?.dataCid;
+        const dataSize = input?.dataSize;
+        let dataBytes;
+        let dataStream;
+        if (dataCid === undefined && dataSize === undefined) {
+            dataBytes = input?.data ?? TestDataGenerator.randomBytes(32);
+            dataStream = DataStream.fromBytes(dataBytes);
+        }
+        const options = {
+            recipient: input?.recipient,
+            protocol: input?.protocol ?? 'http://test-protocol.xyz',
+            protocolPath: input?.protocolPath ?? 'testRecord',
+            protocolRole: input?.protocolRole,
+            schema: input?.schema ?? `http://${TestDataGenerator.randomString(20)}`,
+            tags: input?.tags,
+            recordId: input?.recordId,
+            parentContextId: input?.parentContextId,
+            published: input?.published,
+            dataFormat: input?.dataFormat ?? 'application/json',
+            dateCreated: input?.dateCreated,
+            messageTimestamp: input?.messageTimestamp,
+            datePublished: input?.datePublished,
+            data: dataBytes,
+            dataCid,
+            dataSize,
+            signer,
+            attestationSigners,
+            encryptionInput: input?.encryptionInput,
+            permissionGrantId: input?.permissionGrantId,
+        };
+        const recordsWrite = await RecordsWrite.create(options);
+        const message = recordsWrite.message;
+        return {
+            author,
+            message,
+            dataCid,
+            dataSize,
+            dataBytes,
+            dataStream,
+            recordsWrite
+        };
     }
     ;
     /**
@@ -253,286 +260,264 @@ export class TestDataGenerator {
      * @param input.encryptSymmetricKeyWithProtocolContextDerivedKey
      *        Set to `true` to attach the symmetric key encrypted by the protocol context derived public key
      */
-    static generateProtocolEncryptedRecordsWrite(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            const { plaintextBytes, author, recipient, protocolDefinition, protocolPath, protocolParentContextId, protocolContextDerivingRootKeyId, protocolContextDerivedPublicKeyJwk, } = input;
-            // encrypt the plaintext data for the target with a randomly generated symmetric key
-            const dataEncryptionInitializationVector = TestDataGenerator.randomBytes(12); // 12 bytes for AES-GCM
-            const dataEncryptionKey = TestDataGenerator.randomBytes(32);
-            const { ciphertext: encryptedDataBytes, tag: authenticationTag } = yield Encryption.aeadEncrypt(ContentEncryptionAlgorithm.A256GCM, dataEncryptionKey, dataEncryptionInitializationVector, plaintextBytes);
-            // author generates a RecordsWrite using the encrypted data
-            const protocolPathSegments = protocolPath.split('/');
-            const recordType = protocolPathSegments[protocolPathSegments.length - 1];
-            const { message, dataStream, recordsWrite } = yield TestDataGenerator.generateRecordsWrite({
-                author,
-                recipient,
-                protocol: protocolDefinition.protocol,
-                protocolPath,
-                parentContextId: protocolParentContextId,
-                schema: protocolDefinition.types[recordType].schema,
-                dataFormat: (_a = protocolDefinition.types[recordType].dataFormats) === null || _a === void 0 ? void 0 : _a[0],
-                data: encryptedDataBytes
-            });
-            // final encryption input (`keyEncryptionInputs` to be populated below)
-            const encryptionInput = {
-                initializationVector: dataEncryptionInitializationVector,
-                key: dataEncryptionKey,
-                authenticationTag,
-                keyEncryptionInputs: []
+    static async generateProtocolEncryptedRecordsWrite(input) {
+        const { plaintextBytes, author, recipient, protocolDefinition, protocolPath, protocolParentContextId, protocolContextDerivingRootKeyId, protocolContextDerivedPublicKeyJwk, } = input;
+        // encrypt the plaintext data for the target with a randomly generated symmetric key
+        const dataEncryptionInitializationVector = TestDataGenerator.randomBytes(12); // 12 bytes for AES-GCM
+        const dataEncryptionKey = TestDataGenerator.randomBytes(32);
+        const { ciphertext: encryptedDataBytes, tag: authenticationTag } = await Encryption.aeadEncrypt(ContentEncryptionAlgorithm.A256GCM, dataEncryptionKey, dataEncryptionInitializationVector, plaintextBytes);
+        // author generates a RecordsWrite using the encrypted data
+        const protocolPathSegments = protocolPath.split('/');
+        const recordType = protocolPathSegments[protocolPathSegments.length - 1];
+        const { message, dataStream, recordsWrite } = await TestDataGenerator.generateRecordsWrite({
+            author,
+            recipient,
+            protocol: protocolDefinition.protocol,
+            protocolPath,
+            parentContextId: protocolParentContextId,
+            schema: protocolDefinition.types[recordType].schema,
+            dataFormat: protocolDefinition.types[recordType].dataFormats?.[0],
+            data: encryptedDataBytes
+        });
+        // final encryption input (`keyEncryptionInputs` to be populated below)
+        const encryptionInput = {
+            initializationVector: dataEncryptionInitializationVector,
+            key: dataEncryptionKey,
+            authenticationTag,
+            keyEncryptionInputs: []
+        };
+        if (input.encryptSymmetricKeyWithProtocolPathDerivedKey) {
+            // locate the rule set corresponding the protocol path of the message
+            let protocolRuleSetSegment = protocolDefinition.structure;
+            for (const pathSegment of protocolPathSegments) {
+                protocolRuleSetSegment = protocolRuleSetSegment[pathSegment];
+            }
+            const protocolPathDerivedPublicKeyJwk = protocolRuleSetSegment.$encryption?.publicKeyJwk;
+            const protocolPathDerivationRootKeyId = protocolRuleSetSegment.$encryption?.rootKeyId;
+            const protocolPathDerivedKeyEncryptionInput = {
+                publicKeyId: protocolPathDerivationRootKeyId,
+                publicKey: protocolPathDerivedPublicKeyJwk,
+                derivationScheme: KeyDerivationScheme.ProtocolPath
             };
-            if (input.encryptSymmetricKeyWithProtocolPathDerivedKey) {
-                // locate the rule set corresponding the protocol path of the message
-                let protocolRuleSetSegment = protocolDefinition.structure;
-                for (const pathSegment of protocolPathSegments) {
-                    protocolRuleSetSegment = protocolRuleSetSegment[pathSegment];
-                }
-                const protocolPathDerivedPublicKeyJwk = (_b = protocolRuleSetSegment.$encryption) === null || _b === void 0 ? void 0 : _b.publicKeyJwk;
-                const protocolPathDerivationRootKeyId = (_c = protocolRuleSetSegment.$encryption) === null || _c === void 0 ? void 0 : _c.rootKeyId;
-                const protocolPathDerivedKeyEncryptionInput = {
-                    publicKeyId: protocolPathDerivationRootKeyId,
-                    publicKey: protocolPathDerivedPublicKeyJwk,
-                    derivationScheme: KeyDerivationScheme.ProtocolPath
+            encryptionInput.keyEncryptionInputs.push(protocolPathDerivedKeyEncryptionInput);
+        }
+        if (input.encryptSymmetricKeyWithProtocolContextDerivedKey) {
+            // generate key encryption input that will encrypt the symmetric encryption key using protocol-context derived public key
+            let protocolContextDerivedKeyEncryptionInput;
+            if (protocolParentContextId === undefined) {
+                // author generates protocol-context derived public key for encrypting symmetric key
+                const authorRootPrivateKey = {
+                    rootKeyId: author.keyId,
+                    derivationScheme: KeyDerivationScheme.ProtocolContext,
+                    derivedPrivateKey: author.encryptionKeyPair.privateJwk
+                };
+                const contextId = await RecordsWrite.getEntryId(author.did, message.descriptor);
+                const contextDerivationPath = Records.constructKeyDerivationPathUsingProtocolContextScheme(contextId);
+                const authorGeneratedProtocolContextDerivedPublicKeyJwk = await HdKey.derivePublicKey(authorRootPrivateKey, contextDerivationPath);
+                protocolContextDerivedKeyEncryptionInput = {
+                    publicKeyId: author.keyId,
+                    publicKey: authorGeneratedProtocolContextDerivedPublicKeyJwk,
+                    derivationScheme: KeyDerivationScheme.ProtocolContext
                 };
-                encryptionInput.keyEncryptionInputs.push(protocolPathDerivedKeyEncryptionInput);
             }
-            if (input.encryptSymmetricKeyWithProtocolContextDerivedKey) {
-                // generate key encryption input that will encrypt the symmetric encryption key using protocol-context derived public key
-                let protocolContextDerivedKeyEncryptionInput;
-                if (protocolParentContextId === undefined) {
-                    // author generates protocol-context derived public key for encrypting symmetric key
-                    const authorRootPrivateKey = {
-                        rootKeyId: author.keyId,
-                        derivationScheme: KeyDerivationScheme.ProtocolContext,
-                        derivedPrivateKey: author.encryptionKeyPair.privateJwk
-                    };
-                    const contextId = yield RecordsWrite.getEntryId(author.did, message.descriptor);
-                    const contextDerivationPath = Records.constructKeyDerivationPathUsingProtocolContextScheme(contextId);
-                    const authorGeneratedProtocolContextDerivedPublicKeyJwk = yield HdKey.derivePublicKey(authorRootPrivateKey, contextDerivationPath);
-                    protocolContextDerivedKeyEncryptionInput = {
-                        publicKeyId: author.keyId,
-                        publicKey: authorGeneratedProtocolContextDerivedPublicKeyJwk,
-                        derivationScheme: KeyDerivationScheme.ProtocolContext
-                    };
-                }
-                else {
-                    if (protocolContextDerivingRootKeyId === undefined ||
-                        protocolContextDerivedPublicKeyJwk === undefined) {
-                        throw new Error('`protocolContextDerivingRootKeyId` and `protocolContextDerivedPublicKeyJwk` must both be defined if `protocolContextId` is given');
-                    }
-                    protocolContextDerivedKeyEncryptionInput = {
-                        publicKeyId: protocolContextDerivingRootKeyId,
-                        publicKey: protocolContextDerivedPublicKeyJwk,
-                        derivationScheme: KeyDerivationScheme.ProtocolContext
-                    };
+            else {
+                if (protocolContextDerivingRootKeyId === undefined ||
+                    protocolContextDerivedPublicKeyJwk === undefined) {
+                    throw new Error('`protocolContextDerivingRootKeyId` and `protocolContextDerivedPublicKeyJwk` must both be defined if `protocolContextId` is given');
                 }
-                encryptionInput.keyEncryptionInputs.push(protocolContextDerivedKeyEncryptionInput);
+                protocolContextDerivedKeyEncryptionInput = {
+                    publicKeyId: protocolContextDerivingRootKeyId,
+                    publicKey: protocolContextDerivedPublicKeyJwk,
+                    derivationScheme: KeyDerivationScheme.ProtocolContext
+                };
             }
-            yield recordsWrite.encryptSymmetricEncryptionKey(encryptionInput);
-            yield recordsWrite.sign({ signer: Jws.createSigner(author) });
-            return { message, dataStream: dataStream, recordsWrite, encryptedDataBytes, encryptionInput };
-        });
+            encryptionInput.keyEncryptionInputs.push(protocolContextDerivedKeyEncryptionInput);
+        }
+        await recordsWrite.encryptSymmetricEncryptionKey(encryptionInput);
+        await recordsWrite.sign({ signer: Jws.createSigner(author) });
+        return { message, dataStream: dataStream, recordsWrite, encryptedDataBytes, encryptionInput };
     }
     /**
      * Generates a valid RecordsWrite that modifies the given an existing write.
      * Any mutable property is not specified will be automatically mutated.
      * e.g. if `published` is not specified, it will be toggled from the state of the given existing write.
      */
-    static generateFromRecordsWrite(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            const existingMessage = input.existingWrite.message;
-            const currentTime = Time.getCurrentTimestamp();
-            const published = ((_a = input.published) !== null && _a !== void 0 ? _a : existingMessage.descriptor.published) ? false : true; // toggle from the parent value if not given explicitly
-            const datePublished = (_b = input.datePublished) !== null && _b !== void 0 ? _b : (published ? currentTime : undefined);
-            const dataBytes = (_c = input.data) !== null && _c !== void 0 ? _c : TestDataGenerator.randomBytes(32);
-            const dataStream = DataStream.fromBytes(dataBytes);
-            const options = {
-                recordsWriteMessage: input.existingWrite.message,
-                data: dataBytes,
-                published,
-                datePublished,
-                messageTimestamp: input.messageTimestamp,
-                protocolRole: input.protocolRole,
-                tags: input.tags,
-                signer: Jws.createSigner(input.author)
-            };
-            const recordsWrite = yield RecordsWrite.createFrom(options);
-            return {
-                message: recordsWrite.message,
-                recordsWrite,
-                dataBytes,
-                dataStream
-            };
-        });
+    static async generateFromRecordsWrite(input) {
+        const existingMessage = input.existingWrite.message;
+        const currentTime = Time.getCurrentTimestamp();
+        const published = input.published ?? existingMessage.descriptor.published ? false : true; // toggle from the parent value if not given explicitly
+        const datePublished = input.datePublished ?? (published ? currentTime : undefined);
+        const dataBytes = input.data ?? TestDataGenerator.randomBytes(32);
+        const dataStream = DataStream.fromBytes(dataBytes);
+        const options = {
+            recordsWriteMessage: input.existingWrite.message,
+            data: dataBytes,
+            published,
+            datePublished,
+            messageTimestamp: input.messageTimestamp,
+            protocolRole: input.protocolRole,
+            tags: input.tags,
+            signer: Jws.createSigner(input.author)
+        };
+        const recordsWrite = await RecordsWrite.createFrom(options);
+        return {
+            message: recordsWrite.message,
+            recordsWrite,
+            dataBytes,
+            dataStream
+        };
     }
     /**
      * Generates a RecordsQuery message for testing.
      */
-    static generateRecordsQuery(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            let author = input === null || input === void 0 ? void 0 : input.author;
-            const anonymous = (_a = input === null || input === void 0 ? void 0 : input.anonymous) !== null && _a !== void 0 ? _a : false;
-            if (anonymous && author) {
-                throw new Error('Cannot have `author` and be anonymous at the same time.');
-            }
-            // generate author if needed
-            if (author === undefined && !anonymous) {
-                author = yield TestDataGenerator.generatePersona();
-            }
-            let signer = undefined;
-            if (author !== undefined) {
-                signer = Jws.createSigner(author);
-            }
-            const options = {
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                signer,
-                filter: (_b = input === null || input === void 0 ? void 0 : input.filter) !== null && _b !== void 0 ? _b : { schema: TestDataGenerator.randomString(10) }, // must have one filter property if no filter is given
-                dateSort: input === null || input === void 0 ? void 0 : input.dateSort,
-                pagination: input === null || input === void 0 ? void 0 : input.pagination,
-                protocolRole: input === null || input === void 0 ? void 0 : input.protocolRole,
-            };
-            removeUndefinedProperties(options);
-            const recordsQuery = yield RecordsQuery.create(options);
-            const message = recordsQuery.message;
-            return {
-                author,
-                message
-            };
-        });
+    static async generateRecordsQuery(input) {
+        let author = input?.author;
+        const anonymous = input?.anonymous ?? false;
+        if (anonymous && author) {
+            throw new Error('Cannot have `author` and be anonymous at the same time.');
+        }
+        // generate author if needed
+        if (author === undefined && !anonymous) {
+            author = await TestDataGenerator.generatePersona();
+        }
+        let signer = undefined;
+        if (author !== undefined) {
+            signer = Jws.createSigner(author);
+        }
+        const options = {
+            messageTimestamp: input?.messageTimestamp,
+            signer,
+            filter: input?.filter ?? { schema: TestDataGenerator.randomString(10) }, // must have one filter property if no filter is given
+            dateSort: input?.dateSort,
+            pagination: input?.pagination,
+            protocolRole: input?.protocolRole,
+        };
+        removeUndefinedProperties(options);
+        const recordsQuery = await RecordsQuery.create(options);
+        const message = recordsQuery.message;
+        return {
+            author,
+            message
+        };
     }
     ;
     /**
      * Generates a RecordsSubscribe message for testing.
      */
-    static generateRecordsSubscribe(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            let author = input === null || input === void 0 ? void 0 : input.author;
-            const anonymous = (_a = input === null || input === void 0 ? void 0 : input.anonymous) !== null && _a !== void 0 ? _a : false;
-            if (anonymous && author) {
-                throw new Error('Cannot have `author` and be anonymous at the same time.');
-            }
-            // generate author if needed
-            if (author === undefined && !anonymous) {
-                author = yield TestDataGenerator.generatePersona();
-            }
-            let signer = undefined;
-            if (author !== undefined) {
-                signer = Jws.createSigner(author);
-            }
-            const options = {
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                signer,
-                filter: (_b = input === null || input === void 0 ? void 0 : input.filter) !== null && _b !== void 0 ? _b : { schema: TestDataGenerator.randomString(10) }, // must have one filter property if no filter is given
-                dateSort: input === null || input === void 0 ? void 0 : input.dateSort,
-                pagination: input === null || input === void 0 ? void 0 : input.pagination,
-                protocolRole: input === null || input === void 0 ? void 0 : input.protocolRole,
-            };
-            removeUndefinedProperties(options);
-            const recordsSubscribe = yield RecordsSubscribe.create(options);
-            const message = recordsSubscribe.message;
-            return {
-                author,
-                message
-            };
-        });
+    static async generateRecordsSubscribe(input) {
+        let author = input?.author;
+        const anonymous = input?.anonymous ?? false;
+        if (anonymous && author) {
+            throw new Error('Cannot have `author` and be anonymous at the same time.');
+        }
+        // generate author if needed
+        if (author === undefined && !anonymous) {
+            author = await TestDataGenerator.generatePersona();
+        }
+        let signer = undefined;
+        if (author !== undefined) {
+            signer = Jws.createSigner(author);
+        }
+        const options = {
+            messageTimestamp: input?.messageTimestamp,
+            signer,
+            filter: input?.filter ?? { schema: TestDataGenerator.randomString(10) }, // must have one filter property if no filter is given
+            dateSort: input?.dateSort,
+            pagination: input?.pagination,
+            protocolRole: input?.protocolRole,
+            cursor: input?.cursor,
+        };
+        removeUndefinedProperties(options);
+        const recordsSubscribe = await RecordsSubscribe.create(options);
+        const message = recordsSubscribe.message;
+        return {
+            author,
+            message
+        };
     }
     /**
      * Generates a RecordsCount message for testing.
      */
-    static generateRecordsCount(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            let author = input === null || input === void 0 ? void 0 : input.author;
-            const anonymous = (_a = input === null || input === void 0 ? void 0 : input.anonymous) !== null && _a !== void 0 ? _a : false;
-            if (anonymous && author) {
-                throw new Error('Cannot have `author` and be anonymous at the same time.');
-            }
-            // generate author if needed
-            if (author === undefined && !anonymous) {
-                author = yield TestDataGenerator.generatePersona();
-            }
-            let signer = undefined;
-            if (author !== undefined) {
-                signer = Jws.createSigner(author);
-            }
-            const options = {
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                signer,
-                filter: (_b = input === null || input === void 0 ? void 0 : input.filter) !== null && _b !== void 0 ? _b : { schema: TestDataGenerator.randomString(10) },
-                protocolRole: input === null || input === void 0 ? void 0 : input.protocolRole,
-            };
-            removeUndefinedProperties(options);
-            const recordsCount = yield RecordsCount.create(options);
-            const message = recordsCount.message;
-            return {
-                author,
-                message
-            };
-        });
+    static async generateRecordsCount(input) {
+        let author = input?.author;
+        const anonymous = input?.anonymous ?? false;
+        if (anonymous && author) {
+            throw new Error('Cannot have `author` and be anonymous at the same time.');
+        }
+        // generate author if needed
+        if (author === undefined && !anonymous) {
+            author = await TestDataGenerator.generatePersona();
+        }
+        let signer = undefined;
+        if (author !== undefined) {
+            signer = Jws.createSigner(author);
+        }
+        const options = {
+            messageTimestamp: input?.messageTimestamp,
+            signer,
+            filter: input?.filter ?? { schema: TestDataGenerator.randomString(10) },
+            protocolRole: input?.protocolRole,
+        };
+        removeUndefinedProperties(options);
+        const recordsCount = await RecordsCount.create(options);
+        const message = recordsCount.message;
+        return {
+            author,
+            message
+        };
     }
     /**
      * Generates a RecordsDelete for testing.
      */
-    static generateRecordsDelete(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generateDidKeyPersona();
-            const recordsDelete = yield RecordsDelete.create({
-                recordId: (_b = input === null || input === void 0 ? void 0 : input.recordId) !== null && _b !== void 0 ? _b : yield TestDataGenerator.randomCborSha256Cid(),
-                protocolRole: input === null || input === void 0 ? void 0 : input.protocolRole,
-                signer: Jws.createSigner(author)
-            });
-            return {
-                author,
-                recordsDelete,
-                message: recordsDelete.message
-            };
+    static async generateRecordsDelete(input) {
+        const author = input?.author ?? await TestDataGenerator.generateDidKeyPersona();
+        const recordsDelete = await RecordsDelete.create({
+            recordId: input?.recordId ?? await TestDataGenerator.randomCborSha256Cid(),
+            protocolRole: input?.protocolRole,
+            signer: Jws.createSigner(author)
         });
+        return {
+            author,
+            recordsDelete,
+            message: recordsDelete.message
+        };
     }
     /**
      * Generates a MessagesSubscribe message for testing.
      */
-    static generateMessagesSubscribe(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generatePersona();
-            const signer = Jws.createSigner(author);
-            const options = {
-                filters: input === null || input === void 0 ? void 0 : input.filters,
-                messageTimestamp: input === null || input === void 0 ? void 0 : input.messageTimestamp,
-                permissionGrantId: input === null || input === void 0 ? void 0 : input.permissionGrantId,
-                signer,
-            };
-            removeUndefinedProperties(options);
-            const messagesSubscribe = yield MessagesSubscribe.create(options);
-            const message = messagesSubscribe.message;
-            return {
-                author,
-                messagesSubscribe,
-                message
-            };
-        });
+    static async generateMessagesSubscribe(input) {
+        const author = input?.author ?? await TestDataGenerator.generatePersona();
+        const signer = Jws.createSigner(author);
+        const options = {
+            filters: input?.filters,
+            messageTimestamp: input?.messageTimestamp,
+            permissionGrantId: input?.permissionGrantId,
+            cursor: input?.cursor,
+            signer,
+        };
+        removeUndefinedProperties(options);
+        const messagesSubscribe = await MessagesSubscribe.create(options);
+        const message = messagesSubscribe.message;
+        return {
+            author,
+            messagesSubscribe,
+            message
+        };
     }
-    static generateMessagesRead(input) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const author = (_a = input === null || input === void 0 ? void 0 : input.author) !== null && _a !== void 0 ? _a : yield TestDataGenerator.generatePersona();
-            const signer = Jws.createSigner(author);
-            const options = {
-                signer,
-                messageCid: input.messageCid,
-                permissionGrantId: input.permissionGrantId
-            };
-            const messagesRead = yield MessagesRead.create(options);
-            return {
-                author,
-                messagesRead,
-                message: messagesRead.message,
-            };
-        });
+    static async generateMessagesRead(input) {
+        const author = input?.author ?? await TestDataGenerator.generatePersona();
+        const signer = Jws.createSigner(author);
+        const options = {
+            signer,
+            messageCid: input.messageCid,
+            permissionGrantId: input.permissionGrantId
+        };
+        const messagesRead = await MessagesRead.create(options);
+        return {
+            author,
+            messagesRead,
+            message: messagesRead.message,
+        };
     }
     /**
      * Generates a dummy `authorization` property for a DWN message that only conforms to schema validation.
@@ -557,13 +542,11 @@ export class TestDataGenerator {
     /**
      * Generates a random but well-formed signature string in Base64Url format.
      */
-    static randomSignatureString() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const keyPair = yield ed25519.generateKeyPair();
-            const signatureBytes = yield ed25519.sign(TestDataGenerator.randomBytes(32), keyPair.privateJwk);
-            const signatureString = Encoder.bytesToBase64Url(signatureBytes);
-            return signatureString;
-        });
+    static async randomSignatureString() {
+        const keyPair = await ed25519.generateKeyPair();
+        const signatureBytes = await ed25519.sign(TestDataGenerator.randomBytes(32), keyPair.privateJwk);
+        const signatureString = Encoder.bytesToBase64Url(signatureBytes);
+        return signatureString;
     }
     /**
      * Generates a random alpha-numeric string.
@@ -592,13 +575,11 @@ export class TestDataGenerator {
     /**
      * Generates a random CBOR SHA256 CID.
      */
-    static randomCborSha256Cid() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const randomBytes = TestDataGenerator.randomBytes(32);
-            const randomMultihash = yield sha256.digest(randomBytes);
-            const cid = yield CID.createV1(cbor.code, randomMultihash);
-            return cid.toString();
-        });
+    static async randomCborSha256Cid() {
+        const randomBytes = TestDataGenerator.randomBytes(32);
+        const randomMultihash = await sha256.digest(randomBytes);
+        const cid = await CID.createV1(cbor.code, randomMultihash);
+        return cid.toString();
     }
     /**
      * Generates a random within a range (inclusive).
@@ -648,36 +629,34 @@ export class TestDataGenerator {
     /**
      * Generates a did:key persona.
      */
-    static generateDidKeyPersona() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const did = yield DidKey.create();
-            const signingMethod = yield DidKey.getSigningMethod({ didDocument: did.document });
-            const keyId = signingMethod.id;
-            const portableDid = yield did.export();
-            const keyPair = {
-                // TODO: #672 - port and use type from @enbox/crypto - https://github.com/enboxorg/enbox/issues/672
-                publicJwk: signingMethod.publicKeyJwk,
-                privateJwk: portableDid.privateKeys[0],
-            };
-            // Generate X25519 encryption key pair for did:key personas
-            const encPrivateKey = yield X25519.generateKey();
-            const encPublicKey = yield X25519.getPublicKey({ key: encPrivateKey });
-            const encryptionKeyPair = {
-                publicJwk: encPublicKey,
-                privateJwk: encPrivateKey,
-            };
-            return {
-                did: did.uri,
-                keyId,
-                keyPair,
-                encryptionKeyPair,
-                signer: new PrivateKeySigner({
-                    privateJwk: keyPair.privateJwk,
-                    algorithm: keyPair.privateJwk.alg,
-                    keyId
-                })
-            };
-        });
+    static async generateDidKeyPersona() {
+        const did = await DidKey.create();
+        const signingMethod = await DidKey.getSigningMethod({ didDocument: did.document });
+        const keyId = signingMethod.id;
+        const portableDid = await did.export();
+        const keyPair = {
+            // TODO: #672 - port and use type from @enbox/crypto - https://github.com/enboxorg/enbox/issues/672
+            publicJwk: signingMethod.publicKeyJwk,
+            privateJwk: portableDid.privateKeys[0],
+        };
+        // Generate X25519 encryption key pair for did:key personas
+        const encPrivateKey = await X25519.generateKey();
+        const encPublicKey = await X25519.getPublicKey({ key: encPrivateKey });
+        const encryptionKeyPair = {
+            publicJwk: encPublicKey,
+            privateJwk: encPrivateKey,
+        };
+        return {
+            did: did.uri,
+            keyId,
+            keyPair,
+            encryptionKeyPair,
+            signer: new PrivateKeySigner({
+                privateJwk: keyPair.privateJwk,
+                algorithm: keyPair.privateJwk.alg,
+                keyId
+            })
+        };
     }
 }
 //# sourceMappingURL=test-data-generator.js.map