合约 API 列表

最近更新时间：2022-10-17 15:04:36

我的收藏

本页目录：

ChainMaker Rust 语言版本智能合约有丰富的 API 接口，供用户在撰写智能合约的时候与链进行交互，代码实现详情可以参考API 接口代码实现。
从逻辑方面划分，可将 API 划分为以下类型：
交易信息提取
接口
说明
get_creator_org_id(&self) -> String 
获取合约创建者所属组织 ID
get_creator_role(&self) -> String 
获取合约创建者角色
get_creator_pub_key(&self) -> String
获取合约创建者公钥
get_sender_org_id(&self) -> String 
获取交易发起者所属组织 ID
get_sender_role(&self) -> String 
获取交易发起者角色
get_tx_id(&self) -> String
获取交易 ID
get_sender_pub_key(&self) -> String  
获取交易发起者公钥
get_block_height(&self) -> u64 
获取当前区块高度
账本交互
接口
说明
get_state(&self, key: &str, field: &str) -> Result<Vec<u8>, result_code>
获取合约账户信息。该接口可从链上获取类别 “key” 下属性名为 “field” 的状态信息。
get_state_from_key(&self, key: &str) -> Result<Vec<u8>, result_code>
获取合约账户信息。该接口可以从链上获取类别为 key 的状态信息
put_state(&self, key: &str, field: &str, value: &[u8]) -> result_code
写入合约账户信息。该接口可把类别 “key” 下属性名为 “filed” 的状态更新到链上。更新成功返回 0，失败则返回 1。
put_state_from_key(&self, key: &str, value: &[u8]) -> result_code
写入合约账户信息。
delete_state(&self, key: &str, field: &str) -> result_code
删除合约账户信息。该接口可把类别 “key” 下属性名为 “name” 的状态从链上删除。
delete_state_from_key(&self, key: &str) -> result_code;
删除合约账户信息。该接口可把类别 “key” 下属性名为 “name” 的状态从链上删除。
call_contract(&self, contract_name: &str, method: &str, param: EasyCodec) -> Result<Vec<u8>, result_code>;
跨合约调用。
参数处理
接口
说明
args(&self) -> &EasyCodec
该接口调用 getArgsMap() 接口，把 json 格式的数据反序列化，并将解析出的数据返还给用户。
arg(&self, key: &str) -> Result<Vec<u8>, String>
该接口可返回属性名为 “key” 的参数的属性值（输出格式为Result<Vec<u8>, String>）。
arg_as_utf8_str(&self, key: &str) -> String;
该接口可返回属性名为 “key” 的参数的属性值（输出格式为String）。
其他辅助类
接口
说明
ok(&self, value: &[u8]) -> result_code
该接口可记录用户操作成功的信息，并将操作结果记录到链上。
error(&self, body: &str) -> result_code
该接口可记录用户操作失败的信息，并将操作结果记录到链上。
log(&self, msg: &str)
该接口可记录事件日志。查看方式为在链配置的 log.yml 中，开启 vm:debug 即可看到类似：gasm log>> + msg
emit_event(&mut self, topic: &str, data: &Vec<String>) -> result_code
发送合约事件
new_iterator(&self,start_key: &str,limit_key: &str) -> Result<Box<dyn ResultSet>, result_code>
新建 key 范围迭代器，key 前闭后开，即：startKey <= dbkey < limitKey
new_iterator_with_field(&self, key: &str, start_field: &str, limit_field: &str) -> Result<Box<dyn ResultSet>, result_code>
新建 field 范围迭代器，key 需相同，field 前闭后开，即：key = dbdbkey and startField <= dbfield < limitField
new_iterator_prefix_with_key(&self, key: &str) -> Result<Box<dyn ResultSet>, result_code>
新建指定 key 前缀匹配迭代器，key 需前缀一致，即 dbkey.startWith(key)
new_iterator_prefix_with_key_field(&self, key: &str, field: &str) -> Result<Box<dyn ResultSet>, result_code>
新建指定 field 前缀匹配迭代器，key 需相同，field 前缀一致，即 dbkey = key and dbfield.startWith(field)
﻿

接口	说明
get_creator_org_id(&self) -> String	获取合约创建者所属组织 ID
get_creator_role(&self) -> String	获取合约创建者角色
get_creator_pub_key(&self) -> String	获取合约创建者公钥
get_sender_org_id(&self) -> String	获取交易发起者所属组织 ID
get_sender_role(&self) -> String	获取交易发起者角色
get_tx_id(&self) -> String	获取交易 ID
get_sender_pub_key(&self) -> String	获取交易发起者公钥
get_block_height(&self) -> u64	获取当前区块高度

接口	说明
get_state(&self, key: &str, field: &str) -> Result<Vec<u8>, result_code>	获取合约账户信息。该接口可从链上获取类别 “key” 下属性名为 “field” 的状态信息。
get_state_from_key(&self, key: &str) -> Result<Vec<u8>, result_code>	获取合约账户信息。该接口可以从链上获取类别为 key 的状态信息
put_state(&self, key: &str, field: &str, value: &[u8]) -> result_code	写入合约账户信息。该接口可把类别 “key” 下属性名为 “filed” 的状态更新到链上。更新成功返回 0，失败则返回 1。
put_state_from_key(&self, key: &str, value: &[u8]) -> result_code	写入合约账户信息。
delete_state(&self, key: &str, field: &str) -> result_code	删除合约账户信息。该接口可把类别 “key” 下属性名为 “name” 的状态从链上删除。
delete_state_from_key(&self, key: &str) -> result_code;	删除合约账户信息。该接口可把类别 “key” 下属性名为 “name” 的状态从链上删除。
call_contract(&self, contract_name: &str, method: &str, param: EasyCodec) -> Result<Vec<u8>, result_code>;	跨合约调用。

接口	说明
args(&self) -> &EasyCodec	该接口调用 getArgsMap() 接口，把 json 格式的数据反序列化，并将解析出的数据返还给用户。
arg(&self, key: &str) -> Result<Vec<u8>, String>	该接口可返回属性名为 “key” 的参数的属性值（输出格式为Result<Vec<u8>, String>）。
arg_as_utf8_str(&self, key: &str) -> String;	该接口可返回属性名为 “key” 的参数的属性值（输出格式为String）。

接口	说明
ok(&self, value: &[u8]) -> result_code	该接口可记录用户操作成功的信息，并将操作结果记录到链上。
error(&self, body: &str) -> result_code	该接口可记录用户操作失败的信息，并将操作结果记录到链上。
log(&self, msg: &str)	该接口可记录事件日志。查看方式为在链配置的 log.yml 中，开启 vm:debug 即可看到类似：gasm log>> + msg
emit_event(&mut self, topic: &str, data: &Vec<String>) -> result_code	发送合约事件
new_iterator(&self,start_key: &str,limit_key: &str) -> Result<Box<dyn ResultSet>, result_code>	新建 key 范围迭代器，key 前闭后开，即：startKey <= dbkey < limitKey
new_iterator_with_field(&self, key: &str, start_field: &str, limit_field: &str) -> Result<Box<dyn ResultSet>, result_code>	新建 field 范围迭代器，key 需相同，field 前闭后开，即：key = dbdbkey and startField <= dbfield < limitField
new_iterator_prefix_with_key(&self, key: &str) -> Result<Box<dyn ResultSet>, result_code>	新建指定 key 前缀匹配迭代器，key 需前缀一致，即 dbkey.startWith(key)
new_iterator_prefix_with_key_field(&self, key: &str, field: &str) -> Result<Box<dyn ResultSet>, result_code>	新建指定 field 前缀匹配迭代器，key 需相同，field 前缀一致，即 dbkey = key and dbfield.startWith(field)