@abaxxtech/id 0.0.0

package/dist/esm/src/utils/records.js

@@ -0,0 +1,267 @@
+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 { Encoder } from './encoder.js';
+import { Encryption } from './encryption.js';
+import { KeyDerivationScheme } from './hd-key.js';
+import { Message } from '../core/message.js';
+import { Secp256k1 } from './secp256k1.js';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+import { normalizeProtocolUrl, normalizeSchemaUrl } from './url.js';
+/**
+ * Class containing useful utilities related to the Records interface.
+ */
+export class Records {
+    /**
+     * Decrypts the encrypted data in a message reply using the given ancestor private key.
+     * @param ancestorPrivateKey Any ancestor private key in the key derivation path.
+     */
+    static decrypt(recordsWrite, ancestorPrivateKey, cipherStream) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { encryption } = recordsWrite;
+            // look for an encrypted symmetric key that is encrypted by the public key corresponding to the given private key
+            const matchingEncryptedKey = encryption.keyEncryption.find(key => key.rootKeyId === ancestorPrivateKey.rootKeyId &&
+                key.derivationScheme === ancestorPrivateKey.derivationScheme);
+            if (matchingEncryptedKey === undefined) {
+                throw new DwnError(DwnErrorCode.RecordsDecryptNoMatchingKeyEncryptedFound, `Unable to find a symmetric key encrypted using key \
+        with ID '${ancestorPrivateKey.rootKeyId}' and '${ancestorPrivateKey.derivationScheme}' derivation scheme.`);
+            }
+            const fullDerivationPath = Records.constructKeyDerivationPath(matchingEncryptedKey.derivationScheme, recordsWrite);
+            // NOTE: right now only `ECIES-ES256K` algorithm is supported for asymmetric encryption,
+            // so we will assume that's the algorithm without additional switch/if statements
+            const leafPrivateKey = yield Records.derivePrivateKey(ancestorPrivateKey, fullDerivationPath);
+            const encryptedKeyBytes = Encoder.base64UrlToBytes(matchingEncryptedKey.encryptedKey);
+            const ephemeralPublicKey = Secp256k1.publicJwkToBytes(matchingEncryptedKey.ephemeralPublicKey);
+            const keyEncryptionInitializationVector = Encoder.base64UrlToBytes(matchingEncryptedKey.initializationVector);
+            const messageAuthenticationCode = Encoder.base64UrlToBytes(matchingEncryptedKey.messageAuthenticationCode);
+            const dataEncryptionKey = yield Encryption.eciesSecp256k1Decrypt({
+                ciphertext: encryptedKeyBytes,
+                ephemeralPublicKey,
+                initializationVector: keyEncryptionInitializationVector,
+                messageAuthenticationCode,
+                privateKey: leafPrivateKey
+            });
+            // NOTE: right now only `A256CTR` algorithm is supported for symmetric encryption,
+            // so we will assume that's the algorithm without additional switch/if statements
+            const dataEncryptionInitializationVector = Encoder.base64UrlToBytes(encryption.initializationVector);
+            const plaintextStream = yield Encryption.aes256CtrDecrypt(dataEncryptionKey, dataEncryptionInitializationVector, cipherStream);
+            return plaintextStream;
+        });
+    }
+    /**
+     * Constructs full key derivation path using the specified scheme.
+     */
+    static constructKeyDerivationPath(keyDerivationScheme, recordsWriteMessage) {
+        const descriptor = recordsWriteMessage.descriptor;
+        const contextId = recordsWriteMessage.contextId;
+        let fullDerivationPath;
+        if (keyDerivationScheme === KeyDerivationScheme.DataFormats) {
+            fullDerivationPath = Records.constructKeyDerivationPathUsingDataFormatsScheme(descriptor.schema, descriptor.dataFormat);
+        }
+        else if (keyDerivationScheme === KeyDerivationScheme.ProtocolPath) {
+            fullDerivationPath = Records.constructKeyDerivationPathUsingProtocolPathScheme(descriptor);
+        }
+        else if (keyDerivationScheme === KeyDerivationScheme.ProtocolContext) {
+            fullDerivationPath = Records.constructKeyDerivationPathUsingProtocolContextScheme(contextId);
+        }
+        else {
+            // `schemas` scheme
+            fullDerivationPath = Records.constructKeyDerivationPathUsingSchemasScheme(descriptor.schema);
+        }
+        return fullDerivationPath;
+    }
+    /**
+     * Constructs the full key derivation path using `dataFormats` scheme.
+     */
+    static constructKeyDerivationPathUsingDataFormatsScheme(schema, dataFormat) {
+        if (schema !== undefined) {
+            return [
+                KeyDerivationScheme.DataFormats,
+                schema, // this is as spec-ed on TP27, the intent is to support sharing the key for just a specific data type under a schema
+                dataFormat
+            ];
+        }
+        else {
+            return [
+                KeyDerivationScheme.DataFormats,
+                dataFormat
+            ];
+        }
+    }
+    /**
+     * Constructs the full key derivation path using `protocolPath` scheme.
+     */
+    static constructKeyDerivationPathUsingProtocolPathScheme(descriptor) {
+        // ensure `protocol` is defined
+        // NOTE: no need to check `protocolPath` and `contextId` because earlier code ensures that if `protocol` is defined, those are defined also
+        if (descriptor.protocol === undefined) {
+            throw new DwnError(DwnErrorCode.RecordsProtocolPathDerivationSchemeMissingProtocol, 'Unable to construct key derivation path using `protocols` scheme because `protocol` is missing.');
+        }
+        const protocolPathSegments = descriptor.protocolPath.split('/');
+        const fullDerivationPath = [
+            KeyDerivationScheme.ProtocolPath,
+            descriptor.protocol,
+            ...protocolPathSegments
+        ];
+        return fullDerivationPath;
+    }
+    /**
+     * Constructs the full key derivation path using `protocolContext` scheme.
+     */
+    static constructKeyDerivationPathUsingProtocolContextScheme(contextId) {
+        if (contextId === undefined) {
+            throw new DwnError(DwnErrorCode.RecordsProtocolContextDerivationSchemeMissingContextId, 'Unable to construct key derivation path using `protocolContext` scheme because `contextId` is missing.');
+        }
+        const fullDerivationPath = [
+            KeyDerivationScheme.ProtocolContext,
+            contextId
+        ];
+        return fullDerivationPath;
+    }
+    /**
+     * Constructs the full key derivation path using `schemas` scheme.
+     */
+    static constructKeyDerivationPathUsingSchemasScheme(schema) {
+        if (schema === undefined) {
+            throw new DwnError(DwnErrorCode.RecordsSchemasDerivationSchemeMissingSchema, 'Unable to construct key derivation path using `schemas` scheme because `schema` is missing.');
+        }
+        const fullDerivationPath = [
+            KeyDerivationScheme.Schemas,
+            schema
+        ];
+        return fullDerivationPath;
+    }
+    /**
+     * Derives a descendant private key given an ancestor private key and the full absolute derivation path.
+     * NOTE: right now only `ECIES-ES256K` algorithm is supported for asymmetric encryption,
+     *       so we will only derive SECP256K1 key without additional conditional checks
+     */
+    static derivePrivateKey(ancestorPrivateKey, fullDescendantDerivationPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            if (ancestorPrivateKey.derivedPrivateKey.crv !== 'secp256k1') {
+                throw new DwnError(DwnErrorCode.RecordsDerivePrivateKeyUnSupportedCurve, `Curve ${ancestorPrivateKey.derivedPrivateKey.crv} is not supported.`);
+            }
+            const ancestorPrivateKeyDerivationPath = (_a = ancestorPrivateKey.derivationPath) !== null && _a !== void 0 ? _a : [];
+            Records.validateAncestorKeyAndDescentKeyDerivationPathsMatch(ancestorPrivateKeyDerivationPath, fullDescendantDerivationPath);
+            const subDerivationPath = fullDescendantDerivationPath.slice(ancestorPrivateKeyDerivationPath.length);
+            const ancestorPrivateKeyBytes = Secp256k1.privateJwkToBytes(ancestorPrivateKey.derivedPrivateKey);
+            const leafPrivateKey = yield Secp256k1.derivePrivateKey(ancestorPrivateKeyBytes, subDerivationPath);
+            return leafPrivateKey;
+        });
+    }
+    /**
+     * Validates that ancestor derivation path matches the descendant derivation path completely.
+     * @throws {DwnError} with `DwnErrorCode.RecordsInvalidAncestorKeyDerivationSegment` if fails validation.
+     */
+    static validateAncestorKeyAndDescentKeyDerivationPathsMatch(ancestorKeyDerivationPath, descendantKeyDerivationPath) {
+        for (let i = 0; i < ancestorKeyDerivationPath.length; i++) {
+            const ancestorSegment = ancestorKeyDerivationPath[i];
+            const descendantSegment = descendantKeyDerivationPath[i];
+            if (ancestorSegment !== descendantSegment) {
+                throw new DwnError(DwnErrorCode.RecordsInvalidAncestorKeyDerivationSegment, `Ancestor key derivation segment '${ancestorSegment}' mismatches against the descendant key derivation segment '${descendantSegment}'.`);
+            }
+        }
+    }
+    /**
+     * Normalizes the protocol and schema URLs within a provided RecordsFilter and returns a copy of RecordsFilter with the modified values.
+     *
+     * @param filter incoming RecordsFilter to normalize.
+     * @returns {RecordsFilter} a copy of the incoming RecordsFilter with the normalized properties.
+     */
+    static normalizeFilter(filter) {
+        let protocol;
+        if (filter.protocol === undefined) {
+            protocol = undefined;
+        }
+        else {
+            protocol = normalizeProtocolUrl(filter.protocol);
+        }
+        let schema;
+        if (filter.schema === undefined) {
+            schema = undefined;
+        }
+        else {
+            schema = normalizeSchemaUrl(filter.schema);
+        }
+        return Object.assign(Object.assign({}, filter), { protocol,
+            schema });
+    }
+    /**
+     *  Converts an incoming RecordsFilter into a Filter usable by MessageStore.
+     *
+     * @param filter A RecordsFilter
+     * @returns {Filter} a generic Filter able to be used with MessageStore.
+     */
+    static convertFilter(filter) {
+        const filterCopy = Object.assign({}, filter);
+        const { dateCreated, datePublished, dateUpdated } = filter;
+        const dateCreatedFilter = dateCreated ? this.convertRangeCriterion(dateCreated) : undefined;
+        if (dateCreatedFilter) {
+            filterCopy.dateCreated = dateCreatedFilter;
+        }
+        const datePublishedFilter = datePublished ? this.convertRangeCriterion(datePublished) : undefined;
+        if (datePublishedFilter) {
+            // only return published records when filtering with a datePublished range.
+            filterCopy.published = true;
+            filterCopy.datePublished = datePublishedFilter;
+        }
+        const messageTimestampFilter = dateUpdated ? this.convertRangeCriterion(dateUpdated) : undefined;
+        if (messageTimestampFilter) {
+            filterCopy.messageTimestamp = messageTimestampFilter;
+            delete filterCopy.dateUpdated;
+        }
+        return filterCopy;
+    }
+    static convertRangeCriterion(inputFilter) {
+        let rangeFilter;
+        if (inputFilter.to !== undefined && inputFilter.from !== undefined) {
+            rangeFilter = {
+                gte: inputFilter.from,
+                lt: inputFilter.to,
+            };
+        }
+        else if (inputFilter.to !== undefined) {
+            rangeFilter = {
+                lt: inputFilter.to,
+            };
+        }
+        else if (inputFilter.from !== undefined) {
+            rangeFilter = {
+                gte: inputFilter.from,
+            };
+        }
+        return rangeFilter;
+    }
+    /**
+     * Validates the referential integrity regarding delegated grant.
+     * @param signaturePayload Decoded payload of the signature of the message. `undefined` if message is not signed.
+     *                         Usage of this property is purely for performance optimization so we don't have to decode the signature payload again.
+     */
+    static validateDelegatedGrantReferentialIntegrity(message, signaturePayload) {
+        var _a;
+        // `deletedGrantId` in the payload of the message signature and `authorDelegatedGrant` in `authorization` must both exist or be both undefined
+        const delegatedGrantIdDefined = (signaturePayload === null || signaturePayload === void 0 ? void 0 : signaturePayload.delegatedGrantId) !== undefined;
+        const authorDelegatedGrantDefined = ((_a = message.authorization) === null || _a === void 0 ? void 0 : _a.authorDelegatedGrant) !== undefined;
+        if (delegatedGrantIdDefined !== authorDelegatedGrantDefined) {
+            throw new DwnError(DwnErrorCode.RecordsValidateIntegrityDelegatedGrantAndIdExistenceMismatch, `delegatedGrantId and authorDelegatedGrant must both exist or be undefined. \
+           delegatedGrantId defined: ${delegatedGrantIdDefined}, authorDelegatedGrant defined: ${authorDelegatedGrantDefined}`);
+        }
+        // when delegated grant exists, the grantee (grantedTo) must be the same as the signer of the message
+        if (authorDelegatedGrantDefined) {
+            const delegatedGrant = message.authorization.authorDelegatedGrant;
+            const grantedTo = delegatedGrant.descriptor.grantedTo;
+            const signer = Message.getSigner(message);
+            if (grantedTo !== signer) {
+                throw new DwnError(DwnErrorCode.RecordsValidateIntegrityGrantedToAndSignerMismatch, `grantedTo ${grantedTo} must be the same as the signer ${signer} of the message`);
+            }
+        }
+    }
+}
+//# sourceMappingURL=records.js.map

package/dist/esm/src/utils/records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../../../../src/utils/records.ts"],"names":[],"mappings":";;;;;;;;;AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEpE;;GAEG;AACH,MAAM,OAAO,OAAO;IAClB;;;OAGG;IACI,MAAM,CAAO,OAAO,CACzB,YAAiC,EACjC,kBAAqC,EACrC,YAAsB;;YAEtB,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC;YAEpC,iHAAiH;YACjH,MAAM,oBAAoB,GAAG,UAAW,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAChE,GAAG,CAAC,SAAS,KAAK,kBAAkB,CAAC,SAAS;gBAC9C,GAAG,CAAC,gBAAgB,KAAK,kBAAkB,CAAC,gBAAgB,CAC7D,CAAC;YACF,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACvC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,yCAAyC,EACtD;mBACW,kBAAkB,CAAC,SAAS,UAAU,kBAAkB,CAAC,gBAAgB,sBAAsB,CAC3G,CAAC;YACJ,CAAC;YAED,MAAM,kBAAkB,GAAG,OAAO,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;YAEnH,wFAAwF;YACxF,iFAAiF;YACjF,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;YAC9F,MAAM,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;YACtF,MAAM,kBAAkB,GAAG,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;YAC/F,MAAM,iCAAiC,GAAG,OAAO,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;YAC9G,MAAM,yBAAyB,GAAG,OAAO,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;YAC3G,MAAM,iBAAiB,GAAG,MAAM,UAAU,CAAC,qBAAqB,CAAC;gBAC/D,UAAU,EAAa,iBAAiB;gBACxC,kBAAkB;gBAClB,oBAAoB,EAAG,iCAAiC;gBACxD,yBAAyB;gBACzB,UAAU,EAAa,cAAc;aACtC,CAAC,CAAC;YAGH,kFAAkF;YAClF,iFAAiF;YACjF,MAAM,kCAAkC,GAAG,OAAO,CAAC,gBAAgB,CAAC,UAAW,CAAC,oBAAoB,CAAC,CAAC;YACtG,MAAM,eAAe,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,kCAAkC,EAAE,YAAY,CAAC,CAAC;YAE/H,OAAO,eAAe,CAAC;QACzB,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CACtC,mBAAwC,EACxC,mBAAwC;QAGxC,MAAM,UAAU,GAAG,mBAAmB,CAAC,UAAU,CAAC;QAClD,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,CAAC;QAEhD,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAmB,KAAK,mBAAmB,CAAC,WAAW,EAAE,CAAC;YAC5D,kBAAkB,GAAG,OAAO,CAAC,gDAAgD,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;QAC1H,CAAC;aAAM,IAAI,mBAAmB,KAAK,mBAAmB,CAAC,YAAY,EAAE,CAAC;YACpE,kBAAkB,GAAG,OAAO,CAAC,iDAAiD,CAAC,UAAU,CAAC,CAAC;QAC7F,CAAC;aAAM,IAAI,mBAAmB,KAAK,mBAAmB,CAAC,eAAe,EAAE,CAAC;YACvE,kBAAkB,GAAG,OAAO,CAAC,oDAAoD,CAAC,SAAS,CAAC,CAAC;QAC/F,CAAC;aAAM,CAAC;YACN,mBAAmB;YACnB,kBAAkB,GAAG,OAAO,CAAC,4CAA4C,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/F,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gDAAgD,CAAC,MAA0B,EAAE,UAAkB;QAC3G,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO;gBACL,mBAAmB,CAAC,WAAW;gBAC/B,MAAM,EAAE,oHAAoH;gBAC5H,UAAU;aACX,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,mBAAmB,CAAC,WAAW;gBAC/B,UAAU;aACX,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iDAAiD,CAAC,UAAkC;QAChG,+BAA+B;QAC/B,2IAA2I;QAC3I,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,kDAAkD,EAC/D,iGAAiG,CAClG,CAAC;QACJ,CAAC;QAED,MAAM,oBAAoB,GAAG,UAAU,CAAC,YAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjE,MAAM,kBAAkB,GAAG;YACzB,mBAAmB,CAAC,YAAY;YAChC,UAAU,CAAC,QAAQ;YACnB,GAAG,oBAAoB;SACxB,CAAC;QAEF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oDAAoD,CAAC,SAA6B;QAC9F,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,sDAAsD,EACnE,wGAAwG,CACzG,CAAC;QACJ,CAAC;QAED,MAAM,kBAAkB,GAAG;YACzB,mBAAmB,CAAC,eAAe;YACnC,SAAS;SACV,CAAC;QAEF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4CAA4C,CAAE,MAA0B;QACpF,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,2CAA2C,EACxD,6FAA6F,CAC9F,CAAC;QACJ,CAAC;QAED,MAAM,kBAAkB,GAAG;YACzB,mBAAmB,CAAC,OAAO;YAC3B,MAAM;SACP,CAAC;QAEF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAO,gBAAgB,CAAC,kBAAqC,EAAE,4BAAsC;;;YAChH,IAAI,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,KAAK,WAAW,EAAE,CAAC;gBAC7D,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,uCAAuC,EACpD,SAAS,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,oBAAoB,CACtE,CAAC;YACJ,CAAC;YAED,MAAM,gCAAgC,GAAG,MAAA,kBAAkB,CAAC,cAAc,mCAAI,EAAE,CAAC;YAEjF,OAAO,CAAC,oDAAoD,CAAC,gCAAgC,EAAE,4BAA4B,CAAC,CAAC;YAE7H,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,KAAK,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;YACtG,MAAM,uBAAuB,GAAG,SAAS,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;YAClG,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,iBAAiB,CAAC,CAAC;YAEpG,OAAO,cAAc,CAAC;QACxB,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAC,oDAAoD,CAChE,yBAAmC,EACnC,2BAAqC;QAErC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,yBAAyB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1D,MAAM,eAAe,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC;YACrD,MAAM,iBAAiB,GAAG,2BAA2B,CAAC,CAAC,CAAC,CAAC;YACzD,IAAI,eAAe,KAAK,iBAAiB,EAAE,CAAC;gBAC1C,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,0CAA0C,EACvD,oCAAoC,eAAe,+DAA+D,iBAAiB,IAAI,CAAC,CAAC;YAC7I,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,MAAqB;QACjD,IAAI,QAAQ,CAAC;QACb,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,QAAQ,GAAG,SAAS,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,MAAM,CAAC;QACX,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;QAED,uCACK,MAAM,KACT,QAAQ;YACR,MAAM,IACN;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,MAAqB;QAC/C,MAAM,UAAU,GAAG,kBAAK,MAAM,CAAY,CAAC;QAE3C,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC3D,MAAM,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5F,IAAI,iBAAiB,EAAE,CAAC;YACtB,UAAU,CAAC,WAAW,GAAG,iBAAiB,CAAC;QAC7C,CAAC;QAED,MAAM,mBAAmB,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAA,CAAC,CAAC,SAAS,CAAC;QACjG,IAAI,mBAAmB,EAAE,CAAC;YACxB,2EAA2E;YAC3E,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC;YAC5B,UAAU,CAAC,aAAa,GAAG,mBAAmB,CAAC;QACjD,CAAC;QAED,MAAM,sBAAsB,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjG,IAAI,sBAAsB,EAAE,CAAC;YAC3B,UAAU,CAAC,gBAAgB,GAAG,sBAAsB,CAAC;YACrD,OAAO,UAAU,CAAC,WAAW,CAAC;QAChC,CAAC;QACD,OAAO,UAAoB,CAAC;IAC9B,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,WAA2B;QAC9D,IAAI,WAAoC,CAAC;QACzC,IAAI,WAAW,CAAC,EAAE,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACnE,WAAW,GAAG;gBACZ,GAAG,EAAG,WAAW,CAAC,IAAI;gBACtB,EAAE,EAAI,WAAW,CAAC,EAAE;aACrB,CAAC;QACJ,CAAC;aAAM,IAAI,WAAW,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YACxC,WAAW,GAAG;gBACZ,EAAE,EAAE,WAAW,CAAC,EAAE;aACnB,CAAC;QACJ,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1C,WAAW,GAAG;gBACZ,GAAG,EAAE,WAAW,CAAC,IAAI;aACtB,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,0CAA0C,CACtD,OAA8F,EAC9F,gBAAqD;;QAErD,8IAA8I;QAC9I,MAAM,uBAAuB,GAAG,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,gBAAgB,MAAK,SAAS,CAAC;QACjF,MAAM,2BAA2B,GAAG,CAAA,MAAA,OAAO,CAAC,aAAa,0CAAE,oBAAoB,MAAK,SAAS,CAAC;QAC9F,IAAI,uBAAuB,KAAK,2BAA2B,EAAE,CAAC;YAC5D,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,4DAA4D,EACzE;uCAC+B,uBAAuB,mCAAmC,2BAA2B,EAAE,CACvH,CAAC;QACJ,CAAC;QAED,qGAAqG;QACrG,IAAI,2BAA2B,EAAE,CAAC;YAChC,MAAM,cAAc,GAAG,OAAO,CAAC,aAAc,CAAC,oBAAqB,CAAC;YACpE,MAAM,SAAS,GAAG,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC;YACtD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC1C,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;gBACzB,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,kDAAkD,EAC/D,aAAa,SAAS,mCAAmC,MAAM,iBAAiB,CACjF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/utils/secp256k1.js

@@ -0,0 +1,219 @@
+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());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import * as secp256k1 from '@noble/secp256k1';
+import { Encoder } from '../utils/encoder.js';
+import { sha256 } from 'multiformats/hashes/sha2';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+/**
+ * Class containing SECP256K1 related utility methods.
+ */
+export class Secp256k1 {
+    /**
+     * Validates the given JWK is a SECP256K1 key.
+     * @throws {Error} if fails validation.
+     */
+    static validateKey(jwk) {
+        if (jwk.kty !== 'EC' || jwk.crv !== 'secp256k1') {
+            throw new DwnError(DwnErrorCode.Secp256k1KeyNotValid, 'Invalid SECP256K1 JWK: `kty` MUST be `EC`. `crv` MUST be `secp256k1`');
+        }
+    }
+    /**
+     * Converts a public key in bytes into a JWK.
+     */
+    static publicKeyToJwk(publicKeyBytes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // ensure public key is in uncompressed format so we can convert it into both x and y value
+            let uncompressedPublicKeyBytes;
+            if (publicKeyBytes.byteLength === 33) {
+                // this means given key is compressed
+                const publicKeyHex = secp256k1.etc.bytesToHex(publicKeyBytes);
+                const curvePoints = secp256k1.ProjectivePoint.fromHex(publicKeyHex);
+                uncompressedPublicKeyBytes = curvePoints.toRawBytes(false); // isCompressed = false
+            }
+            else {
+                uncompressedPublicKeyBytes = publicKeyBytes;
+            }
+            // the first byte is a header that indicates whether the key is uncompressed (0x04 if uncompressed), we can safely ignore
+            // bytes 1 - 32 represent X
+            // bytes 33 - 64 represent Y
+            // skip the first byte because it's used as a header to indicate whether the key is uncompressed
+            const x = Encoder.bytesToBase64Url(uncompressedPublicKeyBytes.subarray(1, 33));
+            const y = Encoder.bytesToBase64Url(uncompressedPublicKeyBytes.subarray(33, 65));
+            const publicJwk = {
+                alg: 'ES256K',
+                kty: 'EC',
+                crv: 'secp256k1',
+                x,
+                y
+            };
+            return publicJwk;
+        });
+    }
+    /**
+     * Converts a private key in bytes into a JWK.
+     */
+    static privateKeyToJwk(privateKeyBytes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const publicKeyBytes = yield Secp256k1.getPublicKey(privateKeyBytes);
+            const jwk = yield Secp256k1.publicKeyToJwk(publicKeyBytes);
+            jwk.d = Encoder.bytesToBase64Url(privateKeyBytes);
+            return jwk;
+        });
+    }
+    /**
+     * Creates a compressed key in raw bytes from the given SECP256K1 JWK.
+     */
+    static publicJwkToBytes(publicJwk) {
+        const x = Encoder.base64UrlToBytes(publicJwk.x);
+        const y = Encoder.base64UrlToBytes(publicJwk.y);
+        return secp256k1.ProjectivePoint.fromAffine({
+            x: secp256k1.etc.bytesToNumberBE(x),
+            y: secp256k1.etc.bytesToNumberBE(y)
+        }).toRawBytes(true);
+    }
+    /**
+     * Creates a private key in raw bytes from the given SECP256K1 JWK.
+     */
+    static privateJwkToBytes(privateJwk) {
+        const privateKey = Encoder.base64UrlToBytes(privateJwk.d);
+        return privateKey;
+    }
+    /**
+     * Signs the provided content using the provided JWK.
+     */
+    static sign(content, privateJwk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Secp256k1.validateKey(privateJwk);
+            // the underlying lib expects us to hash the content ourselves:
+            // https://github.com/paulmillr/noble-secp256k1/blob/97aa518b9c12563544ea87eba471b32ecf179916/index.ts#L1160
+            const hashedContent = yield sha256.encode(content);
+            const hashedContentHex = secp256k1.etc.bytesToHex(hashedContent);
+            const privateKeyBytes = Secp256k1.privateJwkToBytes(privateJwk);
+            const privateKeyHex = secp256k1.etc.bytesToHex(privateKeyBytes);
+            return (yield secp256k1.signAsync(hashedContentHex, privateKeyHex)).toCompactRawBytes();
+        });
+    }
+    /**
+     * Verifies a signature against the provided payload hash and public key.
+     * @returns a boolean indicating whether the signature is valid.
+     */
+    static verify(content, signature, publicJwk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Secp256k1.validateKey(publicJwk);
+            const publicKeyBytes = Secp256k1.publicJwkToBytes(publicJwk);
+            const hashedContent = yield sha256.encode(content);
+            return secp256k1.verify(signature, hashedContent, publicKeyBytes);
+        });
+    }
+    /**
+     * Generates a random key pair in JWK format.
+     */
+    static generateKeyPair() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const privateKeyBytes = secp256k1.utils.randomPrivateKey();
+            const publicKeyBytes = secp256k1.getPublicKey(privateKeyBytes, false); // `false` = uncompressed
+            const d = Encoder.bytesToBase64Url(privateKeyBytes);
+            const publicJwk = yield Secp256k1.publicKeyToJwk(publicKeyBytes);
+            const privateJwk = Object.assign(Object.assign({}, publicJwk), { d });
+            return { publicJwk, privateJwk };
+        });
+    }
+    /**
+     * Generates key pair in raw bytes, where the `publicKey` is compressed.
+     */
+    static generateKeyPairRaw() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const privateKey = secp256k1.utils.randomPrivateKey();
+            const publicKey = secp256k1.getPublicKey(privateKey, true); // `true` = compressed
+            return { publicKey, privateKey };
+        });
+    }
+    /**
+     * Gets the compressed public key of the given private key.
+     */
+    static getPublicKey(privateKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const publicKey = secp256k1.getPublicKey(privateKey, true); // `true` = compressed
+            return publicKey;
+        });
+    }
+    /**
+     * Gets the public JWK of the given private JWK.
+     */
+    static getPublicJwk(privateKeyJwk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // strip away `d`
+            const { d: _d } = privateKeyJwk, publicKey = __rest(privateKeyJwk, ["d"]);
+            return publicKey;
+        });
+    }
+    /**
+     * Derives a hardened hierarchical deterministic public key.
+     * @returns uncompressed public key
+     */
+    static derivePublicKey(privateKey, relativePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Secp256k1.validateKeyDerivationPath(relativePath);
+            // derive the private key first then compute the derived public key from the derive private key
+            const derivedPrivateKey = yield Secp256k1.derivePrivateKey(privateKey, relativePath);
+            const derivedPublicKey = yield Secp256k1.getPublicKey(derivedPrivateKey);
+            return derivedPublicKey;
+        });
+    }
+    /**
+     * Derives a hardened hierarchical deterministic private key.
+     */
+    static derivePrivateKey(privateKey, relativePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            Secp256k1.validateKeyDerivationPath(relativePath);
+            let currentPrivateKey = privateKey;
+            for (const segment of relativePath) {
+                const derivationSegment = Encoder.stringToBytes(segment);
+                currentPrivateKey = yield Secp256k1.deriveChildPrivateKey(currentPrivateKey, derivationSegment);
+            }
+            return currentPrivateKey;
+        });
+    }
+    /**
+     * Derives a child private key using the given derivation path segment.
+     */
+    static deriveChildPrivateKey(privateKey, derivationPathSegment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // hash the private key & derivation segment
+            const privateKeyHash = yield sha256.encode(privateKey);
+            const derivationPathSegmentHash = yield sha256.encode(derivationPathSegment);
+            const combinedBytes = secp256k1.etc.concatBytes(privateKeyHash, derivationPathSegmentHash);
+            const derivedPrivateKey = secp256k1.etc.hashToPrivateKey(combinedBytes);
+            return derivedPrivateKey;
+        });
+    }
+    /**
+     * Parses the given key derivation path.
+     * @returns Path segments if successfully validate the derivation path.
+     * @throws {DwnError} with `DwnErrorCode.HdKeyDerivationPathInvalid` if derivation path fails validation.
+     */
+    static validateKeyDerivationPath(pathSegments) {
+        if (pathSegments.includes('')) {
+            throw new DwnError(DwnErrorCode.HdKeyDerivationPathInvalid, `Invalid key derivation path: ${pathSegments}`);
+        }
+    }
+}
+//# sourceMappingURL=secp256k1.js.map

package/dist/esm/src/utils/secp256k1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secp256k1.js","sourceRoot":"","sources":["../../../../src/utils/secp256k1.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAEA,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE9D;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,GAA2B;QACnD,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,GAAG,KAAK,WAAW,EAAE,CAAC;YAChD,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,oBAAoB,EAAE,sEAAsE,CAAC,CAAC;QAChI,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAO,cAAc,CAAC,cAA0B;;YAC7D,2FAA2F;YACzF,IAAI,0BAA0B,CAAC;YAC/B,IAAI,cAAc,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;gBACvC,qCAAqC;gBACnC,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;gBAC9D,MAAM,WAAW,GAAG,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACpE,0BAA0B,GAAG,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,uBAAuB;YACrF,CAAC;iBAAM,CAAC;gBACN,0BAA0B,GAAG,cAAc,CAAC;YAC9C,CAAC;YAED,yHAAyH;YACzH,2BAA2B;YAC3B,4BAA4B;YAE5B,gGAAgG;YAChG,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC/E,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YAEhF,MAAM,SAAS,GAAc;gBAC3B,GAAG,EAAG,QAAQ;gBACd,GAAG,EAAG,IAAI;gBACV,GAAG,EAAG,WAAW;gBACjB,CAAC;gBACD,CAAC;aACF,CAAC;YAEF,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,eAAe,CAAC,eAA2B;;YAC7D,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YAErE,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YAC1D,GAAkB,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YAElE,OAAO,GAAiB,CAAC;QAC3B,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,SAAoB;QACjD,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAE,CAAC,CAAC;QAEjD,OAAO,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC;YAC1C,CAAC,EAAG,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;YACpC,CAAC,EAAG,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;SACrC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,UAAsB;QACpD,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1D,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAO,IAAI,CAAC,OAAmB,EAAE,UAAsB;;YAClE,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAElC,+DAA+D;YAC/D,4GAA4G;YAC5G,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACnD,MAAM,gBAAgB,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACjE,MAAM,eAAe,GAAG,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YAChE,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YAEhE,OAAO,CAAC,MAAM,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,aAAa,CAAG,CAAC,CAAC,iBAAiB,EAAE,CAAC;QAC5F,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAO,MAAM,CAAC,OAAmB,EAAE,SAAqB,EAAE,SAAoB;;YACzF,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YAEjC,MAAM,cAAc,GAAG,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAC7D,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACnD,OAAO,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;QACpE,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,eAAe;;YACjC,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;YAC3D,MAAM,cAAc,GAAG,SAAS,CAAC,YAAY,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;YAEhG,MAAM,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YACpD,MAAM,SAAS,GAAc,MAAM,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YAC5E,MAAM,UAAU,mCAAoB,SAAS,KAAE,CAAC,GAAE,CAAC;YAEnD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QACnC,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,kBAAkB;;YACpC,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,sBAAsB;YAElF,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QACnC,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,YAAY,CAAC,UAAsB;;YACrD,MAAM,SAAS,GAAG,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,sBAAsB;YAClF,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,YAAY,CAAC,aAAyB;;YACxD,iBAAiB;YACjB,MAAM,EAAE,CAAC,EAAE,EAAE,KAAmB,aAAa,EAA3B,SAAS,UAAK,aAAa,EAAvC,KAAuB,CAAgB,CAAC;YAC9C,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAO,eAAe,CAAC,UAAsB,EAAE,YAAsB;;YAChF,SAAS,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;YAElD,+FAA+F;YAC/F,MAAM,iBAAiB,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YACrF,MAAM,gBAAgB,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;YACzE,OAAO,gBAAgB,CAAC;QAC1B,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,gBAAgB,CAAC,UAAsB,EAAE,YAAsB;;YACjF,SAAS,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;YAElD,IAAI,iBAAiB,GAAG,UAAU,CAAC;YACnC,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;gBACnC,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBACzD,iBAAiB,GAAG,MAAM,SAAS,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;YAClG,CAAC;YAED,OAAO,iBAAiB,CAAC;QAC3B,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,qBAAqB,CAAC,UAAsB,EAAE,qBAAiC;;YACjG,4CAA4C;YAC5C,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACvD,MAAM,yBAAyB,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAC7E,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc,EAAE,yBAAyB,CAAC,CAAC;YAC3F,MAAM,iBAAiB,GAAG,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACxE,OAAO,iBAAiB,CAAC;QAC3B,CAAC;KAAA;IAED;;;;OAIG;IACK,MAAM,CAAC,yBAAyB,CAAC,YAAsB;QAC7D,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,gCAAgC,YAAY,EAAE,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/utils/string.js

@@ -0,0 +1,16 @@
+/**
+ * Compares two string given in lexicographical order.
+ * @returns 1 if `a` is larger than `b`; -1 if `a` is smaller/older than `b`; 0 otherwise (same message)
+ */
+export function lexicographicalCompare(a, b) {
+    if (a > b) {
+        return 1;
+    }
+    else if (a < b) {
+        return -1;
+    }
+    else {
+        return 0;
+    }
+}
+//# sourceMappingURL=string.js.map

package/dist/esm/src/utils/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../src/utils/string.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,CAAS,EAAE,CAAS;IACzD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC"}

package/dist/esm/src/utils/time.js

@@ -0,0 +1,84 @@
+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 { Temporal } from '@js-temporal/polyfill';
+import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
+/**
+ * Time related utilities.
+ */
+export class Time {
+    /**
+     * sleeps for the desired duration
+     * @param durationInMillisecond the desired amount of sleep time
+     * @returns when the provided duration has passed
+     */
+    static sleep(durationInMillisecond) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise(resolve => setTimeout(resolve, durationInMillisecond));
+        });
+    }
+    /**
+     * We must sleep for at least 2ms to avoid timestamp collisions during testing.
+     */
+    static minimalSleep() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Time.sleep(2);
+        });
+    }
+    /**
+     * Returns an UTC ISO-8601 timestamp with microsecond precision accepted by DWN.
+     * using @js-temporal/polyfill
+     */
+    static getCurrentTimestamp() {
+        return Temporal.Now.instant().toString({ smallestUnit: 'microseconds' });
+    }
+    /**
+     * Creates a UTC ISO-8601 timestamp in microsecond precision accepted by DWN.
+     * @param options - Options for creating the timestamp.
+     * @returns string
+     */
+    static createTimestamp(options) {
+        const { year, month, day, hour, minute, second, millisecond, microsecond } = options;
+        return Temporal.ZonedDateTime.from({
+            timeZone: 'UTC',
+            year,
+            month,
+            day,
+            hour,
+            minute,
+            second,
+            millisecond,
+            microsecond
+        }).toInstant().toString({ smallestUnit: 'microseconds' });
+    }
+    /**
+     * Creates a UTC ISO-8601 timestamp offset from now or given timestamp accepted by DWN.
+     * @param offset Negative number means offset into the past.
+     */
+    static createOffsetTimestamp(offset, timestamp) {
+        const timestampInstant = timestamp ? Temporal.Instant.from(timestamp) : Temporal.Now.instant();
+        const offsetDuration = Temporal.Duration.from(offset);
+        const offsetInstant = timestampInstant.add(offsetDuration);
+        return offsetInstant.toString({ smallestUnit: 'microseconds' });
+    }
+    /**
+     * Validates that the provided timestamp is a valid number
+     * @param timestamp the timestamp to validate
+     * @throws DwnError if timestamp is not a valid number
+     */
+    static validateTimestamp(timestamp) {
+        try {
+            Temporal.Instant.from(timestamp);
+        }
+        catch (_a) {
+            throw new DwnError(DwnErrorCode.TimestampInvalid, `Invalid timestamp: ${timestamp}`);
+        }
+    }
+}
+//# sourceMappingURL=time.js.map

package/dist/esm/src/utils/time.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"time.js","sourceRoot":"","sources":["../../../../src/utils/time.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE9D;;GAEG;AACH,MAAM,OAAO,IAAI;IACf;;;;OAIG;IACI,MAAM,CAAO,KAAK,CAAC,qBAA6B;;YACrD,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;QAC5E,CAAC;KAAA;IAED;;OAEG;IACI,MAAM,CAAO,YAAY;;YAC9B,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB;QAC/B,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,OAE7B;QACC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QACrF,OAAO,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC;YACjC,QAAQ,EAAE,KAAK;YACf,IAAI;YACJ,KAAK;YACL,GAAG;YACH,IAAI;YACJ,MAAM;YACN,MAAM;YACN,WAAW;YACX,WAAW;SACZ,CAAC,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAA2B,EAAE,SAAkB;QACjF,MAAM,gBAAgB,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAC/F,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,MAAM,aAAa,GAAG,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC3D,OAAO,aAAa,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,IAAI,CAAC;YACH,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;QAAC,WAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,gBAAgB,EAAE,sBAAsB,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;CACF"}