@bsv/sdk 1.2.21 → 1.2.22

package/docs/auth.md

@@ -987,13 +987,51 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | |
 | --- |
+| [createMasterCertificate](#function-createmastercertificate) |
 | [createNonce](#function-createnonce) |
+| [createVerifiableCertificate](#function-createverifiablecertificate) |
 | [verifyNonce](#function-verifynonce) |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
 
+### Function: createMasterCertificate
+
+Creates a Master Certificate by encrypting provided fields and generating a master keyring.
+
+```ts
+export async function createMasterCertificate(wallet: Wallet, fields: Record<string, string>, certificateType: string, certificateSerialNumber: string, certifierPublicKey: string): Promise<MasterCertificate> 
+```
+
+See also: [MasterCertificate](#class-mastercertificate), [Wallet](#interface-wallet)
+
+<details>
+
+<summary>Function createMasterCertificate Details</summary>
+
+Returns
+
+A promise resolving to the created Master Certificate.
+
+Argument Details
+
++ **wallet**
+  + The wallet instance used for encryption and public key retrieval.
++ **fields**
+  + The certificate fields to encrypt.
++ **certificateType**
+  + The type of the certificate being created.
++ **certificateSerialNumber**
+  + The serial number of the certificate.
++ **certifierPublicKey**
+  + The public key of the certifier.
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
 ### Function: createNonce
 
 Creates a nonce derived from a privateKey
@@ -1016,6 +1054,42 @@ A random nonce derived with a wallet
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
+---
+### Function: createVerifiableCertificate
+
+Creates a Verifiable Certificate by signing a Master Certificate and generating a keyring for a verifier.
+
+```ts
+export async function createVerifiableCertificate(masterCertificate: MasterCertificate, wallet: Wallet, verifierIdentityKey: string, fieldsToReveal: string[], certifierPrivateKey: PrivateKey): Promise<VerifiableCertificate> 
+```
+
+See also: [MasterCertificate](#class-mastercertificate), [PrivateKey](#class-privatekey), [VerifiableCertificate](#class-verifiablecertificate), [Wallet](#interface-wallet)
+
+<details>
+
+<summary>Function createVerifiableCertificate Details</summary>
+
+Returns
+
+A promise resolving to the created Verifiable Certificate.
+
+Argument Details
+
++ **masterCertificate**
+  + The master certificate to convert into a verifiable certificate.
++ **wallet**
+  + The wallet instance used for generating a keyring for the verifier.
++ **verifierIdentityKey**
+  + The identity key of the verifier.
++ **fieldsToReveal**
+  + The list of fields to reveal to the verifier.
++ **certifierPrivateKey**
+  + The private key of the certifier for signing the certificate.
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
 ---
 ### Function: verifyNonce
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.2.21",
+  "version": "1.2.22",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/auth/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './verifyNonce.js'
 export * from './createNonce.js'
 export * from './getVerifiableCertificates.js'
-export * from './validateCertificates.js'
+export * from './validateCertificates.js'
+export * from './certificateHelpers.js'

package/src/primitives/Point.ts

@@ -41,7 +41,7 @@ export default class Point extends BasePoint {
    * const derPoint = [ 2, 18, 123, 108, 125, 83, 1, 251, 164, 214, 16, 119, 200, 216, 210, 193, 251, 193, 129, 67, 97, 146, 210, 216, 77, 254, 18, 6, 150, 190, 99, 198, 128 ];
    * const point = Point.fromDER(derPoint);
    */
-  static fromDER (bytes: number[]): Point {
+  static fromDER(bytes: number[]): Point {
     const len = 32
     // uncompressed, hybrid-odd, hybrid-even
     if ((bytes[0] === 0x04 || bytes[0] === 0x06 || bytes[0] === 0x07) &&
@@ -86,12 +86,12 @@ export default class Point extends BasePoint {
    * const pointStr = 'abcdef';
    * const point = Point.fromString(pointStr);
    */
-  static fromString (str: string): Point {
+  static fromString(str: string): Point {
     const bytes = toArray(str, 'hex')
     return Point.fromDER(bytes)
   }
 
-  static redSqrtOptimized (y2: BigNumber): BigNumber {
+  static redSqrtOptimized(y2: BigNumber): BigNumber {
     const red = Point.red
     const p = red.m // The modulus
     const exponent = p.addn(1).iushrn(2) // (p + 1) / 4
@@ -113,12 +113,12 @@ export default class Point extends BasePoint {
    * const xCoordinate = new BigNumber('10');
    * const point = Point.fromX(xCoordinate, true);
    */
-  static fromX (x: BigNumber | number | number[] | string, odd: boolean): Point {
+  static fromX(x: BigNumber | number | number[] | string, odd: boolean): Point {
     if (typeof BigInt === 'function') {
-      function mod (a: bigint, n: bigint): bigint {
+      function mod(a: bigint, n: bigint): bigint {
         return ((a % n) + n) % n
       }
-      function modPow (base: bigint, exponent: bigint, modulus: bigint): bigint {
+      function modPow(base: bigint, exponent: bigint, modulus: bigint): bigint {
         let result = BigInt(1)
         base = mod(base, modulus)
         while (exponent > BigInt(0)) {
@@ -130,7 +130,7 @@ export default class Point extends BasePoint {
         }
         return result
       }
-      function sqrtMod (a: bigint, p: bigint): bigint | null {
+      function sqrtMod(a: bigint, p: bigint): bigint | null {
         const exponent = (p + BigInt(1)) >> BigInt(2) // Precomputed exponent
         const sqrtCandidate = modPow(a, exponent, p)
         if (mod(sqrtCandidate * sqrtCandidate, p) === mod(a, p)) {
@@ -157,7 +157,7 @@ export default class Point extends BasePoint {
       } else if (Array.isArray(x)) {
         xBigInt = BigInt(
           '0x' +
-          Buffer.from(x).toString('hex').padStart(64, '0')
+          toHex(x).padStart(64, '0')
         )
       } else if (typeof x === 'number') {
         xBigInt = BigInt(x)
@@ -232,7 +232,7 @@ export default class Point extends BasePoint {
    * const serializedPoint = '{"x":52,"y":15}';
    * const point = Point.fromJSON(serializedPoint, true);
    */
-  static fromJSON (
+  static fromJSON(
     obj: string | any[], isRed: boolean
   ): Point {
     if (typeof obj === 'string') {
@@ -252,15 +252,15 @@ export default class Point extends BasePoint {
       beta: null,
       doubles: typeof pre.doubles === 'object' && pre.doubles !== null
         ? {
-            step: pre.doubles.step,
-            points: [res].concat(pre.doubles.points.map(obj2point))
-          }
+          step: pre.doubles.step,
+          points: [res].concat(pre.doubles.points.map(obj2point))
+        }
         : undefined,
       naf: typeof pre.naf === 'object' && pre.naf !== null
         ? {
-            wnd: pre.naf.wnd,
-            points: [res].concat(pre.naf.points.map(obj2point))
-          }
+          wnd: pre.naf.wnd,
+          points: [res].concat(pre.naf.points.map(obj2point))
+        }
         : undefined
     }
     return res
@@ -276,7 +276,7 @@ export default class Point extends BasePoint {
    * new Point('abc123', 'def456');
    * new Point(null, null); // Generates Infinity point.
    */
-  constructor (
+  constructor(
     x: BigNumber | number | number[] | string | null,
     y: BigNumber | number | number[] | string | null,
     isRed: boolean = true
@@ -318,7 +318,7 @@ export default class Point extends BasePoint {
    * const aPoint = new Point(x, y);
    * const isValid = aPoint.validate();
    */
-  validate (): boolean {
+  validate(): boolean {
     return this.curve.validate(this)
   }
 
@@ -337,7 +337,7 @@ export default class Point extends BasePoint {
    * const encodedPointArray = aPoint.encode();
    * const encodedPointHex = aPoint.encode(true, 'hex');
    */
-  encode (compact: boolean = true, enc?: 'hex'): number[] | string {
+  encode(compact: boolean = true, enc?: 'hex'): number[] | string {
     const len = this.curve.p.byteLength()
     const x = this.getX().toArray('be', len)
     let res: number[]
@@ -364,7 +364,7 @@ export default class Point extends BasePoint {
    * const aPoint = new Point(x, y);
    * const stringPoint = aPoint.toString();
    */
-  toString (): string {
+  toString(): string {
     return this.encode(true, 'hex') as string
   }
 
@@ -378,24 +378,24 @@ export default class Point extends BasePoint {
    * const aPoint = new Point(x, y);
    * const jsonPoint = aPoint.toJSON();
    */
-  toJSON (): [BigNumber | null, BigNumber | null, { doubles: { step: any, points: any[] } | undefined, naf: { wnd: any, points: any[] } | undefined }?] {
+  toJSON(): [BigNumber | null, BigNumber | null, { doubles: { step: any, points: any[] } | undefined, naf: { wnd: any, points: any[] } | undefined }?] {
     if (this.precomputed == null) { return [this.x, this.y] }
 
     return [this.x, this.y, typeof this.precomputed === 'object' && this.precomputed !== null
       ? {
-          doubles: (this.precomputed.doubles != null)
-            ? {
-                step: this.precomputed.doubles.step,
-                points: this.precomputed.doubles.points.slice(1)
-              }
-            : undefined,
-          naf: (this.precomputed.naf != null)
-            ? {
-                wnd: this.precomputed.naf.wnd,
-                points: this.precomputed.naf.points.slice(1)
-              }
-            : undefined
-        }
+        doubles: (this.precomputed.doubles != null)
+          ? {
+            step: this.precomputed.doubles.step,
+            points: this.precomputed.doubles.points.slice(1)
+          }
+          : undefined,
+        naf: (this.precomputed.naf != null)
+          ? {
+            wnd: this.precomputed.naf.wnd,
+            points: this.precomputed.naf.points.slice(1)
+          }
+          : undefined
+      }
       : undefined]
   }
 
@@ -409,7 +409,7 @@ export default class Point extends BasePoint {
    * const aPoint = new Point(x, y);
    * console.log(aPoint.inspect());
    */
-  inspect (): string {
+  inspect(): string {
     if (this.isInfinity()) {
       return '<EC Point Infinity>'
     }
@@ -426,7 +426,7 @@ export default class Point extends BasePoint {
    * const p = new Point(null, null);
    * console.log(p.isInfinity()); // outputs: true
    */
-  isInfinity (): boolean {
+  isInfinity(): boolean {
     return this.inf
   }
 
@@ -442,7 +442,7 @@ export default class Point extends BasePoint {
    * const p2 = new Point(2, 3);
    * const result = p1.add(p2);
    */
-  add (p: Point): Point {
+  add(p: Point): Point {
     // O + P = P
     if (this.inf) { return p }
 
@@ -474,7 +474,7 @@ export default class Point extends BasePoint {
    * const P = new Point('123', '456');
    * const result = P.dbl();
    * */
-  dbl (): Point {
+  dbl(): Point {
     if (this.inf) { return this }
 
     // 2P = O
@@ -501,7 +501,7 @@ export default class Point extends BasePoint {
    * const P = new Point('123', '456');
    * const x = P.getX();
    */
-  getX (): BigNumber {
+  getX(): BigNumber {
     return this.x.fromRed()
   }
 
@@ -512,7 +512,7 @@ export default class Point extends BasePoint {
    * const P = new Point('123', '456');
    * const x = P.getX();
    */
-  getY (): BigNumber {
+  getY(): BigNumber {
     return this.y.fromRed()
   }
 
@@ -527,7 +527,7 @@ export default class Point extends BasePoint {
    * const p = new Point(1, 2);
    * const result = p.mul(2); // this doubles the Point
    */
-  mul (k: BigNumber | number | number[] | string): Point {
+  mul(k: BigNumber | number | number[] | string): Point {
     if (!BigNumber.isBN(k)) {
       k = new BigNumber(k as number, 16)
     }
@@ -556,7 +556,7 @@ export default class Point extends BasePoint {
    * const p2 = new Point(2, 3);
    * const result = p1.mulAdd(2, p2, 3);
    */
-  mulAdd (k1: BigNumber, p2: Point, k2: BigNumber): Point {
+  mulAdd(k1: BigNumber, p2: Point, k2: BigNumber): Point {
     const points = [this, p2]
     const coeffs = [k1, k2]
     return this._endoWnafMulAdd(points, coeffs) as Point
@@ -577,7 +577,7 @@ export default class Point extends BasePoint {
    * const p2 = new Point(2, 3);
    * const result = p1.jmulAdd(2, p2, 3);
    */
-  jmulAdd (k1: BigNumber, p2: Point, k2: BigNumber): JPoint {
+  jmulAdd(k1: BigNumber, p2: Point, k2: BigNumber): JPoint {
     const points = [this, p2]
     const coeffs = [k1, k2]
     return this._endoWnafMulAdd(points, coeffs, true) as JPoint
@@ -596,7 +596,7 @@ export default class Point extends BasePoint {
    * const p2 = new Point(5, 20);
    * const areEqual = p1.eq(p2); // returns true
    */
-  eq (p: Point): boolean {
+  eq(p: Point): boolean {
     return this === p || (
       (this.inf === p.inf) &&
       (this.inf || (this.x.cmp(p.x) === 0 && this.y.cmp(p.y) === 0)))
@@ -611,7 +611,7 @@ export default class Point extends BasePoint {
    * const P = new Point('123', '456');
    * const result = P.neg();
    */
-  neg (_precompute?: boolean): Point {
+  neg(_precompute?: boolean): Point {
     if (this.inf) { return this }
 
     const res = new Point(this.x, this.y.redNeg())
@@ -647,7 +647,7 @@ export default class Point extends BasePoint {
    * const p = new Point(5, 20);
    * const doubledPoint = p.dblp(10); // returns the point after "doubled" 10 times
    */
-  dblp (k: number): Point {
+  dblp(k: number): Point {
     /* eslint-disable @typescript-eslint/no-this-alias */
     let r: Point = this
     for (let i = 0; i < k; i++) { r = r.dbl() }
@@ -665,7 +665,7 @@ export default class Point extends BasePoint {
    * const point = new Point(xCoordinate, yCoordinate);
    * const jacobianPoint = point.toJ();
    */
-  toJ (): JPoint {
+  toJ(): JPoint {
     if (this.inf) {
       return new JPoint(null, null, null)
     }
@@ -673,7 +673,7 @@ export default class Point extends BasePoint {
     return res
   }
 
-  private _getBeta (): undefined | Point {
+  private _getBeta(): undefined | Point {
     if (typeof this.curve.endo !== 'object') { return }
 
     const pre = this.precomputed
@@ -692,22 +692,22 @@ export default class Point extends BasePoint {
         beta: null,
         naf: (pre.naf != null)
           ? {
-              wnd: pre.naf.wnd,
-              points: pre.naf.points.map(endoMul)
-            }
+            wnd: pre.naf.wnd,
+            points: pre.naf.points.map(endoMul)
+          }
           : undefined,
         doubles: (pre.doubles != null)
           ? {
-              step: pre.doubles.step,
-              points: pre.doubles.points.map(endoMul)
-            }
+            step: pre.doubles.step,
+            points: pre.doubles.points.map(endoMul)
+          }
           : undefined
       }
     }
     return beta
   }
 
-  private _fixedNafMul (k: BigNumber): Point {
+  private _fixedNafMul(k: BigNumber): Point {
     if (typeof this.precomputed !== 'object' || this.precomputed === null) {
       throw new Error('_fixedNafMul requires precomputed values for the point')
     }
@@ -743,7 +743,7 @@ export default class Point extends BasePoint {
     return a.toP()
   }
 
-  private _wnafMulAdd (
+  private _wnafMulAdd(
     defW: number,
     points: Point[],
     coeffs: BigNumber[],
@@ -869,7 +869,7 @@ export default class Point extends BasePoint {
     }
   }
 
-  private _endoWnafMulAdd (points: Point[], coeffs, jacobianResult?: boolean): BasePoint {
+  private _endoWnafMulAdd(points: Point[], coeffs, jacobianResult?: boolean): BasePoint {
     const npoints = this.curve._endoWnafT1
     const ncoeffs = this.curve._endoWnafT2
     let i
@@ -902,7 +902,7 @@ export default class Point extends BasePoint {
     return res
   }
 
-  private _hasDoubles (k: BigNumber): boolean {
+  private _hasDoubles(k: BigNumber): boolean {
     if (this.precomputed == null) { return false }
 
     const doubles = this.precomputed.doubles
@@ -911,7 +911,7 @@ export default class Point extends BasePoint {
     return doubles.points.length >= Math.ceil((k.bitLength() + 1) / doubles.step)
   };
 
-  private _getDoubles (
+  private _getDoubles(
     step?: number,
     power?: number
   ): { step: number, points: any[] } {
@@ -936,7 +936,7 @@ export default class Point extends BasePoint {
     }
   };
 
-  private _getNAFPoints (wnd: number): { wnd: number, points: any[] } {
+  private _getNAFPoints(wnd: number): { wnd: number, points: any[] } {
     if (
       typeof this.precomputed === 'object' && this.precomputed !== null &&
       typeof this.precomputed.naf === 'object' && this.precomputed.naf !== null