SDK:BUMO JAVA SDK

区块链 同时被 3 个专栏收录
951 篇文章 3 订阅
38 篇文章 0 订阅
37 篇文章 6 订阅

BUMO JAVA SDK

概述

本文档详细说明Bumo Java SDK常用接口文档, 使开发者更方便地操作和查询BU区块链。

包引入

JDK要求8或更高版本。

方式一 在项目中添加Maven依赖

需要以下两步来完成,下面以2.0.2为例说明。

  1. 首先在Maven的配置文件中添加BUMO的以下远程仓库
<repository>
    <id>pubnexus</id>                
    <url>http://maven.bumo.io/content/groups/public/</url>
    <releases>
        <enabled>true</enabled>
    </releases>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>
  1. 在pom.xml的配置文件中添加相应版本的依赖包
<dependency>
  <groupId>io.bumo</groupId>
  <artifactId>bumo-sdk</artifactId>
  <version>2.0.2</version>
</dependency>

方式二 在项目中添加jar依赖包

  1. 下载BUMO的java SDK包
  2. 解压缩bumo-sdk-java-{版本号}.zip包。
  3. 将bumo-sdk-{版本号}.jar及其依赖包引入到项目中。

请求参数与响应数据格式

本章节将详细介绍请求参数与响应数据的格式。

请求参数

接口的请求参数的类名,是服务名 + 方法名 + Request,比如: 账户服务下的getInfo接口的请求参数格式是AccountGetInfoRequest。

请求参数的成员,是各个接口的入参的成员。例如:账户服务下的getInfo接口的入参成员是address,那么该接口的请求参数的完整结构如下:

Class AccountGetInfoRequest {
    String address;
}

响应数据

接口的响应数据的类名,是服务名 + 方法名 + Response,比如:账户服务下的getNonce接口的响应数据格式是AccountGetNonceResponse

响应数据的成员,包括错误码、错误描述和返回结果,比如资产服务下的getNonce接口的响应数据的成员如下:

Class AccountGetNonceResponse {
    Integer errorCode;
    String errorDesc;
    AccountGetNonceResult result;
}

说明:

  • errorCode: 错误码。0表示无错误,大于0表示有错误

  • errorDesc: 错误描述。

  • result: 返回结果。一个结构体,其类名是服务名 + 方法名 + Result,其成员是各个接口返回值的成员,例如:账户服务下的getNonce接口的结果类名是AccountGetNonceResult,成员有nonce, 完整结构如下:

Class AccountGetNonceResult {
    Long nonce;
}

使用方法

这里介绍SDK的使用流程,首先需要生成SDK实现,然后调用相应服务的接口,其中服务包括账户服务资产服务合约服务交易服务区块服务,接口按使用分类分为生成公私钥地址有效性校验查询广播交易相关接口。

生成SDK实例

调用SDK的接口getInstance来实现

简单配置

使用如下:

String url = "http://seed1.bumotest.io";
SDK sdk = SDK.getInstance(url);

超时配置

使用如下:

SDKConfigure sdkConfigure = new SDKConfigure();
sdkConfigure.setHttpConnectTimeOut(5000);
sdkConfigure.setHttpReadTimeOut(5000);
sdkConfigure.setUrl("http://seed1.bumotest.io:26002");
sdk = SDK.getInstance(sdkConfigure);

生成公私钥地址

此接口生成BU区块链账户的公钥、私钥和地址,直接调用Keypair.generator接口即可,具体调用如下:

Keypair keypair = Keypair.generator();
System.out.println(keypair.getPrivateKey());
System.out.println(keypair.getPublicKey());
System.out.println(keypair.getAddress());

有效性校验

此接口用于校验信息的有效性的,直接调用相应的接口即可,比如,校验账户地址有效性,具体调用如下:

// 初始化请求参数
String address = "buQemmMwmRQY1JkcU7w3nhruoX5N3j6C29uo";
AccountCheckValidRequest request = new AccountCheckValidRequest();
request.setAddress(address);

// 调用checkValid接口
AccountCheckValidResponse response = 
sdk.getAccountService().checkValid(request);
if(0 == response.getErrorCode()) {
    System.out.println(response.getResult().isValid());
} else {
    System.out.println("error: " + response.getErrorDesc());
}

查询

此接口用于查询BU区块链上的数据,直接调用相应的接口即可,比如,查询账户信息,具体调用如下:

// 初始化请求参数
String accountAddress = "buQemmMwmRQY1JkcU7w3nhruo%X5N3j6C29uo";
AccountGetInfoRequest request = new AccountGetInfoRequest();
request.setAddress(accountAddress);

// 调用getInfo接口
AccountGetInfoResponse response =  sdk.getAccountService().getInfo(request);
if (response.getErrorCode() == 0) {
    AccountGetInfoResult result = response.getResult();
    System.out.println(JSON.toJSONString(result,true));
}
else {
    System.out.println("error: " + response.getErrorDesc());
}

广播交易

广播交易是指通过广播的方式发起交易。广播交易包括以下步骤:

  1. 获取账户nonce值
  2. 构建操作
  3. 序列化交易
  4. 签名交易
  5. 提交交易

获取账户nonce值

开发者可自己维护各个账户nonce,在提交完一个交易后,自动为nonce值递增1,这样可以在短时间内发送多笔交易,否则,必须等上一个交易执行完成后,账户的nonce值才会加1。接口详情请见getNonce,调用如下:

// 初始化请求参数
String senderAddress = "buQnnUEBREw2hB6pWHGPzwanX7d28xk6KVcp";
AccountGetNonceRequest getNonceRequest = new AccountGetNonceRequest();
getNonceRequest.setAddress(senderAddress);

// 调用getNonce接口
AccountGetNonceResponse getNonceResponse =  sdk.getAccountService().getNonce(getNonceRequest);

// 赋值nonce
if (getNonceResponse.getErrorCode() == 0) {
   AccountGetNonceResult result = getNonceResponse.getResult();
   System.out.println("nonce: " + result.getNonce());
}
else {
    System.out.println("error" + getNonceResponse.getErrorDesc());
}

构建操作

这里的操作是指在交易中做的一些动作,便于序列化交易和评估费用。操作详情请见操作。例如,构建发送BU操作(BUSendOperation),接口调用如下:

String senderAddress = "buQnnUEBREw2hB6pWHGPzwanX7d28xk6KVcp";
String destAddress = "buQsurH1M4rjLkfjzkxR9KXJ6jSu2r9xBNEw";
Long buAmount = ToBaseUnit.BU2MO("10.9");

BUSendOperation operation = new BUSendOperation();
operation.setSourceAddress(senderAddress);
operation.setDestAddress(destAddress);
operation.setAmount(buAmount);

序列化交易

该接口用于序列化交易,并生成交易Blob串,便于网络传输。其中nonce和operation是上面接口得到的,接口详情请见buildBlob,调用如下:

// 初始化变量
String senderAddress = "buQnnUEBREw2hB6pWHGPzwanX7d28xk6KVcp";
Long gasPrice = 1000L;
Long feeLimit = ToBaseUnit.BU2MO("0.01");

// 初始化请求参数
TransactionBuildBlobRequest buildBlobRequest = new TransactionBuildBlobRequest();
buildBlobRequest.setSourceAddress(senderAddress);
buildBlobRequest.setNonce(nonce + 1);
buildBlobRequest.setFeeLimit(feeLimit);
buildBlobRequest.setGasPrice(gasPrice);
buildBlobRequest.addOperation(operation);

// 调用buildBlob接口
TransactionBuildBlobResponse buildBlobResponse = sdk.getTransactionService().buildBlob(buildBlobRequest);
if (buildBlobResponse.getErrorCode() == 0) {
    TransactionBuildBlobResult result = buildBlobResponse.getResult();
    System.out.println("txHash: " + result.getHash() + ", blob: " + result.getTransactionBlob());
} else {
    System.out.println("error: " + buildBlobResponse.getErrorDesc());
}

签名交易

该接口用于交易发起者使用其账户私钥对交易进行签名。其中transactionBlob是上面接口得到的,接口详情请见sign,调用如下:

// 初始化请求参数
String senderPrivateKey = "privbyQCRp7DLqKtRFCqKQJr81TurTqG6UKXMMtGAmPG3abcM9XHjWvq";
String []signerPrivateKeyArr = {senderPrivateKey};
TransactionSignRequest signRequest = new TransactionSignRequest();
signRequest.setBlob(transactionBlob);
for (int i = 0; i < signerPrivateKeyArr.length; i++) {
    signRequest.addPrivateKey(signerPrivateKeyArr[i]);
}

// 调用sign接口
TransactionSignResponse signResponse = sdk.getTransactionService().sign(signRequest);
if (signResponse.getErrorCode() == 0) {
    TransactionSignResult result = signResponse.getResult();
    System.out.println(JSON.toJSONString(result, true));
} else {
    System.out.println("error: " + signResponse.getErrorDesc());
}

提交交易

该接口用于向BU区块链发送交易请求,触发交易的执行。其中transactionBlob和signResult是上面接口得到的,接口详情请见submit,调用如下:

// 初始化请求参数
TransactionSubmitRequest submitRequest = new TransactionSubmitRequest();
submitRequest.setTransactionBlob(transactionBlob);
submitRequest.setSignatures(signResult.getSignatures());

// 调用submit接口
TransactionSubmitResponse response = sdk.getTransactionService().submit(submitRequest);
if (0 == response.getErrorCode()) {
    System.out.println("交易广播成功,hash=" + response.getResult().getHash());
} else {
    System.out.println("error: " + response.getErrorDesc());
}

交易服务

交易服务提供交易相关的接口,目前有5个接口:buildBlob、 evaluateFee、 sign、 submit、 getInfo

buildBlob

注意: 调用buildBlob之前需要构建一些操作,详情见操作

  • 接口说明

    该接口用于序列化交易,生成交易Blob串,便于网络传输

  • 调用方法

TransactionBuildBlobResponse buildBlob(TransactionBuildBlobRequest);

  • 请求参数

    参数类型描述
    sourceAddressString必填,发起该操作的源账户地址
    nonceLong必填,待发起的交易序列号,函数里+1,大小限制[1, Long.MAX_VALUE]
    gasPriceLong必填,交易燃料单价,单位MO,1 BU = 10^8 MO,大小限制[1000, Long.MAX_VALUE]
    feeLimitLong必填,交易要求的最低的手续费,单位MO,1 BU = 10^8 MO,大小限制[1, Long.MAX_VALUE]
    operationBaseOperation[]必填,待提交的操作列表,不能为空
    ceilLedgerSeqlong选填,距离当前区块高度指定差值的区块内执行的限制,当区块超出当时区块高度与所设差值的和后,交易执行失败。必须大于等于0,是0时不限制
    metadataString选填,备注
  • 响应数据

    参数类型描述
    transactionBlobStringTransaction序列化后的16进制字符串
    hashString交易hash
  • 错误码

    异常错误码描述
    INVALID_SOURCEADDRESS_ERROR11002Invalid sourceAddress
    INVALID_NONCE_ERROR11048Nonce must be between 1 and Long.MAX_VALUE
    INVALID_DESTADDRESS_ERROR11003Invalid destAddress
    INVALID_INITBALANCE_ERROR11004InitBalance must be between 1 and Long.MAX_VALUE
    SOURCEADDRESS_EQUAL_DESTADDRESS_ERROR11005SourceAddress cannot be equal to destAddress
    INVALID_ISSUE_AMMOUNT_ERROR11008AssetAmount this will be issued must be between 1 and Long.MAX_VALUE
    INVALID_DATAKEY_ERROR11011The length of key must be between 1 and 1024
    INVALID_DATAVALUE_ERROR11012The length of value must be between 0 and 256000
    INVALID_DATAVERSION_ERROR11013The version must be equal to or greater than 0
    INVALID_MASTERWEIGHT _ERROR11015MasterWeight must be between 0 and (Integer.MAX_VALUE * 2L + 1)
    INVALID_SIGNER_ADDRESS_ERROR11016Invalid signer address
    INVALID_SIGNER_WEIGHT _ERROR11017Signer weight must be between 0 and (Integer.MAX_VALUE * 2L + 1)
    INVALID_TX_THRESHOLD_ERROR11018TxThreshold must be between 0 and Long.MAX_VALUE
    INVALID_OPERATION_TYPE_ERROR11019Operation type must be between 1 and 100
    INVALID_TYPE_THRESHOLD_ERROR11020TypeThreshold must be between 0 and Long.MAX_VALUE
    INVALID_ASSET_CODE _ERROR11023The length of key must be between 1 and 64
    INVALID_ASSET_AMOUNT_ERROR11024AssetAmount must be between 0 and Long.MAX_VALUE
    INVALID_BU_AMOUNT_ERROR11026BuAmount must be between 0 and Long.MAX_VALUE
    INVALID_ISSUER_ADDRESS_ERROR11027Invalid issuer address
    NO_SUCH_TOKEN_ERROR11030No such token
    INVALID_TOKEN_NAME_ERROR11031The length of token name must be between 1 and 1024
    INVALID_TOKEN_SYMBOL_ERROR11032The length of symbol must be between 1 and 1024
    INVALID_TOKEN_DECIMALS_ERROR11033Decimals must be between 0 and 8
    INVALID_TOKEN_TOTALSUPPLY_ERROR11034TotalSupply must be between 1 and Long.MAX_VALUE
    INVALID_TOKENOWNER_ERRPR11035Invalid token owner
    INVALID_CONTRACTADDRESS_ERROR11037Invalid contract address
    CONTRACTADDRESS_NOT_CONTRACTACCOUNT_ERROR11038ContractAddress is not a contract account
    INVALID_TOKEN_AMOUNT_ERROR11039Token amount must be between 1 and Long.MAX_VALUE
    SOURCEADDRESS_EQUAL_CONTRACTADDRESS_ERROR11040SourceAddress cannot be equal to contractAddress
    INVALID_FROMADDRESS_ERROR11041Invalid fromAddress
    FROMADDRESS_EQUAL_DESTADDRESS_ERROR11042FromAddress cannot be equal to destAddress
    INVALID_SPENDER_ERROR11043Invalid spender
    PAYLOAD_EMPTY_ERROR11044Payload cannot be empty
    INVALID_LOG_TOPIC_ERROR11045The length of a log topic must be between 1 and 128
    INVALID_LOG_DATA_ERROR11046The length of one piece of log data must be between 1 and1024
    INVALID_CONTRACT_TYPE_ERROR11047Type must be equal or bigger than 0
    INVALID_NONCE_ERROR11048Nonce must be between 1 and Long.MAX_VALUE
    INVALID_ GASPRICE_ERROR11049GasPrice must be between 1000 and Long.MAX_VALUE
    INVALID_FEELIMIT_ERROR11050FeeLimit must be between 1 and Long.MAX_VALUE
    OPERATIONS_EMPTY_ERROR11051Operations cannot be empty
    INVALID_CEILLEDGERSEQ_ERROR11052CeilLedgerSeq must be equal to or greater than 0
    OPERATIONS_ONE_ERROR11053One of the operations cannot be resolved
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化变量
    String senderAddresss = "buQfnVYgXuMo3rvCEpKA6SfRrDpaz8D8A9Ea";
    String destAddress = "buQsurH1M4rjLkfjzkxR9KXJ6jSu2r9xBNEw";
    Long buAmount = ToBaseUnit.BU2MO("10.9");
    Long gasPrice = 1000L;
    Long feeLimit = ToBaseUnit.BU2MO("0.01");
    Long nonce = 1L;
    
    // 构建sendBU操作
    BUSendOperation operation = new BUSendOperation();
    operation.setSourceAddress(senderAddresss);
    operation.setDestAddress(destAddress);
    operation.setAmount(buAmount);
    
    // 初始化请求参数
    TransactionBuildBlobRequest request = new TransactionBuildBlobRequest();
    request.setSourceAddress(senderAddresss);
    request.setNonce(nonce);
    request.setFeeLimit(feeLimit);
    request.setGasPrice(gasPrice);
    request.addOperation(operation);
    
    // 调用buildBlob接口
    String transactionBlob = null;
    TransactionBuildBlobResponse response = sdk.getTransactionService().buildBlob(request);
    if (response.getErrorCode() == 0) {
       TransactionBuildBlobResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

evaluateFee

  • 接口说明

    该接口实现交易的费用评估。

  • 调用方法

    TransactionEvaluateFeeResponse evaluateFee (TransactionEvaluateFeeRequest);

  • 请求参数

    参数类型描述
    sourceAddressString必填,发起该操作的源账户地址
    nonceLong必填,待发起的交易序列号,大小限制[1, Long.MAX_VALUE]
    operationBaseOperation[]必填,待提交的操作列表,不能为空
    signtureNumberInteger选填,待签名者的数量,默认是1,大小限制[1, Integer.MAX_VALUE]
    ceilLedgerSeqLong选填,距离当前区块高度指定差值的区块内执行的限制,当区块超出当时区块高度与所设差值的和后,交易执行失败。必须大于等于0,是0时不限制
    metadataString选填,备注
  • 响应数据

    参数类型描述
    txsTestTx[]评估交易集
  • 错误码

    异常错误码描述
    INVALID_SOURCEADDRESS_ERROR11002Invalid sourceAddress
    INVALID_NONCE_ERROR11048Nonce must be between 1 and Long.MAX_VALUE
    OPERATIONS_EMPTY_ERROR11051Operations cannot be empty
    OPERATIONS_ONE_ERROR11053One of the operations cannot be resolved
    INVALID_SIGNATURENUMBER_ERROR11054SignagureNumber must be between 1 and Integer.MAX_VALUE
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化变量
    String senderAddresss = "buQnnUEBREw2hB6pWHGPzwanX7d28xk6KVcp";
    String destAddress = "buQfnVYgXuMo3rvCEpKA6SfRrDpaz8D8A9Ea";
    Long buAmount = ToBaseUnit.BU2MO("10.9");
    Long gasPrice = 1000L;
    Long feeLimit = ToBaseUnit.BU2MO("0.01");
    Long nonce = 51L;
    
    // 构建sendBU操作
    BUSendOperation buSendOperation = new BUSendOperation();
    buSendOperation.setSourceAddress(senderAddresss);
    buSendOperation.setDestAddress(destAddress);
    buSendOperation.setAmount(buAmount);
    
    // 初始化评估交易请求参数
    TransactionEvaluateFeeRequest request = new TransactionEvaluateFeeRequest();
    request.addOperation(buSendOperation);
    request.setSourceAddress(senderAddresss);
    request.setNonce(nonce);
    request.setSignatureNumber(1);
    request.setMetadata(HexFormat.byteToHex("evaluate fees".getBytes()));
    
    // 调用evaluateFee接口
    TransactionEvaluateFeeResponse response = sdk.getTransactionService().evaluateFee(request);
    if (response.getErrorCode() == 0) {
       TransactionEvaluateFeeResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

sign

  • 接口说明

    该接口用于实现交易的签名

  • 调用方法

    TransactionSignResponse sign(TransactionSignRequest);

  • 请求参数

    参数类型描述
    blobString必填,待签名的交易Blob
    privateKeysString[]必填,私钥列表
  • 响应数据

    参数类型描述
    signaturesSignature[]签名后的数据列表
  • 错误码

    异常错误码描述
    INVALID_BLOB_ERROR11056Invalid blob
    PRIVATEKEY_NULL_ERROR11057PrivateKeys cannot be empty
    PRIVATEKEY_ONE_ERROR11058One of privateKeys is invalid
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String issuePrivateKey = "privbyQCRp7DLqKtRFCqKQJr81TurTqG6UKXMMtGAmPG3abcM9XHjWvq";
    String []signerPrivateKeyArr = {issuePrivateKey};
    String transactionBlob = "0A246275516E6E5545425245773268423670574847507A77616E5837643238786B364B566370102118C0843D20E8073A56080712246275516E6E5545425245773268423670574847507A77616E5837643238786B364B566370522C0A24627551426A4A443142534A376E7A41627A6454656E416870466A6D7852564545746D78481080A9E08704";
    TransactionSignRequest request = new TransactionSignRequest();
    request.setBlob(transactionBlob);
    for (int i = 0; i < signerPrivateKeyArr.length; i++) {
       request.addPrivateKey(signerPrivateKeyArr[i]);
    }
    TransactionSignResponse response = sdk.getTransactionService().sign(request);
    if(0 == response.getErrorCode()){
       System.out.println(JSON.toJSONString(response.getResult(), true));
    }else{
       System.out.println("error: " + response.getErrorDesc());
    }
    

submit

  • 接口说明

    该接口用于实现交易的提交。

  • 调用方法

    TransactionSubmitResponse submit(TransactionSubmitRequest);

  • 请求参数

    参数类型描述
    blobString必填,交易blob
    signatureSignature[]必填,签名列表
  • 响应数据

    参数类型描述
    hashString交易hash
  • 错误码

    异常错误码描述
    INVALID_BLOB_ERROR11056Invalid blob
    SIGNATURE_EMPTY_ERROR11067The signatures cannot be empty
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String transactionBlob = "0A246275516E6E5545425245773268423670574847507A77616E5837643238786B364B566370102118C0843D20E8073A56080712246275516E6E5545425245773268423670574847507A77616E5837643238786B364B566370522C0A24627551426A4A443142534A376E7A41627A6454656E416870466A6D7852564545746D78481080A9E08704";
    Signature signature = new Signature();
    signature.setSignData("D2B5E3045F2C1B7D363D4F58C1858C30ABBBB0F41E4B2E18AF680553CA9C3689078E215C097086E47A4393BCA715C7A5D2C180D8750F35C6798944F79CC5000A");
    signature.setPublicKey("b0011765082a9352e04678ef38d38046dc01306edef676547456c0c23e270aaed7ffe9e31477");
    TransactionSubmitRequest request = new TransactionSubmitRequest();
    request.setTransactionBlob(transactionBlob);
    request.addSignature(signature);
    
    // 调用submit接口
    TransactionSubmitResponse response = sdk.getTransactionService().submit(request);
    if (0 == response.getErrorCode()) { // 交易提交成功
       System.out.println(JSON.toJSONString(response.getResult(), true));
    } else{
       System.out.println("error: " + response.getErrorDesc());
    }
    

getInfo

  • 接口说明

    该接口用于实现根据交易hash查询交易。

  • 调用方法

    TransactionGetInfoResponse getInfo (TransactionGetInfoRequest);

  • 请求参数

    参数类型描述
    hashString交易hash
  • 响应数据

    参数类型描述
    totalCountLong返回的总交易数
    transactionsTransactionHistory[]交易内容
  • 错误码

    异常错误码描述
    INVALID_HASH_ERROR11055Invalid transaction hash
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String txHash = "1653f54fbba1134f7e35acee49592a7c29384da10f2f629c9a214f6e54747705";
    TransactionGetInfoRequest request = new TransactionGetInfoRequest();
    request.setHash(txHash);
    
    // 调用getInfo接口
    TransactionGetInfoResponse response = sdk.getTransactionService().getInfo(request);
    if (response.getErrorCode() == 0) {
       System.out.println(JSON.toJSONString(response.getResult(), true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

操作

操作是指在交易在要做的事情,在构建操作之前,需要构建操作。目前操作有10种,分别是 AccountActivateOperationAccountSetMetadataOperation、 AccountSetPrivilegeOperation、 AssetIssueOperation、 AssetSendOperation、 BUSendOperation、 ContractCreateOperation、 ContractInvokeByAssetOperation、 ContractInvokeByBUOperation、 LogCreateOperation

BaseOperation

BaseOperation是buildBlob接口中所有操作的基类。

成员变量类型描述
sourceAddressString选填,操作源账户地址
metadataString选填,备注

AccountActivateOperation

  • 功能

    该操作用于激活账户。AccountActivateOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是0.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    destAddressString必填,目标账户地址
    initBalanceLong必填,初始化资产,单位MO,1 BU = 10^8 MO, 大小(0, Long.MAX_VALUE]
    metadataString选填,备注

AccountSetMetadataOperation

  • 功能

    该操作用于设置账户metadata。AccountSetMetadataOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是0.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    keyString必填,metadata的关键词,长度限制[1, 1024]
    valueString必填,metadata的内容,长度限制[0, 256000]
    versionLong选填,metadata的版本
    deleteFlagBoolean选填,是否删除metadata
    metadataString选填,备注

AccountSetPrivilegeOperation

  • 功能

    该操作用于设置账户权限。AccountSetPrivilegeOperation继承于BaseOperation。

  • 费用

    feeLimit目前(2018.07.26)固定是0.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    masterWeightString选填,账户自身权重,大小限制[0, (Integer.MAX_VALUE * 2L + 1)]
    signersSigner[]选填,签名者权重列表
    txThresholdString选填,交易门限,大小限制[0, Long.MAX_VALUE]
    typeThresholdTypeThreshold[]选填,指定类型交易门限
    metadataString选填,备注

AssetIssueOperation

  • 功能

    该操作用于发行资产。AssetIssueOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是50.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    codeString必填,资产编码,长度限制[1, 64]
    assetAmountLong必填,资产发行数量,大小限制[0, Long.MAX_VALUE]
    metadataString选填,备注

AssetSendOperation

注意:若目标账户未激活,必须先调用激活账户操作。

  • 功能

    该操作用于转移资产。AssetSendOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是0.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    destAddressString必填,目标账户地址
    codeString必填,资产编码,长度限制[1, 64]
    issuerString必填,资产发行账户地址
    assetAmountLong必填,资产数量,大小限制[0, Long.MAX_VALUE]
    metadataString选填,备注

BUSendOperation

注意:若目标账户未激活,该操作也可使目标账户激活。

  • 功能

    该操作用于转移BU。BUSendOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是0.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    destAddressString必填,目标账户地址
    buAmountLong必填,资产发行数量,大小限制[0, Long.MAX_VALUE]
    metadataString选填,备注

ContractCreateOperation

  • 功能

    该操作用于创建合约。ContractCreateOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是10.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    initBalanceLong必填,给合约账户的初始化资产,单位MO,1 BU = 10^8 MO, 大小限制[1, Long.MAX_VALUE]
    typeInteger选填,合约的语种,默认是0
    payloadString必填,对应语种的合约代码
    initInputString选填,合约代码中init方法的入参
    metadataString选填,备注

ContractInvokeByAssetOperation

注意:若合约账户不存在,必须先创建合约账户。

  • 功能

    该操作用于转移资产并触发合约。ContractInvokeByAssetOperation继承于BaseOperation。

  • 费用

    FeeLimit要根据合约中执行交易来做添加手续费,首先发起交易手续费目前(2018.07.26)是0.01BU,然后合约中的交易也需要交易发起者添加相应交易的手续费。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    contractAddressString必填,合约账户地址
    codeString选填,资产编码,长度限制[0, 64];当为空时,仅触发合约;
    issuerString选填,资产发行账户地址,当null时,仅触发合约
    assetAmountLong选填,资产数量,大小限制[0, Long.MAX_VALUE],当是0时,仅触发合约
    inputString选填,待触发的合约的main()入参
    metadataString选填,备注

ContractInvokeByBUOperation

注意:若目标账户非合约账户且未激活,该操作也可使目标账户激活。

  • 功能

    该操作用于转移BU并触发合约。ContractInvokeByBUOperation继承于BaseOperation。

  • 费用

    FeeLimit要根据合约中执行交易来做添加手续费,首先发起交易手续费目前(2018.07.26)是0.01BU,然后合约中的交易也需要交易发起者添加相应交易的手续费。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    contractAddressString必填,合约账户地址
    buAmountLong选填,资产发行数量,大小限制[0, Long.MAX_VALUE],当0时仅触发合约
    inputString选填,待触发的合约的main()入参
    metadataString选填,备注

LogCreateOperation

  • 功能

    该操作用于记录日志。LogCreateOperation继承于BaseOperation。

  • 费用

    FeeLimit目前(2018.07.26)固定是0.01 BU。

  • 成员

    成员变量类型描述
    sourceAddressString选填,操作源账户地址
    topicString必填,日志主题,长度限制[1, 128]
    datasList必填,日志内容,每个字符串长度限制[1, 1024]
    metadataString选填,备注

账户服务

账户服务提供账户相关的接口,包括6个接口:checkValid、 getInfo、 getNonce、 getBalancegetAssets、 getMetadata

checkValid

  • 接口说明

    该接口用于检查区块链账户地址的有效性

  • 调用方法

    AccounCheckValidResponse checkValid(AccountCheckValidRequest)

  • 请求参数

    参数类型描述
    addressString必填,待检查的区块链账户地址
  • 响应数据

    参数类型描述
    isValidBoolean是否有效
  • 错误码

    异常错误码描述
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String address = "buQemmMwmRQY1JkcU7w3nhruoX5N3j6C29uo";
    AccountCheckValidRequest request = new AccountCheckValidRequest();
    request.setAddress(address);
    
    // 调用checkValid
    AccountCheckValidResponse response = sdk.getAccountService().checkValid(request);
    if(0 == response.getErrorCode()) {
       System.out.println(response.getResult().isValid());
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getInfo

  • 接口说明

    该接口用于获取指定的账户信息

  • 调用方法

    AccountGetInfoResponse GetInfo(AccountGetInfoRequest);

  • 请求参数

    参数类型描述
    addressString必填,待检查的区块链账户地址
  • 响应数据

    参数类型描述
    addressString账户地址
    balanceLong账户余额,单位MO,1 BU = 10^8 MO, 必须大于0
    nonceLong账户交易序列号,必须大于0
    privPriv账户权限
  • 错误码

    异常错误码描述
    INVALID_ADDRESS_ERROR11006Invalid address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String accountAddress = "buQemmMwmRQY1JkcU7w3nhruoX5N3j6C29uo";
    AccountGetInfoRequest request = new AccountGetInfoRequest();
    request.setAddress(accountAddress);
    
    // 调用getInfo接口
    AccountGetInfoResponse response =  sdk.getAccountService().getInfo(request);
    if (response.getErrorCode() == 0) {
       AccountGetInfoResult result = response.getResult();
       System.out.println("账户信息: \n" + JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getNonce

  • 接口说明

    该接口用于获取指定账户的nonce值

  • 调用方法

    AccountGetNonceResponse getNonce(AccountGetNonceRequest);

  • 请求参数

    参数类型描述
    addressString必填,待查询的区块链账户地址
  • 响应数据

    参数类型描述
    nonceLong账户交易序列号
  • 错误码

    异常错误码描述
    INVALID_ADDRESS_ERROR11006Invalid address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String accountAddress = "buQswSaKDACkrFsnP1wcVsLAUzXQsemauEjf";
    AccountGetNonceRequest request = new AccountGetNonceRequest();
    request.setAddress(accountAddress);
    
    // 调用getNonce接口
    AccountGetNonceResponse response = sdk.getAccountService().getNonce(request);
    if(0 == response.getErrorCode()){
       System.out.println("账户nonce:" + response.getResult().getNonce());
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getBalance

  • 接口说明

    该接口用于获取指定账户的BU的余额

  • 调用方法

    AccountGetBalanceResponse getBalance(AccountGetBalanceRequest);

  • 请求参数

    参数类型描述
    addressString必填,待查询的区块链账户地址
  • 响应数据

    参数类型描述
    balanceLongBU的余额,单位MO,1 BU = 10^8 MO
  • 错误码

    异常错误码描述
    INVALID_ADDRESS_ERROR11006Invalid address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String accountAddress = "buQswSaKDACkrFsnP1wcVsLAUzXQsemauEjf";
    AccountGetBalanceRequest request = new AccountGetBalanceRequest();
    request.setAddress(accountAddress);
    
    // 调用getBalance接口
    AccountGetBalanceResponse response = sdk.getAccountService().getBalance(request);
    if(0 == response.getErrorCode()){
       AccountGetBalanceResult result = response.getResult();
       System.out.println("BU余额:" + ToBaseUnit.MO2BU(result.getBalance().toString()) + " BU");
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getAssets

  • 接口说明

    该接口用于获取指定账户的所有资产信息

  • 调用方法

    AccountGetAssets getAssets(AccountGetAssetsRequest);

  • 请求参数

    参数类型描述
    addressString必填,待查询的账户地址
  • 响应数据

    参数类型描述
    assetAssetInfo[]账户资产
  • 错误码

    异常错误码描述
    INVALID_ADDRESS_ERROR11006Invalid address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    NO_ASSET_ERROR11009The account does not have the asset
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    AccountGetAssetsRequest request = new AccountGetAssetsRequest();
    request.setAddress("buQsurH1M4rjLkfjzkxR9KXJ6jSu2r9xBNEw");
    
    // 调用getAssets接口
    AccountGetAssetsResponse response = sdk.getAccountService().getAssets(request);
    if (response.getErrorCode() == 0) {
       AccountGetAssetsResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getMetadata

  • 接口说明

    该接口用于获取指定账户的metadata信息

  • 调用方法

    AccountGetMetadataResponse getMetadata(AccountGetMetadataRequest);

  • 请求参数

    参数类型描述
    addressString必填,待查询的账户地址
    keyString选填,metadata关键字,长度限制[1, 1024]
  • 响应数据

    参数类型描述
    metadataMetadataInfo账户
  • 错误码

    异常错误码描述
    INVALID_ADDRESS_ERROR11006Invalid address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    NO_METADATA_ERROR11010The account does not have the metadata
    INVALID_DATAKEY_ERROR11011The length of key must be between 1 and 1024
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    String accountAddress = "buQsurH1M4rjLkfjzkxR9KXJ6jSu2r9xBNEw";
    AccountGetMetadataRequest request = new AccountGetMetadataRequest();
    request.setAddress(accountAddress);
    request.setKey("20180704");
    
    // 调用getMetadata接口
    AccountGetMetadataResponse response =  sdk.getAccountService().getMetadata(request);
    if (response.getErrorCode() == 0) {
       AccountGetMetadataResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

资产服务

遵循ATP1.0协议,账户服务提供资产相关的接口,目前有1个接口:getInfo

getInfo

  • 接口说明

    该接口用于获取指定账户的指定资产信息

  • 调用方法

    AssetGetInfoResponse getInfo(AssetGetInfoRequest);

  • 请求参数

    参数类型描述
    addressString必填,待查询的账户地址
    codeString必填,资产编码,长度限制[1, 64]
    issuerString必填,资产发行账户地址
  • 响应数据

    参数类型描述
    assetAssetInfo[]账户资产
  • 错误码

    异常错误码描述
    INVALID_ADDRESS_ERROR11006Invalid address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    INVALID_ASSET_CODE_ERROR11023The length of asset code must be between 1 and 64
    INVALID_ISSUER_ADDRESS_ERROR11027Invalid issuer address
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    AssetGetInfoRequest request = new AssetGetInfoRequest();
    request.setAddress("buQsurH1M4rjLkfjzkxR9KXJ6jSu2r9xBNEw");
    request.setIssuer("buQBjJD1BSJ7nzAbzdTenAhpFjmxRVEEtmxH");
    request.setCode("HNC");
    
    // 调用getInfo消息
    AssetGetInfoResponse response = sdk.getAssetService().getInfo(request);
    if (response.getErrorCode() == 0) {
       AssetGetInfoResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

合约服务

合约服务提供合约相关的接口,目前有4个接口:checkValid、 getInfo、 getAddress、 call

checkValid

  • 接口说明

    该接口用于检测合约账户的有效性

  • 调用方法

    ContractCheckValidResponse checkValid(ContractCheckValidRequest)

  • 请求参数

    参数类型描述
    contractAddressString待检测的合约账户地址
  • 响应数据

    参数类型描述
    isValidBoolean是否有效
  • 错误码

    异常错误码描述
    INVALID_CONTRACTADDRESS_ERROR11037Invalid contract address
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONTRACTADDRESS_NOT_CONTRACTACCOUNT_ERROR11038ContractAddress is not a contract account
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    ContractCheckValidRequest request = new ContractCheckValidRequest();
    request.setContractAddress("buQfnVYgXuMo3rvCEpKA6SfRrDpaz8D8A9Ea");
    
    // 调用checkValid接口
    ContractCheckValidResponse response = sdk.getContractService().checkValid(request);
    if (response.getErrorCode() == 0) {
       ContractCheckValidResult result = response.getResult();
       System.out.println(result.getValid());
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getInfo

  • 接口说明

    该接口用于查询合约代码

  • 调用方法

    ContractGetInfoResponse getInfo (ContractGetInfoRequest);

  • 请求参数

    参数类型描述
    contractAddressString待查询的合约账户地址
  • 响应数据

    参数类型描述
    contractContractInfo合约信息
  • 错误码

    异常错误码描述
    INVALID_CONTRACTADDRESS_ERROR11037Invalid contract address
    CONTRACTADDRESS_NOT_CONTRACTACCOUNT_ERROR11038contractAddress is not a contract account
    NO_SUCH_TOKEN_ERROR11030No such token
    GET_TOKEN_INFO_ERROR11066Failed to get token info
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    ContractGetInfoRequest request = new ContractGetInfoRequest();
    request.setContractAddress("buQfnVYgXuMo3rvCEpKA6SfRrDpaz8D8A9Ea");
    
    // 调用getInfo接口
    ContractGetInfoResponse response = sdk.getContractService().getInfo(request);
    if (response.getErrorCode() == 0) {
       System.out.println(JSON.toJSONString(response.getResult(), true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getAddress

  • 接口说明

    该接口用于查询合约地址

  • 调用方法

    ContractGetAddressResponse getInfo (ContractGetAddressRequest);

  • 请求参数

    参数类型描述
    hashString创建合约交易的hash
  • 响应数据

    参数类型描述
    contractAddressListList<ContractAddressInfo>合约地址列表
  • 错误码

    异常错误码描述
    INVALID_HASH_ERROR11055Invalid transaction hash
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    ContractGetAddressRequest request = new ContractGetAddressRequest();
    request.setHash("44246c5ba1b8b835a5cbc29bdc9454cdb9a9d049870e41227f2dcfbcf7a07689");
    
    // 调用getAddress接口
    ContractGetAddressResponse response = sdk.getContractService().getAddress(request);
    if (response.getErrorCode() == 0) {
    System.out.println(JSON.toJSONString(response.getResult(), true));
    } else {
    System.out.println("error: " + response.getErrorDesc());
    }
    

call

  • 接口说明

    该接口用于调试合约代码

  • 调用方法

    ContractCallesponse call(ContractCallRequest);

  • 请求参数

    参数类型描述
    sourceAddressString选填,合约触发账户地址
    contractAddressString选填,合约账户地址,与code不能同时为空
    codeString选填,合约代码,与contractAddress不能同时为空,长度限制[1, 64]
    inputString选填,合约入参
    contractBalanceString选填,赋予合约的初始 BU 余额, 单位MO,1 BU = 10^8 MO, 大小限制[1, Long.MAX_VALUE]
    optTypeInteger必填,0: 调用合约的读写接口 init, 1: 调用合约的读写接口 main, 2 :调用只读接口 query
    feeLimitLong交易要求的最低手续费, 大小限制[1, Long.MAX_VALUE]
    gasPriceLong交易燃料单价,大小限制[1000, Long.MAX_VALUE]
  • 响应数据

    参数类型描述
    logsJSONObject日志信息
    queryRetsJSONArray查询结果集
    statContractStat合约资源占用信息
    txsTransactionEnvs[]交易集
  • 错误码

    异常错误码描述
    INVALID_SOURCEADDRESS_ERROR11002Invalid sourceAddress
    INVALID_CONTRACTADDRESS_ERROR11037Invalid contract address
    CONTRACTADDRESS_CODE_BOTH_NULL_ERROR11063ContractAddress and code cannot be empty at the same time
    INVALID_OPTTYPE_ERROR11064OptType must be between 0 and 2
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    ContractCallRequest request = new ContractCallRequest();
    request.setCode("\"use strict\";log(undefined);function query() { getBalance(thisAddress); }");
    request.setFeeLimit(1000000000L);
    request.setOptType(2);
    
    // 调用call接口
    ContractCallResponse response = sdk.getContractService().call(request);
    if (response.getErrorCode() == 0) {
       ContractCallResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

区块服务

区块服务主要是区块相关的接口,目前有11个接口:getNumber、 checkStatus、 getTransactions、 getInfo、 getLatestInfo、 getValidators、 getLatestValidators、 getReward、 getLatestReward、 getFees、 getLatestFees

getNumber

  • 接口说明

    该接口用于查询最新的区块高度。

  • 调用方法

    BlockGetNumberResponse getNumber();

  • 响应数据

    参数类型描述
    blockNumberLong最新的区块高度,对应底层字段seq
  • 错误码

    异常错误码描述
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 调用getNumber接口
    BlockGetNumberResponse response = sdk.getBlockService().getNumber();
    if(0 == response.getErrorCode()){
       System.out.println(JSON.toJSONString(response.getResult(), true));
    }else{
       System.out.println("error: " + response.getErrorDesc());
    }
    

checkStatus

  • 接口说明

    该接口用于检查本地节点区块是否同步完成。

  • 调用方法

    BlockCheckStatusResponse checkStatus();

  • 响应数据

    参数类型描述
    isSynchronousBoolean区块是否同步
  • 错误码

    异常错误码描述
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 调用checkStatus
    BlockCheckStatusResponse response = sdk.getBlockService().checkStatus();
    if(0 == response.getErrorCode()){
       System.out.println(JSON.toJSONString(response.getResult(), true));
    }else{
       System.out.println("error: " + response.getErrorDesc());
    }
    

getTransactions

  • 接口说明

    该接口用于查询指定区块高度下的所有交易。

  • 调用方法

    BlockGetTransactionsResponse getTransactions(BlockGetTransactionsRequest);

  • 请求参数

    参数类型描述
    blockNumberLong必填,待查询的区块高度,必须大于0
  • 响应数据

    参数类型描述
    totalCountLong返回的总交易数
    transactionsTransactionHistory[]交易内容
  • 错误码

    异常错误码描述
    INVALID_BLOCKNUMBER_ERROR11060BlockNumber must bigger than 0
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    Long blockNumber = 617247L;// 第617247区块
    BlockGetTransactionsRequest request = new BlockGetTransactionsRequest();
    request.setBlockNumber(blockNumber);
    
    // 调用getTransactions接口
    BlockGetTransactionsResponse response = sdk.getBlockService().getTransactions(request);
    if(0 == response.getErrorCode()){
       System.out.println(JSON.toJSONString(response.getResult(), true));
    }else{
       System.out.println("error: " + response.getErrorDesc());
    }
    

getInfo

  • 接口说明

    该接口用于获取区块信息。

  • 调用方法

    BlockGetInfoResponse getInfo(BlockGetInfoRequest);

  • 请求参数

    参数类型描述
    blockNumberLong必填,待查询的区块高度
  • 响应数据

    参数类型描述
    closeTimeLong区块关闭时间
    numberLong区块高度
    txCountLong交易总量
    versionString区块版本
  • 错误码

    异常错误码描述
    INVALID_BLOCKNUMBER_ERROR11060BlockNumber must bigger than 0
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    BlockGetInfoRequest request = new BlockGetInfoRequest();
    request.setBlockNumber(629743L);
    
    // 调用getInfo接口
    BlockGetInfoResponse response = sdk.getBlockService().getInfo(request);
    if (response.getErrorCode() == 0) {
       BlockGetInfoResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getLatestInfo

  • 接口说明

    该接口用于获取最新区块信息。

  • 调用方法

    BlockGetLatestInfoResponse getLatestInfo();

  • 响应数据

    参数类型描述
    closeTimeLong区块关闭时间
    numberLong区块高度,对应底层字段seq
    txCountLong交易总量
    versionString区块版本
  • 错误码

    异常错误码描述
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 调用getLatestInfo接口
    BlockGetLatestInfoResponse response = sdk.getBlockService().getLatestInfo();
    if (response.getErrorCode() == 0) {
       BlockGetLatestInfoResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getValidators

  • 接口说明

    该接口用于获取指定区块中所有验证节点数。

  • 调用方法

    BlockGetValidatorsResponse getValidators(BlockGetValidatorsRequest);

  • 请求参数

    参数类型描述
    blockNumberLong必填,待查询的区块高度,必须大于0
  • 响应数据

    参数类型描述
    validatorsValidatorInfo[]验证节点列表
  • 错误码

    异常错误码描述
    INVALID_BLOCKNUMBER_ERROR11060BlockNumber must bigger than 0
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    BlockGetValidatorsRequest request = new BlockGetValidatorsRequest();
    request.setBlockNumber(629743L);
    
    // 调用getValidators接口
    BlockGetValidatorsResponse response = sdk.getBlockService().getValidators(request);
    if (response.getErrorCode() == 0) {
       BlockGetValidatorsResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getLatestValidators

  • 接口说明

    该接口用于获取最新区块中所有验证节点数。

  • 调用方法

    BlockGetLatestValidatorsResponse getLatestValidators();

  • 响应数据

    参数类型描述
    validatorsValidatorInfo[]验证节点列表
  • 错误码

    异常错误码描述
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 调用getLatestValidators接口
    BlockGetLatestValidatorsResponse response = sdk.getBlockService().getLatestValidators();
    if (response.getErrorCode() == 0) {
       BlockGetLatestValidatorsResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getReward

  • 接口说明

    该接口用于获取指定区块中的区块奖励和验证节点奖励。

  • 调用方法

    BlockGetRewardResponse getReward(BlockGetRewardRequest);

  • 请求参数

    参数类型描述
    blockNumberLong必填,待查询的区块高度,必须大于0
  • 响应数据

    参数类型描述
    blockRewardLong区块奖励数
    validatorsRewardValidatorReward[]验证节点奖励情况
  • 错误码

    异常错误码描述
    INVALID_BLOCKNUMBER_ERROR11060BlockNumber must bigger than 0
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    BlockGetRewardRequest request = new BlockGetRewardRequest();
    request.setBlockNumber(629743L);
    
    // 调用getReward接口
    BlockGetRewardResponse response = sdk.getBlockService().getReward(request);
    if (response.getErrorCode() == 0) {
       BlockGetRewardResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getLatestReward

  • 接口说明

    获取最新区块中的区块奖励和验证节点奖励。

  • 调用方法

    BlockGetLatestRewardResponse getLatestReward();

  • 响应数据

    参数类型描述
    blockRewardLong区块奖励数
    validatorsRewardValidatorReward[]验证节点奖励情况
  • 错误码

    异常错误码描述
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 调用getLatestReward接口
    BlockGetLatestRewardResponse response = sdk.getBlockService().getLatestReward();
    if (response.getErrorCode() == 0) {
       BlockGetLatestRewardResult result = response.getResult();
       System.out.println(JSON.toJSONString(result, true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getFees

  • 接口说明

    获取指定区块中的账户最低资产限制和燃料单价。

  • 调用方法

    BlockGetFeesResponse getFees(BlockGetFeesRequest);

  • 请求参数

    参数类型描述
    blockNumberLong必填,待查询的区块高度,必须大于0
  • 响应数据

    参数类型描述
    feesFees费用
  • 错误码

    异常错误码描述
    INVALID_BLOCKNUMBER_ERROR11060BlockNumber must bigger than 0
    REQUEST_NULL_ERROR12001Request parameter cannot be null
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 初始化请求参数
    BlockGetFeesRequest request = new BlockGetFeesRequest();
    request.setBlockNumber(629743L);
    
    // 调用getFees接口
    BlockGetFeesResponse response = sdk.getBlockService().getFees(request);
    if (response.getErrorCode() == 0) {
       System.out.println(JSON.toJSONString(response.getResult(), true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

getLatestFees

  • 接口说明

    该接口用于获取最新区块中的账户最低资产限制和燃料单价。

  • 调用方法

    BlockGetLatestFeesResponse getLatestFees();

  • 响应数据

    参数类型描述
    feesFees费用
  • 错误码

    异常错误码描述
    CONNECTNETWORK_ERROR11007Failed to connect to the network
    SYSTEM_ERROR20000System error
  • 示例

    // 调用getLatestFees接口
    BlockGetLatestFeesResponse response = sdk.getBlockService().getLatestFees();
    if (response.getErrorCode() == 0) {
       System.out.println(JSON.toJSONString(response.getResult(), true));
    } else {
       System.out.println("error: " + response.getErrorDesc());
    }
    

数据对象

Priv

成员类型描述
masterWeightLong账户自身权重,大小限制[0, (Integer.MAX_VALUE * 2L + 1)]
signersSigner[]签名者权重列表
thresholdThreshold门限

Signer

成员类型描述
addressString签名者区块链账户地址
weightLong签名者权重,大小限制[0, (Integer.MAX_VALUE * 2L + 1)]

Threshold

成员类型描述
txThresholdLong交易默认门限,大小限制[0, Long.MAX_VALUE]
typeThresholdsTypeThreshold[]不同类型交易的门限

TypeThreshold

成员类型描述
typeLong操作类型,必须大于0
thresholdLong门限值,大小限制[0, Long.MAX_VALUE]

AssetInfo

成员类型描述
keyKey资产惟一标识
assetAmountLong资产数量

Key

成员类型描述
codeString资产编码
issuerString资产发行账户地址

ContractInfo

成员类型描述
typeInteger合约类型,默认0
payloadString合约代码

MetadataInfo

成员类型描述
keyStringmetadata的关键词
valueStringmetadata的内容
versionLongmetadata的版本

ContractAddressInfo

成员类型描述
contractAddressString合约地址
operationIndexInteger所在操作的下标

ContractStat

成员类型描述
applyTimeLong接收时间
memoryUsageLong内存占用量
stackUsageLong堆栈占用量
stepLong几步完成

TransactionEnvs

成员类型描述
transactionEnvTransactionEnv交易

TransactionEnv

成员类型描述
transactionTransactionInfo交易内容
triggerContractTrigger合约触发者

TransactionInfo

成员类型描述
sourceAddressString交易发起的源账户地址
feeLimitLong交易要求的最低费用
gasPriceLong交易燃料单价
nonceLong交易序列号
operationsOperation[]操作列表

ContractTrigger

成员类型描述
transactionTriggerTransaction触发交易

Operation

成员类型描述
typeInteger操作类型
sourceAddressString操作发起源账户地址
metadataString备注
createAccountOperationCreateAccount创建账户操作
issueAssetOperationIssueAsset发行资产操作
payAssetOperationPayAsset转移资产操作
payCoinOperationPayCoin发送BU操作
setMetadataOperationSetMetadata设置metadata操作
setPrivilegeOperationSetPrivilege设置账户权限操作
logOperationLog记录日志

TriggerTransaction

成员类型描述
hashString交易hash

OperationCreateAccount

成员类型描述
destAddressString目标账户地址
contractContract合约信息
privPriv账户权限
metadataMetadataInfo[]账户
initBalanceLong账户资产, 单位MO,1 BU = 10^8 MO,
initInputString合约init函数的入参

Contract

成员类型描述
typeInteger合约的语种,默认不赋值
payloadString对应语种的合约代码

MetadataInfo

成员类型描述
keyStringmetadata的关键词
valueStringmetadata的内容
versionLongmetadata的版本

OperationIssueAsset

成员类型描述
codeString资产编码
assetAmountLong资产数量

OperationPayAsset

成员类型描述
destAddressString待转移的目标账户地址
assetAssetInfo账户资产
inputString合约main函数入参

OperationPayCoin

成员类型描述
destAddressString待转移的目标账户地址
buAmountLong待转移的BU数量
inputString合约main函数入参

OperationSetMetadata

成员类型描述
keyStringmetadata的关键词
valueStringmetadata的内容
versionLongmetadata的版本
deleteFlagboolean是否删除metadata

OperationSetPrivilege

成员类型描述
masterWeightString账户自身权重,大小限制[0, (Integer.MAX_VALUE * 2L + 1)]
signersSigner[]签名者权重列表
txThresholdString交易门限,大小限制[0, Long.MAX_VALUE]
typeThresholdTypeThreshold指定类型交易门限

OperationLog

成员类型描述
topicString日志主题
dataString[]日志内容

TestTx

成员类型描述
transactionEnvTestTransactionFees评估交易费用

TestTransactionFees

成员类型描述
transactionFeesTransactionFees交易费用

TransactionFees

成员类型描述
feeLimitLong交易要求的最低费用
gasPriceLong交易燃料单价

Signature

成员类型描述
signDataLong签名后数据
publicKeyLong公钥

TransactionHistory

成员类型描述
actualFeeString交易实际费用
closeTimeLong交易关闭时间
errorCodeLong交易错误码
errorDescString交易描述
hashString交易hash
ledgerSeqLong区块序列号
transactionTransactionInfo交易内容列表
signaturesSignature[]签名列表
txSizeLong交易大小

BlockHeader

MemberTypeDescription
closeTimeLong区块关闭时间
numberLong区块高度
txCountLong交易数量
versionString区块版本号

ValidatorReward

成员类型描述
validatorString验证节点地址
rewardLong验证节点奖励

ValidatorInfo

成员类型描述
addressString共识节点地址
plegeCoinAmountLong验证节点押金

Fees

成员变量类型描述
baseReserveLong账户最低资产限制
gasPriceLong交易燃料单价,单位MO,1 BU = 10^8 MO

错误码

异常错误码描述
ACCOUNT_CREATE_ERROR11001Failed to create the account
INVALID_SOURCEADDRESS_ERROR11002Invalid sourceAddress
INVALID_DESTADDRESS_ERROR11003Invalid destAddress
INVALID_INITBALANCE_ERROR11004InitBalance must be between 1 and Long.MAX_VALUE
SOURCEADDRESS_EQUAL_DESTADDRESS_ERROR11005SourceAddress cannot be equal to destAddress
INVALID_ADDRESS_ERROR11006Invalid address
CONNECTNETWORK_ERROR11007Failed to connect to the network
INVALID_ISSUE_AMOUNT_ERROR11008Amount of the token to be issued must be between 1 and Long.MAX_VALUE
NO_ASSET_ERROR11009The account does not have the asset
NO_METADATA_ERROR11010The account does not have the metadata
INVALID_DATAKEY_ERROR11011The length of key must be between 1 and 1024
INVALID_DATAVALUE_ERROR11012The length of value must be between 0 and 256000
INVALID_DATAVERSION_ERROR11013The version must be equal to or greater than 0
INVALID_MASTERWEIGHT_ERROR11015MasterWeight must be between 0 and (Integer.MAX_VALUE * 2L + 1)
INVALID_SIGNER_ADDRESS_ERROR11016Invalid signer address
INVALID_SIGNER_WEIGHT_ERROR11017Signer weight must be between 0 and (Integer.MAX_VALUE * 2L + 1)
INVALID_TX_THRESHOLD_ERROR11018TxThreshold must be between 0 and Long.MAX_VALUE
INVALID_OPERATION_TYPE_ERROR11019Operation type must be between 1 and 100
INVALID_TYPE_THRESHOLD_ERROR11020TypeThreshold must be between 0 and Long.MAX_VALUE
INVALID_ASSET_CODE_ERROR11023The length of key must be between 1 and 64
INVALID_ASSET_AMOUNT_ERROR11024AssetAmount must be between 0 and Long.MAX_VALUE
INVALID_BU_AMOUNT_ERROR11026BuAmount must be between 0 and Long.MAX_VALUE
INVALID_ISSUER_ADDRESS_ERROR11027Invalid issuer address
NO_SUCH_TOKEN_ERROR11030No such token
INVALID_TOKEN_NAME_ERROR11031The length of token name must be between 1 and 1024
INVALID_TOKEN_SIMBOL_ERROR11032The length of symbol must be between 1 and 1024
INVALID_TOKEN_DECIMALS_ERROR11033Decimals must be between 0 and 8
INVALID_TOKEN_TOTALSUPPLY_ERROR11034TotalSupply must be between 1 and Long.MAX_VALUE
INVALID_TOKENOWNER_ERRPR11035Invalid token owner
INVALID_CONTRACTADDRESS_ERROR11037Invalid contract address
CONTRACTADDRESS_NOT_CONTRACTACCOUNT_ERROR11038contractAddress is not a contract account
INVALID_TOKEN_AMOUNT_ERROR11039TokenAmount must be between 1 and Long.MAX_VALUE
SOURCEADDRESS_EQUAL_CONTRACTADDRESS_ERROR11040SourceAddress cannot be equal to contractAddress
INVALID_FROMADDRESS_ERROR11041Invalid fromAddress
FROMADDRESS_EQUAL_DESTADDRESS_ERROR11042FromAddress cannot be equal to destAddress
INVALID_SPENDER_ERROR11043Invalid spender
PAYLOAD_EMPTY_ERROR11044Payload cannot be empty
INVALID_LOG_TOPIC_ERROR11045The length of a log topic must be between 1 and 128
INVALID_LOG_DATA_ERROR11046The length of one piece of log data must be between 1 and1024
INVALID_CONTRACT_TYPE_ERROR11047Invalid contract type
INVALID_NONCE_ERROR11048Nonce must be between 1 and Long.MAX_VALUE
INVALID_GASPRICE_ERROR11049GasPrice must be between 1000 and Long.MAX_VALUE
INVALID_FEELIMIT_ERROR11050FeeLimit must be between 1 and Long.MAX_VALUE
OPERATIONS_EMPTY_ERROR11051Operations cannot be empty
INVALID_CEILLEDGERSEQ_ERROR11052CeilLedgerSeq must be equal to or greater than 0
OPERATIONS_ONE_ERROR11053One of the operations cannot be resolved
INVALID_SIGNATURENUMBER_ERROR11054SignagureNumber must be between 1 and Integer.MAX_VALUE
INVALID_HASH_ERROR11055Invalid transaction hash
INVALID_BLOB_ERROR11056Invalid blob
PRIVATEKEY_NULL_ERROR11057PrivateKeys cannot be empty
PRIVATEKEY_ONE_ERROR11058One of privateKeys is invalid
SIGNDATA_NULL_ERROR11059SignData cannot be empty
INVALID_BLOCKNUMBER_ERROR11060BlockNumber must be bigger than 0
PUBLICKEY_NULL_ERROR11061PublicKey cannot be empty
URL_EMPTY_ERROR11062Url cannot be empty
CONTRACTADDRESS_CODE_BOTH_NULL_ERROR11063ContractAddress and code cannot be empty at the same time
INVALID_OPTTYPE_ERROR11064OptType must be between 0 and 2
GET_ALLOWANCE_ERROR11065Failed to get allowance
GET_TOKEN_INFO_ERROR11066Failed to get token info
SIGNATURE_EMPTY_ERROR11067The signatures cannot be empty
REQUEST_NULL_ERROR12001Request parameter cannot be null
CONNECTN_BLOCKCHAIN_ERROR19999Failed to connect to the blockchain
SYSTEM_ERROR20000System error
  • 4
    点赞
  • 0
    评论
  • 0
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

©️2021 CSDN 皮肤主题: Age of Ai 设计师:meimeiellie 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值