Merge pull request #10 from bigchaindb/fix-typedefs

getlarge · web-flow · commit 526fd1db844e · 2021-03-09T11:00:57.000+01:00
Fix typedefs
diff --git a/src/types/ed25519-sha256.js b/src/types/ed25519-sha256.js
@@ -4,10 +4,11 @@
  * @module types
  */
 
-const nacl = require('tweetnacl')
+const { sign } = require('tweetnacl')
 const BaseSha256 = require('./base-sha256')
 const MissingDataError = require('../errors/missing-data-error')
 const ValidationError = require('../errors/validation-error')
+const bufferToUint8Array = require('../util/buffer-to-uint-array')
 const Asn1Ed25519FingerprintContents = require('../schemas/fingerprint').Ed25519FingerprintContents
 
 let ed25519
@@ -102,9 +103,9 @@ class Ed25519Sha256 extends BaseSha256 {
       this.setPublicKey(keyPair.publicKey)
       this.signature = ed25519.Sign(message, keyPair)
     } else {
-      const keyPair = nacl.sign.keyPair.fromSeed(privateKey)
+      const keyPair = sign.keyPair.fromSeed(bufferToUint8Array(privateKey))
       this.setPublicKey(Buffer.from(keyPair.publicKey))
-      this.signature = Buffer.from(nacl.sign.detached(message, keyPair.secretKey))
+      this.signature = Buffer.from(sign.detached(bufferToUint8Array(message), keyPair.secretKey))
     }
   }
 
@@ -170,7 +171,7 @@ class Ed25519Sha256 extends BaseSha256 {
     if (ed25519) {
       result = ed25519.Verify(message, this.signature, this.publicKey)
     } else {
-      result = nacl.sign.detached.verify(message, this.signature, this.publicKey)
+      result = sign.detached.verify(bufferToUint8Array(message), bufferToUint8Array(this.signature), bufferToUint8Array(this.publicKey))
     }
 
     if (result !== true) {
diff --git a/src/util/buffer-to-uint-array.js b/src/util/buffer-to-uint-array.js
@@ -0,0 +1,3 @@
+module.exports = function bufferToUint8Array (buffer) {
+  return new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.byteLength / Uint8Array.BYTES_PER_ELEMENT)
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,19 +1,19 @@
-import type Condition from './lib/condition';
-import type Fulfillment from './lib/fulfillment';
-import type TypeRegistry from './lib/type-registry';
-import type {
+import Condition from './lib/condition';
+import Fulfillment from './lib/fulfillment';
+import TypeRegistry from './lib/type-registry';
+import {
   Ed25519Sha256Json,
   PrefixSha256Json,
   PreimageSha256Json,
   RsaSha256Json,
   ThresholdSha256Json,
 } from './types';
-import type PreimageSha256 from './types/preimage-sha256';
-import type PrefixSha256 from './types/prefix-sha256';
-import type ThresholdSha256 from './types/threshold-sha256';
-import type RsaSha256 from './types/rsa-sha256';
-import type Ed25519Sha256 from './types/ed25519-sha256';
-import type base64url from './util/base64url';
+import PreimageSha256 from './types/preimage-sha256';
+import PrefixSha256 from './types/prefix-sha256';
+import ThresholdSha256 from './types/threshold-sha256';
+import RsaSha256 from './types/rsa-sha256';
+import Ed25519Sha256 from './types/ed25519-sha256';
+import base64url from './util/base64url';
 
 export { base64url, Condition, Fulfillment, TypeRegistry };
 
diff --git a/types/lib/fulfillment.d.ts b/types/lib/fulfillment.d.ts
@@ -18,7 +18,9 @@ interface FulfillmentAsn1JsonValueMap {
   [TypeAsn1Fulfillment.Ed25519Sha256]: Ed25519Sha256Json;
 }
 
-export interface FulfillmentAsn1Json<T = TypeAsn1Fulfillment> {
+export interface FulfillmentAsn1Json<
+  T extends keyof FulfillmentAsn1JsonValueMap
+> {
   type: T;
   value: FulfillmentAsn1JsonValueMap[T];
 }
@@ -28,10 +30,21 @@ export default class Fulfillment {
 
   static fromBinary(data: Buffer): Fulfillment;
 
-  static fromAsn1Json(json: FulfillmentAsn1Json): Fulfillment;
+  static fromAsn1Json(
+    json: FulfillmentAsn1Json<keyof FulfillmentAsn1JsonValueMap>
+  ): Fulfillment;
+
+  static fromAsn1Json<T extends keyof FulfillmentAsn1JsonValueMap>(
+    json: FulfillmentAsn1Json<T>
+  ): Fulfillment;
 
   static fromJson(
-    json: PreimageSha256Json | PrefixSha256Json | ThresholdSha256Json | RsaSha256Json | Ed25519Sha256Json
+    json:
+      | PreimageSha256Json
+      | PrefixSha256Json
+      | ThresholdSha256Json
+      | RsaSha256Json
+      | Ed25519Sha256Json
   ): Fulfillment;
 
   getTypeId(): TypeId;
@@ -51,12 +64,20 @@ export default class Fulfillment {
   private calculateCost(): number;
 
   parseAsn1JsonPayload(
-    json: PreimageSha256Json | PrefixSha256Json | ThresholdSha256Json | RsaSha256Json | Ed25519Sha256Json
+    json: FulfillmentAsn1Json<keyof FulfillmentAsn1JsonValueMap>['value']
+  ): void;
+
+  parseAsn1JsonPayload<T extends keyof FulfillmentAsn1JsonValueMap>(
+    json: FulfillmentAsn1JsonValueMap[T]
   ): void;
 
   serializeUri(): string;
 
-  getAsn1Json(): FulfillmentAsn1Json;
+  getAsn1Json(): FulfillmentAsn1Json<keyof FulfillmentAsn1JsonValueMap>;
+
+  getAsn1Json<
+    T extends keyof FulfillmentAsn1JsonValueMap
+  >(): FulfillmentAsn1Json<T>;
 
   serializeBinary(): Buffer;
 
diff --git a/types/lib/type-registry.d.ts b/types/lib/type-registry.d.ts
@@ -24,7 +24,7 @@ export interface RegisteredType {
 }
 
 export default class TypeRegistry {
-  private registeredTypes: RegisteredType[] = [];
+  private registeredTypes: RegisteredType[];
 
   static findByTypeId(typeId: TypeId): RegisteredType['Class'];
 
diff --git a/types/types/ed25519-sha256.d.ts b/types/types/ed25519-sha256.d.ts
@@ -15,7 +15,6 @@ export const TYPE_ASN1_CONDITION: TypeAsn1Condition.Ed25519Sha256;
 export const TYPE_ASN1_FULFILLMENT: TypeAsn1Fulfillment.Ed25519Sha256;
 export const TYPE_CATEGORY: TypeCategory.Ed25519Sha256;
 
-export const TYPE_ID = TypeId.Ed25519Sha256;
 export const CONSTANT_COST = 131072;
 export default class Ed25519Sha256 extends BaseSha256 {
   private publicKey: Buffer;
@@ -43,7 +42,5 @@ export default class Ed25519Sha256 extends BaseSha256 {
 
   getAsn1JsonPayload(): Ed25519Sha256Asn1Json;
 
-  private calculateCost(): number;
-
   validate(message: Buffer): boolean;
 }
diff --git a/types/types/prefix-sha256.d.ts b/types/types/prefix-sha256.d.ts
@@ -8,7 +8,7 @@ import type {
   TypeName,
 } from '.';
 import type Condition from '../lib/condition';
-import type Fulfillment from '../lib/fulfillment';
+import Fulfillment, { FulfillmentAsn1JsonValueMap } from '../lib/fulfillment';
 import type BaseSha256 from './base-sha256';
 
 export const TYPE_ID = TypeId.PrefixSha256;
@@ -52,9 +52,7 @@ export default class PrefixSha256 extends BaseSha256 {
 
   parseJson(json: PrefixSha256Json): void;
 
-  parseAsn1JsonPayload(json: PrefixSha256Asn1Json): void;
-
-  private calculateCost(): number;
+  parseAsn1JsonPayload(json: FulfillmentAsn1JsonValueMap[TypeAsn1Fulfillment.PrefixSha256]): void;
 
   validate(message: Buffer): boolean;
 }
diff --git a/types/types/preimage-sha256.d.ts b/types/types/preimage-sha256.d.ts
@@ -32,7 +32,5 @@ export default class PreimageSha256 extends BaseSha256 {
 
   getAsn1JsonPayload(): PreimageSha256Asn1Json;
 
-  private calculateCost(): number;
-
   validate(message: Buffer): boolean;
 }
diff --git a/types/types/rsa-sha256.d.ts b/types/types/rsa-sha256.d.ts
@@ -1,4 +1,5 @@
 import type {
+  RsaSha256Asn1Json,
   RsaSha256Json,
   TypeAsn1Condition,
   TypeAsn1Fulfillment,
@@ -42,7 +43,5 @@ export default class RsaSha256 extends BaseSha256 {
 
   sign(message: Buffer, privateKey: string): void;
 
-  private calculateCost(): number;
-
   validate(message: Buffer): boolean;
 }
diff --git a/types/types/threshold-sha256.d.ts b/types/types/threshold-sha256.d.ts
@@ -8,7 +8,7 @@ import type {
   TypeName,
 } from '.';
 import type Condition from '../lib/condition';
-import type Fulfillment from '../lib/fulfillment';
+import Fulfillment, { FulfillmentAsn1JsonValueMap } from '../lib/fulfillment';
 import type BaseSha256 from './base-sha256';
 
 export const CONDITION = 'condition';
@@ -19,7 +19,7 @@ interface SubConditionBodyMap {
   fulfillment: Fulfillment;
 }
 
-export type SubCondition<T = 'condition' | 'fulfillment'> = {
+export type SubCondition<T extends keyof SubConditionBodyMap> = {
   type: T;
   body: SubConditionBodyMap[T];
 };
@@ -32,7 +32,7 @@ export const TYPE_CATEGORY = TypeCategory.ThresholdSha256;
 
 export default class ThresholdSha256 extends BaseSha256 {
   private threshold: number;
-  private subconditions: SubCondition[];
+  private subconditions: SubCondition<keyof SubConditionBodyMap>[];
 
   static TYPE_ID: TypeId.ThresholdSha256;
   static TYPE_NAME: TypeName.ThresholdSha256;
@@ -54,9 +54,7 @@ export default class ThresholdSha256 extends BaseSha256 {
 
   private getFingerprintContents(): Buffer;
 
-  private calculateCost(): number;
-
-  static getSubconditionCost(cond: SubCondition): number;
+  static getSubconditionCost<T extends keyof SubConditionBodyMap>(cond: SubCondition<T>): number;
 
   private static calculateWorstCaseLength(
     threshold: number,
@@ -65,7 +63,7 @@ export default class ThresholdSha256 extends BaseSha256 {
 
   parseJson(json: ThresholdSha256Json): void;
 
-  parseAsn1JsonPayload(json: ThresholdSha256Asn1Json): void;
+  parseAsn1JsonPayload(json: FulfillmentAsn1JsonValueMap[TypeAsn1Fulfillment.ThresholdSha256]): void;
 
   getAsn1JsonPayload(): ThresholdSha256Asn1Json;
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = function bufferToUint8Array (buffer) {`
	`2`	`+ return new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.byteLength / Uint8Array.BYTES_PER_ELEMENT)`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export interface RegisteredType {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`export default class TypeRegistry {`
`27`		`- private registeredTypes: RegisteredType[] = [];`
	`27`	`+ private registeredTypes: RegisteredType[];`
`28`	`28`
`29`	`29`	`static findByTypeId(typeId: TypeId): RegisteredType['Class'];`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,5 @@ export default class PreimageSha256 extends BaseSha256 {`
`32`	`32`
`33`	`33`	`getAsn1JsonPayload(): PreimageSha256Asn1Json;`
`34`	`34`
`35`		`- private calculateCost(): number;`
`36`		`-`
`37`	`35`	`validate(message: Buffer): boolean;`
`38`	`36`	`}`