org.stellar.sdk.operations

Class InvokeHostFunctionOperation

java.lang.Object

org.stellar.sdk.operations.Operation

org.stellar.sdk.operations.InvokeHostFunctionOperation

public class InvokeHostFunctionOperation
extends Operation

Represents InvokeHostFunction operation.

See Also:

Scv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<C extends InvokeHostFunctionOperation,B extends InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<C,B>>

Nested classes/interfaces inherited from class org.stellar.sdk.operations.Operation

Operation.OperationBuilder<C extends Operation,B extends Operation.OperationBuilder<C,B>>

Method Summary

Modifier and Type	Method and Description
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	builder()
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	createContractOperationBuilder(byte[] wasmId, Address address, java.util.Collection<SCVal> constructorArgs, byte[] salt) This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create contract.
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	createContractOperationBuilder(java.lang.String wasmId, Address address, java.util.Collection<SCVal> constructorArgs, byte[] salt) This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create contract.
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	createStellarAssetContractOperationBuilder(Address address, byte[] salt) This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create a token contract wrapping a classic asset.
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	createStellarAssetContractOperationBuilder(Asset asset) This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create a token contract wrapping a classic asset.
boolean	equals(java.lang.Object o)
static InvokeHostFunctionOperation	fromXdr(InvokeHostFunctionOp op) Constructs a new InvokeHostFunctionOperation object from the XDR representation of the InvokeHostFunctionOperation.
@NonNull java.util.List<SorobanAuthorizationEntry>	getAuth() The authorizations required to execute the host function
@NonNull HostFunction	getHostFunction() The host function to invoke.
int	hashCode()
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	invokeContractFunctionOperationBuilder(java.lang.String contractId, java.lang.String functionName, java.util.Collection<SCVal> parameters) This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to invoke a contract function.
InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	toBuilder()
java.lang.String	toString()
static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?>	uploadContractWasmOperationBuilder(byte[] wasm) This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to upload contract wasm.

Methods inherited from class org.stellar.sdk.operations.Operation

formatAmountScale, fromXdr, fromXdrAmount, getSourceAccount, setSourceAccount, toXdr, toXdrAmount, toXdrBase64

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

fromXdr

public static InvokeHostFunctionOperation fromXdr(InvokeHostFunctionOp op)

Constructs a new InvokeHostFunctionOperation object from the XDR representation of the InvokeHostFunctionOperation.

Parameters:

op - the XDR representation of the InvokeHostFunctionOperation.

uploadContractWasmOperationBuilder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> uploadContractWasmOperationBuilder(byte[] wasm)

This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to upload contract wasm.

Parameters:

wasm - The wasm bytes to upload.

Returns:

InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder

createContractOperationBuilder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> createContractOperationBuilder(java.lang.String wasmId,
                                                                                                                 Address address,
                                                                                                                 @Nullable
                                                                                                                 java.util.Collection<SCVal> constructorArgs,
                                                                                                                 @Nullable
                                                                                                                 byte[] salt)

This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create contract.

Parameters:

wasmId - The hex-encoded wasm id to use for contract creation.

address - The address to use to derive the contract ID.

constructorArgs - The optional parameters to pass to the constructor of this contract.

salt - The 32-byte salt to use to derive the contract ID, if null, a random salt will be generated.

Returns:

InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder

createContractOperationBuilder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> createContractOperationBuilder(byte[] wasmId,
                                                                                                                 Address address,
                                                                                                                 @Nullable
                                                                                                                 java.util.Collection<SCVal> constructorArgs,
                                                                                                                 @Nullable
                                                                                                                 byte[] salt)

This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create contract.

Parameters:

wasmId - The wasm id to use for contract creation.

address - The address to use to derive the contract ID.

constructorArgs - The optional parameters to pass to the constructor of this contract.

salt - The 32-byte salt to use to derive the contract ID, if null, a random salt will be generated.

Returns:

InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder

createStellarAssetContractOperationBuilder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> createStellarAssetContractOperationBuilder(Asset asset)

This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create a token contract wrapping a classic asset.

Parameters:

asset - The classic asset to wrap.

Returns:

InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder

createStellarAssetContractOperationBuilder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> createStellarAssetContractOperationBuilder(Address address,
                                                                                                                             @Nullable
                                                                                                                             byte[] salt)

This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to create a token contract wrapping a classic asset.

Parameters:

address - The address to use to derive the contract ID.

salt - The 32-byte salt to use to derive the contract ID, if null, a random salt will be generated.

Returns:

InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder

invokeContractFunctionOperationBuilder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> invokeContractFunctionOperationBuilder(java.lang.String contractId,
                                                                                                                         java.lang.String functionName,
                                                                                                                         @Nullable
                                                                                                                         java.util.Collection<SCVal> parameters)

This function will create an InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder with the "hostFunction" parameter preset, so that you can conveniently build an InvokeHostFunctionOperation to invoke a contract function.

Parameters:

contractId - The ID of the contract to invoke.

functionName - The name of the function to invoke.

parameters - The parameters to pass to the method.

Returns:

InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder

See Also:

Scv, Interacting with Contracts

builder

public static InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> builder()

toBuilder

public InvokeHostFunctionOperation.InvokeHostFunctionOperationBuilder<?,?> toBuilder()

getHostFunction

@NonNull
public @NonNull HostFunction getHostFunction()

The host function to invoke.

getAuth

@NonNull
public @NonNull java.util.List<SorobanAuthorizationEntry> getAuth()

The authorizations required to execute the host function

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Operation

hashCode

public int hashCode()

Overrides:

hashCode in class Operation