@bcts/sskr 1.0.0-alpha.8 → 1.0.0-beta.0

package/src/error.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright © 2023-2026 Blockchain Commons, LLC
+ * Copyright © 2025-2026 Parity Technologies
+ *
+ */
+
 // Ported from bc-sskr-rust/src/error.rs
 
 import type { ShamirError } from "@bcts/shamir";
@@ -42,7 +48,7 @@ export class SSKRError extends Error {
       case SSKRErrorType.DuplicateMemberIndex:
         return "When combining shares, the provided shares contained a duplicate member index";
       case SSKRErrorType.GroupSpecInvalid:
-        return "Invalid group specification";
+        return "Invalid group specification.";
       case SSKRErrorType.GroupCountInvalid:
         return "When creating a split spec, the group count is invalid";
       case SSKRErrorType.GroupThresholdInvalid:
@@ -79,4 +85,12 @@ export class SSKRError extends Error {
   }
 }
 
+/**
+ * Mirrors Rust's `Result<T, Error>` (`bc-sskr-rust/src/error.rs:54`).
+ *
+ * The TypeScript port surfaces failures by throwing {@link SSKRError}
+ * rather than returning a sum type, so this alias is a no-op
+ * (`SSKRResult<T>` ≡ `T`). It is kept so signatures published in
+ * `@bcts/sskr` remain visually parallel to their Rust counterparts.
+ */
 export type SSKRResult<T> = T;

package/src/index.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright © 2023-2026 Blockchain Commons, LLC
+ * Copyright © 2025-2026 Parity Technologies
+ *
+ */
+
 // Blockchain Commons Sharded Secret Key Reconstruction (SSKR)
 // Ported from bc-sskr-rust
 //
@@ -53,8 +59,5 @@ export { Secret } from "./secret.js";
 // Specifications
 export { GroupSpec, Spec } from "./spec.js";
 
-// Share
-export { SSKRShare } from "./share.js";
-
 // Encoding/Decoding
 export { sskrGenerate, sskrGenerateUsing, sskrCombine } from "./encoding.js";

package/src/secret.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright © 2023-2026 Blockchain Commons, LLC
+ * Copyright © 2025-2026 Parity Technologies
+ *
+ */
+
 // Ported from bc-sskr-rust/src/secret.rs
 
 import { MIN_SECRET_LEN, MAX_SECRET_LEN } from "./index.js";
@@ -54,6 +60,9 @@ export class Secret {
 
   /**
    * Returns a reference to the secret data.
+   *
+   * Mirrors Rust's `Secret::data(&self) -> &[u8]`
+   * (`bc-sskr-rust/src/secret.rs:43`).
    */
   getData(): Uint8Array {
     return this.data;
@@ -61,6 +70,15 @@ export class Secret {
 
   /**
    * Returns the secret data as a Uint8Array.
+   *
+   * Mirrors Rust's `impl AsRef<[u8]> for Secret`
+   * (`bc-sskr-rust/src/secret.rs:46-49`). In Rust, `as_ref()` is
+   * provided via the `AsRef<[u8]>` trait, which lets the `Secret` flow
+   * naturally through any API expecting `impl AsRef<[u8]>`. TypeScript
+   * has no equivalent of that trait, so we expose the same backing
+   * buffer through both {@link getData} (the field accessor) and
+   * `asRef` (the trait-style accessor) for ergonomic parity. Callers
+   * may pick whichever name reads better at the call site.
    */
   asRef(): Uint8Array {
     return this.data;

package/src/share.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright © 2023-2026 Blockchain Commons, LLC
+ * Copyright © 2025-2026 Parity Technologies
+ *
+ */
+
 // Ported from bc-sskr-rust/src/share.rs
 
 import type { Secret } from "./secret.js";

package/src/spec.ts

@@ -1,8 +1,34 @@
+/**
+ * Copyright © 2023-2026 Blockchain Commons, LLC
+ * Copyright © 2025-2026 Parity Technologies
+ *
+ */
+
 // Ported from bc-sskr-rust/src/spec.rs
 
 import { MAX_SHARE_COUNT } from "@bcts/shamir";
 import { SSKRError, SSKRErrorType } from "./error.js";
 
+/**
+ * Strictly parses a non-negative integer string the way Rust's
+ * `<usize as FromStr>::from_str` does (`bc-sskr-rust/src/spec.rs:102, 108`).
+ *
+ * Accepts an optional leading `+` followed by one or more decimal digits.
+ * Rejects whitespace, decimals (`"2.5"`), trailing characters (`"2x"`),
+ * the `-` sign, and the empty string. Returns `undefined` on rejection so
+ * callers surface the appropriate `GroupSpecInvalid` error in the same
+ * spot Rust's `?` would.
+ */
+const STRICT_USIZE_RE = /^\+?\d+$/;
+function parseStrictUsize(s: string): number | undefined {
+  if (!STRICT_USIZE_RE.test(s)) return undefined;
+  const n = Number(s);
+  // `Number.isSafeInteger` rejects values outside ±2^53; usize on
+  // 64-bit Rust covers a larger range but for SSKR's `member_count`
+  // (capped at 16) this is far beyond any meaningful input.
+  return Number.isSafeInteger(n) ? n : undefined;
+}
+
 /**
  * A specification for a group of shares within an SSKR split.
  */
@@ -55,7 +81,15 @@ export class GroupSpec {
 
   /**
    * Parses a group specification from a string.
-   * Format: "M-of-N" where M is the threshold and N is the count.
+   * Format: `"M-of-N"` where `M` is the threshold and `N` is the count.
+   *
+   * Mirrors Rust's `GroupSpec::parse` (`bc-sskr-rust/src/spec.rs:97-112`),
+   * which calls `parts[0].parse::<usize>()`. Rust's `usize::FromStr` is
+   * strict: it rejects whitespace, decimals, trailing characters, and the
+   * `-` sign, accepting only an optional `+` prefix followed by digits.
+   * We mirror that with the regex `^\+?\d+$` so strings like `"2.5"`,
+   * `"2x"`, `" 2"`, `"-2"`, and `""` all surface
+   * {@link SSKRErrorType.GroupSpecInvalid} on both sides.
    */
   static parse(s: string): GroupSpec {
     const parts = s.split("-");
@@ -63,8 +97,8 @@ export class GroupSpec {
       throw new SSKRError(SSKRErrorType.GroupSpecInvalid);
     }
 
-    const memberThreshold = parseInt(parts[0], 10);
-    if (isNaN(memberThreshold)) {
+    const memberThreshold = parseStrictUsize(parts[0]);
+    if (memberThreshold === undefined) {
       throw new SSKRError(SSKRErrorType.GroupSpecInvalid);
     }
 
@@ -72,8 +106,8 @@ export class GroupSpec {
       throw new SSKRError(SSKRErrorType.GroupSpecInvalid);
     }
 
-    const memberCount = parseInt(parts[2], 10);
-    if (isNaN(memberCount)) {
+    const memberCount = parseStrictUsize(parts[2]);
+    if (memberCount === undefined) {
       throw new SSKRError(SSKRErrorType.GroupSpecInvalid);
     }