GitHub

					DNA SDK 手册

1 准备工作

*** 下载DNA SKD(java版本)，配置JAVA8运行环境

注意：配置java运行环境后运行程序时如出现如下错误： java.security.InvalidKeyException: Illegal key size

则这是秘钥长度大于128，安全策略文件受限的原因。可以去官网下载local_policy.jar和US_export_policy.jar，替换jre目录中${java_home}/jre/lib/security原有的与安全策略这两个jar即可。下载地址：

http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html

2 接入步骤

2.1 OAuth认证

DNA默认关闭认证选项，使用SDK可以直接访问DNA。在联盟链或私有链有认证要求的场景下，您需要首先完成用户注册，并获取授权accessToken才能访问应用。用户注册和获取Token请参考: https://forum.dnaproject.org/t/dna/112。

2.2 SDK调用

调用sdk时，将该访问令牌(非联盟链可任意)作为其中一个初始化参数传递进来，实现数字资产的注册、分发、转移、存证、取证等操作。

3 接口说明

调用每一个接口方法之前必须实例化账户管理器，后续的接口都是基于账户管理来调用的。实例化账户管理器所需参数包括：连接地址url，账户存储位置路径path，访问令牌accessToken。

3.1 创建账户

通过传递一个int类型的数值，可以创建多个账户合约，以合约地址列表形式返回。

参数字段类型描述说明
输入参数 numCount int 单次创建账户个数 int类型占4字节
输出参数 list List 账户合约地址列表合约地址是以A开头的34位字符串

eg:

List list = wm.createAccount(numCount);

3.2 注册资产

通过传递资产的基本信息来产生一笔区块链上合法的资产，返回资产编号。后续的资产类操作就可以使用该资产编号。

参数字段类型描述说明
输入参数 issuer String 发行者地址地址是以A开头的34位字符串 name String 资产名称长度可任意
amount long 资产数量 long类型占8字节
desc String 描述长度可任意
controller String 控制者地址地址是以A开头的34位字符串 precision int 精度 int类型占4字节
输出参数 txid String 交易编号，这里代表资产编号交易编号是64位字符串

eg：

String assetid = wm.reg(issuer, name, amount , desc, controller, precision);

3.3 分发资产

通过传递分发资产的基本信息来完成一笔资产的分发操作，返回交易编号。

参数字段类型描述说明
输入参数 controller String 资产控制者地址地址是以A开头的34位字符串
assetid String 资产编号资产编号对应注册资产的交易编号，长度为64位字符串 amount long 分发数量 long类型占8字节
recver String 接收者地址地址是以A开头的34位字符串
desc String 描述长度可任意
输出参数 txid String 交易编号交易编号是64位字符串

eg:

String txid = wm.iss(controller, assetid, amount , recver , desc );

3.4 转移资产

通过传递分发资产的基本信息来完成一笔资产的分发操作，返回交易编号。

参数字段类型描述说明
输入参数 controller String 资产控制者地址地址是以A开头的34位字符串
assetid String 资产编号资产编号对应注册资产的交易编号，长度为64位字符串 amount long 转移数量 long类型占8字节
recver String 接收者地址地址是以A开头的34位字符串
desc String 描述长度可任意
输出参数 txid String 交易编号交易编号是64位字符串

eg:

String txid = wm.trf(controller, assetid, amount , recver , desc );

3.5 存证

通过传递存证交易的基本信息来完成一笔资产的分发操作，返回交易编号。

参数字段类型描述说明
输入参数 content String 存证信息长度任意的字符串
desc String 描述长度任意的字符串
输出参数 txid String 交易编号交易编号是64位字符串

eg:

String txid = wm.storeCert(content, desc);

3.6 取证

查询类操作，传递存证时的交易编号，输出具体存证内容

参数字段类型描述说明
输入参数 txid String 交易编号交易编号是64位字符串输出参数 cotent String 存证内容长度任意的字符串

eg：

String content= wm.queryCert(txid);

3.7 账户信息

查询类操作，传递账户地址，输出账户具体信息

参数字段类型描述说明
输入参数 address String 合约地址地址是以A开头的34位字符串
输出参数 info AccountInfo 账户信息自定义类型，包括合约地址/公钥/私钥/公钥hash/私钥wif

自定义类型子字段子类型描述说明
AccountInfo address String 合约地址地址是以A开头的34位字符串
pubkey String 公钥压缩模式下公钥的十六进制字符串表示
prikey String 私钥私钥的十六进制字符串表示
priwif String 私钥WIF 私钥Base58算法之后的字符串表示
pkhash String 公钥哈希压缩模式下公钥哈希之后的十六进制字符串表示

eg:

AccountInfo info = wm.getAccountInfo(address);

3.8 账户资产

查询类操作。传递账户地址，输出账户资产详情

参数字段类型描述说明
输入参数 address String 合约地址合约地址是以A开头的34位字符串
输出参数 info AccountAsset 账户资产信息账户资产信息包括合约地址、可用资产/冻结资产

自定义类型子字段子类型描述说明
AccountAsset address String 合约地址合约地址是以A开头的34位字符串
canUseAssets List 可用资产列表可用资产列表，资产类型包括资产编号和资产数量 freezeAssets List 冻结资产列表不可用资产列表，资产包括资产编号和资产数量 Asset assetid String 资产编号 64位字符串
amount long 资产数量 8字节的long类型

eg:

AccountAsset info = wm.getAccountAsset(userAddr);

3.9 资产信息

查询类操作。传递资产编号，输出资产详情。

参数字段类型描述说明
输入参数 assetid String 资产编号 64位字符串
输出参数 info AssetInfo 资产信息资产信息包括资产编号、名称、注册数量、注册者、控制者

自定义类型子字段子类型描述说明
AssetInfo name String 资产名称长度任意的字符串
precision int 精度 4字节的int类型
assetType int 资产类型 4字节的int类型，取值：17代表代币，1代表股权，0代表法币 recordType int 记账模式 4字节的int类型，取值：0代表utxo模式，1代表余额模式

eg:

AssetInfo info = wm.getAssetInfo(assetid);

3.10 交易信息

查询类操作。传递交易编号，返回交易具体信息。

参数字段类型描述说明
输入参数 txid String 交易编号 64位字符串
输出参数 info TransactionInfo 交易信息交易信息包括交易编号、交易输入、交易输出

自定义类型子字段子类型描述说明
TransactionInfo txid String 交易编号 64位字符串
type String 交易类型取值：注册交易/分发交易/转账交易/存证交易 inputs List 交易输入交易资产的来源
outputs List 交易输出交易资产的去向
attrs String 描述任意长度的字符串
TxInputInfo address String 合约地址合约地址是以A开头的34位字符串
assetid String 资产编号 64位字符串
amount long 资产数量 8字节的long类型
TxOutputInfo address String 合约地址合约地址是以A开头的34位字符串
assetid String 资产编号 64位字符串
amount long 资产数量 8字节的long类型

eg：

TransactionInfo info = wm.getTransactionInfo(txid);

3.11 解析块

参数字段类型描述说明
输入参数 dat String json格式块信息该数据是用户通过websocket获取到的Block数据输出参数 block Block 区块信息该类型定义区块的基本信息，包括高度/哈希值/交易等

自定义类型子字段子类型描述说明
Block version int 版本信息目前为0
prevBlock UInt256 前一个区块散列值 32位byte数组 merkleRoot UInt256 区块所有交易默克尔树根 32位byte数组 timestamp int 时间戳 4字节int类型 height int 区块高度 4字节int类型 nonce long 随机数 8字节long类型 nextMiner UInt160 下一个记账合约地址 20位byte数组 script Script 验证脚本签名验证脚本
transactions Transaction[] 交易列表区块交易列表
Program code byte[] 签名信息签名信息
parameter byte[] 公钥信息公钥信息
Transaction type TransactionType 交易类型 byte单字节
nonce long 随机数 8字节long类型 attributes TransactionAttribute 交易特性自定义类型
inputs TransactionInput 交易输入自定义类型
outputs TransactionOutput 交易输出自定义类型
script Script 验证脚本签名验证脚本
TransactionAttribute usage TransactionAttributeUsage 用途 byte单字节
data byte[] 描述 byte[]数组 TransactionInput prevHash UInt256 引用交易散列值 32位byte数组 prevIndex short 引用交易输出索引 2字节类型
TransactionOutput assetId UInt256 资产编号 32位byte数组 value Fixed8 数量 long类型封装 scriptHash UInt160 收款地址 20位byte数组

eg:

Block block = UserWalletManager.fromWebSocketData(dat);

4 调用示例

4.1 创建账户

// 打开账户管理器
String path = "./dat/tsGo_01.db3";
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(path, url, accessToken);
// 创建账户
String user01 = wm.createAccount();			// 创建单个账户
List<String> list = wm.createAccount(10); 	// 批量创建10个账户
System.out.println("user:"+user01);
System.out.println("list:"+list);

4.2 注册资产

// 打开账户管理器
String path = "./dat/tsGo_01.db3";
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(path, url, accessToken);
// 方式1：注册资产
String issuer= "";		// 资产发行者地址
String name = "";			// 资产名称
long amount = 10000;		// 资产数量
String desc = "";			// 描述
String controller = "";		// 资产控制者地址
int precision = 0;			// 精度
String assetid = wm.reg(issuer, name, amount , desc, controller, precision);
System.out.println("rs:"+assetid);

// 方式2: 分步骤注册资产
// S1:构造交易
Transaction tx = wm.createRegTx(issuer, name, amount , desc, controller, precision);
// S2:交易签名
String txHex = wm.signTx(tx);
// S3:发送交易
boolean rr = wm.sendTx(txHex);
//
System.out.println("rs1:"+rr+",txid:"+tx.hash().toString());

4.3 发行资产

// 打开账户管理器
String path = "./dat/tsGo_01.db3";
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(path, url, accessToken);
// 方式1：分发资产
String controller= "";		// 资产控制者地址
String assetid = "";		// 资产编号(由注册资产产生)
long amount = 100;			// 分发数量
String recver = "";			// 分发资产接收者地址
String desc = "";			// 描述
String txid = wm.iss(controller, assetid, amount , recver , desc );
System.out.println("rs:"+txid);

// 方式2: 分步骤分发资产
// S1:构造交易
Transaction tx = wm.createIssTx(controller, assetid, amount , recver , desc );
// S2:交易签名
String txHex = wm.signTx(tx);
// S3:发送交易
boolean rr = wm.sendTx(txHex);
//
System.out.println("rs2:"+rr+",txid:"+tx.hash().toString());

4.4 转移资产

// 打开账户管理器
String path = "./dat/tsGo_01.db3";
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(path, url, accessToken);
// 方式1：转移资产
String controller= "";		// 资产控制者地址
String assetid = "";		// 资产编号(由注册资产产生)
long amount = 100;		// 转移数量
String recver = "";		// 转移资产接收者地址
String desc = "";		// 描述
String txid = wm.trf(controller, assetid, amount , recver , desc );
System.out.println("rs:"+txid);

// 方式2: 分步骤转移资产
// S1:构造交易
Transaction tx = wm.createTrfTx(controller, assetid, amount , recver , desc );
// S2:交易签名
String txHex = wm.signTx(tx);
// S3:发送交易
boolean rr = wm.sendTx(txHex);
//
System.out.println("rs2:"+rr+",txid:"+tx.hash().toString());

4.5 存证

// 打开账户管理器
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(url, accessToken);
// 方式1：存证
String content = "";		// 待存储的信息
String desc = "";			// 描述
String txid = wm.storeCert(content, desc);
System.out.println("rs:"+txid);

4.6 取证

// 打开账户管理器
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(url, accessToken);
// 取证
String txid = "";		// 存证编号
String content= wm.queryCert(txid);
System.out.println("rs:"+content);

4.7 账户信息

// 打开账户管理器
String path = "./dat/tsGo_01.db3";
UserWalletManager wm = UserWalletManager.getWallet(path);
// 查询账户信息
String userAddr = "";		// 账户地址
AccountInfo info = wm.getAccountInfo(userAddr);

4.8 账户资产

// 打开账户管理器
String path = "./dat/tsGo_01.db3";
UserWalletManager wm = UserWalletManager.getWallet(path);
// 查询账户资产
String userAddr = "";		// 账户地址
AccountAsset info = wm.getAccountAsset(userAddr);

4.9 资产信息

// 打开账户管理器
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(url, accessToken);
// 查询账户资产
String assetid = "";
AssetInfo info = wm.getAssetInfo(assetid);

4.10 交易信息

// 打开账户管理器
String url = "http://localhost:20334";
String accessToken = "";				// 非必需项，如开启OAuth认证，则需要填写
UserWalletManager wm = UserWalletManager.getWallet(url, accessToken);
// 查询账户资产
String txid = "";
TransactionInfo info = wm.getTransactionInfo(txid);

4.11 解析块

// 解析json为block类型
String dat = "";				// 该数据为用户通过websocket方式或者通过rest方式获取到块信息的json格式数据
Block block = UserWalletManager.from(dat);

5 开发说明

该SDK供客户端使用，其中含有账户信息的管理，比如合约地址、公钥、私钥，这些信息保存至客户端数据库中。具体的数据库可根据需求自由选择，目前实现的数据库有sqlite、mysql，sqlite是一个文件数据库，初始化时需要传递路径，上面的示例是根据该sqlite保存账户信息的数据库实现给出的，mysql使用时还需要创建对应的表，以及实现具体的数据库连接。通过SDK接入DNA区块链时，可以直接使用当前的Sqlite数据库保存账户的公私钥信息的UserWalletManager，也可自己实现一个账户管理器来管理账户私密信息。自己实现账户管理器可参考DNA.Implementations.Wallets.SQLite.UserWallet类和DNA.Implementations.Wallets.Mysql.WebWallet类。

6 错误代码

返回代码描述信息说明
0 SUCCESS 成功
41001 SESSION_EXPIRED 会话无效或已过期（需要重新登录） 41002 SERVICE_CEILING 达到服务上限
41003 ILLEGAL_DATAFORMAT 不合法数据格式
42001 INVALID_METHOD 无效的方法
42002 INVALID_PARAMS 无效的参数
42003 INVALID_TOKEN 无效的令牌
43001 INVALID_TRANSACTION 无效的交易
43002 INVALID_ASSET 无效的资产
43003 INVALID_BLOCK 无效的块
44001 UNKNOWN_TRANSACTION 找不到交易
44002 UNKNOWN_ASSET 找不到资产
44003 UNKNOWN_BLOCK 找不到块
45001 INVALID_VERSION 协议版本错误
45002 INTERNAL_ERROR 内部错误

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
src/main/java/DNA		src/main/java/DNA
.classpath		.classpath
.project		.project
LICENSE		LICENSE
README.md		README.md
README_CN.md		README_CN.md
pom.xml		pom.xml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

About

Releases

Packages

Languages

License

tssqzr/DNASDKJava

Folders and files

Latest commit

History

Repository files navigation

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages