@smartledger/bsv 9.1.1 → 9.3.0

package/docs/getting-started/INSTALLATION.md

@@ -48,7 +48,7 @@ const tx: Transaction = new Transaction();
 #### **Core Library Only (937KB)**
 For basic Bitcoin SV operations:
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 <script>
   const privateKey = new bsv.PrivateKey();
   const address = privateKey.toAddress();
@@ -58,7 +58,7 @@ For basic Bitcoin SV operations:
 #### **Complete Bundle (937KB)**  
 Everything in one file:
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 <script>
   // All features available immediately
   const shares = bsv.splitSecret('secret', 5, 3);
@@ -71,9 +71,9 @@ Everything in one file:
 
 #### **Smart Contract Development (~2.7MB total — each bundle is self-contained and re-embeds core BSV)**
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-covenant.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-covenant.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js"></script>
 <script>
   const covenant = bsv.SmartContract.createCovenantBuilder()
     .extractField('amount').push(50000).greaterThanOrEqual().build();
@@ -82,9 +82,9 @@ Everything in one file:
 
 #### **Legal & Identity Development (~3.2MB total — each bundle is self-contained and re-embeds core BSV)**
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-ltp.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js"></script>
 <script>
   // Legal Token Protocol
   const propertyToken = bsv.createPropertyToken({
@@ -98,9 +98,9 @@ Everything in one file:
 
 #### **Security & Cryptography (~1.4MB total — each bundle is self-contained and re-embeds core BSV)**
 ```html
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-security.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-shamir.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-security.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-shamir.min.js"></script>
 <script>
   // Threshold Cryptography
   const shares = bsv.splitSecret('my_secret_key', 5, 3);
@@ -114,18 +114,18 @@ Everything in one file:
 
 | Module | Size | Purpose | CDN Link |
 |--------|------|---------|----------|
-| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js` |
-| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@9.1.1/bsv.bundle.js` |
-| **bsv-smartcontract.min.js** | 937KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@9.1.1/bsv-smartcontract.min.js` |
-| **bsv-ltp.min.js** | 1184KB | **Legal Token Protocol** | `unpkg.com/@smartledger/bsv@9.1.1/bsv-ltp.min.js` |
-| **bsv-gdaf.min.js** | 1184KB | **Digital Identity & Attestation** | `unpkg.com/@smartledger/bsv@9.1.1/bsv-gdaf.min.js` |
-| **bsv-shamir.min.js** | 432KB | **Threshold Cryptography** | `unpkg.com/@smartledger/bsv@9.1.1/bsv-shamir.min.js` |
-| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@9.1.1/bsv-security.min.js` |
-| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@9.1.1/bsv-mnemonic.min.js` |
-| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@9.1.1/bsv-ecies.min.js` |
-| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@9.1.1/bsv-covenant.min.js` |
-| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@9.1.1/bsv-script-helper.min.js` |
-| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@9.1.1/bsv-message.min.js` |
+| **bsv.min.js** | 937KB | Core BSV + SmartContract | `unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js` |
+| **bsv.bundle.js** | 937KB | Everything in one file | `unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js` |
+| **bsv-smartcontract.min.js** | 937KB | Complete covenant framework | `unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js` |
+| **bsv-ltp.min.js** | 1184KB | **Legal Token Protocol** | `unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js` |
+| **bsv-gdaf.min.js** | 1184KB | **Digital Identity & Attestation** | `unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js` |
+| **bsv-shamir.min.js** | 432KB | **Threshold Cryptography** | `unpkg.com/@smartledger/bsv@9.3.0/bsv-shamir.min.js` |
+| **bsv-security.min.js** | 26KB | Security enhancements (opt-in helpers — see README › Security) | `unpkg.com/@smartledger/bsv@9.3.0/bsv-security.min.js` |
+| **bsv-mnemonic.min.js** | 681KB | HD wallets | `unpkg.com/@smartledger/bsv@9.3.0/bsv-mnemonic.min.js` |
+| **bsv-ecies.min.js** | 71KB | Encryption | `unpkg.com/@smartledger/bsv@9.3.0/bsv-ecies.min.js` |
+| **bsv-covenant.min.js** | 913KB | Covenant operations | `unpkg.com/@smartledger/bsv@9.3.0/bsv-covenant.min.js` |
+| **bsv-script-helper.min.js** | 26KB | Custom script tools | `unpkg.com/@smartledger/bsv@9.3.0/bsv-script-helper.min.js` |
+| **bsv-message.min.js** | 26KB | Message signing | `unpkg.com/@smartledger/bsv@9.3.0/bsv-message.min.js` |
 
 ## ⚙️ **Development Environment Setup**
 

package/docs/getting-started/QUICK_START.md

@@ -14,10 +14,10 @@ npm install @smartledger/bsv
 ### Browser CDN (Instant)
 ```html
 <!-- Core library (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 
 <!-- Everything included (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 ```
 
 ## 💰 **Your First Transaction (60 seconds)**
@@ -127,19 +127,19 @@ SmartLedger-BSV offers 12 different loading options - use only what you need:
 
 ```html
 <!-- Core BSV only (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 
 <!-- Smart contracts (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js"></script>
 
 <!-- Legal tokens (1.16MB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js"></script>
 
 <!-- Digital identity (1.16MB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js"></script>
 
 <!-- Everything (937KB) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 ```
 
 ## ⚡ **Key Advantages**

package/docs/migration/FROM_BSV_1_5_6.md

@@ -159,17 +159,17 @@ const recovered = bsv.reconstructSecret([shares[0], shares[2], shares[4]]);
 ### **New Modular Options** 
 ```html
 <!-- Core compatibility (same size as bsv@1.5.6) -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.min.js"></script>
 
 <!-- Add smart contracts when ready -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-smartcontract.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-smartcontract.min.js"></script>
 
 <!-- Add advanced features as needed -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-ltp.min.js"></script>
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv-gdaf.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-ltp.min.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv-gdaf.min.js"></script>
 
 <!-- Everything in one file -->
-<script src="https://unpkg.com/@smartledger/bsv@9.1.1/bsv.bundle.js"></script>
+<script src="https://unpkg.com/@smartledger/bsv@9.3.0/bsv.bundle.js"></script>
 ```
 
 ## 🔍 **Testing Your Migration**

package/gdaf-entry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * GDAF — governed data anchoring.
+ *
+ * Same class as `require("@smartledger/bsv").GDAF`.
+ */
+import { GDAF } from '@smartledger/bsv';
+export = GDAF;

package/index.js

@@ -307,6 +307,7 @@ bsv.createCredentialTemplate = function(credentialType) {
 
 // Legal Token Protocol (LTP) - Primitives-Only Interface
 bsv.LTP = require('./lib/ltp')
+bsv.JCS = require('./lib/util/jcs')
 
 // LTP Right Token Primitives
 bsv.prepareRightToken = function(type, issuerDID, subjectDID, claim, issuerPrivateKey, options) {
@@ -508,12 +509,12 @@ bsv.createClaimTemplate = function(schemaName) {
 }
 
 // LTP Utility Functions
-bsv.canonicalizeClaim = function(claim) {
-  return bsv.LTP.Claim.canonicalize(claim)
+bsv.canonicalizeClaim = function(claim, canonicalization) {
+  return bsv.LTP.Claim.canonicalize(claim, canonicalization)
 }
 
-bsv.hashClaim = function(claim) {
-  return bsv.LTP.Claim.hash(claim)
+bsv.hashClaim = function(claim, canonicalization) {
+  return bsv.LTP.Claim.hash(claim, canonicalization)
 }
 
 bsv.addCustomClaimSchema = function(name, schema) {

package/index.mjs

@@ -18,6 +18,7 @@ export const {
   HDPrivateKey,
   HDPublicKey,
   Input,
+  JCS,
   LTP,
   MerkleBlock,
   Message,

package/jcs-entry.d.ts

@@ -0,0 +1,12 @@
+/**
+ * RFC 8785 (JSON Canonicalization Scheme).
+ *
+ * Object keys sort by UTF-16 code unit, applied during serialization rather than by
+ * rebuilding an object — rebuilding lets V8 reorder integer-like keys ahead of the
+ * sort, producing `{"2":…,"10":…}` where the RFC requires `{"10":…,"2":…}`.
+ *
+ * Throws on non-finite numbers, bigint, circular structures, and values with no JSON
+ * representation, rather than coercing them: a canonicalizer that silently serializes
+ * a different document than the one supplied defeats its own purpose.
+ */
+export declare function stringify(value: any): string;

package/jcs-entry.js

@@ -0,0 +1 @@
+module.exports = require('./lib/util/jcs')

package/lib/ltp/claim.js

@@ -3,6 +3,8 @@
 var Hash = require('../crypto/hash')
 var $ = require('../util/preconditions')
 var Id = require('../util/id')
+var JCS = require('../util/jcs')
+var deprecate = require('../util/deprecate')
 
 /**
  * Legal Token Protocol - Claim Preparation Primitives
@@ -282,8 +284,14 @@ var ClaimValidator = {
         errors: errors,
         warnings: warnings,
         schema: schemaName,
-        claimHash: this.hash(claim),
-        canonical: this.canonicalize(claim)
+        // Both pinned to LEGACY, not inheriting the deprecated default: these are
+        // stored as identifiers by callers who cannot pass an argument here, and a
+        // warning naming a function they did not call is noise. 10.0.0 moves them to
+        // JCS as one documented change rather than a silent one.
+        claimHash: Hash.sha256(Buffer.from(
+          this._canonicalizeWith(claim, this.CANONICALIZATION.LEGACY)
+        )).toString('hex'),
+        canonical: this._canonicalizeWith(claim, this.CANONICALIZATION.LEGACY)
       }
       
       return {
@@ -360,7 +368,10 @@ var ClaimValidator = {
       }
       
       // Create attestation hash
-      var attestationHash = Hash.sha256(Buffer.from(this.canonicalize(attestation))).toString('hex')
+      // Pinned to LEGACY — see the note on validateClaim's canonical field.
+      var attestationHash = Hash.sha256(Buffer.from(
+        this._canonicalizeWith(attestation, this.CANONICALIZATION.LEGACY)
+      )).toString('hex')
       attestation.attestationHash = attestationHash
       
       return {
@@ -426,7 +437,10 @@ var ClaimValidator = {
       }
       
       // Create dispute hash
-      var disputeHash = Hash.sha256(Buffer.from(this.canonicalize(disputeRecord))).toString('hex')
+      // Pinned to LEGACY — see the note on validateClaim's canonical field.
+      var disputeHash = Hash.sha256(Buffer.from(
+        this._canonicalizeWith(disputeRecord, this.CANONICALIZATION.LEGACY)
+      )).toString('hex')
       disputeRecord.disputeHash = disputeHash
       
       return {
@@ -541,29 +555,106 @@ var ClaimValidator = {
     }
   },
   
+  /**
+   * Canonicalization forms understood when hashing a claim.
+   *
+   * JCS is RFC 8785 and is what a claim hash should be computed with: two independent
+   * implementations produce identical bytes, which is the only property that makes a
+   * hash meaningful to anyone but us.
+   *
+   * LEGACY is the sorted-key form this module has always used. It sorts keys and then
+   * REBUILDS an object, which loses the sort — V8 orders integer-like own properties
+   * numerically ahead of string keys whatever order they were inserted in:
+   *
+   *     LEGACY   {"2":"two","10":"ten"}
+   *     JCS      {"10":"ten","2":"two"}      (RFC 8785, UTF-16 code unit order)
+   *
+   * Deterministic, so nothing already hashed is wrong or forgeable. Not interoperable,
+   * so an RFC 8785 verifier in any other language computes a different claim hash.
+   */
+  CANONICALIZATION: {
+    JCS: 'jcs',
+    LEGACY: 'legacy'
+  },
+
   /**
    * Canonicalize claim for hashing
+   *
    * @param {Object} claim - Claim to canonicalize
+   * @param {String} [canonicalization] - CANONICALIZATION.JCS or .LEGACY. Omitting it
+   *        selects LEGACY and emits a deprecation notice; the default becomes JCS in
+   *        10.0.0. Pass one explicitly to pin the behaviour across that change.
    * @returns {String} Canonical JSON string
    */
-  canonicalize: function(claim) {
+  canonicalize: function(claim, canonicalization) {
+    return this._canonicalizeWith(
+      claim,
+      this._resolveCanonicalization(canonicalization, 'LTP.Claim.canonicalize')
+    )
+  },
+
+  /**
+   * Hash claim
+   *
+   * @param {Object} claim - Claim to hash
+   * @param {String} [canonicalization] - see canonicalize()
+   * @returns {String} SHA256 hash
+   */
+  hash: function(claim, canonicalization) {
+    var canonical = this._canonicalizeWith(
+      claim,
+      this._resolveCanonicalization(canonicalization, 'LTP.Claim.hash')
+    )
+    return Hash.sha256(Buffer.from(canonical)).toString('hex')
+  },
+
+  /**
+   * Canonicalize with the form already decided. No deprecation notice: the caller has
+   * chosen, either explicitly or on its behalf by _resolveCanonicalization.
+   */
+  _canonicalizeWith: function(claim, canonicalization) {
     $.checkArgument(claim && typeof claim === 'object', 'Invalid claim')
-    
+
+    if (canonicalization === this.CANONICALIZATION.JCS) {
+      return JCS.stringify(claim)
+    }
+
     // Sort keys recursively
     var canonical = this._sortObjectKeys(claim)
-    
+
     // Return deterministic JSON
     return JSON.stringify(canonical)
   },
-  
+
   /**
-   * Hash claim
-   * @param {Object} claim - Claim to hash
-   * @returns {String} SHA256 hash
+   * Resolve an optional canonicalization argument to a concrete form.
+   *
+   * An unrecognised value throws rather than falling back. A silent fallback would
+   * turn a typo such as `'JCS'` into a differently-hashed claim that still looks
+   * successful, which is the failure mode this whole change exists to remove.
    */
-  hash: function(claim) {
-    var canonical = this.canonicalize(claim)
-    return Hash.sha256(Buffer.from(canonical)).toString('hex')
+  _resolveCanonicalization: function(canonicalization, caller) {
+    if (canonicalization === undefined) {
+      // Per STABILITY.md: mark it in a minor, flip it in a major. 9.x does not break
+      // callers, so the default stays LEGACY and the notice carries the migration.
+      deprecate({
+        what: caller + '() without a canonicalization argument',
+        since: '9.2.0',
+        removeIn: '10.0.0',
+        use: caller + '(claim, bsv.LTP.Claim.CANONICALIZATION.JCS)',
+        why: 'the default sorted-key form is not RFC 8785, so other implementations compute a different claim hash'
+      })
+      return this.CANONICALIZATION.LEGACY
+    }
+
+    $.checkArgument(
+      canonicalization === this.CANONICALIZATION.JCS ||
+      canonicalization === this.CANONICALIZATION.LEGACY,
+      'Unknown canonicalization: ' + canonicalization +
+      ". Expected 'jcs' or 'legacy' (bsv.LTP.Claim.CANONICALIZATION)"
+    )
+
+    return canonicalization
   },
   
   /**

package/lib/ordinals/inscription.js

@@ -89,6 +89,103 @@ function resolveLock (params) {
   throw new Error('buildInscription requires an address or a lock script')
 }
 
+// Tags the Ordinals spec names. Everything else is "unrecognized", and the spec
+// treats unrecognized tags by parity — see assertTagIsSafe.
+var KNOWN_TAGS = [0, 1, 2, 3, 5, 7, 9, 11]
+
+var BODY_TAG = 0
+var CONTENT_TYPE_TAG = 1
+
+/**
+ * Push a field tag the way a parser expects to read it back.
+ *
+ * Tags are script numbers. 1..16 have dedicated opcodes; anything larger has no
+ * opcode form at all, because OP_16 is the largest numeric opcode — so tag 21
+ * must be a data push. Indexers read the resulting STACK ELEMENT, so `OP_5` and
+ * a one-byte push of `0x05` are the same tag; the opcode form is used wherever
+ * it exists because the data-push form of a small number is non-minimal, and
+ * non-minimal pushes are non-standard.
+ */
+function addTag (script, tag) {
+  if (tag >= 1 && tag <= 16) return script.add(Opcode.OP_1 - 1 + tag)
+
+  var le = []
+  var n = tag
+  while (n > 0) { le.push(n & 0xff); n = Math.floor(n / 256) }
+  // A script number carries its sign in the high bit of its last byte, so a
+  // value ending >= 0x80 needs a zero pad or it reads back negative.
+  if (le[le.length - 1] & 0x80) le.push(0x00)
+  return script.add(Buffer.from(le))
+}
+
+/**
+ * Refuse a tag that would produce a permanently broken inscription.
+ *
+ * The parity rule is the one that costs money. From the spec: "inscriptions with
+ * unrecognized even fields must be displayed as unbound, that is, without a
+ * location". An unknown ODD tag is simply ignored by an indexer that does not
+ * know it; an unknown EVEN tag costs the inscription its location, everywhere,
+ * permanently, on an output already paid for — and nothing local reports it,
+ * because a builder and its own parser agreeing proves only that they agree.
+ *
+ * This refuses rather than warns, but it is deliberately not a hard wall. The
+ * set of named tags grows as the protocol does, so a library that can never be
+ * overridden would eventually be wrong AND unbypassable, and the workaround —
+ * hand-assembling envelope bytes — is far more dangerous than the thing being
+ * prevented. Hence `allowUnknownEvenFields`, which exists to be reached for
+ * knowingly and named so it cannot be passed by accident.
+ */
+function assertTagIsSafe (tag, allowUnknownEven) {
+  if (!Number.isSafeInteger(tag) || tag < 0) {
+    throw new Error('field tag must be a non-negative integer, got ' + JSON.stringify(tag))
+  }
+  if (tag === BODY_TAG) {
+    throw new Error('field tag 0 opens the inscription body and cannot carry a field: ' +
+      'anything pushed after it becomes part of the content')
+  }
+  if (tag === CONTENT_TYPE_TAG) {
+    throw new Error('field tag 1 is the content type; pass `contentType` instead of ' +
+      'a field, or the inscription declares it twice')
+  }
+  if (tag % 2 === 0 && KNOWN_TAGS.indexOf(tag) === -1 && !allowUnknownEven) {
+    throw new Error('field tag ' + tag + ' is an unrecognized even tag. The Ordinals ' +
+      'spec requires such an inscription to be treated as unbound — it would be ' +
+      'indexed without a location, permanently, and nothing local would report it. ' +
+      'Use an odd tag, or pass { allowUnknownEvenFields: true } if you have ' +
+      'established that every indexer you care about recognises ' + tag + '.')
+  }
+}
+
+/**
+ * Normalise `params.fields` into ordered [tag, value] pairs.
+ *
+ * Emitted in ascending tag order rather than in whatever order the object was
+ * written, so the same fields always produce the same bytes. Field order is not
+ * significant to a parser before the body opens, but reproducibility is worth
+ * more than honouring insertion order nobody specified.
+ */
+function resolveFields (params) {
+  var fields = params.fields
+  if (fields == null) return []
+  if (typeof fields !== 'object' || Array.isArray(fields) || Buffer.isBuffer(fields)) {
+    throw new Error('fields must be an object of tag numbers to values, e.g. { 5: metadata }')
+  }
+
+  return Object.keys(fields)
+    .filter(function (k) { return fields[k] != null })
+    .map(function (k) {
+      var tag = Number(k)
+      assertTagIsSafe(tag, params.allowUnknownEvenFields)
+      var value = toBuf(fields[k], 'field ' + tag)
+      if (!value.length) {
+        throw new Error('field ' + tag + ' has an empty value; omit the field instead ' +
+          'of inscribing a zero-length one permanently')
+      }
+      return [tag, value]
+    })
+    .sort(function (a, b) { return a[0] - b[0] })
+}
+
 /**
  * Build a 1Sat Ordinals inscription locking script: a base lock followed by the
  * inert `OP_FALSE OP_IF ... OP_ENDIF` envelope carrying the content.
@@ -106,6 +203,12 @@ function resolveLock (params) {
  *   with `address`)
  * @param {Address|string} [params.address]     P2PKH owner (mutually exclusive with `lock`)
  * @param {boolean} [params.allowEmptyLock]     permit an empty base lock; see resolveLock
+ * @param {object} [params.fields]              additional envelope fields as tag numbers
+ *   to values, e.g. `{ 5: manifest, 21: thumbnail }`. Tag 5 is `metadata`, the spec's
+ *   own home for an object's own record. Emitted in ascending tag order, between the
+ *   content type and the body. Unrecognized EVEN tags are refused — see assertTagIsSafe.
+ * @param {boolean} [params.allowUnknownEvenFields] permit an unrecognized even tag.
+ *   Costs the inscription its location in conformant indexers, permanently.
  * @returns {Script} the full inscription locking script
  */
 function buildInscription (params) {
@@ -135,12 +238,21 @@ function buildInscription (params) {
   }
 
   // Clone the base lock so we never mutate the caller's Script.
+  var fields = resolveFields(params)
+
   var s = Script.fromBuffer(lock.toBuffer())
   s.add(Opcode.OP_FALSE)
   s.add(Opcode.OP_IF)
   s.add(ORD)
   s.add(Opcode.OP_1)
   s.add(contentType)
+  // Every field goes here, between the content type and the body. Tag 0 opens
+  // the body and everything after it IS the body, so a field emitted late does
+  // not fail — it silently becomes part of the file.
+  fields.forEach(function (f) {
+    addTag(s, f[0])
+    s.add(f[1])
+  })
   s.add(Opcode.OP_0)
   s.add(content)
   s.add(Opcode.OP_ENDIF)

package/lib/util/jcs.js

@@ -35,6 +35,21 @@ var JCS = {}
  * @returns {String}
  */
 JCS.stringify = function (value) {
+  return serialize(value, [])
+}
+
+/**
+ * `stack` carries the containers currently being serialized, so a cycle throws a
+ * typed error instead of recursing until the call stack is exhausted. That matters
+ * now the function is public API reachable from a verifier: verification input is by
+ * definition untrusted, and a RangeError raised at an arbitrary depth is a worse
+ * failure than a deliberate one. A linear scan beats a Set here because these
+ * structures are shallow and the array avoids the allocation entirely for the common
+ * acyclic case.
+ *
+ * No acyclic input changes behaviour, so nothing already signed is affected.
+ */
+function serialize (value, stack) {
   if (value === null) return 'null'
 
   var type = typeof value
@@ -50,23 +65,38 @@ JCS.stringify = function (value) {
 
   if (type === 'string') return JSON.stringify(value)
 
-  if (Array.isArray(value)) {
-    // Arrays are order-significant. `undefined` has no JSON form and becomes null in an
-    // array, matching JSON.stringify.
-    return '[' + value.map(function (item) {
-      return item === undefined ? 'null' : JCS.stringify(item)
-    }).join(',') + ']'
+  if (type === 'bigint') {
+    // JSON has no bigint form and coercing one would silently canonicalize a
+    // different document than the caller supplied. Carry it as a string.
+    throw new Error('Cannot canonicalize bigint; represent it as a string')
   }
 
-  if (type === 'object') {
-    // Absent and explicitly-undefined are indistinguishable in JSON, so both are dropped.
-    var keys = Object.keys(value).filter(function (key) {
-      return value[key] !== undefined && typeof value[key] !== 'function'
-    }).sort()
+  if (Array.isArray(value) || type === 'object') {
+    if (stack.indexOf(value) !== -1) {
+      throw new Error('Cannot canonicalize a circular structure')
+    }
+    stack.push(value)
+
+    var out
+    if (Array.isArray(value)) {
+      // Arrays are order-significant. `undefined` has no JSON form and becomes null in an
+      // array, matching JSON.stringify.
+      out = '[' + value.map(function (item) {
+        return item === undefined ? 'null' : serialize(item, stack)
+      }).join(',') + ']'
+    } else {
+      // Absent and explicitly-undefined are indistinguishable in JSON, so both are dropped.
+      var keys = Object.keys(value).filter(function (key) {
+        return value[key] !== undefined && typeof value[key] !== 'function'
+      }).sort()
+
+      out = '{' + keys.map(function (key) {
+        return JSON.stringify(key) + ':' + serialize(value[key], stack)
+      }).join(',') + '}'
+    }
 
-    return '{' + keys.map(function (key) {
-      return JSON.stringify(key) + ':' + JCS.stringify(value[key])
-    }).join(',') + '}'
+    stack.pop()
+    return out
   }
 
   throw new Error('Cannot canonicalize value of type: ' + type)

package/ltp-entry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Legal Token Protocol — rights, claims, obligations, and their registry.
+ *
+ * Same class as `require("@smartledger/bsv").LTP`, including its statics.
+ */
+import { LTP } from '@smartledger/bsv';
+export = LTP;