cn.tdchain.api

类 ContractApi

java.lang.Object

cn.tdchain.api.ContractApi

public class ContractApi
extends java.lang.Object

Contract API.

版本:

1.0

作者:

Bingoer.H 2018-12-18

构造器概要

构造器

构造器和说明
ContractApi()

方法概要

限定符和类型	方法和说明
java.util.Map<java.lang.String,java.lang.String>	create(java.lang.String address, java.lang.String ksPassword, java.lang.String contractName, java.lang.String templateName, java.lang.String[] args) Create contract.
com.alibaba.fastjson.JSONObject	findByHash(java.lang.String hash) Find contract by hash.
com.alibaba.fastjson.JSONObject	findByName(java.lang.String contractName) Find contract by name.
com.alibaba.fastjson.JSONObject	findExByHash(java.lang.String hash) Find contract and state by contract hash.
cn.tdchain.cb.domain.ContractState	findStateByHash(java.lang.String hash) Find contract state by hash.
java.util.Map<java.lang.String,java.lang.String>	freeze(java.lang.String address, java.lang.String ksPassword, java.lang.String contractName) Freeze contract.
java.util.Map<java.lang.String,java.lang.String>	migrateToNewTemplate(java.lang.String address, java.lang.String ksPassword, java.lang.String contractName, java.lang.String newTemplateName) Migration contract to new template.
java.lang.String	queryContractAttr(java.lang.String csHash, java.lang.String attributeName) Query contract attribute value from contract state.
java.util.List<com.alibaba.fastjson.JSONObject>	queryContractHistory(java.lang.String contractName) Query contract history(up to 20 records).
java.lang.String	queryContractLatestAttr(java.lang.String contractName, java.lang.String attributeName) Query contract attribute latest value from contract state.
java.util.List<com.alibaba.fastjson.JSONObject>	queryContractStateHistory(java.lang.String contractName) Query contract state history(up to 20 records).
java.util.Map<java.lang.String,java.lang.String>	run(java.lang.String address, java.lang.String ksPassword, java.lang.String contractName, java.lang.String methodName, java.lang.String[] args) Run contract.
java.util.Map<java.lang.String,java.lang.String>	unfreeze(java.lang.String address, java.lang.String ksPassword, java.lang.String contractName) Unfreeze contract.
java.util.Map<java.lang.String,java.lang.String>	update(java.lang.String address, java.lang.String ksPassword, java.lang.String contractName, java.lang.String[] syncAttrs, java.lang.String[] newArgs) Update contract.

从类继承的方法 java.lang.Object

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

构造器详细资料

ContractApi

public ContractApi()

方法详细资料

create

public java.util.Map<java.lang.String,java.lang.String> create(java.lang.String address,
                                                               java.lang.String ksPassword,
                                                               java.lang.String contractName,
                                                               java.lang.String templateName,
                                                               java.lang.String[] args)
                                                        throws cn.tdchain.cb.exception.BusinessException

Create contract.

参数:

address - operator address

ksPassword - operator key store password

contractName - contract name

templateName - template hash

args - constructor arguments

返回:

contract hash

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

run

public java.util.Map<java.lang.String,java.lang.String> run(java.lang.String address,
                                                            java.lang.String ksPassword,
                                                            java.lang.String contractName,
                                                            java.lang.String methodName,
                                                            java.lang.String[] args)
                                                     throws cn.tdchain.cb.exception.BusinessException

Run contract.

参数:

address - account address

ksPassword - account key store password

contractName - contract name

methodName - contract method name

args - method arguments

返回:

record hash

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

freeze

public java.util.Map<java.lang.String,java.lang.String> freeze(java.lang.String address,
                                                               java.lang.String ksPassword,
                                                               java.lang.String contractName)
                                                        throws cn.tdchain.cb.exception.BusinessException

Freeze contract.

参数:

address - contract owner or super account address

ksPassword - account key store password

contractName - contract name

返回:

record hash

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

unfreeze

public java.util.Map<java.lang.String,java.lang.String> unfreeze(java.lang.String address,
                                                                 java.lang.String ksPassword,
                                                                 java.lang.String contractName)
                                                          throws cn.tdchain.cb.exception.BusinessException

Unfreeze contract.

参数:

address - owner or super account address

ksPassword - account key store password

contractName - contract name

返回:

result message

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

update

public java.util.Map<java.lang.String,java.lang.String> update(java.lang.String address,
                                                               java.lang.String ksPassword,
                                                               java.lang.String contractName,
                                                               java.lang.String[] syncAttrs,
                                                               java.lang.String[] newArgs)
                                                        throws cn.tdchain.cb.exception.BusinessException

Update contract.

参数:

address - contract owner address

ksPassword - owner account key store password

contractName - contract name

syncAttrs - synchronize attributes

newArgs - new constructor arguments

返回:

new contract hash or error message

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

migrateToNewTemplate

public java.util.Map<java.lang.String,java.lang.String> migrateToNewTemplate(java.lang.String address,
                                                                             java.lang.String ksPassword,
                                                                             java.lang.String contractName,
                                                                             java.lang.String newTemplateName)
                                                                      throws cn.tdchain.cb.exception.BusinessException

Migration contract to new template.

参数:

address - operator account address

ksPassword - super account key store password

contractName - contract name

newTemplateName - new template name

返回:

contract hash

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

findByHash

public com.alibaba.fastjson.JSONObject findByHash(java.lang.String hash)
                                           throws cn.tdchain.cb.exception.BusinessException

Find contract by hash.

参数:

hash - contract hash

返回:

contract data

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

findStateByHash

public cn.tdchain.cb.domain.ContractState findStateByHash(java.lang.String hash)
                                                   throws cn.tdchain.cb.exception.BusinessException

Find contract state by hash.

参数:

hash - contract state hash

返回:

contract state data

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

findExByHash

public com.alibaba.fastjson.JSONObject findExByHash(java.lang.String hash)
                                             throws cn.tdchain.cb.exception.BusinessException

Find contract and state by contract hash.

参数:

hash - contract hash

返回:

contract and state data

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

findByName

public com.alibaba.fastjson.JSONObject findByName(java.lang.String contractName)
                                           throws cn.tdchain.cb.exception.BusinessException

Find contract by name.

参数:

contractName - contract name

返回:

contract data

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

queryContractHistory

public java.util.List<com.alibaba.fastjson.JSONObject> queryContractHistory(java.lang.String contractName)
                                                                     throws cn.tdchain.cb.exception.BusinessException

Query contract history(up to 20 records).

参数:

contractName - contract name

返回:

contract data

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

queryContractStateHistory

public java.util.List<com.alibaba.fastjson.JSONObject> queryContractStateHistory(java.lang.String contractName)
                                                                          throws cn.tdchain.cb.exception.BusinessException

Query contract state history(up to 20 records).

参数:

contractName - contract name

返回:

contract state data

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

queryContractAttr

public java.lang.String queryContractAttr(java.lang.String csHash,
                                          java.lang.String attributeName)
                                   throws cn.tdchain.cb.exception.BusinessException

Query contract attribute value from contract state.

参数:

csHash - contract state hash(include history record)

attributeName - attribute name in contract codes

返回:

attribute value

抛出:

cn.tdchain.cb.exception.BusinessException - business exception

queryContractLatestAttr

public java.lang.String queryContractLatestAttr(java.lang.String contractName,
                                                java.lang.String attributeName)
                                         throws cn.tdchain.cb.exception.BusinessException

Query contract attribute latest value from contract state.

参数:

contractName - contract name

attributeName - attribute name

返回:

attribute value

抛出:

cn.tdchain.cb.exception.BusinessException - business exception