@node-lightning/bitcoin

@node-lightning/bitcoin

This package provides common Bitcoin functionality and does not rely on third party libraries.

Transaction Building

Transaction building uses the TxBuilder class. This class allows modification of the version and locktime. It also allows addition of inputs and outputs via the addInput and addOutput methods.

A typical workflow for transaction building looks like:

1. Create the builder
2. Set the version
3. Set the locktime
4. Add inputs via their outpoint
5. Add outputs by specifying a value in Bitcoin and including a locking script
6. Sign your inputs and assign the signature to corresponding input's ScriptSig

A simple example looks like:

// here are some dummy values that are needed
const privA; // 32-byte private key
const pubkeyA; // 33-byte compressed public key
const pubkeyhashB; // 20-byte hash of B's public key

// construct a builder
const txb = new TxBuilder();

// attach a single input that has 50 bitcoin in it
txb.addInput("9d0e63ad73020a9fad0106b6727e31d36e3ab4b9a01451233926d4759569de68:0");

// attach a spending output that pays to B's pubkeyhash
txb.addOutput(1, Script.p2pkhLock(pubkeyhashB));

// attach a change output that pays back to A's pubkey
txb.addOutput(48.9999, Script.p2pkhLock(pubkeyA));

// sign the input using the prior locking script
const commitScript = Script.p2pkhLock(pubkeyA);
const sig = txb.sign(0, commitScript, privA);

// create the scriptSig for the input that includes the signature and pubkey
// corresponding to the signature
txb.inputs[0].scriptSig = Script.p2pkhUnlock(sig, pubkeyA);

// convert the transaction into an immutable transaction
const tx = tx.toTx();

Legacy

• Spend P2PKH to P2PKH output
• Spend P2PK to P2PK output
• Spend P2PKH to P2SH-P2PKH
• Spend P2PKH to P2MS
• Spend P2MS to P2PKH
• Spend P2SH-P2PKH to P2SH
• Spend P2SH to P2SH
• Spend P2PKH to P2SH-P2MS
• Spend P2SH-P2MS to P2PKH

Special Transactions

• Spend P2PKH with OP_RETURN
• Spend P2PKH with BIP125 RBF
• Spend using CPFP
• Spend to block based CLTV
• Spend to time based CLTV
• Spend to block CSV delay
• Spend to time CSV delay

Native P2WPKH

• Spend P2PKH to P2WPKH
• Spend P2WPKH to P2WPKH

P2SH-P2WPKH

• Spend P2PKH to P2SH-P2WPKH
• Spend P2SH-P2WPKH to P2WPKH

Native P2WSH

• Spend P2PKH to P2WSH(P2MS)
• Spend P2WSH(P2MS) to P2WPKH

P2SH-P2WSH

• Spend P2PKH to P2SH-P2WSH

• Spend P2SH-P2WSH to P2PKH

• Spend P2PKH to P2SH-P2WSH(P2MS)

• Spend P2SH-P2WSH(P2MS) to P2WPKH