English / 中文
数字资产管理
Version 0.7.0
钱包 Wallet
钱包Wallet是一个Json格式的数据存储文件。在本体Ontology中, Wallet既可存储数字身份,也可以存储数字资产。
Wallet 数据规范
{
name: string;
defaultOntid: string;
defaultAccountAddress : string;
createTime: string;
version: string;
scrypt: {
"n": number;
"r": number;
"p": number;
};
identities: Array<Identity>;
accounts: Array<Account>;
extra: null;
}
name
是用户为钱包所取的名称。
defaultOntid
是钱包默认的数字身份的ONT ID。
defaultAccountAddress
是钱包默认的资产账户的地址
createTime
是ISO格式表示的钱包的创建时间,如 : “2018-02-06T03:05:12.360Z”
version
目前为固定值1.0,留待未来功能升级使用。
scrypt
是加密算法所需的参数,该算法是在钱包加密和解密私钥时使用。
identities
是钱包中所有数字身份对象的数组
accounts
是钱包中所有数字资产账户对象的数组
extra
是客户端由开发者用来存储额外数据字段,可以为null。
希望了解更多钱包数据规范请参考Wallet_File_Specification.
创建钱包
用户可以从零开始创建自己的钱包。
1)创建一个空的钱包
用户只需要传入钱包名称。
import {Wallet} from 'Ont'
//@param name {string} Name of the wallet
var wallet = Wallet.create( name )
2) 创建账户并添加到钱包中
需要提供以下参数来创建账户:
privateKey
PrivateKey 实例。
password
用户的密码,用来加密私钥。
label
账户名称。
params
额外的参数用来加密解密私钥。它具有以下结构,如果不传,SDK会使用默认值创建账户。
interface ScryptParams {
cost: number;
blockSize: number;
parallel: number;
size: number;
}
默认值如下:
const DEFAULT_SCRYPT = {
cost: 4096,
blockSize: 8,
parallel: 8,
size: 64
};
该参数在加密和解密时必须使用一致的值,否则解密会失败。
2.1) 生成私钥
我们可以使用相应的算法和曲线生成随机的私钥。SDK支持以下三种公私钥生成算法:
- ECDSA
- SM2
- EDDSA
ECDSA 是默认的算法. SECP256R1是默认的曲线。
import { Crypto } from 'ontology-ts-sdk';
cont keyType = Crypto.KeyType.ECDSA;
const keyParameters = new Crypto.KeyParameters(Crypto.CurveLabel.SECP256R1);
const privateKey = Crypto.PrivateKey.random(keyType, keyParameters)
const privateKey2 = Crypto.PrivateKey.random() // Use default params
2.2) 创建账户
然后我们可以创建账户并添加到钱包中。
import {Account, Crypto} from 'ontology-ts-sdk';
var account = Account.create( privateKey, password, name ); //Use the default scrypt params
wallet.addAccount(account)
账户
账户用来管理用户的资产。
账户的数据结构
{
"address": "AJQLNWy9X6qdeEFrSH6UzgEjadSsRiYDCS",
"label": "mickey",
"lock": false,
"algorithm": "ECDSA",
"parameters": {
"curve": "P-256"
},
"key": "qFbemAbu7fEjOJzAZZhGkmzp2YNxdSCuK7xyvhBAnUBX/FmAj2Ns84Y7frh6hfQv",
"enc-alg": "aes-256-gcm",
"salt": "u+SiqpRk17b0vIPesh4xXA==",
"isDefault": false,
"publicKey": "037fb6dfc9420e1d8275d9133d6d69fe64e8e3567241e7583234b9efa8b2ce7ae1",
"signatureScheme": "SHA256withECDSA"
}
address
账户地址。base58格式。
label
账户名称。
lock
声明账户是否锁定。
algorithm
公私钥生成算法名称。
parameters
算法的参数
curve
算法使用的曲线.
key
加密后私钥。
enc-alg
加密私钥的算法.
salt
加密算法的盐值。base64格式.
isDefault
声明是否是默认账户.
publicKey
账户的公钥.
signatureScheme
签名算法.
创建账户
import {Account} from 'ontology-ts-sdk'
//@param {PrivateKey} The user's private key
//@param {string} The user's password
//@param {string} Optional. Name of the account
//@param {object} Optional parameter. The encryption algorithm object.
var account = Account.create(privateKey, password, label, params)
导入账户
可以通过备份的数据导入账户。
导入keystore
导入账户的过程中会验证密码和加密后的私钥,如果不正确会抛出相应错误码。
import { Account, Crypto } from 'ontology-ts-sdk'
//@param label {srint} Name of the account
//@param encryptedPrivateKey {PrivateKey} The encrypted private key
//@param password {string} The password used to decrypt private key
//@param address {Address} The address of the account
//@param salt {string} The salt in base64 format
//@param params {ScryptParams} Optional scrypt params to decrypt private key
var account;
const encryptedPrivateKey = new Crypto.PrivateKey(key);//key is the encrypted private key
try {
account = Account.importAccount(
label,
encryptedPrivateKey
password,
address,
salt,
params)
} catch(error) {
//密码或私钥不正确
}
数字资产转账 Transfer
转账函数说明
function makeTransferTransaction(tokenType:string, from : string, to : string, value : string, privateKey : string)
tokenType: token 类型
from: 转账者的公钥哈希地址
to: 接收者的公钥哈希地址
value: 转账数值,需要乘以10^8以避免小数点后精度损失
privateKey: 转账者公钥对应的私钥
####Token类型
TOKEN_TYPE = {
ONT : 'ONT', //Ontology Token
ONG : 'ONG' //Ontology Gas
}
样例
import { makeTransferTransaction, buildRestParam } from "../src/transaction/transactionBuilder";
var tx = makeTransferTransaction( 'ONT', '0144587c1094f6929ed7362d6328cffff4fb4da2', 'ffeeddccbbaa99887766554433221100ffeeddcc', '1000000000', '760bb46952845a4b91b1df447c2f2d15bb40ab1d9a368d9f0ee4bf0d67500160' )
var restData = buildRestParam(tx)
axios.post('127.0.0.1:20386', restData).then(res => {
console.log('transfer response: ' + JSON.stringify(res.data))
}).catch(err => {
console.log(err)
})
数字资产查询 getBalance
查询余额链接
//nodeURL 节点的IP地址
//HTTP_REST_PORT 节点暴露给Restful接口的端口
//address 查询余额的地址
http://${nodeURL}:${HTTP_REST_PORT}/api/v1/balance/${address}
样例:
let request = `http://127.0.0.1:20384/api/v1/balance/TA5uYzLU2vBvvfCMxyV2sdzc9kPqJzGZWq`
axios.get(request).then((res : any) => {
if(res.data.Error === 0) {
let obj = {
error : 0,
result : res.data.Result
}
} else {
let obj = {
error: res.data.Error,
result : ''
}
}
}).catch( (err:any) => {
let obj = {
error: JSON.stringify(err),
result: ''
}
})