Package org.bitcoinj.script

Class ScriptBuilder

  • public class ScriptBuilder
extends java.lang.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 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

      • creationTime

        public ScriptBuilder creationTime​(java.time.Instant creationTime)
        Associates this script to be built with a given creation time. This is currently used in the context of watching wallets only, where the scriptPubKeys being watched actually represent public keys and their addresses.
        Parameters:
        creationTime - creation time to associate the script with
        Returns:
        this builder

      • 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(long)

      • 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 greater than 16, and although it will accept numbers in the range 0-16 inclusive, the encoding would be considered non-standard.
        See Also:
        number(long)

      • 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(long)

      • 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 greater than 16, and although it will accept numbers in the range 0-16 inclusive, the encoding would be considered non-standard.
        See Also:
        number(long)

      • opTrue

        public ScriptBuilder opTrue()
        Adds true to the end of the program.
        Returns:
        this

      • opTrue

        public ScriptBuilder opTrue​(int index)
        Adds true to the given index in the program.
        Parameters:
        index - at which insert true
        Returns:
        this

      • opFalse

        public ScriptBuilder opFalse()
        Adds false to the end of the program.
        Returns:
        this

      • opFalse

        public ScriptBuilder opFalse​(int index)
        Adds false to the given index in the program.
        Parameters:
        index - at which insert true
        Returns:
        this

      • build

        public Script build()
        Creates a new immutable Script based on the state of the builder.

      • createEmpty

        public static Script createEmpty()
        Creates an empty script.

      • createOutputScript

        public static Script createOutputScript​(Address to,
                                        java.time.Instant creationTime)
        Creates a scriptPubKey that locks an output to the given address.
        Parameters:
        to - address to lock an output to
        creationTime - creation time of the scriptPubKey
        Returns:
        scriptPubKey that locks an output

      • createOutputScript

        public static Script createOutputScript​(Address to)
        Creates a scriptPubKey that locks an output to the given address.
        Parameters:
        to - address to lock an output to
        Returns:
        scriptPubKey that locks an output

      • createInputScript

        public static Script createInputScript​(@Nullable
                                       TransactionSignature signature,
                                       ECKey pubKey)
        Creates a scriptSig that can redeem a P2PKH 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 P2PK output. If given signature is null, incomplete scriptSig will be created with OP_0 instead of signature

      • createMultiSigOutputScript

        public static Script createMultiSigOutputScript​(int threshold,
                                                java.util.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​(java.util.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​(java.util.List<byte[]> signatures)
        Create a program that satisfies an OP_CHECKMULTISIG program, using pre-encoded signatures.

      • createP2SHMultiSigInputScript

        public static Script createP2SHMultiSigInputScript​(@Nullable
                                                   java.util.List<TransactionSignature> signatures,
                                                   Script multisigProgram)
        Create a program that satisfies a P2SH 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​(java.util.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)

      • createP2PKOutputScript

        public static Script createP2PKOutputScript​(byte[] pubKey)
        Creates a scriptPubKey that locks an output to the given raw public key. The pubkey can be arbitrary data and may be invalid.

        This is a special purpose method. For normal P2PK use, it is recommended to construct a pubkey with ECKey.fromPublicOnly(byte[]) and use that on createP2PKOutputScript(ECKey).

        Parameters:
        pubKey - arbitrary pubkey bytes to lock an output to
        Returns:
        P2PK scriptPubKey that locks an output

      • createP2PKOutputScript

        public static Script createP2PKOutputScript​(ECKey pubKey)
        Creates a scriptPubKey that locks an output to the given public key.
        Parameters:
        pubKey - pubkey to lock an output to
        Returns:
        P2PK scriptPubKey that locks an output

      • createP2PKHOutputScript

        public static Script createP2PKHOutputScript​(byte[] pubKeyHash)
        Creates a scriptPubKey that locks an output to the given public key hash.
        Parameters:
        pubKeyHash - 20 hash bytes of the pubkey to lock an output to
        Returns:
        P2PKH scriptPubKey that locks an output

      • createP2PKHOutputScript

        public static Script createP2PKHOutputScript​(ECKey pubKey)
        Creates a scriptPubKey that locks an output to a hash of a given public key.
        Parameters:
        pubKey - pubkey whose hash to lock an output to
        Returns:
        P2PKH scriptPubKey that locks an output

      • createP2WPKHOutputScript

        public static Script createP2WPKHOutputScript​(byte[] pubKeyHash)
        Creates a segwit scriptPubKey that locks an output to the given public key hash.
        Parameters:
        pubKeyHash - 20 hash bytes of the pubkey to lock an output to
        Returns:
        P2WPKH scriptPubKey that locks an output

      • createP2WPKHOutputScript

        public static Script createP2WPKHOutputScript​(ECKey pubKey)
        Creates a segwit scriptPubKey that locks an output to the hash of a given public key. In accordance with the segwit specification, the public key must be compressed.
        Parameters:
        pubKey - pubkey whose hash to lock an output to
        Returns:
        P2WPKH scriptPubKey that locks an output

      • createP2SHOutputScript

        public static Script createP2SHOutputScript​(byte[] redeemScriptHash)
        Creates a scriptPubKey that locks an output to the given script hash. Read BIP 16 to learn more about this kind of script.
        Parameters:
        redeemScriptHash - 20 hash bytes of the redeem script to lock an output to
        Returns:
        P2SH scriptPubKey that locks an output

      • createP2SHOutputScript

        public static Script createP2SHOutputScript​(Script redeemScript)
        Creates a scriptPubKey that locks an output to a hash of the given redeem script.
        Parameters:
        redeemScript - redeem script whose hash to lock an output to
        Returns:
        P2SH scriptPubKey that locks an output

      • createP2WSHOutputScript

        public static Script createP2WSHOutputScript​(byte[] redeemScriptHash)
        Creates a segwit scriptPubKey that locks an output to the given script hash.
        Parameters:
        redeemScriptHash - 32 hash bytes of the redeem script to lock an output to
        Returns:
        P2WSH scriptPubKey that locks an output

      • createP2WSHOutputScript

        public static Script createP2WSHOutputScript​(Script redeemScript)
        Creates a segwit scriptPubKey that locks an output to a hash of the given redeem script.
        Parameters:
        redeemScript - redeem script whose hash to lock an output to
        Returns:
        P2WSH scriptPubKey that locks an output

      • createP2SHOutputScript

        public static Script createP2SHOutputScript​(int threshold,
                                            java.util.List<ECKey> pubkeys)
        Creates a P2SH output script for n-of-m multisig with given public keys and threshold. Given public keys will be placed in redeem script in the lexicographical sorting order.
        Parameters:
        threshold - The threshold number of keys that must sign (n)
        pubkeys - list of m public keys to lock an output to
        Returns:
        P2SH multisig scriptPubKey that locks an output

      • createRedeemScript

        public static Script createRedeemScript​(int threshold,
                                        java.util.List<ECKey> pubkeys)
        Creates an n-of-m multisig redeem script with given public keys and threshold. Given public keys will be placed in redeem script in the lexicographical sorting order.
        Parameters:
        threshold - The threshold number of keys that must sign (n)
        pubkeys - list of m public keys to lock an output to
        Returns:
        P2SH multisig scriptPubKey that locks an output

      • 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.