io.neow3j.utils

Class Keys

java.lang.Object

io.neow3j.utils.Keys

public class Keys
extends java.lang.Object

Key utilities.

Method Summary

Modifier and Type	Method and Description
static byte[]	checkAndEncodePublicKey(byte[] publicKey) Checks if the given public key is in encoded format and encodes it if not.
static java.lang.String	getAddress(java.math.BigInteger publicKey)
static java.lang.String	getAddress(byte[] publicKey)
static java.lang.String	getAddress(java.lang.String publicKeyWithNoPrefix)
static java.lang.String	getMultiSigAddress(int amountSignatures, java.math.BigInteger... publicKeys)
static java.lang.String	getMultiSigAddress(int amountSignatures, byte[]... publicKeys)
static java.lang.String	getMultiSigAddress(int amountSignatures, java.util.List<java.math.BigInteger> publicKeys)
static byte[]	getPublicKeyEncoded(byte[] publicKeyNotEncoded)
static byte[]	getScriptHashFromPublicKey(byte[] publicKey) Deprecated.
static byte[]	getScriptHashFromPublicKey(int amountSignatures, byte[]... publicKeys) Deprecated. Use ScriptHash.fromPublicKey(byte[]) instead.
static byte[]	getVerificationScriptFromPublicKey(java.math.BigInteger publicKey) Creates the verification script for the given key.
static byte[]	getVerificationScriptFromPublicKey(byte[] publicKey) Creates the verification script for the given key.
static byte[]	getVerificationScriptFromPublicKeys(int signingThreshold, byte[]... publicKeys) Creates the multi-sig verification script for the given keys and the signing threshold.
static byte[]	getVerificationScriptFromPublicKeys(int signingThreshold, java.util.List<java.math.BigInteger> publicKeys) Creates the multi-sig verification script for the given keys and the signing threshold.
static boolean	isPublicKeyEncoded(byte[] publicKey)
static boolean	isValidAddress(java.lang.String address)
static byte[]	privateKeyIntegerToByteArray(java.math.BigInteger privateKey)
static byte[]	publicKeyIntegerToByteArray(java.math.BigInteger publicKey)
static java.lang.String	scriptHashToAddress(java.lang.String scriptHash) Deprecated. Use ScriptHash.toAddress() instead.
static java.lang.String	toAddress(byte[] scriptHash) Deprecated. Use ScriptHash.toAddress() instead.
static byte[]	toScriptHash(java.lang.String address) Deprecated. Use ScriptHash.fromAddress(String) instead.

Methods inherited from class java.lang.Object

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

Method Detail

getAddress

public static java.lang.String getAddress(java.math.BigInteger publicKey)

getAddress

public static java.lang.String getAddress(java.lang.String publicKeyWithNoPrefix)

getAddress

public static java.lang.String getAddress(byte[] publicKey)

getMultiSigAddress

public static java.lang.String getMultiSigAddress(int amountSignatures,
                                                  java.util.List<java.math.BigInteger> publicKeys)

getMultiSigAddress

public static java.lang.String getMultiSigAddress(int amountSignatures,
                                                  java.math.BigInteger... publicKeys)

getMultiSigAddress

public static java.lang.String getMultiSigAddress(int amountSignatures,
                                                  byte[]... publicKeys)

getScriptHashFromPublicKey

@Deprecated
public static byte[] getScriptHashFromPublicKey(byte[] publicKey)

Deprecated.

Creates a script hash from the given public key.

Parameters:

publicKey - The public key to calculate the script hash for.

Returns:

the script hash.

getScriptHashFromPublicKey

@Deprecated
public static byte[] getScriptHashFromPublicKey(int amountSignatures,
                                                            byte[]... publicKeys)

Deprecated. Use ScriptHash.fromPublicKey(byte[]) instead.

Calculates the script hash from the given public keys and number of signatures needed to sign with them.

Parameters:

amountSignatures - The signing threshold for the set of public keys.

publicKeys - The public keys.

Returns:

the script hash in little-endian order.

checkAndEncodePublicKey

public static byte[] checkAndEncodePublicKey(byte[] publicKey)

Checks if the given public key is in encoded format and encodes it if not.

Parameters:

publicKey - Key to encode.

Returns:

encoded public key.

publicKeyIntegerToByteArray

public static byte[] publicKeyIntegerToByteArray(java.math.BigInteger publicKey)

privateKeyIntegerToByteArray

public static byte[] privateKeyIntegerToByteArray(java.math.BigInteger privateKey)

getVerificationScriptFromPublicKey

public static byte[] getVerificationScriptFromPublicKey(java.math.BigInteger publicKey)

Creates the verification script for the given key. Checks if the key is in encoded format, and encodes it if not.

Parameters:

publicKey - Key to create script for.

Returns:

the verification script.

getVerificationScriptFromPublicKey

public static byte[] getVerificationScriptFromPublicKey(byte[] publicKey)

Creates the verification script for the given key. Checks if the key is in encoded format, and encodes it if not.

Parameters:

publicKey - Key to create script for.

Returns:

the verification script.

getVerificationScriptFromPublicKeys

public static byte[] getVerificationScriptFromPublicKeys(int signingThreshold,
                                                         java.util.List<java.math.BigInteger> publicKeys)

Creates the multi-sig verification script for the given keys and the signing threshold. Checks if the keys are in encoded format, and encodes them if not.

Parameters:

signingThreshold - the minimum number of public keys needed to sign transactions from the given public keys.

publicKeys - the public keys to create the script for.

Returns:

the multi-sig verification script.

getVerificationScriptFromPublicKeys

public static byte[] getVerificationScriptFromPublicKeys(int signingThreshold,
                                                         byte[]... publicKeys)

Creates the multi-sig verification script for the given keys and the signing threshold. Checks if the keys are in encoded format, and encodes them if not.

Parameters:

signingThreshold - the minimum number of public keys needed to sign transactions from the given public keys.

publicKeys - the public keys to create the script for.

Returns:

the multi-sig verification script.

getPublicKeyEncoded

public static byte[] getPublicKeyEncoded(byte[] publicKeyNotEncoded)

isPublicKeyEncoded

public static boolean isPublicKeyEncoded(byte[] publicKey)

toAddress

@Deprecated
public static java.lang.String toAddress(byte[] scriptHash)

Deprecated. Use ScriptHash.toAddress() instead.

Derives the address from the given script hash.

The script hash needs to be in little-endian order.

Parameters:

scriptHash - The script hash to get the address for.

Returns:

the address

isValidAddress

public static boolean isValidAddress(java.lang.String address)

toScriptHash

@Deprecated
public static byte[] toScriptHash(java.lang.String address)

Deprecated. Use ScriptHash.fromAddress(String) instead.

Transforms the given address into its script hash.

Parameters:

address - The address to get the script hash for.

Returns:

the script hash byte array in little-endian order.

scriptHashToAddress

@Deprecated
public static java.lang.String scriptHashToAddress(java.lang.String scriptHash)

Deprecated. Use ScriptHash.toAddress() instead.

Derives the address from the given script hash.

The script hash needs to be in little-endian order.

Parameters:

scriptHash - The script hash to get the address for.

Returns:

the address