invokefunction Method
Invokes a smart contract with its scripthash based on the specified operation and parameters and returns the result.
This method is used to test your VM script as if they ran on the blockchain at that point in time. This RPC call does not affect the blockchain in any way.
You must install the plugin RpcServer before you can invoke the method.
Parameter Description
-
scripthash: Smart contract scripthash. You need to use the proper byte order of the address passed according to its data type. If the data type is Hash160, use the big endian scripthash; if the data type is ByteArray, use the little endian scripthash.
-
operation: The operation name (string).
-
params: Optional. The parameters to be passed into the smart contract operation.
-
signers or witnesses: Optional. You can set a list of signature accounts or witnesses for the transaction.
The structure of signers is as follows:
-
account: signature account
-
scopes: signature's valid scopes, allowed values are:
-
None: Only transactions are signed and no contracts are allowed to use this signature.
-
CalledByEntry: It only applies to the chain call entry. That is, if the user invokes contract A, and then contract A calls contract B, only contract A can use the signature. It is recommended as the default value for the wallet.
-
CustomContracts: Custom contract. The signature can be used in the specified contract. It can be used in conjunction with CalledByEntry.
-
CustomGroups: Custom contract groups that can be used in a specified contract group. It can be used in conjunction with CalledByEntry.
-
Global: Global. The risk is extremely high because the contract may transfer all assets in the address. Only choose it when the contract is extremely trusted.
-
allowedcontracts: contracts of the signature can take effect, if scopes is CustomContracts
-
allowedgroups: pubkeys of the signature can take effect, if scopes is CustomGroups
-
invocation: InvocationScript in Base64 encoded format.
-
verification: VerificationScript in Base64 encoded format.
The structure of witnesses is as follows:
-
You need to use the proper byte order of the address passed according to its data type. If the data type is Hash160, use the big endian script hash; if the data type is ByteArray, use the little endian scripthash.
For example:
Example
Request body:
Response body:
Response description:
-
script: the invocation script of the contract. You can analysis from https://neo.org/converter
-
state:
HALT
means the vm executed successfully, andFAULT
means the vm exited due to an exception. -
gasconsumed: the system fee consumed for invocation.
-
stack: the contract execution result. If the value is String or ByteArray, it is encoded by Base64.
-
tx: the transaction's hex string of this invocation, need open wallet and added signers correctly.
About iterator
If the execution result of contract includes iterators, the iteration times are constrained according to the MaxIteratorResultItems
value configured in the RpcServer
config
file. The default limit is 100 times.
In the following example, up to 6 returned results are actually available. When the MaxIteratorResultItems
value is 5, only 5 iterations are returned and truncated
is true, indicating that there is still data to be returned.
When the MaxIteratorResultItems
value is greater than or equal to 6, then 6 iterations are returned and truncated
is false, indicating that all data has been returned.