Package org.stellar.sdk.contract

Class ContractSpec

java.lang.Object

org.stellar.sdk.contract.ContractSpec

public final class ContractSpec
extends Object

Represents a SEP-0048 contract interface specification.

Entries are stored in module order and exposed as an unmodifiable list. The classified views (getFunctions(), getEvents(), etc.) are derived from getEntries() on each call. Construct with raw SCSpecEntry values, decode from contract Wasm bytes via fromWasm(byte[]), or decode from a SEP-0048 XDR stream via fromXdrBytes(byte[]).

SEP-0048 does not require entry names to be unique, so the getFunction/ getEvent/getUdt lookups return the first matching entry in module order.

This wrapper is shallow immutable: the entry list cannot be modified, but the contained SCSpecEntry objects are the underlying mutable XDR types. Do not mutate them after construction; doing so also affects equals(Object), hashCode(), and the classified views.

See Also:

• SEP-0048

Constructor Summary

Constructors

Constructor	Description
ContractSpec()
ContractSpec(List<SCSpecEntry> entries)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ContractSpec	fromWasm(byte[] wasm)	Creates a ContractSpec from contract Wasm bytes.
static ContractSpec	fromWasmFile(Path path)	Creates a ContractSpec from a contract Wasm file.
static ContractSpec	fromXdrBytes(byte[] data)	Creates a ContractSpec from a SEP-0048 XDR stream of SCSpecEntry values.
List<SCSpecEntry>	getEntries()
List<SCSpecUDTEnumV0>	getEnums()
List<SCSpecUDTErrorEnumV0>	getErrorEnums()
Optional<SCSpecEventV0>	getEvent(String name)	Returns the first event with the given name, if present.
List<SCSpecEventV0>	getEvents()
Optional<SCSpecFunctionV0>	getFunction(String name)	Returns the first function with the given name, if present.
List<SCSpecFunctionV0>	getFunctions()
List<SCSpecUDTStructV0>	getStructs()
Optional<SCSpecEntry>	getUdt(String name)	Returns the first user-defined type entry (struct, union, enum, or error enum) with the given name, if present.
List<SCSpecUDTUnionV0>	getUnions()
int	hashCode()
String	toString()
byte[]	toXdrBytes()	Serializes the entries as a SEP-0048 XDR stream.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ContractSpec

public ContractSpec()

ContractSpec

public ContractSpec(List<SCSpecEntry> entries)

Method Details

getFunctions

public List<SCSpecFunctionV0> getFunctions()

getEvents

public List<SCSpecEventV0> getEvents()

getStructs

public List<SCSpecUDTStructV0> getStructs()

getUnions

public List<SCSpecUDTUnionV0> getUnions()

getEnums

public List<SCSpecUDTEnumV0> getEnums()

getErrorEnums

public List<SCSpecUDTErrorEnumV0> getErrorEnums()

fromWasm

public static ContractSpec fromWasm(byte[] wasm)

Creates a ContractSpec from contract Wasm bytes. Returns an empty spec if the contractspecv0 section is absent.

Parameters:

wasm - contract Wasm bytes

Throws:

InvalidWasmException - if the Wasm module or specification section cannot be decoded, or if multiple contractspecv0 sections are present

fromWasmFile

public static ContractSpec fromWasmFile(Path path)
                                 throws IOException

Creates a ContractSpec from a contract Wasm file.

Parameters:

path - path to the contract Wasm file

Throws:

IOException - if the file cannot be read

InvalidWasmException - if the Wasm module or specification section cannot be decoded

fromXdrBytes

public static ContractSpec fromXdrBytes(byte[] data)

Creates a ContractSpec from a SEP-0048 XDR stream of SCSpecEntry values.

Parameters:

data - XDR stream bytes

Throws:

InvalidWasmException - if the XDR stream cannot be decoded

toXdrBytes

public byte[] toXdrBytes()

Serializes the entries as a SEP-0048 XDR stream.

getFunction

public Optional<SCSpecFunctionV0> getFunction(String name)

Returns the first function with the given name, if present. SEP-0048 does not require names to be unique.

Throws:

InvalidWasmException - if a function name is not valid UTF-8

getEvent

public Optional<SCSpecEventV0> getEvent(String name)

Returns the first event with the given name, if present. SEP-0048 does not require names to be unique.

Throws:

InvalidWasmException - if an event name is not valid UTF-8

getUdt

public Optional<SCSpecEntry> getUdt(String name)

Returns the first user-defined type entry (struct, union, enum, or error enum) with the given name, if present. SEP-0048 does not require names to be unique.

Throws:

InvalidWasmException - if a type name is not valid UTF-8

getEntries

public List<SCSpecEntry> getEntries()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object