io.neow3j.contract

Class ScriptBuilder

java.lang.Object

io.neow3j.contract.ScriptBuilder

public class ScriptBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptBuilder()

Method Summary

Modifier and Type	Method and Description
static byte[]	buildVerificationScript(byte[] encodedPublicKey) Builds a verification script for the given public key.
static byte[]	buildVerificationScript(java.util.List<byte[]> encodedPublicKeys, int signingThreshold) Builds a verification script for a multi signature account from the given public keys.
ScriptBuilder	contractCall(ScriptHash scriptHash, java.lang.String method, java.util.List<ContractParameter> params) Appends a call to the contract denoted by the given script hash.
ScriptBuilder	opCode(OpCode opCode) Appends an OpCode to the script.
ScriptBuilder	opCode(OpCode opCode, byte[] argument) Appends an OpCode and a belonging argument to the script.
ScriptBuilder	pack()
ScriptBuilder	pushArray(ContractParameter[] params)
ScriptBuilder	pushBoolean(boolean bool)
ScriptBuilder	pushData(byte[] data) Adds the data to the script, prefixed with the correct code for its length.
ScriptBuilder	pushData(java.lang.String data) Adds the data to the script, prefixed with the correct code for its length.
ScriptBuilder	pushInteger(java.math.BigInteger v) Adds a push operation with the given integer to the script.
ScriptBuilder	pushInteger(int v) Adds a push operation with the given integer to the script.
ScriptBuilder	pushParam(ContractParameter param)
ScriptBuilder	pushParams(java.util.List<ContractParameter> params) Adds the given contract parameters to the script.
ScriptBuilder	sysCall(InteropServiceCode operation)
byte[]	toArray()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptBuilder

public ScriptBuilder()

Method Detail

opCode

public ScriptBuilder opCode(OpCode opCode)

Appends an OpCode to the script.

Parameters:

opCode - The OpCode to append.

Returns:

this ScriptBuilder object.

opCode

public ScriptBuilder opCode(OpCode opCode,
                            byte[] argument)

Appends an OpCode and a belonging argument to the script.

Parameters:

opCode - The OpCode to append.

argument - The argument of the OpCode.

Returns:

this ScriptBuilder object.

contractCall

public ScriptBuilder contractCall(ScriptHash scriptHash,
                                  java.lang.String method,
                                  java.util.List<ContractParameter> params)

Appends a call to the contract denoted by the given script hash.

Parameters:

scriptHash - The script hash of the contract to call.

method - The method to call.

params - The parameters that will be used in the call. Need to be in correct order.

Returns:

this ScriptBuilder object.

sysCall

public ScriptBuilder sysCall(InteropServiceCode operation)

pushParams

public ScriptBuilder pushParams(java.util.List<ContractParameter> params)

Adds the given contract parameters to the script.

Example with two parameters in the list:

  PUSHBYTES4 a3b00183
  PUSHBYTES20 0100000000000000000000000000000000000000
  PUSH2
  PACK
 

This method should also be used if the parameters list is empty. In that case the script looks like the following:

  PUSH0
  PACK
 

Parameters:

params - The list of parameters to add.

Returns:

this

pushParam

public ScriptBuilder pushParam(ContractParameter param)

pushInteger

public ScriptBuilder pushInteger(int v)

Adds a push operation with the given integer to the script.

Parameters:

v - The number to push.

Returns:

this.

Throws:

java.lang.IllegalArgumentException - if the given number is smaller than -1.

pushInteger

public ScriptBuilder pushInteger(java.math.BigInteger v)

Adds a push operation with the given integer to the script. The integer is encoded in its two's complement and in little-endian order.

The integer can be up to 32 bytes long.

Parameters:

v - The integer to push.

Returns:

this.

Throws:

java.lang.IllegalArgumentException - if the given integer is smaller than -1 or takes more space than 32 bytes.

pushBoolean

public ScriptBuilder pushBoolean(boolean bool)

pushData

public ScriptBuilder pushData(java.lang.String data)

Adds the data to the script, prefixed with the correct code for its length.

Parameters:

data - The data to add to the script.

Returns:

this ScriptBuilder object.

pushData

public ScriptBuilder pushData(byte[] data)

Adds the data to the script, prefixed with the correct code for its length.

Parameters:

data - The data to add to the script.

Returns:

this ScriptBuilder object.

pushArray

public ScriptBuilder pushArray(ContractParameter[] params)

pack

public ScriptBuilder pack()

toArray

public byte[] toArray()

buildVerificationScript

public static byte[] buildVerificationScript(byte[] encodedPublicKey)

Builds a verification script for the given public key.

Parameters:

encodedPublicKey - The public key encoded in compressed format.

Returns:

the script.

buildVerificationScript

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

Builds a verification script for a multi signature account from the given public keys.

Parameters:

encodedPublicKeys - The public keys encoded in compressed format.

signingThreshold - The desired minimum number of signatures required when using the multi-sig account.

Returns:

the script.