@pbnjam/bandersnatch 0.1.0 → 0.7.2-rc1

package/LICENSE

@@ -0,0 +1,206 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include Communications that are clearly marked or
+      otherwise designated in writing by the copyright owner as "Not a Work").
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is clearly marked or otherwise designated
+      in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+
+

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@pbnjam/bandersnatch",
-  "version": "0.1.0",
+  "version": "0.7.2-rc1",
   "description": "Bandersnatch elliptic curve implementation",
+  "license": "Apache-2.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -18,13 +19,13 @@
     "docs": "npx typedoc --out docs --entryPoints src/index.ts --entryPointStrategy expand --readme none --name '@pbnjam/bandersnatch' --includeVersion --tsconfig tsconfig.typedoc.json"
   },
   "dependencies": {
-    "@noble/curves": "^2.0.1",
-    "@noble/hashes": "^2.0.1"
+    "@noble/curves": "2.0.1",
+    "@noble/hashes": "2.0.1"
   },
   "devDependencies": {
-    "@types/bun": "^1.3.1",
+    "@types/bun": "1.3.5",
     "@types/node": "^22.0.0",
-    "bun-types": "^1.3.1",
+    "bun-types": "1.3.5",
     "typescript": "5.9.3",
     "typedoc": "0.28.15"
   },

package/src/curve.ts

@@ -43,12 +43,12 @@ export const Bandersnatch = edwards(BANDERSNATCH_CURVE)
 
 /**
  * Bandersnatch curve operations using @noble/curves.
- * 
+ *
  * This class provides a high-level interface for working with points on the
  * Bandersnatch elliptic curve. It implements all standard elliptic curve operations
  * including point addition, scalar multiplication, and point compression/decompression
  * compatible with arkworks serialization format.
- * 
+ *
  * The Bandersnatch curve is a Twisted Edwards curve defined over the BLS12-381 scalar field,
  * designed for efficient cryptographic operations in the JAM protocol.
  */
@@ -92,7 +92,7 @@ export class BandersnatchCurve {
 
   /**
    * Decompresses arkworks-compatible point bytes to a Noble EdwardsPoint.
-   * 
+   *
    * This is the inverse operation of `pointToBytes`. It handles arkworks sign bit logic
    * to reconstruct the full point from compressed bytes. The method:
    * 1. Extracts the y-coordinate from the first 31 bytes (little-endian)
@@ -193,12 +193,12 @@ export class BandersnatchCurve {
 
   /**
    * Performs scalar multiplication on a curve point.
-   * 
+   *
    * Computes `scalar * point` on the Bandersnatch curve. Handles edge cases including:
    * - Scalar 0: returns the identity point (infinity)
    * - Negative scalars: negates the point and uses positive scalar
    * - Scalars >= curve order: reduces modulo curve order
-   * 
+   *
    * @param point - The curve point to multiply
    * @param scalar - The scalar multiplier (can be negative or >= curve order)
    * @returns The result of scalar multiplication: `scalar * point`
@@ -234,10 +234,10 @@ export class BandersnatchCurve {
 
   /**
    * Adds two curve points together.
-   * 
+   *
    * Performs point addition on the Bandersnatch curve: `P + Q`.
    * This operation is commutative: `add(P, Q) === add(Q, P)`.
-   * 
+   *
    * @param p1 - First curve point
    * @param p2 - Second curve point
    * @returns The sum of the two points: `p1 + p2`
@@ -249,10 +249,10 @@ export class BandersnatchCurve {
 
   /**
    * Doubles a curve point.
-   * 
+   *
    * Computes `2 * point` on the Bandersnatch curve. This is equivalent to
    * `add(point, point)` but is typically more efficient.
-   * 
+   *
    * @param point - The curve point to double
    * @returns The doubled point: `2 * point`
    * @throws {Error} If the point is invalid or not on the curve
@@ -263,10 +263,10 @@ export class BandersnatchCurve {
 
   /**
    * Negates a curve point.
-   * 
+   *
    * Computes the additive inverse of a point on the Bandersnatch curve.
    * The result satisfies: `add(point, negate(point)) === INFINITY`.
-   * 
+   *
    * @param point - The curve point to negate
    * @returns The negated point: `-point`
    * @throws {Error} If the point is invalid or not on the curve
@@ -277,10 +277,10 @@ export class BandersnatchCurve {
 
   /**
    * Checks if a point lies on the Bandersnatch curve.
-   * 
+   *
    * Validates that the point satisfies the Twisted Edwards curve equation:
    * `a*x^2 + y^2 = 1 + d*x^2*y^2` where `a = -5` and `d` is the curve parameter.
-   * 
+   *
    * @param point - The curve point to validate
    * @returns `true` if the point is on the curve, `false` otherwise
    */
@@ -290,10 +290,10 @@ export class BandersnatchCurve {
 
   /**
    * Gets the generator point (base point) of the Bandersnatch curve.
-   * 
+   *
    * The generator is a point on the curve that generates the prime subgroup G.
    * All points in the prime subgroup can be expressed as scalar multiples of the generator.
-   * 
+   *
    * @returns The generator point G
    */
   static get GENERATOR() {
@@ -302,10 +302,10 @@ export class BandersnatchCurve {
 
   /**
    * Gets the identity point (point at infinity) of the Bandersnatch curve.
-   * 
+   *
    * The identity point is the neutral element for point addition:
    * `add(point, INFINITY) === point` for any point on the curve.
-   * 
+   *
    * @returns The identity point (point at infinity)
    */
   static get INFINITY() {
@@ -314,11 +314,11 @@ export class BandersnatchCurve {
 
   /**
    * Converts a curve point to its byte representation.
-   * 
+   *
    * Serializes the point to bytes, typically used for challenge generation
    * in cryptographic protocols. The output format matches the point compression
    * format used by the curve implementation.
-   * 
+   *
    * @param point - The curve point to hash
    * @returns Byte representation of the point
    * @throws {Error} If the point is invalid
@@ -329,10 +329,10 @@ export class BandersnatchCurve {
 
   /**
    * Gets the order (cardinality) of the prime subgroup of the Bandersnatch curve.
-   * 
+   *
    * The curve order is the number of points in the prime subgroup G.
    * For any point P in G, `scalarMultiply(P, CURVE_ORDER) === INFINITY`.
-   * 
+   *
    * @returns The curve order as a bigint
    */
   static get CURVE_ORDER() {

package/src/index.ts

@@ -5,16 +5,16 @@
  * with all necessary operations for cryptographic applications.
  */
 
-// Export types
-export type { CurvePoint } from './types'
 // Export curve parameters
 export { BANDERSNATCH_PARAMS } from './config'
 // Elligator2 hash-to-curve is now available in bandersnatch-vrf package
 // Export curve implementations
 // Temporary alias for legacy compatibility
 export {
-  BandersnatchCurve,
   Bandersnatch,
+  BandersnatchCurve,
 } from './curve'
 // VRF functionality moved to bandersnatch-vrf package
-export * from './math'
+export * from './math'
+// Export types
+export type { CurvePoint } from './types'

package/src/math.ts

@@ -10,10 +10,10 @@ import {
 
 /**
  * Computes the non-negative modular reduction.
- * 
+ *
  * Returns `a mod m` where the result is always non-negative (0 <= result < m).
  * This handles negative inputs correctly by adding the modulus to negative results.
- * 
+ *
  * @param a - The value to reduce
  * @param m - The modulus
  * @returns Non-negative result of `a mod m`
@@ -25,10 +25,10 @@ export function mod(a: bigint, m: bigint): bigint {
 
 /**
  * Computes the modular inverse using the extended Euclidean algorithm.
- * 
+ *
  * Finds the value `x` such that `(a * x) mod m = 1`. The modular inverse exists
  * if and only if `gcd(a, m) = 1`.
- * 
+ *
  * @param a - The value to find the inverse of
  * @param m - The modulus
  * @returns The modular inverse of `a` modulo `m`
@@ -53,10 +53,10 @@ export function modInverse(a: bigint, m: bigint): bigint {
 
 /**
  * Computes the modular square root using the noble package FpSqrt.
- * 
+ *
  * Finds a value `x` such that `x^2 mod p = value`. The square root exists
  * if and only if `value` is a quadratic residue modulo `p`.
- * 
+ *
  * @param value - The value to find the square root of
  * @param p - The prime modulus
  * @param field - The field implementation from @noble/curves
@@ -81,11 +81,10 @@ export function modSqrt(
 }
 
 export function numberToBytesLittleEndian(value: bigint): Uint8Array {
-    const bytes = new Uint8Array(32)
-    const hex = value.toString(16).padStart(64, '0')
-    for (let i = 0; i < 32; i++) {
-      bytes[i] = Number.parseInt(hex.slice(62 - i * 2, 64 - i * 2), 16)
-    }
-    return bytes
+  const bytes = new Uint8Array(32)
+  const hex = value.toString(16).padStart(64, '0')
+  for (let i = 0; i < 32; i++) {
+    bytes[i] = Number.parseInt(hex.slice(62 - i * 2, 64 - i * 2), 16)
   }
-  
+  return bytes
+}

package/src/types.ts

@@ -4,11 +4,11 @@
 
 /**
  * Represents a point on an elliptic curve.
- * 
+ *
  * This interface defines the structure for curve points used in Bandersnatch
  * curve operations. Points can be either finite points with (x, y) coordinates
  * or the point at infinity.
- * 
+ *
  * @interface CurvePoint
  */
 export interface CurvePoint {
@@ -19,4 +19,3 @@ export interface CurvePoint {
   /** Whether this point is the point at infinity (identity element) */
   isInfinity: boolean
 }
-