本文档汇总了合约平台支持的所有 JS API,并对接口调用的返回值予以说明。具体接口信息参见相关接口文档。
环境接口
| 接口 | 描述 |
|---|---|
| Chain | 环境实例初始化 |
账户接口
| 接口 | 描述 |
|---|---|
| CreateAccount | 创建账户 |
| TransferBalance | 转账 |
| SetRecoverkey | 设置恢复公钥 |
| PreResetPubKey | 预重置公钥 |
| ResetPubKey | 重置公钥 |
| UpdateAuthMap | 更新权重 |
合约接口
| 接口 | 描述 |
|---|---|
| contract | 构造合约实例 |
| new | 部署合约 |
| 自定义合约方法名 | 调用合约 |
| update | 升级合约 |
查询接口
| 接口 | 描述 |
|---|---|
| QueryBlockHeader | 查询区块头 |
| QueryLastBlock | 查询最后一个区块 |
| QueryBlock | 查询指定的区块 |
| QueryTransaction | 查询交易 |
| QueryTransactionReceipt | 查询收据 |
| QueryAccount | 查询账户 |
| QueryContract | 查询合约账户 |
本地执行接口
| 接口 | 描述 |
|---|---|
| LocalTransaction | 本地执行普通交易 |
| 合约相关操作方法 | 本地执行合约相关交易 |
原生存证接口
| 接口 | 描述 |
|---|---|
| NativeDepositData | 在合约链上对目标数据进行存证。 |
事件接口
| 接口 | 描述 |
|---|---|
| event.account | 订阅账户事件 |
| accountEvent.close | 取消订阅账户事件 |
| event.contract | 订阅合约事件 |
| contractEvent.close | 取消订阅合约事件 |
| event.topic | 订阅主题事件 |
| topicEvent.close | 取消订阅主题事件 |
| event.block | 订阅区块事件 |
| blockEvent.close | 取消订阅区块事件 |
| 订阅合约自定义事件 | 完成合约内自定义事件的订阅 |
辅助工具类接口
| 接口 | 描述 |
|---|---|
| getHash | 对给定字符串计算 hash |
| toDecimal | 将十六进制转换成十进制 |
| toUtf8 | 将十六进制字符串转换成 utf8 字符串 |
| getKeyInfo | 获取账户信息 |
返回值
JS SDK 多数接口都以相同的回调方式返回结果,对于合约相关接口,结果返回方式稍有不同。
- 普通接口返回值
| 参数 | 类型 | 说明 |
|---|---|---|
| err | string | 使用的账户名,用此账户来创建新账户 |
| data | object | 交易回执的结果 |
- 合约部署和调用接口返回值
| 参数 | 类型 | 说明 |
|---|---|---|
| err | string | 错误信息,如果为 undefined,则说明无错误 |
| output | 不确定 | 如果是合约部署,此字段为合约的 bytecode;如果是合约调用此字段,则与合约方法返回值类型相同 |
| data | object | 交易回执的结果 |
以上 data 字段内容根据不同的接口返回不同内容,具体请查看接口返回值。
该文章对您有帮助吗?