@1sat/templates 0.0.22 → 0.0.24

package/dist/index.d.ts

@@ -3,7 +3,13 @@ export type { Signer } from './signer.js';
 export { default as Inscription } from './inscription/inscription.js';
 export { default as BSV20 } from './bsv20/bsv20.js';
 export { default as BSV21 } from './bsv21/bsv21.js';
+export { default as Shrug, SHRUG_TAG_HEX } from './shrug/shrug.js';
+export type { ShrugData } from './shrug/shrug.js';
+export { SHRUG_METADATA_CONTENT_TYPE, decodeShrugMetadata, encodeShrugMetadata, outpointFromBytes, outpointToBytes, } from './shrug/metadata.js';
+export type { ShrugMetadata } from './shrug/metadata.js';
 export { default as OrdLock } from './ordlock/ordlock.js';
+export { default as OpNS, OPNS_CONTRACT_BYTES, OPNS_GENESIS_BYTES, } from './opns/opns.js';
+export type { OpNSData } from './opns/opns.js';
 export { default as Lock } from './lock/lock.js';
 export { default as Cosign } from './cosign/cosign.js';
 export type { CosignData } from './cosign/cosign.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC5D,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGzC,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AACtD,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,wBAAwB,CAAA;AACxD,YAAY,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAGtD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,CAAC,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAGhD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAIzD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAKpD,YAAY,EACX,eAAe,EACf,kBAAkB,GAClB,MAAM,8BAA8B,CAAA;AAKrC,YAAY,EACX,cAAc,EACd,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GACZ,MAAM,kBAAkB,CAAA;AAKzB,YAAY,EACX,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,YAAY,GACZ,MAAM,kBAAkB,CAAA;AAKzB,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAKrE,YAAY,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAKzD,YAAY,EACX,QAAQ,EACR,cAAc,EACd,aAAa,GACb,MAAM,oBAAoB,CAAA;AAK3B,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAK5C,YAAY,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAK7D,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EACN,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,iBAAiB,CAAA;AAKxB,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAKxD,YAAY,EACX,GAAG,EACH,SAAS,EACT,YAAY,EACZ,YAAY,GACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAK1E,OAAO,EACN,iBAAiB,EACjB,cAAc,GACd,MAAM,sBAAsB,CAAA;AAC7B,YAAY,EACX,aAAa,EACb,WAAW,EACX,WAAW,EACX,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,GACd,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC5D,YAAY,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGzC,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAClE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EACN,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,GACf,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EACN,OAAO,IAAI,IAAI,EACf,mBAAmB,EACnB,kBAAkB,GAClB,MAAM,gBAAgB,CAAA;AACvB,YAAY,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AACtD,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,wBAAwB,CAAA;AACxD,YAAY,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAGtD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,CAAC,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAGhD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAIzD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAKpD,YAAY,EACX,eAAe,EACf,kBAAkB,GAClB,MAAM,8BAA8B,CAAA;AAKrC,YAAY,EACX,cAAc,EACd,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GACZ,MAAM,kBAAkB,CAAA;AAKzB,YAAY,EACX,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,YAAY,GACZ,MAAM,kBAAkB,CAAA;AAKzB,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAKrE,YAAY,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAKzD,YAAY,EACX,QAAQ,EACR,cAAc,EACd,aAAa,GACb,MAAM,oBAAoB,CAAA;AAK3B,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAK5C,YAAY,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAK7D,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EACN,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,iBAAiB,CAAA;AAKxB,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAKxD,YAAY,EACX,GAAG,EACH,SAAS,EACT,YAAY,EACZ,YAAY,GACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAK1E,OAAO,EACN,iBAAiB,EACjB,cAAc,GACd,MAAM,sBAAsB,CAAA;AAC7B,YAAY,EACX,aAAa,EACb,WAAW,EACX,WAAW,EACX,aAAa,EACb,cAAc,EACd,YAAY,EACZ,cAAc,GACd,MAAM,sBAAsB,CAAA"}

package/dist/index.js

@@ -4,7 +4,10 @@ export { PrivateKeySigner, WalletSigner } from './signer.js';
 export { default as Inscription } from './inscription/inscription.js';
 export { default as BSV20 } from './bsv20/bsv20.js';
 export { default as BSV21 } from './bsv21/bsv21.js';
+export { default as Shrug, SHRUG_TAG_HEX } from './shrug/shrug.js';
+export { SHRUG_METADATA_CONTENT_TYPE, decodeShrugMetadata, encodeShrugMetadata, outpointFromBytes, outpointToBytes, } from './shrug/metadata.js';
 export { default as OrdLock } from './ordlock/ordlock.js';
+export { default as OpNS, OPNS_CONTRACT_BYTES, OPNS_GENESIS_BYTES, } from './opns/opns.js';
 export { default as Lock } from './lock/lock.js';
 export { default as Cosign } from './cosign/cosign.js';
 export { default as P2MS } from './multisig/multisig.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG5D,mBAAmB;AACnB,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEtD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAGxD,mBAAmB;AACnB,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,CAAC,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAEhD,UAAU;AACV,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEzD,qEAAqE;AACrE,kCAAkC;AAClC,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAqCpD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAMrE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAezD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAM5C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAM7D,OAAO,EACN,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,iBAAiB,CAAA;AAMxB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAWxD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE1E,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAC/E,OAAO,EACN,iBAAiB,EACjB,cAAc,GACd,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG5D,mBAAmB;AACnB,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAElE,OAAO,EACN,2BAA2B,EAC3B,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,GACf,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EACN,OAAO,IAAI,IAAI,EACf,mBAAmB,EACnB,kBAAkB,GAClB,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEtD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAGxD,mBAAmB;AACnB,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,CAAC,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAEhD,UAAU;AACV,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEzD,qEAAqE;AACrE,kCAAkC;AAClC,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAqCpD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAMrE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAezD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAM5C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAM7D,OAAO,EACN,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,iBAAiB,CAAA;AAMxB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAWxD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE1E,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAC/E,OAAO,EACN,iBAAiB,EACjB,cAAc,GACd,MAAM,sBAAsB,CAAA"}

package/dist/opns/opns.d.ts

@@ -0,0 +1,101 @@
+import { Script, type Transaction, UnlockingScript } from '@bsv/sdk';
+/** OpNS covenant contract as a byte array (the compiled sCrypt prefix). */
+export declare const OPNS_CONTRACT_BYTES: any[];
+/** Genesis outpoint bytes embedded in every node's state. */
+export declare const OPNS_GENESIS_BYTES: any[];
+/** Decoded OpNS node state. */
+export interface OpNSData {
+    /** Claimed-character bitfield (little-endian). */
+    claimed: number[];
+    /** The name mined so far. */
+    domain: string;
+    /** Proof-of-work root: sha256d hash the node was mined to. */
+    pow: number[];
+}
+/**
+ * OpNS - Ordinals Name System covenant template.
+ *
+ * A node output locks the compiled covenant plus a stateful OP_RETURN trailer
+ * carrying {genesis, claimed, domain, pow}. Spending it mines one character:
+ * the keyless unlock pushes char + nonce + ownerScript + trailingOutputs +
+ * the BIP-143 preimage (SIGHASH_ALL | ANYONECANPAY | FORKID), and the covenant
+ * validates the three mandated outputs (restated parent, child node, name
+ * inscription) against its own introspected state.
+ *
+ * @example
+ * ```typescript
+ * const node = OpNS.decode(parentTx.outputs[1].lockingScript)
+ * const child = OpNS.lock([0], node.domain + 'h', solutionHash)
+ * ```
+ */
+export default class OpNS {
+    /**
+     * Builds a node locking script: the compiled covenant followed by the
+     * stateful OP_RETURN trailer.
+     *
+     * @param claimed - Claimed-character bitfield (little-endian)
+     * @param domain - The name mined so far
+     * @param pow - The sha256d hash the node was mined to (32 bytes)
+     * @returns The node locking script
+     */
+    static lock(claimed: number[], domain: string, pow: number[]): Script;
+    /**
+     * Decodes a node's state from its locking script.
+     *
+     * @param script - The locking script to decode
+     * @returns Decoded node state, or null if not an OpNS node
+     */
+    static decode(script: Script): OpNSData | null;
+    /**
+     * Sets the bit for a claimed character in the node's bitfield.
+     *
+     * @param claimed - Current claimed bitfield (little-endian)
+     * @param char - Character byte to mark claimed
+     * @returns Updated claimed bitfield
+     */
+    static claimBit(claimed: number[], char: number): number[];
+    /**
+     * Builds the 1Sat ordinal inscription for a mined name, locked to
+     * ownerScript.
+     *
+     * @param domain - The mined name
+     * @param ownerScript - The owner's locking script (prefix)
+     * @returns The inscription locking script
+     */
+    static buildInscription(domain: string, ownerScript: Script): Script;
+    /**
+     * Tests whether a nonce solves the proof-of-work for a character: the
+     * top OPNS_DIFFICULTY bits of the reversed sha256d(pow ‖ char ‖ nonce)
+     * must be zero.
+     *
+     * @param pow - The node's pow root (32 bytes)
+     * @param char - Character byte being mined
+     * @param nonce - Candidate nonce (32 bytes)
+     * @returns The solution hash if valid, otherwise null
+     */
+    static testSolution(pow: number[], char: number, nonce: number[]): number[] | null;
+    /**
+     * Serializes a transaction output (8-byte LE value + varint length +
+     * script) as the covenant expects in trailingOutputs.
+     *
+     * @param satoshis - Output value
+     * @param script - Locking script bytes
+     * @returns Serialized output bytes
+     */
+    static buildOutput(satoshis: number, script: number[]): number[];
+    /**
+     * Builds the keyless covenant unlock for a mined character. The unlock
+     * pushes char, nonce, ownerScript, the serialized trailing outputs (those
+     * beyond the three mandated by the covenant), and the BIP-143 preimage.
+     *
+     * @param char - Character byte being mined
+     * @param nonce - The winning nonce (32 bytes)
+     * @param ownerScript - The owner's locking script for the name
+     * @returns Unlock template with sign and estimateLength methods
+     */
+    static unlock(char: number, nonce: number[], ownerScript: Script): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
+    };
+}
+//# sourceMappingURL=opns.d.ts.map

package/dist/opns/opns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opns.d.ts","sourceRoot":"","sources":["../../src/opns/opns.ts"],"names":[],"mappings":"AACA,OAAO,EAIN,MAAM,EACN,KAAK,WAAW,EAEhB,eAAe,EAEf,MAAM,UAAU,CAAA;AAEjB,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,OAAsC,CAAA;AAEtE,6DAA6D;AAC7D,eAAO,MAAM,kBAAkB,OAAqC,CAAA;AAQpE,+BAA+B;AAC/B,MAAM,WAAW,QAAQ;IACxB,kDAAkD;IAClD,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,8DAA8D;IAC9D,GAAG,EAAE,MAAM,EAAE,CAAA;CACb;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACxB;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM;IAkBrE;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAwB9C;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE;IAY1D;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IAgBpE;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAClB,GAAG,EAAE,MAAM,EAAE,EACb,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,GACb,MAAM,EAAE,GAAG,IAAI;IAelB;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAQhE;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,CACZ,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,WAAW,EAAE,MAAM,GACjB;QACF,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KACxE;CA6DD"}

package/dist/opns/opns.js

@@ -0,0 +1,224 @@
+import { OPNS_CONTRACT, OPNS_DIFFICULTY, OPNS_GENESIS } from '@1sat/types';
+import { BigNumber, Hash, OP, Script, TransactionSignature, UnlockingScript, Utils, } from '@bsv/sdk';
+/** OpNS covenant contract as a byte array (the compiled sCrypt prefix). */
+export const OPNS_CONTRACT_BYTES = Utils.toArray(OPNS_CONTRACT, 'hex');
+/** Genesis outpoint bytes embedded in every node's state. */
+export const OPNS_GENESIS_BYTES = Utils.toArray(OPNS_GENESIS, 'hex');
+/** Ordinal inscription bitcom address for OpNS names. */
+const OPNS_BITCOM = '1opNSUJVbBc2Vf8LFNSoywGGK4jMcGVrC';
+/** OpNS content type. */
+const OPNS_CONTENT_TYPE = 'application/op-ns';
+/**
+ * OpNS - Ordinals Name System covenant template.
+ *
+ * A node output locks the compiled covenant plus a stateful OP_RETURN trailer
+ * carrying {genesis, claimed, domain, pow}. Spending it mines one character:
+ * the keyless unlock pushes char + nonce + ownerScript + trailingOutputs +
+ * the BIP-143 preimage (SIGHASH_ALL | ANYONECANPAY | FORKID), and the covenant
+ * validates the three mandated outputs (restated parent, child node, name
+ * inscription) against its own introspected state.
+ *
+ * @example
+ * ```typescript
+ * const node = OpNS.decode(parentTx.outputs[1].lockingScript)
+ * const child = OpNS.lock([0], node.domain + 'h', solutionHash)
+ * ```
+ */
+export default class OpNS {
+    /**
+     * Builds a node locking script: the compiled covenant followed by the
+     * stateful OP_RETURN trailer.
+     *
+     * @param claimed - Claimed-character bitfield (little-endian)
+     * @param domain - The name mined so far
+     * @param pow - The sha256d hash the node was mined to (32 bytes)
+     * @returns The node locking script
+     */
+    static lock(claimed, domain, pow) {
+        const state = new Script()
+            .writeOpCode(OP.OP_RETURN)
+            .writeOpCode(OP.OP_FALSE)
+            .writeBin(OPNS_GENESIS_BYTES)
+            .writeBin(claimed)
+            .writeBin(Utils.toArray(domain, 'utf8'))
+            .writeBin(pow);
+        const stateBin = state.toBinary();
+        const writer = new Utils.Writer();
+        writer.write(stateBin);
+        writer.writeUInt32LE(stateBin.length - 1);
+        writer.writeUInt8(0);
+        return Script.fromBinary([...OPNS_CONTRACT_BYTES, ...writer.toArray()]);
+    }
+    /**
+     * Decodes a node's state from its locking script.
+     *
+     * @param script - The locking script to decode
+     * @returns Decoded node state, or null if not an OpNS node
+     */
+    static decode(script) {
+        try {
+            const bin = script.toBinary();
+            for (let i = 0; i < OPNS_CONTRACT_BYTES.length; i++) {
+                if (bin[i] !== OPNS_CONTRACT_BYTES[i])
+                    return null;
+            }
+            // State starts after the contract plus OP_RETURN + OP_FALSE.
+            const state = Script.fromBinary(bin.slice(OPNS_CONTRACT_BYTES.length + 2));
+            const genesis = state.chunks[0]?.data;
+            if (genesis == null)
+                return null;
+            for (let i = 0; i < OPNS_GENESIS_BYTES.length; i++) {
+                if (genesis[i] !== OPNS_GENESIS_BYTES[i])
+                    return null;
+            }
+            const domainData = state.chunks[2]?.data ?? [];
+            return {
+                claimed: state.chunks[1]?.data ?? [],
+                domain: Utils.toUTF8(domainData),
+                pow: state.chunks[3]?.data ?? [],
+            };
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Sets the bit for a claimed character in the node's bitfield.
+     *
+     * @param claimed - Current claimed bitfield (little-endian)
+     * @param char - Character byte to mark claimed
+     * @returns Updated claimed bitfield
+     */
+    static claimBit(claimed, char) {
+        let bits = 0n;
+        for (const b of [...claimed].reverse())
+            bits = (bits << 8n) | BigInt(b);
+        bits |= 1n << BigInt(char);
+        const out = [];
+        for (let v = bits; v > 0n; v >>= 8n)
+            out.unshift(Number(v & 0xffn));
+        // Sign guard: keep the value positive when the top byte's MSB is set.
+        if ((out[0] & 0x80) !== 0)
+            out.unshift(0);
+        return out.reverse();
+    }
+    /**
+     * Builds the 1Sat ordinal inscription for a mined name, locked to
+     * ownerScript.
+     *
+     * @param domain - The mined name
+     * @param ownerScript - The owner's locking script (prefix)
+     * @returns The inscription locking script
+     */
+    static buildInscription(domain, ownerScript) {
+        return new Script()
+            .writeScript(ownerScript)
+            .writeOpCode(OP.OP_FALSE)
+            .writeOpCode(OP.OP_IF)
+            .writeBin(Utils.toArray('ord', 'utf8'))
+            .writeOpCode(OP.OP_1)
+            .writeBin(Utils.toArray(OPNS_CONTENT_TYPE, 'utf8'))
+            .writeOpCode(OP.OP_0)
+            .writeBin(Utils.toArray(domain, 'utf8'))
+            .writeOpCode(OP.OP_ENDIF)
+            .writeOpCode(OP.OP_RETURN)
+            .writeBin(Utils.toArray(OPNS_BITCOM, 'utf8'))
+            .writeBin(OPNS_GENESIS_BYTES);
+    }
+    /**
+     * Tests whether a nonce solves the proof-of-work for a character: the
+     * top OPNS_DIFFICULTY bits of the reversed sha256d(pow ‖ char ‖ nonce)
+     * must be zero.
+     *
+     * @param pow - The node's pow root (32 bytes)
+     * @param char - Character byte being mined
+     * @param nonce - Candidate nonce (32 bytes)
+     * @returns The solution hash if valid, otherwise null
+     */
+    static testSolution(pow, char, nonce) {
+        const preimage = [...pow, char, ...nonce];
+        const hash = Hash.sha256(Hash.sha256(preimage));
+        const fullBytes = Math.floor(OPNS_DIFFICULTY / 8);
+        for (let i = 0; i < fullBytes; i++) {
+            if (hash[31 - i] !== 0)
+                return null;
+        }
+        const rem = OPNS_DIFFICULTY % 8;
+        if (rem > 0) {
+            const mask = (0xff << (8 - rem)) & 0xff;
+            if ((hash[31 - fullBytes] & mask) !== 0)
+                return null;
+        }
+        return hash;
+    }
+    /**
+     * Serializes a transaction output (8-byte LE value + varint length +
+     * script) as the covenant expects in trailingOutputs.
+     *
+     * @param satoshis - Output value
+     * @param script - Locking script bytes
+     * @returns Serialized output bytes
+     */
+    static buildOutput(satoshis, script) {
+        const writer = new Utils.Writer();
+        writer.writeUInt64LEBn(new BigNumber(satoshis));
+        writer.writeVarIntNum(script.length);
+        writer.write(script);
+        return writer.toArray();
+    }
+    /**
+     * Builds the keyless covenant unlock for a mined character. The unlock
+     * pushes char, nonce, ownerScript, the serialized trailing outputs (those
+     * beyond the three mandated by the covenant), and the BIP-143 preimage.
+     *
+     * @param char - Character byte being mined
+     * @param nonce - The winning nonce (32 bytes)
+     * @param ownerScript - The owner's locking script for the name
+     * @returns Unlock template with sign and estimateLength methods
+     */
+    static unlock(char, nonce, ownerScript) {
+        return {
+            sign: async (tx, inputIndex) => {
+                const input = tx.inputs[inputIndex];
+                const sourceTXID = input.sourceTXID ?? input.sourceTransaction?.id('hex');
+                if (!sourceTXID) {
+                    throw new Error('The input sourceTXID or sourceTransaction is required for signing.');
+                }
+                const sourceOutput = input.sourceTransaction?.outputs[input.sourceOutputIndex];
+                if (!sourceOutput?.satoshis || !sourceOutput.lockingScript) {
+                    throw new Error('The input sourceTransaction is required for signing the covenant.');
+                }
+                const preimage = TransactionSignature.format({
+                    sourceTXID,
+                    sourceOutputIndex: input.sourceOutputIndex,
+                    sourceSatoshis: sourceOutput.satoshis,
+                    transactionVersion: tx.version,
+                    otherInputs: [],
+                    inputIndex,
+                    outputs: tx.outputs,
+                    inputSequence: input.sequence ?? 0xffffffff,
+                    subscript: sourceOutput.lockingScript,
+                    lockTime: tx.lockTime,
+                    scope: TransactionSignature.SIGHASH_ALL |
+                        TransactionSignature.SIGHASH_ANYONECANPAY |
+                        TransactionSignature.SIGHASH_FORKID,
+                });
+                // Trailing outputs are those beyond the three the covenant mandates.
+                const trailing = [];
+                for (const out of tx.outputs.slice(3)) {
+                    trailing.push(...OpNS.buildOutput(out.satoshis ?? 0, (out.lockingScript ?? new Script()).toBinary()));
+                }
+                return new UnlockingScript()
+                    .writeBin([char])
+                    .writeBin(nonce)
+                    .writeBin(ownerScript.toBinary())
+                    .writeBin(trailing)
+                    .writeBin(preimage);
+            },
+            estimateLength: async (tx, inputIndex) => {
+                return (await OpNS.unlock(char, nonce, ownerScript).sign(tx, inputIndex)).toBinary().length;
+            },
+        };
+    }
+}
+//# sourceMappingURL=opns.js.map

package/dist/opns/opns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opns.js","sourceRoot":"","sources":["../../src/opns/opns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1E,OAAO,EACN,SAAS,EACT,IAAI,EACJ,EAAE,EACF,MAAM,EAEN,oBAAoB,EACpB,eAAe,EACf,KAAK,GACL,MAAM,UAAU,CAAA;AAEjB,2EAA2E;AAC3E,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;AAEtE,6DAA6D;AAC7D,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;AAEpE,yDAAyD;AACzD,MAAM,WAAW,GAAG,mCAAmC,CAAA;AAEvD,yBAAyB;AACzB,MAAM,iBAAiB,GAAG,mBAAmB,CAAA;AAY7C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACxB;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,OAAiB,EAAE,MAAc,EAAE,GAAa;QAC3D,MAAM,KAAK,GAAG,IAAI,MAAM,EAAE;aACxB,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC;aACzB,WAAW,CAAC,EAAE,CAAC,QAAQ,CAAC;aACxB,QAAQ,CAAC,kBAAkB,CAAC;aAC5B,QAAQ,CAAC,OAAO,CAAC;aACjB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;aACvC,QAAQ,CAAC,GAAG,CAAC,CAAA;QACf,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;QAEjC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAA;QACjC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACtB,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACzC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QAEpB,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,mBAAmB,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;IACxE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAc;QAC3B,IAAI,CAAC;YACJ,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACrD,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,CAAC,CAAC;oBAAE,OAAO,IAAI,CAAA;YACnD,CAAC;YACD,6DAA6D;YAC7D,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;YAC1E,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAA;YACrC,IAAI,OAAO,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAA;YAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpD,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,kBAAkB,CAAC,CAAC,CAAC;oBAAE,OAAO,IAAI,CAAA;YACtD,CAAC;YACD,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,CAAA;YAC9C,OAAO;gBACN,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE;gBACpC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;gBAChC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE;aAChC,CAAA;QACF,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAiB,EAAE,IAAY;QAC9C,IAAI,IAAI,GAAG,EAAE,CAAA;QACb,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,OAAO,EAAE;YAAE,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACvE,IAAI,IAAI,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,CAAA;QAE1B,MAAM,GAAG,GAAa,EAAE,CAAA;QACxB,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,EAAE;YAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;QACnE,sEAAsE;QACtE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;YAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QACzC,OAAO,GAAG,CAAC,OAAO,EAAE,CAAA;IACrB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAc,EAAE,WAAmB;QAC1D,OAAO,IAAI,MAAM,EAAE;aACjB,WAAW,CAAC,WAAW,CAAC;aACxB,WAAW,CAAC,EAAE,CAAC,QAAQ,CAAC;aACxB,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC;aACrB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;aACtC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC;aACpB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;aAClD,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC;aACpB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;aACvC,WAAW,CAAC,EAAE,CAAC,QAAQ,CAAC;aACxB,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC;aACzB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;aAC5C,QAAQ,CAAC,kBAAkB,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAClB,GAAa,EACb,IAAY,EACZ,KAAe;QAEf,MAAM,QAAQ,GAAG,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,CAAA;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,CAAC,CAAC,CAAA;QACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAA;QACpC,CAAC;QACD,MAAM,GAAG,GAAG,eAAe,GAAG,CAAC,CAAA;QAC/B,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAA;YACvC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAA;QACrD,CAAC;QACD,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,MAAgB;QACpD,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAA;QACjC,MAAM,CAAC,eAAe,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC/C,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACpC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACpB,OAAO,MAAM,CAAC,OAAO,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,CACZ,IAAY,EACZ,KAAe,EACf,WAAmB;QAKnB,OAAO;YACN,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBACnD,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBACnC,MAAM,UAAU,GACf,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;gBACvD,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CACd,oEAAoE,CACpE,CAAA;gBACF,CAAC;gBACD,MAAM,YAAY,GACjB,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;gBAC1D,IAAI,CAAC,YAAY,EAAE,QAAQ,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;oBAC5D,MAAM,IAAI,KAAK,CACd,mEAAmE,CACnE,CAAA;gBACF,CAAC;gBAED,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC5C,UAAU;oBACV,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;oBAC1C,cAAc,EAAE,YAAY,CAAC,QAAQ;oBACrC,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW,EAAE,EAAE;oBACf,UAAU;oBACV,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,aAAa,EAAE,KAAK,CAAC,QAAQ,IAAI,UAAU;oBAC3C,SAAS,EAAE,YAAY,CAAC,aAAa;oBACrC,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EACJ,oBAAoB,CAAC,WAAW;wBAChC,oBAAoB,CAAC,oBAAoB;wBACzC,oBAAoB,CAAC,cAAc;iBACpC,CAAC,CAAA;gBAEF,qEAAqE;gBACrE,MAAM,QAAQ,GAAa,EAAE,CAAA;gBAC7B,KAAK,MAAM,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvC,QAAQ,CAAC,IAAI,CACZ,GAAG,IAAI,CAAC,WAAW,CAClB,GAAG,CAAC,QAAQ,IAAI,CAAC,EACjB,CAAC,GAAG,CAAC,aAAa,IAAI,IAAI,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAC9C,CACD,CAAA;gBACF,CAAC;gBAED,OAAO,IAAI,eAAe,EAAE;qBAC1B,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;qBAChB,QAAQ,CAAC,KAAK,CAAC;qBACf,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;qBAChC,QAAQ,CAAC,QAAQ,CAAC;qBAClB,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACrB,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBAC7D,OAAO,CACN,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAChE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAA;YACpB,CAAC;SACD,CAAA;IACF,CAAC;CACD"}

package/dist/shrug/metadata.d.ts

@@ -0,0 +1,29 @@
+/** Inscription content type for shrug token display metadata */
+export declare const SHRUG_METADATA_CONTENT_TYPE = "application/shrug+cbor";
+/**
+ * Display metadata carried by an inscription on a token's deploy output.
+ * All fields are optional.
+ */
+export interface ShrugMetadata {
+    /** Token symbol. Uniqueness is not enforced */
+    sym?: string;
+    /** Icon outpoint as `txid_vout` */
+    icon?: string;
+    /** Decimal precision 0-18, default 0 */
+    dec?: number;
+}
+/** Convert a `txid_vout` outpoint string to its 36-byte wire encoding */
+export declare function outpointToBytes(outpoint: string): number[] | null;
+/** Convert a 36-byte wire outpoint to its `txid_vout` string form */
+export declare function outpointFromBytes(bytes: number[]): string | null;
+/**
+ * Encode shrug metadata as a deterministic CBOR map (RFC 8949 §4.2).
+ * The icon is encoded as a 36-byte byte string.
+ */
+export declare function encodeShrugMetadata(meta: ShrugMetadata): number[];
+/**
+ * Decode a shrug metadata document. Unknown map keys are ignored.
+ * Returns null when the document is not a valid metadata map.
+ */
+export declare function decodeShrugMetadata(content: number[] | Uint8Array): ShrugMetadata | null;
+//# sourceMappingURL=metadata.d.ts.map

package/dist/shrug/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/shrug/metadata.ts"],"names":[],"mappings":"AAIA,gEAAgE;AAChE,eAAO,MAAM,2BAA2B,2BAA2B,CAAA;AAEnE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,yEAAyE;AACzE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAgBjE;AAED,qEAAqE;AACrE,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAMhE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,EAAE,CAmBjE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAClC,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,GAC5B,aAAa,GAAG,IAAI,CAsDtB"}

package/dist/shrug/metadata.js

@@ -0,0 +1,106 @@
+import { Utils } from '@bsv/sdk';
+import { decode as cborDecode, encode as cborEncode } from 'cbor2';
+import { sortCoreDeterministic } from 'cbor2/sorts';
+/** Inscription content type for shrug token display metadata */
+export const SHRUG_METADATA_CONTENT_TYPE = 'application/shrug+cbor';
+/** Convert a `txid_vout` outpoint string to its 36-byte wire encoding */
+export function outpointToBytes(outpoint) {
+    if (outpoint.charAt(64) !== '_')
+        return null;
+    const txid = outpoint.slice(0, 64);
+    if (!/^[0-9a-fA-F]{64}$/.test(txid))
+        return null;
+    const vout = Number(outpoint.slice(65));
+    if (!Number.isInteger(vout) || vout < 0 || vout > 0xffffffff) {
+        return null;
+    }
+    const bytes = Utils.toArray(txid, 'hex').reverse();
+    bytes.push(vout & 0xff, (vout >>> 8) & 0xff, (vout >>> 16) & 0xff, (vout >>> 24) & 0xff);
+    return bytes;
+}
+/** Convert a 36-byte wire outpoint to its `txid_vout` string form */
+export function outpointFromBytes(bytes) {
+    if (bytes.length !== 36)
+        return null;
+    const txid = Utils.toHex(bytes.slice(0, 32).reverse());
+    const vout = (bytes[32] | (bytes[33] << 8) | (bytes[34] << 16) | (bytes[35] << 24)) >>> 0;
+    return `${txid}_${vout}`;
+}
+/**
+ * Encode shrug metadata as a deterministic CBOR map (RFC 8949 §4.2).
+ * The icon is encoded as a 36-byte byte string.
+ */
+export function encodeShrugMetadata(meta) {
+    const wire = {};
+    if (meta.sym !== undefined) {
+        wire.sym = meta.sym;
+    }
+    if (meta.dec !== undefined) {
+        if (!Number.isInteger(meta.dec) || meta.dec < 0 || meta.dec > 18) {
+            throw new Error(`dec ${meta.dec} out of range 0-18`);
+        }
+        wire.dec = meta.dec;
+    }
+    if (meta.icon !== undefined) {
+        const bytes = outpointToBytes(meta.icon);
+        if (!bytes) {
+            throw new Error(`invalid icon outpoint: ${meta.icon}`);
+        }
+        wire.icon = new Uint8Array(bytes);
+    }
+    return Array.from(cborEncode(wire, { sortKeys: sortCoreDeterministic }));
+}
+/**
+ * Decode a shrug metadata document. Unknown map keys are ignored.
+ * Returns null when the document is not a valid metadata map.
+ */
+export function decodeShrugMetadata(content) {
+    let value;
+    try {
+        value = cborDecode(content instanceof Uint8Array ? content : new Uint8Array(content));
+    }
+    catch {
+        return null;
+    }
+    let get;
+    if (value instanceof Map) {
+        get = (key) => value.get(key);
+    }
+    else if (typeof value === 'object' &&
+        value !== null &&
+        !Array.isArray(value)) {
+        get = (key) => value[key];
+    }
+    else {
+        return null;
+    }
+    const meta = {};
+    const sym = get('sym');
+    if (sym !== undefined) {
+        if (typeof sym !== 'string')
+            return null;
+        meta.sym = sym;
+    }
+    const dec = get('dec');
+    if (dec !== undefined) {
+        const num = typeof dec === 'bigint' ? Number(dec) : dec;
+        if (typeof num !== 'number' ||
+            !Number.isInteger(num) ||
+            num < 0 ||
+            num > 18) {
+            return null;
+        }
+        meta.dec = num;
+    }
+    const icon = get('icon');
+    if (icon !== undefined) {
+        if (!(icon instanceof Uint8Array))
+            return null;
+        const outpoint = outpointFromBytes(Array.from(icon));
+        if (!outpoint)
+            return null;
+        meta.icon = outpoint;
+    }
+    return meta;
+}
+//# sourceMappingURL=metadata.js.map

package/dist/shrug/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/shrug/metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAChC,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,OAAO,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEnD,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG,wBAAwB,CAAA;AAenE,yEAAyE;AACzE,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC/C,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG;QAAE,OAAO,IAAI,CAAA;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAClC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;IACvC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,UAAU,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAA;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;IAClD,KAAK,CAAC,IAAI,CACT,IAAI,GAAG,IAAI,EACX,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,IAAI,EACnB,CAAC,IAAI,KAAK,EAAE,CAAC,GAAG,IAAI,EACpB,CAAC,IAAI,KAAK,EAAE,CAAC,GAAG,IAAI,CACpB,CAAA;IACD,OAAO,KAAK,CAAA;AACb,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,iBAAiB,CAAC,KAAe;IAChD,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE;QAAE,OAAO,IAAI,CAAA;IACpC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IACtD,MAAM,IAAI,GACT,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;IAC7E,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;AACzB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAmB;IACtD,MAAM,IAAI,GAA4B,EAAE,CAAA;IACxC,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;IACpB,CAAC;IACD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,GAAG,oBAAoB,CAAC,CAAA;QACrD,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;IACpB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QACvD,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAA;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAClC,OAA8B;IAE9B,IAAI,KAAc,CAAA;IAClB,IAAI,CAAC;QACJ,KAAK,GAAG,UAAU,CACjB,OAAO,YAAY,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,CACjE,CAAA;IACF,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,IAAI,GAA6B,CAAA;IACjC,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;QAC1B,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;SAAM,IACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EACpB,CAAC;QACF,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAE,KAAiC,CAAC,GAAG,CAAC,CAAA;IACvD,CAAC;SAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,MAAM,IAAI,GAAkB,EAAE,CAAA;IAE9B,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAA;IACtB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAA;QACxC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IACf,CAAC;IAED,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAA;IACtB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QACvD,IACC,OAAO,GAAG,KAAK,QAAQ;YACvB,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;YACtB,GAAG,GAAG,CAAC;YACP,GAAG,GAAG,EAAE,EACP,CAAC;YACF,OAAO,IAAI,CAAA;QACZ,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAA;IACxB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC;YAAE,OAAO,IAAI,CAAA;QAC9C,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAA;IACrB,CAAC;IAED,OAAO,IAAI,CAAA;AACZ,CAAC"}

package/dist/shrug/shrug.d.ts

@@ -0,0 +1,52 @@
+import { LockingScript, Script } from '@bsv/sdk';
+import Inscription from '../inscription/inscription.js';
+import { type ShrugMetadata } from './metadata.js';
+/** The 13-byte UTF-8 shrug tag ¯\_(ツ)_/¯ */
+export declare const SHRUG_TAG_HEX = "c2af5c5f28e38384295f2fc2af";
+/**
+ * Decoded shrug token output.
+ *
+ * Wire format:
+ * `<push tag> <push 36-byte id | OP_0> OP_2DROP <push amount | OP_0> OP_DROP <owner script>`
+ */
+export interface ShrugData {
+    /** Token id `txid_vout`; absent on deploy outputs (the id is the output's own outpoint) */
+    id?: string;
+    /** 0n = mint authority, >0n = token value; arbitrary precision */
+    amount: bigint;
+    /** Script following the prefix (owner script, possibly with an inscription envelope) */
+    scriptSuffix: number[];
+    /** Inscription found in the suffix, if any */
+    insc?: Inscription;
+    /** Populated when the suffix inscription carries application/shrug+cbor */
+    metadata?: ShrugMetadata;
+}
+/**
+ * Shrug token template: a binary evolution of BSV-21 encoding token data as
+ * a stack-neutral prefix of raw pushes at the front of the locking script.
+ */
+export default class Shrug {
+    /** Token id `txid_vout`; omit for deploy outputs */
+    readonly id?: string;
+    /** 0n = mint authority, >0n = token value */
+    readonly amount: bigint;
+    constructor(token?: {
+        id?: string;
+        amount?: bigint;
+    });
+    /**
+     * Decode a shrug output from a locking script.
+     *
+     * Runs the inscription decoder on the script suffix; an
+     * application/shrug+cbor inscription populates `metadata`. Malformed
+     * metadata does not invalidate the token output.
+     */
+    static decode(script: Script): ShrugData | null;
+    /**
+     * Build a shrug locking script.
+     *
+     * @param suffix - owner locking script, optionally preceded by an inscription envelope
+     */
+    lock(suffix?: Script | LockingScript): LockingScript;
+}
+//# sourceMappingURL=shrug.d.ts.map

package/dist/shrug/shrug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shrug.d.ts","sourceRoot":"","sources":["../../src/shrug/shrug.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAM,MAAM,EAAS,MAAM,UAAU,CAAA;AAC3D,OAAO,WAAW,MAAM,+BAA+B,CAAA;AACvD,OAAO,EAEN,KAAK,aAAa,EAIlB,MAAM,eAAe,CAAA;AAEtB,4CAA4C;AAC5C,eAAO,MAAM,aAAa,+BAA+B,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACzB,2FAA2F;IAC3F,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAA;IACd,wFAAwF;IACxF,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,aAAa,CAAA;CACxB;AAkCD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACzB,oDAAoD;IACpD,SAAgB,EAAE,CAAC,EAAE,MAAM,CAAA;IAC3B,6CAA6C;IAC7C,SAAgB,MAAM,EAAE,MAAM,CAAA;gBAElB,KAAK,GAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO;IAQxD;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IA0C/C;;;;OAIG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,aAAa;CAmCpD"}

package/dist/shrug/shrug.js

@@ -0,0 +1,137 @@
+import { LockingScript, OP, Script, Utils } from '@bsv/sdk';
+import Inscription from '../inscription/inscription.js';
+import { SHRUG_METADATA_CONTENT_TYPE, decodeShrugMetadata, outpointFromBytes, outpointToBytes, } from './metadata.js';
+/** The 13-byte UTF-8 shrug tag ¯\_(ツ)_/¯ */
+export const SHRUG_TAG_HEX = 'c2af5c5f28e38384295f2fc2af';
+/** Encode a non-negative bigint as a minimal Bitcoin script number (little-endian) */
+function encodeScriptNum(n) {
+    const bytes = [];
+    let v = n;
+    while (v > 0n) {
+        bytes.push(Number(v & 0xffn));
+        v >>= 8n;
+    }
+    if (bytes.length > 0 && (bytes[bytes.length - 1] & 0x80) !== 0) {
+        bytes.push(0x00);
+    }
+    return bytes;
+}
+/** Decode a minimal Bitcoin script number. Returns null for non-minimal encodings */
+function decodeScriptNum(data) {
+    if (data.length === 0)
+        return 0n;
+    const last = data[data.length - 1];
+    if ((last & 0x7f) === 0 &&
+        (data.length === 1 || (data[data.length - 2] & 0x80) === 0)) {
+        return null;
+    }
+    let v = 0n;
+    for (let i = data.length - 1; i >= 0; i--) {
+        const byte = i === data.length - 1 ? data[i] & 0x7f : data[i];
+        v = (v << 8n) | BigInt(byte);
+    }
+    return (last & 0x80) !== 0 ? -v : v;
+}
+/**
+ * Shrug token template: a binary evolution of BSV-21 encoding token data as
+ * a stack-neutral prefix of raw pushes at the front of the locking script.
+ */
+export default class Shrug {
+    /** Token id `txid_vout`; omit for deploy outputs */
+    id;
+    /** 0n = mint authority, >0n = token value */
+    amount;
+    constructor(token = {}) {
+        if (token.amount !== undefined && token.amount < 0n) {
+            throw new Error('amount must be non-negative');
+        }
+        this.id = token.id;
+        this.amount = token.amount ?? 0n;
+    }
+    /**
+     * Decode a shrug output from a locking script.
+     *
+     * Runs the inscription decoder on the script suffix; an
+     * application/shrug+cbor inscription populates `metadata`. Malformed
+     * metadata does not invalidate the token output.
+     */
+    static decode(script) {
+        const chunks = script.chunks;
+        if (chunks.length < 5)
+            return null;
+        const [tag, idChunk, twoDrop, amountChunk, drop] = chunks;
+        if (!tag.data || Utils.toHex(tag.data) !== SHRUG_TAG_HEX)
+            return null;
+        let id;
+        if (idChunk.op > OP.OP_PUSHDATA4)
+            return null;
+        if (idChunk.data && idChunk.data.length === 36) {
+            id = outpointFromBytes(idChunk.data) ?? undefined;
+            if (!id)
+                return null;
+        }
+        else if (idChunk.data && idChunk.data.length !== 0) {
+            return null;
+        }
+        if (twoDrop.op !== OP.OP_2DROP)
+            return null;
+        if (amountChunk.op > OP.OP_PUSHDATA4)
+            return null;
+        const amount = decodeScriptNum(amountChunk.data ?? []);
+        if (amount === null || amount < 0n)
+            return null;
+        if (drop.op !== OP.OP_DROP)
+            return null;
+        const suffix = new Script(chunks.slice(5));
+        const data = {
+            id,
+            amount,
+            scriptSuffix: suffix.toBinary(),
+        };
+        const insc = Inscription.decode(suffix);
+        if (insc) {
+            data.insc = insc;
+            if (insc.file.type === SHRUG_METADATA_CONTENT_TYPE) {
+                data.metadata = decodeShrugMetadata(insc.file.content) ?? undefined;
+            }
+        }
+        return data;
+    }
+    /**
+     * Build a shrug locking script.
+     *
+     * @param suffix - owner locking script, optionally preceded by an inscription envelope
+     */
+    lock(suffix) {
+        const chunks = [
+            { op: 13, data: Utils.toArray(SHRUG_TAG_HEX, 'hex') },
+        ];
+        if (this.id !== undefined) {
+            const idBytes = outpointToBytes(this.id);
+            if (!idBytes) {
+                throw new Error(`invalid token id outpoint: ${this.id}`);
+            }
+            chunks.push({ op: 36, data: idBytes });
+        }
+        else {
+            chunks.push({ op: OP.OP_0 });
+        }
+        chunks.push({ op: OP.OP_2DROP });
+        if (this.amount > 0n) {
+            const amountBytes = encodeScriptNum(this.amount);
+            chunks.push({
+                op: amountBytes.length <= 75 ? amountBytes.length : OP.OP_PUSHDATA1,
+                data: amountBytes,
+            });
+        }
+        else {
+            chunks.push({ op: OP.OP_0 });
+        }
+        chunks.push({ op: OP.OP_DROP });
+        if (suffix) {
+            chunks.push(...suffix.chunks);
+        }
+        return new LockingScript(chunks);
+    }
+}
+//# sourceMappingURL=shrug.js.map

package/dist/shrug/shrug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shrug.js","sourceRoot":"","sources":["../../src/shrug/shrug.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAC3D,OAAO,WAAW,MAAM,+BAA+B,CAAA;AACvD,OAAO,EACN,2BAA2B,EAE3B,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,GACf,MAAM,eAAe,CAAA;AAEtB,4CAA4C;AAC5C,MAAM,CAAC,MAAM,aAAa,GAAG,4BAA4B,CAAA;AAqBzD,sFAAsF;AACtF,SAAS,eAAe,CAAC,CAAS;IACjC,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,IAAI,CAAC,GAAG,CAAC,CAAA;IACT,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;QAC7B,CAAC,KAAK,EAAE,CAAA;IACT,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACjB,CAAC;IACD,OAAO,KAAK,CAAA;AACb,CAAC;AAED,qFAAqF;AACrF,SAAS,eAAe,CAAC,IAAc;IACtC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAChC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAClC,IACC,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAC1D,CAAC;QACF,OAAO,IAAI,CAAA;IACZ,CAAC;IACD,IAAI,CAAC,GAAG,EAAE,CAAA;IACV,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC7D,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACzB,oDAAoD;IACpC,EAAE,CAAS;IAC3B,6CAA6C;IAC7B,MAAM,CAAQ;IAE9B,YAAY,QAA0C,EAAE;QACvD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,EAAE,CAAA;IACjC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAc;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,IAAI,CAAA;QAClC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,MAAM,CAAA;QAEzD,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,aAAa;YAAE,OAAO,IAAI,CAAA;QAErE,IAAI,EAAsB,CAAA;QAC1B,IAAI,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,YAAY;YAAE,OAAO,IAAI,CAAA;QAC7C,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAChD,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,SAAS,CAAA;YACjD,IAAI,CAAC,EAAE;gBAAE,OAAO,IAAI,CAAA;QACrB,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtD,OAAO,IAAI,CAAA;QACZ,CAAC;QAED,IAAI,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAE3C,IAAI,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,YAAY;YAAE,OAAO,IAAI,CAAA;QACjD,MAAM,MAAM,GAAG,eAAe,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;QACtD,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,GAAG,EAAE;YAAE,OAAO,IAAI,CAAA;QAE/C,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO;YAAE,OAAO,IAAI,CAAA;QAEvC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1C,MAAM,IAAI,GAAc;YACvB,EAAE;YACF,MAAM;YACN,YAAY,EAAE,MAAM,CAAC,QAAQ,EAAE;SAC/B,CAAA;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACvC,IAAI,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,2BAA2B,EAAE,CAAC;gBACpD,IAAI,CAAC,QAAQ,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,SAAS,CAAA;YACpE,CAAC;QACF,CAAC;QAED,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,MAA+B;QACnC,MAAM,MAAM,GAAsC;YACjD,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE;SACrD,CAAA;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACxC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;YACzD,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QACvC,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;QAC7B,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEhC,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACtB,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAChD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,WAAW,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY;gBACnE,IAAI,EAAE,WAAW;aACjB,CAAC,CAAA;QACH,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;QAC7B,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QAE/B,IAAI,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;QAC9B,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;CACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1sat/templates",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "Bitcoin script templates for 1Sat Ordinals SDK",
   "type": "module",
   "main": "./dist/index.js",
@@ -32,7 +32,8 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@1sat/types": "0.0.30"
+    "@1sat/types": "0.0.33",
+    "cbor2": "^2.3.0"
   },
   "peerDependencies": {
     "@bsv/sdk": "^2.0.13"