@noble/curves 0.4.0 → 0.5.0

package/lib/{montgomery.js → abstract/montgomery.js}

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.montgomery = void 0;
+/*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
 const mod = require("./modular.js");
 const utils_js_1 = require("./utils.js");
 const _0n = BigInt(0);
@@ -162,8 +163,14 @@ function montgomery(curveDef) {
             throw new Error(`Expected ${montgomeryBytes} or ${fieldLen} bytes, got ${bytes.length}`);
         return (0, utils_js_1.bytesToNumberLE)(adjustScalarBytes(bytes));
     }
-    // Multiply point u by scalar
-    function scalarMult(u, scalar) {
+    /**
+     * Computes shared secret between private key "scalar" and public key's "u" (x) coordinate.
+     * We can get 'y' coordinate from 'u',
+     * but Point.fromHex also wants 'x' coordinate oddity flag,
+     * and we cannot get 'x' without knowing 'v'.
+     * Need to add generic conversion between twisted edwards and complimentary curve for JubJub.
+     */
+    function scalarMult(scalar, u) {
         const pointU = decodeUCoordinate(u);
         const _scalar = decodeScalar(scalar);
         const pu = montgomeryLadder(pointU, _scalar);
@@ -173,17 +180,19 @@ function montgomery(curveDef) {
             throw new Error('Invalid private or public key received');
         return encodeUCoordinate(pu);
     }
-    // Multiply base point by scalar
+    /**
+     * Computes public key from private.
+     * Executes scalar multiplication of curve's base point by scalar.
+     * @param scalar private key
+     * @returns new public key
+     */
     function scalarMultBase(scalar) {
-        return scalarMult(CURVE.Gu, scalar);
+        return scalarMult(scalar, CURVE.Gu);
     }
     return {
-        // NOTE: we can get 'y' coordinate from 'u', but Point.fromHex also wants 'x' coordinate oddity flag, and we cannot get 'x' without knowing 'v'
-        // Need to add generic conversion between twisted edwards and complimentary curve for JubJub
         scalarMult,
         scalarMultBase,
-        // NOTE: these function work on complimentary montgomery curve
-        // getSharedSecret: (privateKey: Hex, publicKey: Hex) => scalarMult(publicKey, privateKey),
+        getSharedSecret: (privateKey, publicKey) => scalarMult(privateKey, publicKey),
         getPublicKey: (privateKey) => scalarMultBase(privateKey),
         Gu: CURVE.Gu,
     };

package/lib/{utils.d.ts → abstract/utils.d.ts}

@@ -1,4 +1,4 @@
-/*! @noble/curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+/*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
 import * as mod from './modular.js';
 export declare type Hex = Uint8Array | string;
 export declare type PrivKey = Hex | bigint | number;

package/lib/{utils.js → abstract/utils.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bitMask = exports.bitSet = exports.bitGet = exports.bitLen = exports.equalBytes = exports.hashToPrivateScalar = exports.nLength = exports.concatBytes = exports.ensureBytes = exports.numberToBytesLE = exports.numberToBytesBE = exports.bytesToNumberLE = exports.bytesToNumberBE = exports.hexToBytes = exports.hexToNumber = exports.numberToHexUnpadded = exports.bytesToHex = exports.validateOpts = void 0;
-/*! @noble/curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
+/*! noble-curves - MIT License (c) 2022 Paul Miller (paulmillr.com) */
 const mod = require("./modular.js");
 const _0n = BigInt(0);
 const _1n = BigInt(1);

package/lib/{weierstrass.d.ts → abstract/weierstrass.d.ts}

@@ -2,7 +2,7 @@
 import * as mod from './modular.js';
 import { Hex, PrivKey } from './utils.js';
 import * as utils from './utils.js';
-import { htfOpts } from './hashToCurve.js';
+import { htfOpts } from './hash-to-curve.js';
 import { Group, GroupConstructor } from './group.js';
 declare type HmacFnSync = (key: Uint8Array, ...messages: Uint8Array[]) => Uint8Array;
 declare type EndomorphismOpts = {
@@ -19,8 +19,8 @@ export declare type BasicCurve<T> = utils.BasicCurve<T> & {
     b: T;
     normalizePrivateKey?: (key: PrivKey) => PrivKey;
     endo?: EndomorphismOpts;
-    isTorsionFree?: (c: JacobianConstructor<T>, point: JacobianPointType<T>) => boolean;
-    clearCofactor?: (c: JacobianConstructor<T>, point: JacobianPointType<T>) => JacobianPointType<T>;
+    isTorsionFree?: (c: ProjectiveConstructor<T>, point: ProjectivePointType<T>) => boolean;
+    clearCofactor?: (c: ProjectiveConstructor<T>, point: ProjectivePointType<T>) => ProjectivePointType<T>;
     htfDefaults?: htfOpts;
     mapToCurve?: (scalar: bigint[]) => {
         x: T;
@@ -53,19 +53,19 @@ declare type SignOpts = {
  *
  * TODO: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#unique-symbol
  */
-export interface JacobianPointType<T> extends Group<JacobianPointType<T>> {
+export interface ProjectivePointType<T> extends Group<ProjectivePointType<T>> {
     readonly x: T;
     readonly y: T;
     readonly z: T;
-    multiply(scalar: number | bigint, affinePoint?: PointType<T>): JacobianPointType<T>;
-    multiplyUnsafe(scalar: bigint): JacobianPointType<T>;
+    multiply(scalar: number | bigint, affinePoint?: PointType<T>): ProjectivePointType<T>;
+    multiplyUnsafe(scalar: bigint): ProjectivePointType<T>;
     toAffine(invZ?: T): PointType<T>;
 }
-export interface JacobianConstructor<T> extends GroupConstructor<JacobianPointType<T>> {
-    new (x: T, y: T, z: T): JacobianPointType<T>;
-    fromAffine(p: PointType<T>): JacobianPointType<T>;
-    toAffineBatch(points: JacobianPointType<T>[]): PointType<T>[];
-    normalizeZ(points: JacobianPointType<T>[]): JacobianPointType<T>[];
+export interface ProjectiveConstructor<T> extends GroupConstructor<ProjectivePointType<T>> {
+    new (x: T, y: T, z: T): ProjectivePointType<T>;
+    fromAffine(p: PointType<T>): ProjectivePointType<T>;
+    toAffineBatch(points: ProjectivePointType<T>[]): PointType<T>[];
+    normalizeZ(points: ProjectivePointType<T>[]): ProjectivePointType<T>[];
 }
 export interface PointType<T> extends Group<PointType<T>> {
     readonly x: T;
@@ -93,14 +93,14 @@ export declare type CurvePointsType<T> = BasicCurve<T> & {
 };
 export declare type CurvePointsRes<T> = {
     Point: PointConstructor<T>;
-    JacobianPoint: JacobianConstructor<T>;
+    ProjectivePoint: ProjectiveConstructor<T>;
     normalizePrivateKey: (key: PrivKey) => bigint;
     weierstrassEquation: (x: T) => T;
     isWithinCurveOrder: (num: bigint) => boolean;
 };
 export declare function weierstrassPoints<T>(opts: CurvePointsType<T>): {
     Point: PointConstructor<T>;
-    JacobianPoint: JacobianConstructor<T>;
+    ProjectivePoint: ProjectiveConstructor<T>;
     normalizePrivateKey: (key: PrivKey) => bigint;
     weierstrassEquation: (x: T) => T;
     isWithinCurveOrder: (num: bigint) => boolean;
@@ -147,8 +147,8 @@ declare function validateOpts(curve: CurveType): Readonly<{
     readonly b: bigint;
     readonly normalizePrivateKey?: ((key: PrivKey) => PrivKey) | undefined;
     readonly endo?: EndomorphismOpts | undefined;
-    readonly isTorsionFree?: ((c: JacobianConstructor<bigint>, point: JacobianPointType<bigint>) => boolean) | undefined;
-    readonly clearCofactor?: ((c: JacobianConstructor<bigint>, point: JacobianPointType<bigint>) => JacobianPointType<bigint>) | undefined;
+    readonly isTorsionFree?: ((c: ProjectiveConstructor<bigint>, point: ProjectivePointType<bigint>) => boolean) | undefined;
+    readonly clearCofactor?: ((c: ProjectiveConstructor<bigint>, point: ProjectivePointType<bigint>) => ProjectivePointType<bigint>) | undefined;
     readonly htfDefaults?: htfOpts | undefined;
     readonly mapToCurve?: ((scalar: bigint[]) => {
         x: bigint;
@@ -169,7 +169,7 @@ export declare type CurveFn = {
         lowS?: boolean;
     }) => boolean;
     Point: PointConstructor<bigint>;
-    JacobianPoint: JacobianConstructor<bigint>;
+    ProjectivePoint: ProjectiveConstructor<bigint>;
     Signature: SignatureConstructor;
     utils: {
         mod: (a: bigint, b?: bigint) => bigint;
@@ -187,4 +187,16 @@ export declare type CurveFn = {
     };
 };
 export declare function weierstrass(curveDef: CurveType): CurveFn;
+export declare function SWUFpSqrtRatio<T>(Fp: mod.Field<T>, Z: T): (u: T, v: T) => {
+    isValid: boolean;
+    value: T;
+};
+export declare function mapToCurveSimpleSWU<T>(Fp: mod.Field<T>, opts: {
+    A: T;
+    B: T;
+    Z: T;
+}): (u: T) => {
+    x: T;
+    y: T;
+};
 export {};