Runestone encoding/decoding

package.json

@@ -22,6 +22,7 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
+    "@sniptt/monads": "^0.5.10",
     "bip86": "^0.0.3",
     "bitcoinjs-lib": "^6.1.5",
     "ecpair": "^2.1.0",

src/constants.ts

@@ -4,3 +4,4 @@ export const MAX_DIVISIBILITY = 38;
 export const MAX_LIMIT = u128(1n << 64n);
 export const RESERVED = u128(6402364363415443603228541259936211926n);
 export const SUBSIDY_HALVING_INTERVAL = 210_000;
+export const MAX_SCRIPT_ELEMENT_SIZE = 520;

src/etching.ts

@@ -1,10 +1,22 @@
+import { None, Option, Some } from '@sniptt/monads';
 import { Mint } from './mint';
 import { Rune } from './rune';
 
-export type Etching = {
-  divisibility: number;
-  mint?: Mint;
-  rune?: Rune;
-  spacers: number;
-  symbol?: string;
-};
+export class Etching {
+  readonly symbol: Option<string>;
+
+  constructor(
+    readonly divisibility: number,
+    readonly rune: Option<Rune>,
+    readonly spacers: number,
+    symbol: Option<string>,
+    readonly mint: Option<Mint>
+  ) {
+    this.symbol = symbol.andThen((value) => {
+      const codePoint = value.codePointAt(0);
+      return codePoint !== undefined
+        ? Some(String.fromCodePoint(codePoint))
+        : None;
+    });
+  }
+}

src/flag.ts

@@ -0,0 +1,23 @@
+import { u128 } from './u128';
+
+export enum Flag {
+  ETCH = 0,
+  MINT = 1,
+  BURN = 127,
+}
+
+export namespace Flag {
+  export function mask(flag: Flag): u128 {
+    return u128(1n << BigInt(flag));
+  }
+
+  export function take(flags: u128, flag: Flag): { set: boolean; flags: u128 } {
+    const mask = Flag.mask(flag);
+    const set = (flags & mask) !== 0n;
+    return { set, flags: u128(flags - (set ? mask : 0n)) };
+  }
+
+  export function set(flags: u128, flag: Flag): u128 {
+    return u128(flags | Flag.mask(flag));
+  }
+}

src/mint.ts

@@ -1,7 +1,8 @@
+import { Option } from '@sniptt/monads';
 import { u128 } from './u128';
 
 export type Mint = {
-  deadline?: number;
-  limit?: u128;
-  term?: number;
+  deadline: Option<number>;
+  limit: Option<u128>;
+  term: Option<number>;
 };

src/runeid.ts

@@ -4,7 +4,7 @@ export class RuneId {
   constructor(readonly height: number, readonly index: number) {}
 
   toU128() {
-    return u128((this.height << 16) | this.index);
+    return u128((BigInt(this.height) << 16n) | BigInt(this.index));
   }
 
   toString() {