refactor: messaging

src/messaging/CredentialApiMessageType.ts

@@ -104,8 +104,9 @@ export function ensureOwnerIsSender(message: IMessage): void {
  *
  * @param decryptedMessage The decrypted message to check.
  */
-export function verify(decryptedMessage: IMessage): void {
+export function assertKnownMessage(decryptedMessage: IMessage): IMessage['body'] {
   verifyMessageBody(decryptedMessage)
   verifyMessageEnvelope(decryptedMessage)
   ensureOwnerIsSender(decryptedMessage)
+  return decryptedMessage.body
 }

src/messaging/Error.ts

@@ -6,14 +6,18 @@
  */
 
 export declare class MessageError extends Error {}
-
 export declare class HashMalformedError extends MessageError {
   constructor(hash?: string, type?: string)
 }
 
 export declare class SignatureMalformedError extends MessageError {}
 export declare class UnknownMessageBodyTypeError extends MessageError {}
 export declare class DecodingMessageError extends MessageError {}
+export declare class CTypeUnknownPropertiesError extends MessageError {}
+export declare class InvalidDidFormatError extends MessageError {}
+export declare class DidError extends MessageError {
+  constructor(context?: string, type?: string)
+}
 export declare class IdentityMismatchError extends MessageError {
   constructor(context?: string, type?: string)
 }

src/messaging/Message.test.ts

@@ -10,7 +10,7 @@
 import { u8aToHex } from '@polkadot/util'
 import { Attestation, CType, Claim, Credential, Quote } from '@kiltprotocol/core'
 import * as Did from '@kiltprotocol/did'
-import { SDKErrors, init } from '@kiltprotocol/sdk-js'
+import { init } from '@kiltprotocol/sdk-js'
 import * as MessageError from './Error'
 import { Crypto } from '@kiltprotocol/utils'
 import type {
@@ -36,7 +36,7 @@ import {
 } from '../tests'
 import { fromBody, verifyRequiredCTypeProperties } from './utils'
 import { decrypt, encrypt, verifyMessageEnvelope } from './MessageEnvelope'
-import { ensureOwnerIsSender, verify, verifyMessageBody } from './CredentialApiMessageType'
+import { ensureOwnerIsSender, assertKnownMessage, verifyMessageBody } from './CredentialApiMessageType'
 import type {
   IEncryptedMessage,
   IMessage,
@@ -133,7 +133,7 @@ describe('Messaging', () => {
     const decryptedMessage = await decrypt(encryptedMessage, bobEncKey.decrypt, { resolveKey })
     expect(JSON.stringify(message.body)).toEqual(JSON.stringify(decryptedMessage.body))
 
-    expect(() => verify(decryptedMessage)).not.toThrow()
+    expect(() => assertKnownMessage(decryptedMessage)).not.toThrow()
 
     const encryptedMessageWrongContent = JSON.parse(
       JSON.stringify(encryptedMessage)
@@ -666,11 +666,11 @@ describe('Error checking / Verification', () => {
 
   it('Checking required properties for given CType', () => {
     expect(() => verifyRequiredCTypeProperties(['id', 'name'], testCType)).toThrowError(
-      SDKErrors.CTypeUnknownPropertiesError
+      MessageError.CTypeUnknownPropertiesError
     )
 
     expect(() => verifyRequiredCTypeProperties(['id', 'name'], testCTypeWithMultipleProperties)).not.toThrowError(
-      SDKErrors.CTypeUnknownPropertiesError
+      MessageError.CTypeUnknownPropertiesError
     )
 
     expect(() => verifyRequiredCTypeProperties(['id', 'name'], testCTypeWithMultipleProperties)).not.toThrowError()
@@ -707,7 +707,7 @@ describe('Error checking / Verification', () => {
   it('message envelope verifier should throw errors on faulty envelopes', () => {
     // @ts-ignore
     messageSubmitTerms.sender = 'this is not a sender did'
-    expect(() => verifyMessageEnvelope(messageSubmitTerms)).toThrowError(SDKErrors.InvalidDidFormatError)
+    expect(() => verifyMessageEnvelope(messageSubmitTerms)).toThrowError(MessageError.InvalidDidFormatError)
     // @ts-ignore
     messageRequestAttestationForClaim.messageId = 12
     expect(() => verifyMessageEnvelope(messageRequestAttestationForClaim)).toThrowError(TypeError)

src/messaging/MessageEnvelope.ts

@@ -7,7 +7,6 @@
 
 import { DecryptCallback, DidResolveKey, DidResourceUri, EncryptCallback } from '@kiltprotocol/types'
 import * as Did from '@kiltprotocol/did'
-import { SDKErrors } from '@kiltprotocol/sdk-js'
 import * as MessageError from './Error'
 import { hexToU8a, stringToU8a, u8aToHex, u8aToString } from '@polkadot/util'
 
@@ -60,7 +59,7 @@ export async function decrypt(
 
   const { fragment } = Did.parse(receiverKeyUri)
   if (!fragment) {
-    throw new SDKErrors.DidError(`No fragment for the receiver key ID "${receiverKeyUri}"`)
+    throw new MessageError.DidError(`No fragment for the receiver key ID "${receiverKeyUri}"`)
   }
 
   let data: Uint8Array

src/messaging/utils.ts

@@ -7,7 +7,8 @@
 
 import { ICType } from '@kiltprotocol/types'
 import { IMessage, MessageBody } from '../types'
-import { CType, SDKErrors } from '@kiltprotocol/sdk-js'
+import * as MessageError from './Error'
+import { CType } from '@kiltprotocol/sdk-js'
 import { UUID } from '@kiltprotocol/utils'
 
 /**
@@ -40,6 +41,6 @@ export function verifyRequiredCTypeProperties(requiredProperties: string[], cTyp
 
   const unknownProperties = requiredProperties.find((property) => !(property in cType.properties))
   if (unknownProperties) {
-    throw new SDKErrors.CTypeUnknownPropertiesError()
+    throw new MessageError.CTypeUnknownPropertiesError()
   }
 }

src/quote/Error.ts

@@ -12,3 +12,5 @@ export declare class HashMalformedError extends QuoteError {
 }
 
 export declare class QuoteUnverifiableError extends QuoteError {}
+export declare class SignatureUnverifiableError extends QuoteError {}
+export declare class DidSubjectMismatchError extends QuoteError {}

src/quote/Quote.test.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 /* eslint-disable @typescript-eslint/ban-ts-comment */
+
 /**
  * Copyright (c) 2018-2023, BOTLabs GmbH.
  *
@@ -20,12 +21,13 @@ import type {
   IQuoteAttesterSigned,
   ResolvedDidKey,
 } from '@kiltprotocol/types'
-import { Crypto, SDKErrors } from '@kiltprotocol/utils'
+import { Crypto } from '@kiltprotocol/utils'
 import { Credential, CType } from '@kiltprotocol/sdk-js'
 
 import { createLocalDemoFullDidFromKeypair, makeSigningKeyTool } from '../tests'
 import * as Quote from './Quote'
 import { QuoteSchema } from './QuoteSchema'
+import * as QuoteError from './Error'
 
 describe('Quote', () => {
   let claimerIdentity: DidDocument
@@ -193,7 +195,7 @@ describe('Quote', () => {
       Quote.verifyAttesterSignedQuote(messedWithCurrency, {
         didResolveKey: mockResolveKey,
       })
-    ).rejects.toThrow(SDKErrors.SignatureUnverifiableError)
+    ).rejects.toThrow(QuoteError.SignatureUnverifiableError)
     const messedWithRootHash: IQuoteAgreement = {
       ...quoteBothAgreed,
       rootHash: '0x1234',
@@ -202,7 +204,7 @@ describe('Quote', () => {
       Quote.verifyQuoteAgreement(messedWithRootHash, {
         didResolveKey: mockResolveKey,
       })
-    ).rejects.toThrow(SDKErrors.SignatureUnverifiableError)
+    ).rejects.toThrow(QuoteError.SignatureUnverifiableError)
   })
 
   it('complains if attesterDid does not match attester signature', async () => {
@@ -224,7 +226,7 @@ describe('Quote', () => {
       Quote.verifyAttesterSignedQuote(wrongSignerAttester, {
         didResolveKey: mockResolveKey,
       })
-    ).rejects.toThrow(SDKErrors.DidSubjectMismatchError)
+    ).rejects.toThrow(QuoteError.DidSubjectMismatchError)
   })
 
   it('complains if claimerDid does not match claimer signature', async () => {
@@ -246,6 +248,6 @@ describe('Quote', () => {
       Quote.verifyQuoteAgreement(wrongSignerClaimer, {
         didResolveKey: mockResolveKey,
       })
-    ).rejects.toThrow(SDKErrors.DidSubjectMismatchError)
+    ).rejects.toThrow(QuoteError.DidSubjectMismatchError)
   })
 })

src/tests/index.ts

@@ -1,2 +1,9 @@
+/**
+ * Copyright (c) 2018-2023, BOTLabs GmbH.
+ *
+ * This source code is licensed under the BSD 4-Clause "Original" license
+ * found in the LICENSE file in the root directory of this source tree.
+ */
+
 export * from './messageUtils'
 export * from './utils'

src/types/Imported.ts

@@ -5,11 +5,7 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-export type {
-  ISubmittableResult,
-  AnyNumber,
-  AnyJson,
-} from '@polkadot/types/types'
+export type { ISubmittableResult, AnyNumber, AnyJson } from '@polkadot/types/types'
 export type { BN } from '@polkadot/util'
 export type { HexString } from '@polkadot/util/types'
 export type { Prefix } from '@polkadot/util-crypto/address/types'

src/types/Message.ts

@@ -1,4 +1,14 @@
-import type { ICredential, ICredentialPresentation, IAttestation, CTypeHash, DidResourceUri, DidUri, IDelegationNode, PartialClaim, ICType } from '@kiltprotocol/types'
+import type {
+  ICredential,
+  ICredentialPresentation,
+  IAttestation,
+  CTypeHash,
+  DidResourceUri,
+  DidUri,
+  IDelegationNode,
+  PartialClaim,
+  ICType,
+} from '@kiltprotocol/types'
 import type { IQuoteAgreement, IQuoteAttesterSigned } from './Quote'
 
 /**
@@ -30,12 +40,11 @@ export type MessageBodyType =
   | 'submit-credential'
   | 'reject-terms'
 
-export interface IMessageBodyBase<Type extends string = string, Content = unknown>  {
+export interface IMessageBodyBase<Type extends string = string, Content = unknown> {
   content: Content
   type: Type
 }
 
-
 /**
  * - `body` - The body of the message, see [[MessageBody]].
  * - `createdAt` - The timestamp of the message construction.
@@ -46,7 +55,7 @@ export interface IMessageBodyBase<Type extends string = string, Content = unknow
  * - `inReplyTo` - The id of the parent-message.
  * - `references` - The references or the in-reply-to of the parent-message followed by the message-id of the parent-message.
  */
-export interface IMessage<Body extends IMessageBodyBase = {type: string, content: unknown}> {
+export interface IMessage<Body extends IMessageBodyBase = { type: string; content: unknown }> {
   body: Body
   createdAt: number
   sender: DidUri
@@ -61,19 +70,18 @@ export interface IMessage<Body extends IMessageBodyBase = {type: string, content
  * Error messages signal unintentional programming errors which happened during
  * the processing of the incoming messages or when constructing a response message.
  */
-export type IError = IMessageBodyBase<'error', {name? : string, message?: string}>;
+export type IError = IMessageBodyBase<'error', { name?: string; message?: string }>
 
 /**
  * Rejection messages signal the intentional cancelling of an individual step in the flow.
  */
-export type IReject = IMessageBodyBase<'reject', {name? : string, message?: string}>;
+export type IReject = IMessageBodyBase<'reject', { name?: string; message?: string }>
 
 /**
  * An attester utilizes the message to propose a claim. The purpose of the extension is to enable
  * the user to authorize and endorse the claims prepared by the attester.
  */
-export type ISubmitTerms = IMessageBodyBase<'submit-terms', ITerms>;
-
+export type ISubmitTerms = IMessageBodyBase<'submit-terms', ITerms>
 
 /**
  * The content of the [IRequestAttestation] message.
@@ -90,7 +98,6 @@ export interface IRequestAttestationContent {
  */
 export type IRequestAttestation = IMessageBodyBase<'request-attestation', IRequestAttestationContent>
 
-
 /**
  * The content of the [IRequestPayment] message.
  */
@@ -104,7 +111,6 @@ export interface IRequestPaymentContent {
  */
 export type IRequestPayment = IMessageBodyBase<'request-payment', IRequestPaymentContent>
 
-
 /**
  * The content of the [ISubmitAttestation] message.
  */
@@ -117,15 +123,11 @@ export interface ISubmitAttestationContent {
  */
 export type ISubmitAttestation = IMessageBodyBase<'submit-attestation', ISubmitAttestationContent>
 
-
 /**
  * If the attester does not approve the attestation request, the extension receives the [IRejectAttestation] message.
  */
 export type IRejectAttestation = IMessageBodyBase<'reject-attestation', ICredential['rootHash']>
 
-
-
-
 /**
  * The content of the [ISubmitTerms] message.
  */
@@ -141,7 +143,6 @@ export interface ITerms {
   cTypes?: ICType[]
 }
 
-
 /** Message to submit credentials from the extension or dapp.*/
 export type ISubmitCredential = IMessageBodyBase<'submit-credential', ICredentialPresentation[]>
 
@@ -159,7 +160,6 @@ export interface IRequestCredentialContent {
 
 export type IRequestCredential = IMessageBodyBase<'request-credential', IRequestCredentialContent>
 
-
 /**
  * The content of the [IConfirmPayment] message.
  */
@@ -172,7 +172,6 @@ export interface IConfirmPaymentContent {
   blockHash: string
 }
 
-
 /**
  * After the user has authorized the payment and it has been transferred,
  * the extension confirms the transfer to the attester by sending the [IConfirmPayment] message.
@@ -182,7 +181,10 @@ export type IConfirmPayment = IMessageBodyBase<'confirm-payment', IConfirmPaymen
 /**
  * Everything which is part of the encrypted and protected part of the [[IMessage]].
  */
-export type IEncryptedMessageContents<Body extends IMessageBodyBase = {type: string, content: unknown}> = Omit<IMessage<Body>, 'receivedAt'>
+export type IEncryptedMessageContents<Body extends IMessageBodyBase = { type: string; content: unknown }> = Omit<
+  IMessage<Body>,
+  'receivedAt'
+>
 
 /**
  * Removes the plaintext [[IEncryptedMessageContents]] from an [[IMessage]] and instead includes them in encrypted form.
@@ -192,7 +194,10 @@ export type IEncryptedMessageContents<Body extends IMessageBodyBase = {type: str
  * - `receiverKeyUri` - The URI of the receiver's encryption key.
  * - `senderKeyUri` - The URI of the sender's encryption key.
  */
-export type IEncryptedMessage<Body extends IMessageBodyBase = {type: string, content: unknown}> = Pick<IMessage<Body>, 'receivedAt'> & {
+export type IEncryptedMessage<Body extends IMessageBodyBase = { type: string; content: unknown }> = Pick<
+  IMessage<Body>,
+  'receivedAt'
+> & {
   receiverKeyUri: DidResourceUri
   senderKeyUri: DidResourceUri
   ciphertext: string

src/types/Quote.ts

@@ -28,7 +28,7 @@ export interface IQuote {
  * Signed quote from attester
  */
 export interface IQuoteAttesterSigned extends IQuote {
- // Signature of the attester
+  // Signature of the attester
   attesterSignature: DidSignature
 }
 
@@ -42,4 +42,3 @@ export interface IQuoteAgreement extends IQuoteAttesterSigned {
   // The signature of the claimer.
   claimerSignature: DidSignature
 }
-