Skip to content

docs: update README and plan to remove P2SH template references #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sgbett merged 1 commit into from
Feb 12, 2026
Merged

docs: update README and plan to remove P2SH template references #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .claude/plans/20260210-advanced-script-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Context

Issue #22, sub-task of HLR #8. Adds template constructors for P2PK, P2SH, and bare multisig (P2MS) script types. Currently only `p2pkh_lock`, `p2pkh_unlock`, and `op_return` exist.
Issue #22, sub-task of HLR #8. Adds template constructors for P2PK and bare multisig (P2MS) script types. Currently only `p2pkh_lock`, `p2pkh_unlock`, and `op_return` exist.

> **Note:** P2SH constructors (`p2sh_lock`, `p2sh_unlock`) were originally implemented in this task but later removed per #52 (Protocol Philosophy). P2SH is not valid on BSV. Detection (`p2sh?`, `script_hash`) is retained for parsing historical outputs.

The "custom locking scripts" acceptance criterion is already met by the Builder API (#23).

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ puts tx.to_hex
- **Cryptographic Primitives** — ECDSA signing with RFC 6979 deterministic nonces, Schnorr signatures, ECIES encryption/decryption, Bitcoin Signed Messages. All built on Ruby's stdlib OpenSSL.
- **Key Management** — BIP-32 HD key derivation, BIP-39 mnemonic generation (12/24-word phrases), WIF import/export, Base58Check encoding/decoding.
- **Script Layer** — Complete opcode set, script parsing and serialisation, type detection and predicates (`p2pkh?`, `p2pk?`, `p2sh?`, `multisig?`, `op_return?`), data extraction (pubkey hashes, script hashes, addresses), and a fluent builder API.
- **Script Templates** — Ready-made locking and unlocking script generators for P2PKH, P2PK, P2SH, P2MS (multisig), and OP_RETURN.
- **Script Templates** — Ready-made locking and unlocking script generators for P2PKH, P2PK, P2MS (multisig), and OP_RETURN.
- **Transaction Construction** — Input/output building, BIP-143 sighash computation (all SIGHASH types with FORKID), P2PKH signing, fee estimation.
- **SPV Structures** — Merkle path construction and verification, BEEF (Background Evaluation Extended Format) serialisation and deserialisation.
- **Network Integration** — ARC broadcaster for transaction submission, WhatsOnChain chain provider for UTXO queries and fee rates.
Expand Down