Class Script

java.lang.Object
com.codename1.crypto.bitcoin.Script
public final class Script extends Object

A Bitcoin script: the locking scriptPubKey of an output, or the scriptSig, redeem and witness scripts that unlock one. Immutable.

The standard output templates have factories (p2pkh(byte[]), p2wpkh(byte[]), p2tr(byte[])...) and matching tests; builder() writes anything else with minimal pushes.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Script.Builder
    Appends opcodes and pushes to a script.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    OP_0
    OP_0, also the empty push.
    static final int
    OP_1
    OP_1; OP_2..OP_16 follow it.
    static final int
    OP_16
    OP_16.
    static final int
    OP_1NEGATE
    OP_1NEGATE.
    static final int
    OP_CHECKLOCKTIMEVERIFY
    OP_CHECKLOCKTIMEVERIFY.
    static final int
    OP_CHECKMULTISIG
    OP_CHECKMULTISIG.
    static final int
    OP_CHECKSEQUENCEVERIFY
    OP_CHECKSEQUENCEVERIFY.
    static final int
    OP_CHECKSIG
    OP_CHECKSIG.
    static final int
    OP_CHECKSIGADD
    OP_CHECKSIGADD, the Tapscript multisig opcode.
    static final int
    OP_DUP
    OP_DUP.
    static final int
    OP_EQUAL
    OP_EQUAL.
    static final int
    OP_EQUALVERIFY
    OP_EQUALVERIFY.
    static final int
    OP_HASH160
    OP_HASH160.
    static final int
    OP_PUSHDATA1
    OP_PUSHDATA1.
    static final int
    OP_PUSHDATA2
    OP_PUSHDATA2.
    static final int
    OP_PUSHDATA4
    OP_PUSHDATA4.
    static final int
    OP_RETURN
    OP_RETURN.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Script.Builder
    builder()
    A builder that appends opcodes and minimal pushes.
    static Script
    empty()
    The empty script.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static Script
    fromHex(String hex)
    Wraps script bytes given in hex.
    byte[]
    getDestinationHash()
    The 20-byte hash a P2PKH or P2SH output commits to, the 20 or 32-byte program of a SegWit output, or null for any other script.
    byte[]
    getWitnessProgram()
    The witness program of a SegWit output, or null.
    int
    getWitnessVersion()
    The witness version of a SegWit output, or -1 when this is not one.
    int
    hashCode()
    Returns a hash code value for the object.
    boolean
    isP2pkh()
    Tells whether this is a P2PKH output.
    boolean
    isP2sh()
    Tells whether this is a P2SH output.
    boolean
    isP2tr()
    Tells whether this is a Taproot output.
    boolean
    isP2wpkh()
    Tells whether this is a P2WPKH output.
    boolean
    isP2wsh()
    Tells whether this is a P2WSH output.
    int
    length()
    The script length in bytes.
    static Script
    multisig(int m, byte[][] publicKeys)
    m <pubkey>... n OP_CHECKMULTISIG, the bare multisig redeem or witness script.
    static Script
    of(byte[] program)
    Wraps serialized script bytes.
    static Script
    opReturn(byte[] data)
    OP_RETURN <data>, a provably unspendable data carrier.
    static Script
    p2pkh(byte[] pubKeyHash20)
    OP_DUP OP_HASH160 <hash> OP_EQUALVERIFY OP_CHECKSIG.
    static Script
    p2sh(byte[] scriptHash20)
    OP_HASH160 <hash> OP_EQUAL.
    static Script
    p2tr(byte[] outputKey32)
    OP_1 <x-only key>, Taproot.
    static Script
    p2wpkh(byte[] pubKeyHash20)
    OP_0 <hash>, native SegWit v0 key hash.
    static Script
    p2wsh(byte[] scriptHash32)
    OP_0 <sha256(witnessScript)>, native SegWit v0 script hash.
    byte[]
    toBytes()
    A copy of the serialized script.
    String
    toHex()
    The serialized script in hex.
    String
    toString()
    Returns a string representation of the object.
    static Script
    witness(int version, byte[] program)
    A witness output of any version (0 to 16) and program.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Method Details

    • empty

      public static Script empty()
      The empty script.

    • of

      public static Script of(byte[] program)
      Wraps serialized script bytes.

    • fromHex

      public static Script fromHex(String hex)
      Wraps script bytes given in hex.

    • p2pkh

      public static Script p2pkh(byte[] pubKeyHash20)
      OP_DUP OP_HASH160 <hash> OP_EQUALVERIFY OP_CHECKSIG.

    • p2sh

      public static Script p2sh(byte[] scriptHash20)
      OP_HASH160 <hash> OP_EQUAL.

    • p2wpkh

      public static Script p2wpkh(byte[] pubKeyHash20)
      OP_0 <hash>, native SegWit v0 key hash.

    • p2wsh

      public static Script p2wsh(byte[] scriptHash32)
      OP_0 <sha256(witnessScript)>, native SegWit v0 script hash.

    • p2tr

      public static Script p2tr(byte[] outputKey32)
      OP_1 <x-only key>, Taproot.

    • witness

      public static Script witness(int version, byte[] program)
      A witness output of any version (0 to 16) and program.

    • opReturn

      public static Script opReturn(byte[] data)
      OP_RETURN <data>, a provably unspendable data carrier.

    • multisig

      public static Script multisig(int m, byte[][] publicKeys)
      m <pubkey>... n OP_CHECKMULTISIG, the bare multisig redeem or witness script.

    • builder

      public static Script.Builder builder()
      A builder that appends opcodes and minimal pushes.

    • isP2pkh

      public boolean isP2pkh()
      Tells whether this is a P2PKH output.

    • isP2sh

      public boolean isP2sh()
      Tells whether this is a P2SH output.

    • isP2wpkh

      public boolean isP2wpkh()
      Tells whether this is a P2WPKH output.

    • isP2wsh

      public boolean isP2wsh()
      Tells whether this is a P2WSH output.

    • isP2tr

      public boolean isP2tr()
      Tells whether this is a Taproot output.

    • getWitnessVersion

      public int getWitnessVersion()
      The witness version of a SegWit output, or -1 when this is not one.

    • getWitnessProgram

      public byte[] getWitnessProgram()
      The witness program of a SegWit output, or null.

    • getDestinationHash

      public byte[] getDestinationHash()
      The 20-byte hash a P2PKH or P2SH output commits to, the 20 or 32-byte program of a SegWit output, or null for any other script.

    • toBytes

      public byte[] toBytes()
      A copy of the serialized script.

    • length

      public int length()
      The script length in bytes.

    • toHex

      public String toHex()
      The serialized script in hex.

    • toString

      public String toString()
      Description copied from class: Object
      Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + '@' + Integer.toHexString(hashCode())
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Description copied from class: Object
      Indicates whether some other object is "equal to" this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Description copied from class: Object
      Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
      Overrides:
      hashCode in class Object