io.neow3j.contract

Class ScriptHash

java.lang.Object

io.neow3j.io.NeoSerializable

io.neow3j.contract.ScriptHash

All Implemented Interfaces:

NeoSerializableInterface, java.lang.Comparable<ScriptHash>

public class ScriptHash
extends NeoSerializable
implements java.lang.Comparable<ScriptHash>

A script hash is as its name says the hash of a executable NeoVM script. It is always 20 bytes long and is created by hashing a script with SHA256 and then RIPEMD160

Field Summary

Fields

Modifier and Type	Field and Description
static ScriptHash	ZERO A zero address script hash.

Constructor Summary

Constructors

Constructor and Description
ScriptHash() Constructs a new script hash with 20 zero bytes.
ScriptHash(byte[] scriptHash) Constructs a new script hash from the given byte array.
ScriptHash(java.lang.String scriptHash) Constructs a new script hash from the given hexadecimal string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ScriptHash o)
void	deserialize(BinaryReader reader)
boolean	equals(java.lang.Object o)
static ScriptHash	fromAddress(java.lang.String address) Creates a script hash from the given address.
static ScriptHash	fromPublicKey(byte[] encodedPublicKey)
static ScriptHash	fromPublicKeys(java.util.List<byte[]> encodedPublicKeys, int signingThreshold)
static ScriptHash	fromScript(byte[] script) Creates a script hash from the given script in byte array form.
static ScriptHash	fromScript(java.lang.String script) Creates a script hash from the given script in hexadecimal string form.
int	getSize() Gets the byte size of this serializable in serialized form.
int	hashCode()
void	serialize(BinaryWriter writer)
java.lang.String	toAddress() Derives the address corresponding to this script hash.
byte[]	toArray() Gets the script hash as a byte array in little-endian order.
java.lang.String	toString() Gets the script hash as a hexadecimal string in big-endian order without the '0x' prefix.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.neow3j.io.NeoSerializableInterface

from, fromAsList

Field Detail

ZERO

public static final ScriptHash ZERO

A zero address script hash.

Constructor Detail

ScriptHash

public ScriptHash()

Constructs a new script hash with 20 zero bytes.

ScriptHash

public ScriptHash(byte[] scriptHash)

Constructs a new script hash from the given byte array. The array must represent the script hash in little-endian order and can be 160 (contract script hash) or 256 (global asset id) bits long.

Parameters:

scriptHash - The script hash in little-endian order.

ScriptHash

public ScriptHash(java.lang.String scriptHash)

Constructs a new script hash from the given hexadecimal string. The string must represent the script hash in big-endian order and can be 160 (contract script hash) or 256 (global asset id) bits long.

Parameters:

scriptHash - The script hash in big-endian order.

Method Detail

deserialize

public void deserialize(BinaryReader reader)
                 throws DeserializationException

Specified by:

deserialize in interface NeoSerializableInterface

Throws:

DeserializationException

serialize

public void serialize(BinaryWriter writer)
               throws java.io.IOException

Specified by:

serialize in interface NeoSerializableInterface

Throws:

java.io.IOException

getSize

public int getSize()

Description copied from interface: NeoSerializableInterface

Gets the byte size of this serializable in serialized form. This includes possible size prefixes.

Specified by:

getSize in interface NeoSerializableInterface

Returns:

the byte size.

toArray

public byte[] toArray()

Gets the script hash as a byte array in little-endian order.

Specified by:

toArray in interface NeoSerializableInterface

Returns:

the script hash byte array in little-endian order.

toString

public java.lang.String toString()

Gets the script hash as a hexadecimal string in big-endian order without the '0x' prefix.

Overrides:

toString in class java.lang.Object

Returns:

the script hash as hex string in big-endian order.

toAddress

public java.lang.String toAddress()

Derives the address corresponding to this script hash.

Returns:

the address.

fromAddress

public static ScriptHash fromAddress(java.lang.String address)

Creates a script hash from the given address.

Parameters:

address - The address from which to derive the script hash.

Returns:

the script hash.

fromScript

public static ScriptHash fromScript(byte[] script)

Creates a script hash from the given script in byte array form.

Parameters:

script - The script to calculate the script hash for.

Returns:

the script hash.

fromPublicKey

public static ScriptHash fromPublicKey(byte[] encodedPublicKey)

fromPublicKeys

public static ScriptHash fromPublicKeys(java.util.List<byte[]> encodedPublicKeys,
                                        int signingThreshold)

fromScript

public static ScriptHash fromScript(java.lang.String script)

Creates a script hash from the given script in hexadecimal string form.

Parameters:

script - The script to calculate the script hash for.

Returns:

the script hash.

compareTo

public int compareTo(ScriptHash o)

Specified by:

compareTo in interface java.lang.Comparable<ScriptHash>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object