Review Script Template

When to Use

• Review a new template before merging
• Audit existing template implementations
• Validate template follows ts-templates patterns
• Check for common implementation errors

Review Checklist

Structure Validation

• File located in

  src/template/

  appropriate subdirectory
• Implements

  ScriptTemplate

  interface from @bsv/sdk
• Exports PREFIX constant
• Exports Data interface with all protocol fields
• Default export is the template class
• Added to mod.ts exports (class + types)

Interface Requirements

• data

  property is

  public readonly

• Constructor accepts Data interface

• bitcomIndex?: number

  field for protocol position

• valid?: boolean

  field for verification status

Required Methods

decode()

lock()

unlock()

verify()

Code Quality

• Uses

  script.chunks

  directly (no toASM().split())
• Uses @bsv/sdk Utils (no Buffer, TextEncoder)
• Proper error handling in decode()
• No hardcoded magic numbers
• Consistent with other templates in repo

Chunk Parsing Review

const script = Script.fromBinary(protocol.script)
const chunks = script.chunks
const field = Utils.toUTF8(chunks[0].data ?? [])

// BAD: String splitting
const parts = script.toASM().split(' ')

// BAD: Buffer usage
const field = Buffer.from(chunks[0].data).toString()

// BAD: TextEncoder
new TextEncoder().encode(field)

Utils Usage Review

Utils.toArray(str, 'utf8')

Buffer.from()

TextEncoder

Utils.toUTF8(bytes)

Buffer.toString()

TextDecoder

Utils.toHex(bytes)

Buffer.toString('hex')

Utils.toBase64(bytes)

Buffer.toString('base64')

Signature Verification Review

• Uses BSM.sign() for signing
• Tries all 4 recovery factors (0-3)
• Uses Signature.fromCompact() for decoding
• Verifies address matches recovered public key
• Sets

  valid

  field after verification

BitCom Integration Review

• Uses BitCom class for lock()
• Creates Protocol array with correct structure
• Proper pipe delimiter handling
• decode() accepts BitComDecoded parameter

Common Issues

Issue 1: Missing Null Checks

// BAD: Can throw on missing data
const field = Utils.toUTF8(chunks[0].data)

// GOOD: Handle missing data
const field = Utils.toUTF8(chunks[0].data ?? [])

Issue 2: Wrong Chunk Index

• Check protocol documentation for field order
• Account for protocol prefix being separate

Issue 3: Incomplete Error Handling

// BAD: Crashes on parse error
static decode(bitcom: BitComDecoded): Protocol[] {
  const script = Script.fromBinary(protocol.script) // Can throw!
}

// GOOD: Handle parse errors
static decode(bitcom: BitComDecoded): Protocol[] {
  try {
    const script = Script.fromBinary(protocol.script)
  } catch {
    continue // Skip invalid protocols
  }
}

Issue 4: Missing mod.ts Export

export { default as Protocol, PREFIX } from './src/template/...'
export type { ProtocolData, ProtocolOptions } from './src/template/...'

Review Output Format

## Template Review: [TemplateName]

### Structure: ✅ PASS / ❌ FAIL
- [Details]

### Methods: ✅ PASS / ❌ FAIL
- [Details]

### Code Quality: ✅ PASS / ❌ FAIL
- [Details]

### Issues Found
1. [Issue description and fix]
2. [Issue description and fix]

### Recommendations
- [Optional improvements]

Additional Resources

Reference Files

• references/checklist-detailed.md

  - Extended validation criteria

• references/common-bugs.md

  - Known issues and fixes