org.bitcoinj.script

Class ScriptBuilder

java.lang.Object

org.bitcoinj.script.ScriptBuilder

public class ScriptBuilder
extends Object

Tools for the construction of commonly used script types. You don't normally need this as it's hidden behind convenience methods on Transaction, but they are useful when working with the protocol at a lower level.

Constructor Summary

Constructors

Constructor and Description
ScriptBuilder() Creates a fresh ScriptBuilder with an empty program.
ScriptBuilder(Script template) Creates a fresh ScriptBuilder with the given program as the starting point.

Method Summary

Modifier and Type	Method and Description
ScriptBuilder	addChunk(int index, ScriptChunk chunk) Adds the given chunk at the given index in the program
ScriptBuilder	addChunk(ScriptChunk chunk) Adds the given chunk to the end of the program
protected ScriptBuilder	bigNum(int index, long num) Adds the given number as a push data chunk to the given index in the program.
protected ScriptBuilder	bigNum(long num) Adds the given number as a push data chunk.
Script	build() Creates a new immutable Script based on the state of the builder.
static Script	createCLTVPaymentChannelInput(byte[] from, byte[] to)
static Script	createCLTVPaymentChannelInput(TransactionSignature from, TransactionSignature to)
static Script	createCLTVPaymentChannelOutput(BigInteger time, ECKey from, ECKey to)
static Script	createCLTVPaymentChannelP2SHInput(byte[] from, byte[] to, Script redeemScript)
static Script	createCLTVPaymentChannelP2SHRefund(TransactionSignature signature, Script redeemScript)
static Script	createCLTVPaymentChannelRefund(TransactionSignature signature)
static Script	createInputScript(TransactionSignature signature) Creates a scriptSig that can redeem a pay-to-pubkey output.
static Script	createInputScript(TransactionSignature signature, ECKey pubKey) Creates a scriptSig that can redeem a pay-to-address output.
static Script	createMultiSigInputScript(List<TransactionSignature> signatures) Create a program that satisfies an OP_CHECKMULTISIG program.
static Script	createMultiSigInputScript(TransactionSignature... signatures) Create a program that satisfies an OP_CHECKMULTISIG program.
static Script	createMultiSigInputScriptBytes(List<byte[]> signatures) Create a program that satisfies an OP_CHECKMULTISIG program, using pre-encoded signatures.
static Script	createMultiSigInputScriptBytes(List<byte[]> signatures, byte[] multisigProgramBytes) Create a program that satisfies an OP_CHECKMULTISIG program, using pre-encoded signatures.
static Script	createMultiSigOutputScript(int threshold, List<ECKey> pubkeys) Creates a program that requires at least N of the given keys to sign, using OP_CHECKMULTISIG.
static Script	createOpReturnScript(byte[] data) Creates a script of the form OP_RETURN [data].
static Script	createOutputScript(Address to) Creates a scriptPubKey that encodes payment to the given address.
static Script	createOutputScript(ECKey key) Creates a scriptPubKey that encodes payment to the given raw public key.
static Script	createP2SHMultiSigInputScript(List<TransactionSignature> signatures, Script multisigProgram) Create a program that satisfies a pay-to-script hashed OP_CHECKMULTISIG program.
static Script	createP2SHOutputScript(byte[] hash) Creates a scriptPubKey that sends to the given script hash.
static Script	createP2SHOutputScript(int threshold, List<ECKey> pubkeys) Creates a P2SH output script with given public keys and threshold.
static Script	createP2SHOutputScript(Script redeemScript) Creates a scriptPubKey for the given redeem script.
static Script	createRedeemScript(int threshold, List<ECKey> pubkeys) Creates redeem script with given public keys and threshold.
ScriptBuilder	data(byte[] data) Adds a copy of the given byte array as a data element (i.e.
ScriptBuilder	data(int index, byte[] data) Adds a copy of the given byte array as a data element (i.e.
ScriptBuilder	number(int index, long num) Adds the given number to the given index in the program.
ScriptBuilder	number(long num) Adds the given number to the end of the program.
ScriptBuilder	op(int opcode) Adds the given opcode to the end of the program.
ScriptBuilder	op(int index, int opcode) Adds the given opcode to the given index in the program
ScriptBuilder	smallNum(int num) Adds the given number as a OP_N opcode to the end of the program.
ScriptBuilder	smallNum(int index, int num) Adds the given number as a OP_N opcode to the given index in the program.
static Script	updateScriptWithSignature(Script scriptSig, byte[] signature, int targetIndex, int sigsPrefixCount, int sigsSuffixCount) Returns a copy of the given scriptSig with the signature inserted in the given position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptBuilder

public ScriptBuilder()

Creates a fresh ScriptBuilder with an empty program.

ScriptBuilder

public ScriptBuilder(Script template)

Creates a fresh ScriptBuilder with the given program as the starting point.

Method Detail

addChunk

public ScriptBuilder addChunk(ScriptChunk chunk)

Adds the given chunk to the end of the program

addChunk

public ScriptBuilder addChunk(int index,
                              ScriptChunk chunk)

Adds the given chunk at the given index in the program

op

public ScriptBuilder op(int opcode)

Adds the given opcode to the end of the program.

op

public ScriptBuilder op(int index,
                        int opcode)

Adds the given opcode to the given index in the program

data

public ScriptBuilder data(byte[] data)

Adds a copy of the given byte array as a data element (i.e. PUSHDATA) at the end of the program.

data

public ScriptBuilder data(int index,
                          byte[] data)

Adds a copy of the given byte array as a data element (i.e. PUSHDATA) at the given index in the program.

number

public ScriptBuilder number(long num)

Adds the given number to the end of the program. Automatically uses shortest encoding possible.

number

public ScriptBuilder number(int index,
                            long num)

Adds the given number to the given index in the program. Automatically uses shortest encoding possible.

smallNum

public ScriptBuilder smallNum(int num)

Adds the given number as a OP_N opcode to the end of the program. Only handles values 0-16 inclusive.

See Also:

#number(int)

bigNum

protected ScriptBuilder bigNum(long num)

Adds the given number as a push data chunk. This is intended to use for negative numbers or values > 16, and although it will accept numbers in the range 0-16 inclusive, the encoding would be considered non-standard.

See Also:

#number(int)

smallNum

public ScriptBuilder smallNum(int index,
                              int num)

Adds the given number as a OP_N opcode to the given index in the program. Only handles values 0-16 inclusive.

See Also:

#number(int)

bigNum

protected ScriptBuilder bigNum(int index,
                               long num)

Adds the given number as a push data chunk to the given index in the program. This is intended to use for negative numbers or values > 16, and although it will accept numbers in the range 0-16 inclusive, the encoding would be considered non-standard.

See Also:

#number(int)

build

public Script build()

Creates a new immutable Script based on the state of the builder.

createOutputScript

public static Script createOutputScript(Address to)

Creates a scriptPubKey that encodes payment to the given address.

createOutputScript

public static Script createOutputScript(ECKey key)

Creates a scriptPubKey that encodes payment to the given raw public key.

createInputScript

public static Script createInputScript(@Nullable
                                       TransactionSignature signature,
                                       ECKey pubKey)

Creates a scriptSig that can redeem a pay-to-address output. If given signature is null, incomplete scriptSig will be created with OP_0 instead of signature

createInputScript

public static Script createInputScript(@Nullable
                                       TransactionSignature signature)

Creates a scriptSig that can redeem a pay-to-pubkey output. If given signature is null, incomplete scriptSig will be created with OP_0 instead of signature

createMultiSigOutputScript

public static Script createMultiSigOutputScript(int threshold,
                                                List<ECKey> pubkeys)

Creates a program that requires at least N of the given keys to sign, using OP_CHECKMULTISIG.

createMultiSigInputScript

public static Script createMultiSigInputScript(List<TransactionSignature> signatures)

Create a program that satisfies an OP_CHECKMULTISIG program.

createMultiSigInputScript

public static Script createMultiSigInputScript(TransactionSignature... signatures)

Create a program that satisfies an OP_CHECKMULTISIG program.

createMultiSigInputScriptBytes

public static Script createMultiSigInputScriptBytes(List<byte[]> signatures)

Create a program that satisfies an OP_CHECKMULTISIG program, using pre-encoded signatures.

createP2SHMultiSigInputScript

public static Script createP2SHMultiSigInputScript(@Nullable
                                                   List<TransactionSignature> signatures,
                                                   Script multisigProgram)

Create a program that satisfies a pay-to-script hashed OP_CHECKMULTISIG program. If given signature list is null, incomplete scriptSig will be created with OP_0 instead of signatures

createMultiSigInputScriptBytes

public static Script createMultiSigInputScriptBytes(List<byte[]> signatures,
                                                    @Nullable
                                                    byte[] multisigProgramBytes)

Create a program that satisfies an OP_CHECKMULTISIG program, using pre-encoded signatures. Optionally, appends the script program bytes if spending a P2SH output.

updateScriptWithSignature

public static Script updateScriptWithSignature(Script scriptSig,
                                               byte[] signature,
                                               int targetIndex,
                                               int sigsPrefixCount,
                                               int sigsSuffixCount)

Returns a copy of the given scriptSig with the signature inserted in the given position. This function assumes that any missing sigs have OP_0 placeholders. If given scriptSig already has all the signatures in place, IllegalArgumentException will be thrown.

Parameters:

targetIndex - where to insert the signature

sigsPrefixCount - how many items to copy verbatim (e.g. initial OP_0 for multisig)

sigsSuffixCount - how many items to copy verbatim at end (e.g. redeemScript for P2SH)

createP2SHOutputScript

public static Script createP2SHOutputScript(byte[] hash)

Creates a scriptPubKey that sends to the given script hash. Read BIP 16 to learn more about this kind of script.

createP2SHOutputScript

public static Script createP2SHOutputScript(Script redeemScript)

Creates a scriptPubKey for the given redeem script.

createP2SHOutputScript

public static Script createP2SHOutputScript(int threshold,
                                            List<ECKey> pubkeys)

Creates a P2SH output script with given public keys and threshold. Given public keys will be placed in redeem script in the lexicographical sorting order.

createRedeemScript

public static Script createRedeemScript(int threshold,
                                        List<ECKey> pubkeys)

Creates redeem script with given public keys and threshold. Given public keys will be placed in redeem script in the lexicographical sorting order.

createOpReturnScript

public static Script createOpReturnScript(byte[] data)

Creates a script of the form OP_RETURN [data]. This feature allows you to attach a small piece of data (like a hash of something stored elsewhere) to a zero valued output which can never be spent and thus does not pollute the ledger.

createCLTVPaymentChannelOutput

public static Script createCLTVPaymentChannelOutput(BigInteger time,
                                                    ECKey from,
                                                    ECKey to)

createCLTVPaymentChannelRefund

public static Script createCLTVPaymentChannelRefund(TransactionSignature signature)

createCLTVPaymentChannelP2SHRefund

public static Script createCLTVPaymentChannelP2SHRefund(TransactionSignature signature,
                                                        Script redeemScript)

createCLTVPaymentChannelP2SHInput

public static Script createCLTVPaymentChannelP2SHInput(byte[] from,
                                                       byte[] to,
                                                       Script redeemScript)

createCLTVPaymentChannelInput

public static Script createCLTVPaymentChannelInput(TransactionSignature from,
                                                   TransactionSignature to)

createCLTVPaymentChannelInput

public static Script createCLTVPaymentChannelInput(byte[] from,
                                                   byte[] to)