@vbyte/btc-dev 1.1.0 → 1.1.2

package/dist/types/meta.d.ts

@@ -2,10 +2,10 @@ import type { WitnessType, WitnessVersion } from './witness.js';
 export type LocktimeData = LocktimeStamp | LocktimeHeight;
 export type SequenceConfig = Partial<SequenceData>;
 export type SequenceData = SequenceHeightLock | SequenceStampLock;
-export type TxOutputType = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn';
+export type TxOutputType = 'p2pkh' | 'p2sh' | 'p2w-pkh' | 'p2w-sh' | 'p2tr' | 'opreturn';
 export interface TxOutputInfo {
-    type: TxOutputType;
-    version: WitnessVersion;
+    type: TxOutputType | null;
+    version: WitnessVersion | null;
 }
 export interface TxInputInfo {
     type: WitnessType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbyte/btc-dev",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Batteries-included toolset for plebian bitcoin development",
   "type": "module",
   "keywords": [

package/src/lib/meta/locktime.ts

@@ -5,7 +5,7 @@ import type { LocktimeData } from '@/types/index.js'
 // The threshold between block height and timestamp.
 const LOCKTIME_THRESHOLD = 500000000
 
-export namespace LocktimeUtil {
+export namespace LocktimeField {
   export const encode = encode_locktime
   export const decode = decode_locktime
 }

package/src/lib/meta/ref.ts

@@ -1,4 +1,4 @@
-export namespace RefEncoder {
+export namespace RefPointer {
   export const outpoint = {
     encode : encode_outpoint,
     decode : decode_outpoint,

package/src/lib/meta/scribe.ts

@@ -1,7 +1,7 @@
-import { Buff, Stream }  from '@vbyte/buff'
-import { Assert }        from '@vbyte/micro-lib'
-import { encode_script } from '@/lib/script/encode.js'
-import { decode_script } from '@/lib/script/decode.js'
+import { Buff, Bytes, Stream } from '@vbyte/buff'
+import { Assert }              from '@vbyte/micro-lib'
+import { encode_script }       from '@/lib/script/encode.js'
+import { decode_script }       from '@/lib/script/decode.js'
 
 import type { InscriptionData } from '@/types/index.js'
 
@@ -9,23 +9,24 @@ const _0n  = BigInt(0)
 const _1n  = BigInt(1)
 const _26n = BigInt(26)
 
-export namespace ScribeEncoder {
+export namespace InscriptionUtil {
+  export type Type    = InscriptionData
   export const encode = encode_inscription
   export const decode = decode_inscription
 }
 
 export function decode_inscription (
-  script : string
+  script : Bytes
 ) : InscriptionData[] {
   const envelopes = parse_envelopes(script)
   return envelopes.map(parse_record)
 }
 
-export function encode_inscription (data : InscriptionData[]) : string {
-  return data.map(create_envelope).join('')
+export function encode_inscription (data : InscriptionData[]) : Buff {
+  return Buff.join(data.map(create_envelope))
 }
 
-function create_envelope (data : InscriptionData) : string {
+function create_envelope (data : InscriptionData) : Buff {
   let asm : string[] = [ 'OP_0', 'OP_IF', '6f7264' ]
 
   if (typeof data.delegate === 'string') {
@@ -73,7 +74,7 @@ function create_envelope (data : InscriptionData) : string {
 }
 
 function parse_envelopes (
-  script : string
+  script : Bytes
 ) : string[][] {
 
   const words     = decode_script(script)
@@ -98,7 +99,7 @@ function parse_envelopes (
   return envelopes
 }
 
-function parse_record (envelope : string[]) {
+function parse_record (envelope : Bytes[]) {
   const record : InscriptionData = {}
 
   for (let i = 0; i < envelope.length; i++) {
@@ -124,7 +125,7 @@ function parse_record (envelope : string[]) {
         i += 1
         break
       case 'OP_WITHIN':
-        record.ref = envelope[i+1]
+        record.ref = decode_bytes(envelope[i+1])
         i += 1
         break;
       case 'OP_NOP':
@@ -139,6 +140,10 @@ function parse_record (envelope : string[]) {
   return record
 }
 
+function decode_bytes (bytes : Bytes) : string {
+  return Buff.bytes(bytes).hex
+}
+
 function encode_id (
   identifier : string
 ) : string {
@@ -151,9 +156,9 @@ function encode_id (
 }
 
 function decode_id (
-  hexstr : string
+  identifier : Bytes
 ) : string {
-  const bytes = Buff.hex(hexstr)
+  const bytes = Buff.bytes(identifier)
   const idx   = bytes.at(-1) ?? 0
   const txid  = bytes.slice(0, -1).reverse().hex
   return txid + 'i' + String(idx)
@@ -166,9 +171,9 @@ function encode_pointer (
 }
 
 function decode_pointer (
-  hexstr : string
+  bytes : Bytes
 ) : number {
-  return Buff.hex(hexstr).reverse().num
+  return Buff.bytes(bytes).reverse().num
 }
 
 function encode_label (
@@ -178,9 +183,9 @@ function encode_label (
 }
 
 function decode_label (
-  hexstr : string
+  label : Bytes
 ) : string {
-  return Buff.hex(hexstr).str
+  return Buff.bytes(label).str
 }
 
 function encode_content (
@@ -204,11 +209,11 @@ function encode_content (
 }
 
 function decode_content (
-  hexstrs : string[],
-  type    : 'hex' | 'utf8' = 'hex'
+  chunks : Bytes[],
+  format : 'hex' | 'utf8' = 'hex'
 ) : string {
-  const data = Buff.join(hexstrs)
-  return (type === 'hex')
+  const data = Buff.join(chunks)
+  return (format === 'hex')
     ? data.hex
     : data.str
 }
@@ -225,9 +230,9 @@ function encode_rune_label (label : string) : string {
   return Buff.big(big).reverse().hex
 }
 
-function decode_rune_label (hex: string): string {
+function decode_rune_label (label: Bytes): string {
   // Convert hex to BigInt, with byte order reversed
-  let big = Buff.hex(hex).reverse().big
+  let big = Buff.bytes(label).reverse().big
   // Add 1 as per the encoding algorithm
   big = big + _1n
   // Initialize result string

package/src/lib/meta/sequence.ts

@@ -23,7 +23,7 @@ const TIMELOCK_GRANULARITY = 512         // Seconds per timestamp unit (BIP-68 s
 
 /* ===== [ API ] ============================================================ */
 
-export namespace SequenceUtil {
+export namespace SequenceField {
   export const encode = encode_sequence
   export const decode = decode_sequence
 }

package/src/lib/script/decode.ts

@@ -1,4 +1,4 @@
-import { Stream } from '@vbyte/buff'
+import { Bytes, Stream } from '@vbyte/buff'
 
 import {
   get_op_code,
@@ -10,7 +10,7 @@ import {
  * Decode a bitcoin script into asm instructions.
  */
 export function decode_script (
-  script : string | Uint8Array
+  script : Bytes
 ) : string[] {
   const stream = new Stream(script)
 

package/src/lib/script/encode.ts

@@ -10,8 +10,8 @@ const MAX_WORD_SIZE = 520
 export function encode_script (
   words : (string | number | Uint8Array)[],
   varint = false
-) : string {
-  if (words.length === 0) return '00'
+) : Buff {
+  if (words.length === 0) return Buff.num(0, 1)
 
   const bytes = []
 
@@ -23,11 +23,10 @@ export function encode_script (
   const buffer = Buff.join(bytes)
 
   return (varint)
-    ? buffer.prepend(Buff.varint(buffer.length, 'le')).hex
-    : buffer.hex
+    ? buffer.prepend(Buff.varint(buffer.length, 'le'))
+    : buffer
 }
 
-
 /** Check if the word is a valid opcode,
  *  and return its integer value.
  */

package/src/lib/tx/util.ts

@@ -1,4 +1,4 @@
-import { Buff }               from '@vbyte/buff'
+import { Buff, Bytes }        from '@vbyte/buff'
 import { Test }               from '@vbyte/micro-lib'
 import { Assert }             from '@vbyte/micro-lib/assert'
 import { hash256 }            from '@vbyte/micro-lib/hash'
@@ -17,34 +17,36 @@ import type {
   WitnessVersion
 } from '@/types/index.js'
 
-export function is_return_script (script : string) : boolean {
-  return script.startsWith('6a')
+export function is_return_script (script : Bytes) : boolean {
+  const bytes = Buff.bytes(script)
+  return bytes.at(0) === 0x6a
 }
 
-export function get_vout_info (txout : TxOutput) : TxOutputInfo {
+export function get_vout_script_info (script : Bytes) : TxOutputInfo {
   return {
-    type    : get_vout_type(txout.script_pk),
-    version : get_vout_version(txout.script_pk)
+    type    : get_vout_script_type(script),
+    version : get_vout_script_version(script)
   }
 }
 
-export function get_vout_type (
-  script : string
-) : TxOutputType {
+export function get_vout_script_type (
+  script : Bytes
+) : TxOutputType | null {
+  const hex = Buff.bytes(script).hex
   for (const [ type, regex ] of Object.entries(LOCK_SCRIPT_REGEX)) {
-    if (regex.test(script)) return type as TxOutputType
+    if (regex.test(hex)) return type as TxOutputType
   }
-  return 'unknown'
+  return null
 }
 
-export function get_vout_version (
-  script : string
-) : WitnessVersion {
-  const wit_ver = script.slice(0, 4)
-  switch (wit_ver) {
-    case '0014' : return 0
-    case '5120' : return 1
-    default     : return null
+export function get_vout_script_version (
+  script : Bytes
+) : WitnessVersion | null{
+  const version = Buff.bytes(script)
+  switch (version.at(0)) {
+    case 0x00 : return 0
+    case 0x51 : return 1
+    default   : return null
   }
 }
 

package/src/types/meta.ts

@@ -3,11 +3,11 @@ import type{ WitnessType, WitnessVersion } from './witness.js'
 export type LocktimeData   = LocktimeStamp | LocktimeHeight
 export type SequenceConfig = Partial<SequenceData>
 export type SequenceData   = SequenceHeightLock | SequenceStampLock
-export type TxOutputType   = WitnessType | 'p2pkh' | 'p2sh' | 'opreturn'
+export type TxOutputType   = 'p2pkh' | 'p2sh' | 'p2w-pkh' | 'p2w-sh' | 'p2tr' | 'opreturn'
 
 export interface TxOutputInfo {
-  type    : TxOutputType
-  version : WitnessVersion
+  type    : TxOutputType   | null
+  version : WitnessVersion | null
 }
 
 export interface TxInputInfo {