XdrHostFunction
extends XdrHostFunctionBase
in package
Table of Contents
Properties
- $createContract : XdrCreateContractArgs|null
- $createContractV2 : XdrCreateContractArgsV2|null
- $invokeContract : XdrInvokeContractArgs|null
- $type : XdrHostFunctionType
- $wasm : XdrDataValueMandatory|null
Methods
- __construct() : mixed
- decode() : static
- encode() : string
- forCreatingContract() : XdrHostFunction
- forCreatingContractV2() : XdrHostFunction
- forCreatingContractV2WithArgs() : XdrHostFunction
- forCreatingContractV2WithExternalRef() : XdrHostFunction
- Builds a create contract v2 host function whose executable is a CAP-85 external reference, passing constructor arguments to the created instance.
- forCreatingContractWithArgs() : XdrHostFunction
- forCreatingContractWithExternalRef() : XdrHostFunction
- Builds a create contract host function whose executable is a CAP-85 external reference: the instance runs the wasm named by the owner contract's persistent entry under the given tag.
- forDeploySACWithAsset() : XdrHostFunction
- forInvokingContractWithArgs() : XdrHostFunction
- forUploadContractWasm() : XdrHostFunction
- fromBase64Xdr() : static
- fromJson() : static
- fromJsonValue() : static
- fromTxRep() : static
- Override fromTxRep so the wasm field is parsed from a hex string into an XdrDataValueMandatory wrapper (the base assigns a raw string to the typed field).
- getCreateContract() : XdrCreateContractArgs|null
- getCreateContractV2() : XdrCreateContractArgsV2|null
- getInvokeContract() : XdrInvokeContractArgs|null
- getType() : XdrHostFunctionType
- getWasm() : XdrDataValueMandatory|null
- setCreateContract() : void
- setCreateContractV2() : void
- setInvokeContract() : void
- setType() : void
- setWasm() : void
- toBase64Xdr() : string
- toJson() : string
- toJsonValue() : mixed
- toTxRep() : void
- Override toTxRep so the wasm field is serialized as a hex string from the XdrDataValueMandatory wrapper (the base passes the object directly to bytesToHex).
Properties
$createContract
public
XdrCreateContractArgs|null
$createContract
= null
$createContractV2
public
XdrCreateContractArgsV2|null
$createContractV2
= null
$invokeContract
public
XdrInvokeContractArgs|null
$invokeContract
= null
$type
public
XdrHostFunctionType
$type
$wasm
public
XdrDataValueMandatory|null
$wasm
= null
Methods
__construct()
public
__construct([XdrHostFunctionType|null $type = null ]) : mixed
Parameters
- $type : XdrHostFunctionType|null = null
decode()
public
static decode(XdrBuffer $xdr) : static
Parameters
- $xdr : XdrBuffer
Return values
staticencode()
public
encode() : string
Return values
stringforCreatingContract()
public
static forCreatingContract(XdrSCAddress $address, string $wasmIdHex, string $salt) : XdrHostFunction
Parameters
- $address : XdrSCAddress
- $wasmIdHex : string
- $salt : string
Return values
XdrHostFunctionforCreatingContractV2()
public
static forCreatingContractV2(XdrSCAddress $address, string $wasmIdHex, string $salt, array<string|int, XdrSCVal> $constructorArgs) : XdrHostFunction
Parameters
- $address : XdrSCAddress
- $wasmIdHex : string
- $salt : string
- $constructorArgs : array<string|int, XdrSCVal>
Return values
XdrHostFunctionforCreatingContractV2WithArgs()
public
static forCreatingContractV2WithArgs(XdrCreateContractArgsV2 $args) : XdrHostFunction
Parameters
- $args : XdrCreateContractArgsV2
Return values
XdrHostFunctionforCreatingContractV2WithExternalRef()
Builds a create contract v2 host function whose executable is a CAP-85 external reference, passing constructor arguments to the created instance.
public
static forCreatingContractV2WithExternalRef(XdrSCAddress $address, XdrSCAddress $executableOwner, string $tag, string $salt, array<string|int, XdrSCVal> $constructorArgs) : XdrHostFunction
Parameters
- $address : XdrSCAddress
-
the deployer address
- $executableOwner : XdrSCAddress
-
the contract holding the executable tag entry
- $tag : string
-
the tag of the executable entry on the owner
- $salt : string
-
32 byte salt for contract id generation
- $constructorArgs : array<string|int, XdrSCVal>
-
arguments passed to the contract constructor
Return values
XdrHostFunctionforCreatingContractWithArgs()
public
static forCreatingContractWithArgs(XdrCreateContractArgs $args) : XdrHostFunction
Parameters
- $args : XdrCreateContractArgs
Return values
XdrHostFunctionforCreatingContractWithExternalRef()
Builds a create contract host function whose executable is a CAP-85 external reference: the instance runs the wasm named by the owner contract's persistent entry under the given tag.
public
static forCreatingContractWithExternalRef(XdrSCAddress $address, XdrSCAddress $executableOwner, string $tag, string $salt) : XdrHostFunction
Parameters
- $address : XdrSCAddress
-
the deployer address
- $executableOwner : XdrSCAddress
-
the contract holding the executable tag entry
- $tag : string
-
the tag of the executable entry on the owner
- $salt : string
-
32 byte salt for contract id generation
Return values
XdrHostFunctionforDeploySACWithAsset()
public
static forDeploySACWithAsset(XdrAsset $asset) : XdrHostFunction
Parameters
- $asset : XdrAsset
Return values
XdrHostFunctionforInvokingContractWithArgs()
public
static forInvokingContractWithArgs(XdrInvokeContractArgs $args) : XdrHostFunction
Parameters
- $args : XdrInvokeContractArgs
Return values
XdrHostFunctionforUploadContractWasm()
public
static forUploadContractWasm(string $contractCodeRawBytes) : XdrHostFunction
Parameters
- $contractCodeRawBytes : string
Return values
XdrHostFunctionfromBase64Xdr()
public
static fromBase64Xdr(string $xdr) : static
Parameters
- $xdr : string
Return values
staticfromJson()
public
static fromJson(string $json) : static
Parameters
- $json : string
Tags
Return values
staticfromJsonValue()
public
static fromJsonValue(mixed $value) : static
Parameters
- $value : mixed
Return values
staticfromTxRep()
Override fromTxRep so the wasm field is parsed from a hex string into an XdrDataValueMandatory wrapper (the base assigns a raw string to the typed field).
public
static fromTxRep(array<string, string> $map, string $prefix) : static
Parameters
- $map : array<string, string>
- $prefix : string
Return values
staticgetCreateContract()
public
getCreateContract() : XdrCreateContractArgs|null
Return values
XdrCreateContractArgs|nullgetCreateContractV2()
public
getCreateContractV2() : XdrCreateContractArgsV2|null
Return values
XdrCreateContractArgsV2|nullgetInvokeContract()
public
getInvokeContract() : XdrInvokeContractArgs|null
Return values
XdrInvokeContractArgs|nullgetType()
public
getType() : XdrHostFunctionType
Return values
XdrHostFunctionTypegetWasm()
public
getWasm() : XdrDataValueMandatory|null
Return values
XdrDataValueMandatory|nullsetCreateContract()
public
setCreateContract(XdrCreateContractArgs|null $createContract) : void
Parameters
- $createContract : XdrCreateContractArgs|null
setCreateContractV2()
public
setCreateContractV2(XdrCreateContractArgsV2|null $createContractV2) : void
Parameters
- $createContractV2 : XdrCreateContractArgsV2|null
setInvokeContract()
public
setInvokeContract(XdrInvokeContractArgs|null $invokeContract) : void
Parameters
- $invokeContract : XdrInvokeContractArgs|null
setType()
public
setType(XdrHostFunctionType $type) : void
Parameters
- $type : XdrHostFunctionType
setWasm()
public
setWasm(XdrDataValueMandatory|null $wasm) : void
Parameters
- $wasm : XdrDataValueMandatory|null
toBase64Xdr()
public
toBase64Xdr() : string
Return values
stringtoJson()
public
toJson() : string
Tags
Return values
stringtoJsonValue()
public
toJsonValue() : mixed
toTxRep()
Override toTxRep so the wasm field is serialized as a hex string from the XdrDataValueMandatory wrapper (the base passes the object directly to bytesToHex).
public
toTxRep(string $prefix, array<string, string> &$lines) : void
Parameters
- $prefix : string
- $lines : array<string, string>