Node: Force nominal typing for zkgroup ByteArray subclasses

Without this, two ByteArray types without any additional operations are structurally equivalent, and so TypeScript permits passing one as the other. (Thanks, Fedor!)
selfisekai · Jun 17, 2022 · 9e6343b · 9e6343b
1 parent 395e36e
commit 9e6343b
Showing 32 changed files with 57 additions and 0 deletions.
diff --git a/node/ts/zkgroup/NotarySignature.ts b/node/ts/zkgroup/NotarySignature.ts
@@ -6,6 +6,7 @@
 import ByteArray from './internal/ByteArray';
 
 export default class NotarySignature extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 64;
 
   constructor(contents: Buffer) {

diff --git a/node/ts/zkgroup/ServerPublicParams.ts b/node/ts/zkgroup/ServerPublicParams.ts
@@ -8,6 +8,8 @@ import * as Native from '../../Native';
 import NotarySignature from './NotarySignature';
 
 export default class ServerPublicParams extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ServerPublicParams_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/ServerSecretParams.ts b/node/ts/zkgroup/ServerSecretParams.ts
@@ -12,6 +12,8 @@ import ServerPublicParams from './ServerPublicParams';
 import NotarySignature from './NotarySignature';
 
 export default class ServerSecretParams extends ByteArray {
+  private readonly __type?: never;
+
   static generate(): ServerSecretParams {
     const random = randomBytes(RANDOM_LENGTH);
 

diff --git a/node/ts/zkgroup/auth/AuthCredential.ts b/node/ts/zkgroup/auth/AuthCredential.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class AuthCredential extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.AuthCredential_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/auth/AuthCredentialPresentation.ts b/node/ts/zkgroup/auth/AuthCredentialPresentation.ts
@@ -8,6 +8,8 @@ import * as Native from '../../../Native';
 import UuidCiphertext from '../groups/UuidCiphertext';
 
 export default class AuthCredentialPresentation extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.AuthCredentialPresentation_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/auth/AuthCredentialResponse.ts b/node/ts/zkgroup/auth/AuthCredentialResponse.ts
@@ -5,7 +5,10 @@
 
 import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
+
 export default class AuthCredentialResponse extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.AuthCredentialResponse_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/groups/GroupIdentifier.ts b/node/ts/zkgroup/groups/GroupIdentifier.ts
@@ -6,6 +6,7 @@
 import ByteArray from '../internal/ByteArray';
 
 export default class GroupIdentifier extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 32;
 
   constructor(contents: Buffer) {

diff --git a/node/ts/zkgroup/groups/GroupMasterKey.ts b/node/ts/zkgroup/groups/GroupMasterKey.ts
@@ -6,6 +6,7 @@
 import ByteArray from '../internal/ByteArray';
 
 export default class GroupMasterKey extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 32;
 
   constructor(contents: Buffer) {

diff --git a/node/ts/zkgroup/groups/GroupPublicParams.ts b/node/ts/zkgroup/groups/GroupPublicParams.ts
@@ -8,6 +8,8 @@ import * as Native from '../../../Native';
 import GroupIdentifier from './GroupIdentifier';
 
 export default class GroupPublicParams extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.GroupPublicParams_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/groups/GroupSecretParams.ts b/node/ts/zkgroup/groups/GroupSecretParams.ts
@@ -12,6 +12,8 @@ import GroupMasterKey from './GroupMasterKey';
 import GroupPublicParams from './GroupPublicParams';
 
 export default class GroupSecretParams extends ByteArray {
+  private readonly __type?: never;
+
   static generate(): GroupSecretParams {
     const random = randomBytes(RANDOM_LENGTH);
 

diff --git a/node/ts/zkgroup/groups/ProfileKeyCiphertext.ts b/node/ts/zkgroup/groups/ProfileKeyCiphertext.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ProfileKeyCiphertext extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ProfileKeyCiphertext_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/groups/UuidCiphertext.ts b/node/ts/zkgroup/groups/UuidCiphertext.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class UuidCiphertext extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.UuidCiphertext_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ExpiringProfileKeyCredential.ts b/node/ts/zkgroup/profiles/ExpiringProfileKeyCredential.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ExpiringProfileKeyCredential extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ExpiringProfileKeyCredential_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ExpiringProfileKeyCredentialResponse.ts b/node/ts/zkgroup/profiles/ExpiringProfileKeyCredentialResponse.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ExpiringProfileKeyCredentialResponse extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(
       contents,

diff --git a/node/ts/zkgroup/profiles/PniCredential.ts b/node/ts/zkgroup/profiles/PniCredential.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class PniCredential extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.PniCredential_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/PniCredentialPresentation.ts b/node/ts/zkgroup/profiles/PniCredentialPresentation.ts
@@ -9,6 +9,8 @@ import UuidCiphertext from '../groups/UuidCiphertext';
 import ProfileKeyCiphertext from '../groups/ProfileKeyCiphertext';
 
 export default class PniCredentialPresentation extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.PniCredentialPresentation_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/PniCredentialRequestContext.ts b/node/ts/zkgroup/profiles/PniCredentialRequestContext.ts
@@ -8,6 +8,8 @@ import * as Native from '../../../Native';
 import ProfileKeyCredentialRequest from './ProfileKeyCredentialRequest';
 
 export default class PniCredentialRequestContext extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.PniCredentialRequestContext_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/PniCredentialResponse.ts b/node/ts/zkgroup/profiles/PniCredentialResponse.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class PniCredentialResponse extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.PniCredentialResponse_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ProfileKey.ts b/node/ts/zkgroup/profiles/ProfileKey.ts
@@ -10,6 +10,7 @@ import ProfileKeyVersion from './ProfileKeyVersion';
 import { UUIDType, fromUUID } from '../internal/UUIDUtil';
 
 export default class ProfileKey extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 32;
 
   constructor(contents: Buffer) {

diff --git a/node/ts/zkgroup/profiles/ProfileKeyCommitment.ts b/node/ts/zkgroup/profiles/ProfileKeyCommitment.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ProfileKeyCommitment extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ProfileKeyCommitment_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ProfileKeyCredential.ts b/node/ts/zkgroup/profiles/ProfileKeyCredential.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ProfileKeyCredential extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ProfileKeyCredential_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ProfileKeyCredentialPresentation.ts b/node/ts/zkgroup/profiles/ProfileKeyCredentialPresentation.ts
@@ -9,6 +9,8 @@ import UuidCiphertext from '../groups/UuidCiphertext';
 import ProfileKeyCiphertext from '../groups/ProfileKeyCiphertext';
 
 export default class ProfileKeyCredentialPresentation extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ProfileKeyCredentialPresentation_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ProfileKeyCredentialRequest.ts b/node/ts/zkgroup/profiles/ProfileKeyCredentialRequest.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ProfileKeyCredentialRequest extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ProfileKeyCredentialRequest_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ProfileKeyCredentialRequestContext.ts b/node/ts/zkgroup/profiles/ProfileKeyCredentialRequestContext.ts
@@ -8,6 +8,8 @@ import * as Native from '../../../Native';
 import ProfileKeyCredentialRequest from './ProfileKeyCredentialRequest';
 
 export default class ProfileKeyCredentialRequestContext extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(
       contents,

diff --git a/node/ts/zkgroup/profiles/ProfileKeyCredentialResponse.ts b/node/ts/zkgroup/profiles/ProfileKeyCredentialResponse.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ProfileKeyCredentialResponse extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ProfileKeyCredentialResponse_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/profiles/ProfileKeyVersion.ts b/node/ts/zkgroup/profiles/ProfileKeyVersion.ts
@@ -6,6 +6,7 @@
 import ByteArray from '../internal/ByteArray';
 
 export default class ProfileKeyVersion extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 64;
 
   constructor(contents: Buffer | string) {

diff --git a/node/ts/zkgroup/receipts/ReceiptCredential.ts b/node/ts/zkgroup/receipts/ReceiptCredential.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ReceiptCredential extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ReceiptCredential_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/receipts/ReceiptCredentialPresentation.ts b/node/ts/zkgroup/receipts/ReceiptCredentialPresentation.ts
@@ -8,6 +8,7 @@ import * as Native from '../../../Native';
 import ReceiptSerial from './ReceiptSerial';
 
 export default class ReceiptCredentialPresentation extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 329;
 
   constructor(contents: Buffer) {

diff --git a/node/ts/zkgroup/receipts/ReceiptCredentialRequest.ts b/node/ts/zkgroup/receipts/ReceiptCredentialRequest.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ReceiptCredentialRequest extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ReceiptCredentialRequest_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/receipts/ReceiptCredentialRequestContext.ts b/node/ts/zkgroup/receipts/ReceiptCredentialRequestContext.ts
@@ -8,6 +8,7 @@ import * as Native from '../../../Native';
 import ReceiptCredentialRequest from './ReceiptCredentialRequest';
 
 export default class ReceiptCredentialRequestContext extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 177;
 
   constructor(contents: Buffer) {

diff --git a/node/ts/zkgroup/receipts/ReceiptCredentialResponse.ts b/node/ts/zkgroup/receipts/ReceiptCredentialResponse.ts
@@ -7,6 +7,8 @@ import ByteArray from '../internal/ByteArray';
 import * as Native from '../../../Native';
 
 export default class ReceiptCredentialResponse extends ByteArray {
+  private readonly __type?: never;
+
   constructor(contents: Buffer) {
     super(contents, Native.ReceiptCredentialResponse_CheckValidContents);
   }

diff --git a/node/ts/zkgroup/receipts/ReceiptSerial.ts b/node/ts/zkgroup/receipts/ReceiptSerial.ts
@@ -6,6 +6,7 @@
 import ByteArray from '../internal/ByteArray';
 
 export default class ReceiptSerial extends ByteArray {
+  private readonly __type?: never;
   static SIZE = 16;
 
   constructor(contents: Buffer) {