@totemsdk/txpow 1.0.2 → 1.1.0

package/dist/cjs/admission/template.d.ts

@@ -0,0 +1,138 @@
+/**
+ * admission/template.ts — Minima block-candidate template handling.
+ *
+ * Builds a TxHeader tail that is structurally capable of becoming a legitimate
+ * Minima block. The fields (block number, block difficulty, super-parents, MMR
+ * root/total, magic, time) come from the current chain tip via an injected
+ * MinimaWorkTemplateProvider — mirroring TxPoWGenerator.generateTxPoW in
+ * Minima. The action commitment is placed in the header's customHash field.
+ *
+ * The TxPoW package stays transport/node-client agnostic: callers inject the
+ * template provider. A real Minima node / Axia integration supplies live chain
+ * state; tests supply fixtures.
+ */
+import type { MinimaWorkTemplate } from './types.js';
+/**
+ * Serialize the super-parent RLE runs per TxHeader.writeDataStream.
+ *
+ * Consecutive equal hashes are coalesced into (count: MiniByte, hash) runs.
+ * A fresh candidate with all-distinct parents serializes as 32 runs.
+ */
+export declare function serializeSuperParents(superParents: string[]): Uint8Array;
+/**
+ * Build the empty burn transaction bytes (TxBody.writeDataStream fields 5-6).
+ *
+ * Equivalent to serializeTransaction({ linkHash: [0x00], inputs: [], outputs: [],
+ * state: [] }): 0 inputs, 0 outputs, 0 state, linkHash = ZERO_TXPOWID (1 byte).
+ */
+export declare function buildEmptyBurnTxBytes(): Uint8Array;
+/**
+ * Build the empty burn witness bytes (TxBody.writeDataStream field 6).
+ * 0 signatures, 0 coinproofs, 0 scriptproofs.
+ */
+export declare function buildEmptyBurnWitnessBytes(): Uint8Array;
+/**
+ * Build the empty transaction bytes (TxBody.writeDataStream field 3).
+ * 0 inputs, 0 outputs, 0 state, linkHash = ZERO_TXPOWID (1 byte).
+ */
+export declare function buildEmptyTransactionBytes(): Uint8Array;
+/**
+ * Build the empty witness bytes (TxBody.writeDataStream field 4).
+ * 0 signatures, 0 coinproofs, 0 scriptproofs.
+ */
+export declare function buildEmptyWitnessBytes(): Uint8Array;
+/**
+ * Build the serialized TxBody for a fresh block candidate.
+ *
+ * Mirrors TxBody.writeDataStream with an empty transaction and witness (the
+ * same shape Minima's MINEPULSE automine uses for block candidates):
+ *   mPRNG | mTxnDifficulty | mTransaction | mWitness |
+ *   mBurnTransaction | mBurnWitness | mTxPowIDList
+ *
+ * @param prng          32-byte PRNG (deterministic for tests; random otherwise).
+ * @param txnDifficulty Transaction difficulty (32-byte hex). For a block
+ *                      candidate this is typically the block difficulty.
+ */
+export declare function buildEmptyBlockBody(prng: Uint8Array, txnDifficulty: string): Uint8Array;
+/**
+ * Assemble the complete Minima TxPoW wire format:
+ *   TxHeader | 0x01 (hasBody) | TxBody
+ *
+ * This is the representation required for network submission of a genuine L1
+ * block candidate. A mined header alone is NOT sufficient.
+ *
+ * @param headerBytes  Serialized TxHeader bytes (with the winning nonce).
+ * @param bodyBytes    Serialized TxBody bytes.
+ */
+export declare function assembleTxPoWEnvelope(headerBytes: Uint8Array, bodyBytes: Uint8Array): Uint8Array;
+/**
+ * Build the TxHeader tail (everything after the nonce field) for a block
+ * candidate with the given customHash commitment.
+ *
+ * Field order (TxHeader.writeDataStream):
+ *   mNonce | mChainID | mTimeMilli | mBlockNumber | mBlockDifficulty |
+ *   super-parents RLE | mMMRRoot | mMMRTotal | mMagic | mCustomHash | mTxBodyHash
+ *
+ * @param template     The current Minima work template.
+ * @param customHash   The action commitment (32-byte hex) to place in mCustomHash.
+ * @param txBodyHash   SHA3-256 of the serialized TxBody (32-byte hex).
+ */
+export declare function buildBlockHeaderTail(template: MinimaWorkTemplate, customHash: string, txBodyHash: string): Uint8Array;
+/**
+ * Compute the TxPoW ID for a mined block-candidate header.
+ * txpowId = SHA3-256(serialized TxHeader).
+ */
+export declare function computeBlockCandidateId(headerBytes: Uint8Array): Uint8Array;
+/**
+ * Check whether a txpowId beats the block target (i.e. is a genuine Minima block).
+ * valid = txpowId < blockDifficulty (big-endian 256-bit comparison).
+ */
+export declare function isBlockWinner(txpowId: Uint8Array, blockDifficulty: string): boolean;
+/**
+ * Compute the Minima Super level for a TxPoW ID against a block difficulty,
+ * with Minima's exact integer semantics.
+ *
+ * From TxPoW.calculateTXPOWID() / getSuperLevel():
+ *   quot  = blockDifficulty / txpowId          (unsigned BigInteger division)
+ *   super = quot.bitLength() - 1               (floor(log2(quot)))
+ *   if super >= MINIMA_CASCADE_LEVELS (32) → clamp to 31
+ *
+ * When the TxPoW is NOT a block (txpowId >= blockDifficulty), quot = 0,
+ * bitLength(0) = 0, so super = -1.
+ *
+ * Result:
+ *   -1   — not a Minima block
+ *    0   — ordinary/base Minima block (Super-0)
+ *    1..31 — Super-1 … Super-31 (stronger blocks; 31 is the maximum represented)
+ *
+ * @param txpowId        SHA3-256(header), 32 bytes.
+ * @param blockDifficulty 32-byte hex block difficulty target.
+ */
+export declare function computeSuperLevel(txpowId: Uint8Array, blockDifficulty: string): number;
+/**
+ * Default staleness policy: a template is "current enough" for admission if it
+ * was captured within the window, and "current" for L1 broadcast if it matches
+ * the latest template id.
+ */
+export declare function templateFreshness(template: MinimaWorkTemplate, latest: MinimaWorkTemplate | null, options?: {
+    admissionWindowMs?: number;
+    now?: number;
+}): {
+    admissionValid: boolean;
+    broadcastable: boolean;
+};
+/**
+ * Reconstruct the complete Minima TxPoW envelope for a proof.
+ *
+ * Rebuilds the empty block TxBody deterministically, recomputes the body hash,
+ * and reassembles header | 0x01 | body. Used by verification to confirm the
+ * proof corresponds to a complete, Minima-serializable candidate.
+ *
+ * @param proofTemplate The template the proof was mined against.
+ * @param headerBytes   The mined TxHeader bytes.
+ * @param prng          The PRNG used when the proof was mined (32 bytes).
+ */
+export declare function reconstructTxPoWEnvelope(proofTemplate: MinimaWorkTemplate, headerBytes: Uint8Array, prng: Uint8Array): {
+    envelope: Uint8Array;
+    bodyHash: string;
+};

package/dist/cjs/admission/template.js

@@ -0,0 +1,247 @@
+"use strict";
+/**
+ * admission/template.ts — Minima block-candidate template handling.
+ *
+ * Builds a TxHeader tail that is structurally capable of becoming a legitimate
+ * Minima block. The fields (block number, block difficulty, super-parents, MMR
+ * root/total, magic, time) come from the current chain tip via an injected
+ * MinimaWorkTemplateProvider — mirroring TxPoWGenerator.generateTxPoW in
+ * Minima. The action commitment is placed in the header's customHash field.
+ *
+ * The TxPoW package stays transport/node-client agnostic: callers inject the
+ * template provider. A real Minima node / Axia integration supplies live chain
+ * state; tests supply fixtures.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeSuperParents = serializeSuperParents;
+exports.buildEmptyBurnTxBytes = buildEmptyBurnTxBytes;
+exports.buildEmptyBurnWitnessBytes = buildEmptyBurnWitnessBytes;
+exports.buildEmptyTransactionBytes = buildEmptyTransactionBytes;
+exports.buildEmptyWitnessBytes = buildEmptyWitnessBytes;
+exports.buildEmptyBlockBody = buildEmptyBlockBody;
+exports.assembleTxPoWEnvelope = assembleTxPoWEnvelope;
+exports.buildBlockHeaderTail = buildBlockHeaderTail;
+exports.computeBlockCandidateId = computeBlockCandidateId;
+exports.isBlockWinner = isBlockWinner;
+exports.computeSuperLevel = computeSuperLevel;
+exports.templateFreshness = templateFreshness;
+exports.reconstructTxPoWEnvelope = reconstructTxPoWEnvelope;
+const core_1 = require("@totemsdk/core");
+const core_2 = require("@totemsdk/core");
+const constants_js_1 = require("../constants.js");
+function hexToBytes(hex) {
+    const h = hex.startsWith('0x') ? hex.slice(2) : hex;
+    const out = new Uint8Array(h.length / 2);
+    for (let i = 0; i < h.length; i += 2) {
+        out[i / 2] = parseInt(h.slice(i, i + 2), 16);
+    }
+    return out;
+}
+function toHex(bytes) {
+    return Array.from(bytes).map(b => b.toString(16).padStart(2, '0')).join('');
+}
+/**
+ * Serialize the super-parent RLE runs per TxHeader.writeDataStream.
+ *
+ * Consecutive equal hashes are coalesced into (count: MiniByte, hash) runs.
+ * A fresh candidate with all-distinct parents serializes as 32 runs.
+ */
+function serializeSuperParents(superParents) {
+    if (superParents.length !== constants_js_1.CASCADE_LEVELS) {
+        throw new Error(`superParents must have ${constants_js_1.CASCADE_LEVELS} entries, got ${superParents.length}`);
+    }
+    const parts = [];
+    let runHash = superParents[0];
+    let runCount = 1;
+    for (let i = 1; i < superParents.length; i++) {
+        if (superParents[i] === runHash) {
+            runCount++;
+        }
+        else {
+            parts.push(new Uint8Array([runCount]));
+            parts.push((0, core_2.writeHashToStream)(hexToBytes(runHash)));
+            runHash = superParents[i];
+            runCount = 1;
+        }
+    }
+    parts.push(new Uint8Array([runCount]));
+    parts.push((0, core_2.writeHashToStream)(hexToBytes(runHash)));
+    return (0, core_2.concat)(...parts);
+}
+/**
+ * Build the empty burn transaction bytes (TxBody.writeDataStream fields 5-6).
+ *
+ * Equivalent to serializeTransaction({ linkHash: [0x00], inputs: [], outputs: [],
+ * state: [] }): 0 inputs, 0 outputs, 0 state, linkHash = ZERO_TXPOWID (1 byte).
+ */
+function buildEmptyBurnTxBytes() {
+    return (0, core_2.concat)((0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeHashToStream)(new Uint8Array([0x00])));
+}
+/**
+ * Build the empty burn witness bytes (TxBody.writeDataStream field 6).
+ * 0 signatures, 0 coinproofs, 0 scriptproofs.
+ */
+function buildEmptyBurnWitnessBytes() {
+    return (0, core_2.concat)((0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0));
+}
+/**
+ * Build the empty transaction bytes (TxBody.writeDataStream field 3).
+ * 0 inputs, 0 outputs, 0 state, linkHash = ZERO_TXPOWID (1 byte).
+ */
+function buildEmptyTransactionBytes() {
+    return (0, core_2.concat)((0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeHashToStream)(new Uint8Array([0x00])));
+}
+/**
+ * Build the empty witness bytes (TxBody.writeDataStream field 4).
+ * 0 signatures, 0 coinproofs, 0 scriptproofs.
+ */
+function buildEmptyWitnessBytes() {
+    return (0, core_2.concat)((0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0), (0, core_2.writeMiniNumber)(0n, 0));
+}
+/**
+ * Build the serialized TxBody for a fresh block candidate.
+ *
+ * Mirrors TxBody.writeDataStream with an empty transaction and witness (the
+ * same shape Minima's MINEPULSE automine uses for block candidates):
+ *   mPRNG | mTxnDifficulty | mTransaction | mWitness |
+ *   mBurnTransaction | mBurnWitness | mTxPowIDList
+ *
+ * @param prng          32-byte PRNG (deterministic for tests; random otherwise).
+ * @param txnDifficulty Transaction difficulty (32-byte hex). For a block
+ *                      candidate this is typically the block difficulty.
+ */
+function buildEmptyBlockBody(prng, txnDifficulty) {
+    return (0, core_2.concat)((0, core_2.writeHashToStream)(prng), (0, core_2.writeMiniData)(hexToBytes(txnDifficulty)), buildEmptyTransactionBytes(), buildEmptyWitnessBytes(), buildEmptyBurnTxBytes(), buildEmptyBurnWitnessBytes(), (0, core_2.writeMiniNumber)(0n, 0));
+}
+/**
+ * Assemble the complete Minima TxPoW wire format:
+ *   TxHeader | 0x01 (hasBody) | TxBody
+ *
+ * This is the representation required for network submission of a genuine L1
+ * block candidate. A mined header alone is NOT sufficient.
+ *
+ * @param headerBytes  Serialized TxHeader bytes (with the winning nonce).
+ * @param bodyBytes    Serialized TxBody bytes.
+ */
+function assembleTxPoWEnvelope(headerBytes, bodyBytes) {
+    return (0, core_2.concat)(headerBytes, new Uint8Array([0x01]), bodyBytes);
+}
+/**
+ * Build the TxHeader tail (everything after the nonce field) for a block
+ * candidate with the given customHash commitment.
+ *
+ * Field order (TxHeader.writeDataStream):
+ *   mNonce | mChainID | mTimeMilli | mBlockNumber | mBlockDifficulty |
+ *   super-parents RLE | mMMRRoot | mMMRTotal | mMagic | mCustomHash | mTxBodyHash
+ *
+ * @param template     The current Minima work template.
+ * @param customHash   The action commitment (32-byte hex) to place in mCustomHash.
+ * @param txBodyHash   SHA3-256 of the serialized TxBody (32-byte hex).
+ */
+function buildBlockHeaderTail(template, customHash, txBodyHash) {
+    return (0, core_2.concat)((0, core_2.writeMiniData)(hexToBytes(template.chainId)), (0, core_2.writeMiniNumber)(template.timeMilli, 0), (0, core_2.writeMiniNumber)(template.blockNumber, 0), (0, core_2.writeMiniData)(hexToBytes(template.blockDifficulty)), serializeSuperParents(template.superParents), (0, core_2.writeHashToStream)(hexToBytes(template.mmrRoot)), (0, core_2.writeMiniNumber)(template.mmrTotal, 0), hexToBytes(template.magic), (0, core_2.writeHashToStream)(hexToBytes(customHash)), (0, core_2.writeHashToStream)(hexToBytes(txBodyHash)));
+}
+/**
+ * Compute the TxPoW ID for a mined block-candidate header.
+ * txpowId = SHA3-256(serialized TxHeader).
+ */
+function computeBlockCandidateId(headerBytes) {
+    return (0, core_1.sha3_256)(headerBytes);
+}
+/**
+ * Check whether a txpowId beats the block target (i.e. is a genuine Minima block).
+ * valid = txpowId < blockDifficulty (big-endian 256-bit comparison).
+ */
+function isBlockWinner(txpowId, blockDifficulty) {
+    const target = hexToBytes(blockDifficulty);
+    for (let i = 0; i < 32; i++) {
+        if (txpowId[i] < target[i])
+            return true;
+        if (txpowId[i] > target[i])
+            return false;
+    }
+    return false;
+}
+/** Java BigInteger.bitLength() for non-negative values. bitLength(0) = 0. */
+function bigIntBitLength(x) {
+    if (x <= 0n)
+        return 0;
+    let bits = 0;
+    let v = x;
+    while (v > 0n) {
+        v >>= 1n;
+        bits++;
+    }
+    return bits;
+}
+function bytesToBigInt(bytes) {
+    let v = 0n;
+    for (let i = 0; i < bytes.length; i++) {
+        v = (v << 8n) | BigInt(bytes[i]);
+    }
+    return v;
+}
+/**
+ * Compute the Minima Super level for a TxPoW ID against a block difficulty,
+ * with Minima's exact integer semantics.
+ *
+ * From TxPoW.calculateTXPOWID() / getSuperLevel():
+ *   quot  = blockDifficulty / txpowId          (unsigned BigInteger division)
+ *   super = quot.bitLength() - 1               (floor(log2(quot)))
+ *   if super >= MINIMA_CASCADE_LEVELS (32) → clamp to 31
+ *
+ * When the TxPoW is NOT a block (txpowId >= blockDifficulty), quot = 0,
+ * bitLength(0) = 0, so super = -1.
+ *
+ * Result:
+ *   -1   — not a Minima block
+ *    0   — ordinary/base Minima block (Super-0)
+ *    1..31 — Super-1 … Super-31 (stronger blocks; 31 is the maximum represented)
+ *
+ * @param txpowId        SHA3-256(header), 32 bytes.
+ * @param blockDifficulty 32-byte hex block difficulty target.
+ */
+function computeSuperLevel(txpowId, blockDifficulty) {
+    const diffBigInt = bytesToBigInt(hexToBytes(blockDifficulty));
+    const idBigInt = bytesToBigInt(txpowId);
+    // Not a block: quot = 0 → super = -1
+    if (idBigInt >= diffBigInt)
+        return -1;
+    const quot = diffBigInt / idBigInt;
+    let superLevel = bigIntBitLength(quot) - 1;
+    // Clamp to the maximum represented Super level, exactly as Minima does.
+    if (superLevel >= constants_js_1.CASCADE_LEVELS) {
+        superLevel = constants_js_1.CASCADE_LEVELS - 1;
+    }
+    return superLevel;
+}
+/**
+ * Default staleness policy: a template is "current enough" for admission if it
+ * was captured within the window, and "current" for L1 broadcast if it matches
+ * the latest template id.
+ */
+function templateFreshness(template, latest, options) {
+    const now = options?.now ?? Date.now();
+    const windowMs = options?.admissionWindowMs ?? 5 * 60 * 1000;
+    const age = now - template.capturedAt;
+    const admissionValid = age >= 0 && age <= windowMs;
+    const broadcastable = latest !== null && template.templateId === latest.templateId;
+    return { admissionValid, broadcastable };
+}
+/**
+ * Reconstruct the complete Minima TxPoW envelope for a proof.
+ *
+ * Rebuilds the empty block TxBody deterministically, recomputes the body hash,
+ * and reassembles header | 0x01 | body. Used by verification to confirm the
+ * proof corresponds to a complete, Minima-serializable candidate.
+ *
+ * @param proofTemplate The template the proof was mined against.
+ * @param headerBytes   The mined TxHeader bytes.
+ * @param prng          The PRNG used when the proof was mined (32 bytes).
+ */
+function reconstructTxPoWEnvelope(proofTemplate, headerBytes, prng) {
+    const body = buildEmptyBlockBody(prng, proofTemplate.blockDifficulty);
+    const bodyHash = toHex((0, core_1.sha3_256)(body));
+    const envelope = assembleTxPoWEnvelope(headerBytes, body);
+    return { envelope, bodyHash };
+}

package/dist/cjs/admission/types.d.ts

@@ -0,0 +1,224 @@
+/**
+ * admission/types.ts — Machine Work Admission core types.
+ *
+ * Machine Work Admission lets a receiver require a sender to perform bounded
+ * computational work before scarce machine resources are allocated. The work
+ * searches the nonce space of a real current Minima block candidate, so the
+ * same hashes that admit the machine action also search for Minima L1 blocks.
+ *
+ * The three distinct concepts:
+ *   - WorkChallenge  — the receiver-controlled admission requirement
+ *   - MachineWorkAction — the domain-separated application action commitment
+ *   - MachineWorkAdmissionProof — the mined result
+ *
+ * The TxPoW package knows only "there is an application action represented by
+ * canonical bytes". It does NOT know about negotiation, compute, storage, or
+ * any particular Edge resource. Domain-specific packages supply the action.
+ */
+/** Current Machine Work Admission protocol version. */
+export declare const MACHINE_WORK_ADMISSION_VERSION = 1;
+/** Canonical protocol domain prefix for the commitment hash. */
+export declare const MACHINE_WORK_DOMAIN = "totem.machine-work-admission";
+/**
+ * The receiver controls the admission requirement.
+ *
+ * A challenge must be unique enough to prevent useful pre-mining, must expire,
+ * must bind to the intended receiver, and must bind to an application domain.
+ * `target` is an absolute cryptographic target: verification is `hash < target`.
+ */
+export interface WorkChallenge {
+    /** Protocol version. */
+    version: number;
+    /** Unique challenge identifier (receiver-generated, prevents pre-mining). */
+    challengeId: string;
+    /** The intended receiver this challenge is bound to. */
+    recipient: string;
+    /** Application domain (e.g. "totem.negotiation.proposal"). Open-ended. */
+    domain: string;
+    /** Absolute 32-byte cryptographic target (big-endian 256-bit). */
+    target: string;
+    /** Receiver-generated random nonce to prevent pre-mining. */
+    nonce: string;
+    /** Epoch milliseconds when the challenge was issued. */
+    issuedAt: number;
+    /** Epoch milliseconds after which the challenge is invalid. */
+    expiresAt: number;
+    /** Optional network identifier (e.g. "mainnet", "testnet"). */
+    network?: string;
+}
+/**
+ * The application action, represented in a generic domain-separated form.
+ *
+ * Only a commitment to this action enters the TxPoW header — never the
+ * application payload itself. The application remains off-chain.
+ */
+export interface MachineWorkAction {
+    /** Protocol version. */
+    version: number;
+    /** Application domain (e.g. "totem.compute.reserve"). Open-ended. */
+    domain: string;
+    /** The sender performing the work. */
+    sender: string;
+    /** The intended recipient. */
+    recipient: string;
+    /** Unique action identifier. */
+    actionId: string;
+    /** SHA3-256 hex commitment to the application payload (off-chain). */
+    payloadHash: string;
+    /** Optional domain-specific context (canonicalized into the commitment). */
+    context?: Record<string, string>;
+}
+/**
+ * A Minima block-candidate work template.
+ *
+ * This is the chain state a candidate is mined against. It is structurally
+ * capable of becoming a legitimate Minima block: block number, block
+ * difficulty, super-parents, MMR root/total, magic, and time are all taken
+ * from the current chain tip (see TxPoWGenerator.generateTxPoW in Minima).
+ */
+export interface MinimaWorkTemplate {
+    /** Chain ID (MAIN_NET = 0x00). */
+    chainId: string;
+    /** Block number = current tip + 1. */
+    blockNumber: bigint;
+    /** Current block difficulty target (32-byte hex). */
+    blockDifficulty: string;
+    /** Super-parent hashes at each cascade level (RLE-serialized). */
+    superParents: string[];
+    /** Current MMR root (32-byte hex). */
+    mmrRoot: string;
+    /** Current MMR total (sum of all coins). */
+    mmrTotal: bigint;
+    /** Serialized Magic struct (hex). */
+    magic: string;
+    /** Candidate timestamp in epoch milliseconds. */
+    timeMilli: bigint;
+    /** Template identifier (e.g. tip txpowId) for staleness checks. */
+    templateId: string;
+    /** Epoch milliseconds when the template was captured. */
+    capturedAt: number;
+}
+/**
+ * Provider abstraction for the current Minima block-candidate template.
+ *
+ * The TxPoW package remains transport/node-client agnostic: callers inject a
+ * provider that fetches the current template from a Minima node, Axia, or a
+ * test fixture.
+ *
+ * `MinimaWorkRelay` is the preferred long-term relay boundary. The legacy
+ * `broadcastBlockCandidate` callback is retained as a compatibility/fallback
+ * path only — new consumers should use `relay` via `MinimaWorkRelay` and not
+ * build around the lossy `candidate: unknown` shape.
+ */
+export interface MinimaWorkTemplateProvider {
+    /** Fetch the current block-candidate template. */
+    getCurrentTemplate(): Promise<MinimaWorkTemplate>;
+    /** Optional: fetch the latest template for freshness checks. Falls back to getCurrentTemplate. */
+    getLatestTemplate?(): Promise<MinimaWorkTemplate>;
+    /** Optional: validate a template before mining against it. */
+    validateTemplate?(template: MinimaWorkTemplate): Promise<boolean>;
+    /**
+     * @deprecated Prefer `MinimaWorkRelay.submitBlock` (complete envelope).
+     * Retained for compatibility; only invoked for genuine Minima blocks
+     * (Super-0 … Super-31) when no relay is configured.
+     */
+    broadcastBlockCandidate?(candidate: MachineWorkAdmissionProof): Promise<void>;
+}
+/**
+ * Relay boundary for a complete Minima TxPoW envelope.
+ *
+ * Keeps Minima networking outside core mining logic. A future
+ * @totemsdk/minima-rpc or chain-provider adapter may implement this port.
+ * Duplicate relay attempts must be safe/idempotent at the integration boundary.
+ */
+export interface MinimaWorkRelay {
+    /** Submit a complete Minima TxPoW envelope for block relay. */
+    submitBlock(envelope: Uint8Array): Promise<void>;
+}
+/**
+ * The mined Machine Work Admission proof.
+ *
+ * Reuses the existing TxPoW types where possible:
+ *   - `txpow`          — serialized TxHeader bytes (SHA3-256 of these is `txpowId`)
+ *   - `txpowEnvelope`  — the COMPLETE Minima TxPoW wire format
+ *                        (header | 0x01 hasBody | body), required for network
+ *                        submission of a genuine Minima block
+ *   - `txpowId`        — SHA3-256(header)
+ *
+ * `qualifiesAsMinimaBlock`, `isBlock`, and `superLevel` are DERIVED METADATA
+ * recorded at mining time. They are never trusted by verification —
+ * verification recomputes all of them from the re-derived txpowId and the
+ * template's block difficulty.
+ */
+export interface MachineWorkAdmissionProof {
+    /** Protocol version. */
+    version: number;
+    /** Hex commitment placed in the TxPoW header's customHash field. */
+    actionCommitment: string;
+    /** The challenge this proof was mined against. */
+    challengeId: string;
+    /** The admission target (32-byte hex) the proof satisfies. */
+    admissionTarget: string;
+    /** Serialized TxHeader bytes (SHA3-256 of these is the TxPoW ID). */
+    txpow: string;
+    /** Complete Minima TxPoW envelope (header | 0x01 | body) for block relay. */
+    txpowEnvelope: string;
+    /** SHA3-256(header) — the canonical TxPoW ID. */
+    txpowId: string;
+    /** The winning nonce. */
+    nonce: string;
+    /** Epoch milliseconds when the proof was mined. */
+    minedAt: number;
+    /** Always true for a valid admission proof. */
+    qualifiesForAdmission: true;
+    /**
+     * DERIVED METADATA: true when the mined hash also beats the block difficulty
+     * encoded by the candidate template (i.e. a genuine Minima block). Never
+     * trusted by verification — it is recomputed from the re-derived txpowId.
+     */
+    qualifiesAsMinimaBlock: boolean;
+    /**
+     * DERIVED METADATA: Minima Super level (-1 = not a block, 0..31 = block
+     * strength). Never trusted by verification.
+     */
+    superLevel: number;
+    /** DERIVED METADATA: superLevel >= 0. Never trusted by verification. */
+    isBlock: boolean;
+    /** Template the proof was mined against (for staleness policy). */
+    template: MinimaWorkTemplate;
+}
+/**
+ * Result of verifying a Machine Work Admission proof.
+ *
+ * Three distinct claims, never to be confused:
+ *   A. `valid` — the hash satisfies the challenge target (admission proof).
+ *   B. `superLevel` / `isBlock` — the hash ALSO satisfies the block difficulty
+ *      encoded by the candidate template, yielding an exact Minima Super level.
+ *   C. `broadcastable` — the candidate still corresponds to sufficiently
+ *      current live Minima state AND can be submitted through the relay.
+ *
+ * A stale candidate may remain `valid = true` (and `superLevel >= 0`) while
+ * `broadcastable = false`.
+ *
+ * `superLevel === -1 ⇔ isBlock === false`, and
+ * `superLevel >= 0 ⇔ isBlock === true`. Verification recomputes these — it
+ * never trusts sender-supplied `isBlock`/`superLevel` metadata.
+ */
+export interface WorkAdmissionVerification {
+    /** Level A: the hash satisfies the challenge target. */
+    valid: boolean;
+    reason?: string;
+    /**
+     * Level B: exact Minima Super level of the candidate hash.
+     * -1 = not a Minima block; 0..31 = Super-0 … Super-31 block strength.
+     */
+    superLevel?: number;
+    /** Level B: superLevel >= 0 (a genuine Minima block). */
+    isBlock?: boolean;
+    /**
+     * Level C: isBlock AND the template is current AND a live template provider
+     * was supplied. Undefined in offline mode (no provider) — offline
+     * verification must NOT claim Minima block contribution.
+     */
+    broadcastable?: boolean;
+}

package/dist/cjs/admission/types.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * admission/types.ts — Machine Work Admission core types.
+ *
+ * Machine Work Admission lets a receiver require a sender to perform bounded
+ * computational work before scarce machine resources are allocated. The work
+ * searches the nonce space of a real current Minima block candidate, so the
+ * same hashes that admit the machine action also search for Minima L1 blocks.
+ *
+ * The three distinct concepts:
+ *   - WorkChallenge  — the receiver-controlled admission requirement
+ *   - MachineWorkAction — the domain-separated application action commitment
+ *   - MachineWorkAdmissionProof — the mined result
+ *
+ * The TxPoW package knows only "there is an application action represented by
+ * canonical bytes". It does NOT know about negotiation, compute, storage, or
+ * any particular Edge resource. Domain-specific packages supply the action.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MACHINE_WORK_DOMAIN = exports.MACHINE_WORK_ADMISSION_VERSION = void 0;
+/** Current Machine Work Admission protocol version. */
+exports.MACHINE_WORK_ADMISSION_VERSION = 1;
+/** Canonical protocol domain prefix for the commitment hash. */
+exports.MACHINE_WORK_DOMAIN = 'totem.machine-work-admission';

package/dist/cjs/admission/verify.d.ts

@@ -0,0 +1,50 @@
+/**
+ * admission/verify.ts — Machine Work Admission verification.
+ *
+ * Verification NEVER trusts sender-reported hardware speed or self-reported
+ * block metadata (`isBlock`, `superLevel`, `qualifiesAsMinimaBlock`,
+ * `broadcastable`). It recomputes the canonical action commitment, re-derives
+ * the TxPoW ID from the mined header, and checks `txpowId < challenge.target`.
+ * It also checks challenge validity (expiry, recipient, domain) and template
+ * freshness.
+ *
+ * Three distinct claims, never to be confused:
+ *   A. valid — the hash satisfies the challenge target.
+ *   B. superLevel/isBlock — the exact Minima Super level (-1 or 0..31)
+ *      computed from blockDifficulty / txpowId.
+ *   C. broadcastable — isBlock AND the template is current AND a live
+ *      template provider was supplied.
+ *
+ * A stale candidate may remain valid = true (and superLevel >= 0) while
+ * broadcastable = false. Offline verification (no provider) must NOT claim
+ * Minima block contribution — `broadcastable` is left undefined.
+ */
+import { type MachineWorkAction, type MachineWorkAdmissionProof, type MinimaWorkTemplate, type MinimaWorkTemplateProvider, type WorkChallenge, type WorkAdmissionVerification } from './types.js';
+export interface VerifyWorkAdmissionOptions {
+    /** Override the current time for deterministic testing. */
+    now?: number;
+    /** Staleness window (ms) within which a template is acceptable for admission. */
+    admissionWindowMs?: number;
+    /** The latest template, for broadcastability checks. */
+    latestTemplate?: MinimaWorkTemplate | null;
+}
+/**
+ * Verify a Machine Work Admission proof.
+ *
+ * The admission target is taken from the validated challenge — never from the
+ * proof. `proof.qualifiesAsMinimaBlock`, `proof.superLevel`, and
+ * `proof.isBlock` are treated as derived metadata and are NOT trusted; the
+ * Super level is recomputed from the re-derived txpowId and the template's
+ * block difficulty.
+ *
+ * @param action           The application action the proof claims to commit.
+ * @param challenge        The challenge the proof claims to satisfy.
+ * @param proof            The mined proof.
+ * @param templateProvider Optional live provider. When supplied, template
+ *                         freshness and broadcastability are checked and
+ *                         `broadcastable` is set. When omitted, verification
+ *                         runs in offline mode and does NOT claim Minima
+ *                         block contribution (`broadcastable` is undefined).
+ * @param options          Verification options.
+ */
+export declare function verifyWorkAdmission(action: MachineWorkAction, challenge: WorkChallenge, proof: MachineWorkAdmissionProof, templateProvider?: MinimaWorkTemplateProvider, options?: VerifyWorkAdmissionOptions): Promise<WorkAdmissionVerification>;