迅雷链提供 Go-SDK 以方便开发者与区块链系统（BaaS接入层）进行通信和交互。
- 封装区块链接口，实现账户管理、普通交易和合约交易等功能；
- 集成多个账户的账户信息，作为钱包账户服务中心；
- 与Baas接入层交互。
简言之：SDK接收账户请求并封装，随后将其转发至BaaS接入层。
.
├── sdk.go // SDK接口的结构体实例
├── sdkapi.go // SDK实例的所有接口实现
├── args.go // SDK使用的消息结构
├── account.go // SDK账户管理
├── config.go // SDK包所需的所有配置信息
├── log.go // SDK包日志接口
├── dnscache.go // BaaS接入层的DNS解析缓存
├── client.go // 封装与BaaS接入层交互的客户端
├── httpcli.go // 封装简易HTTP请求方法
├── util.go // 通用函数
└── errors.go // 错误码开发者在使用SDK时，需遵循以下步骤：
在SDK中，其需要的所有配置信息如下：
// AuthInfo 负责通过认证与BaaS交互
type AuthInfo struct {
ChainID string `json:"chainid"` // 链ID
ID string `json:"id"` // BaaS为开发者分配的ID
Key string `json:"key"` // BaaS为开发者分配的Key
}
// Config SDK配置信息
type Config struct {
Keystore string // Keystore目录 保存用户账户秘钥
UnlockAccounts map[string]string
RPCProtocal string // BaaS接入层 协议
XHost string // BaaS接入层 Host
Namespace string // 区块链名称空间 tcapi
ChainID int64 // 链ID
GetGasPrice bool // 是否从BaaS获取GasPrice
AuthInfo AuthInfo
}开发者需构造SDK包内的Config类型，填充其信息并将构造的Config作为入参构造SDK。
需要注意的是，UnlockAccounts 和 AuthInfo 需开发者自行解析。
构造过程如本目录下的Server示例所示：
// 1. 构造基础配置
sdkConf := &sdk.Config{
Keystore: conf.Keystore,
UnlockAccounts: make(map[string]string),
RPCProtocal: conf.RPCProtocal,
XHost: conf.XHost,
Namespace: conf.Namespace,
ChainID: conf.ChainID,
GetGasPrice: conf.GetGasPrice,
}
// 2. 解析得到 AuthInfo
authInfoJSON, err := ioutil.ReadFile(authInfoFilePath)
err = json.Unmarshal(authInfoJSON, &sdkConf.AuthInfo)
// 3. 解析得到 UnlockAccounts
passwdsJSON, err := ioutil.ReadFile(passwdFile)
err = json.Unmarshal(passwdsJSON, &sdkConf.UnlockAccounts)
// 4. 返回构造的sdkConf
return sdkConfSDK实现了所有与BaaS交互的必要接口。
需要注意的是，获取SDK实例时需传入 Config 和满足 sdk.Logger 接口的log实现，该log将在SDK内部提供日志功能。
开发者可以通过调用以下接口获取和释放SDK资源：
func NewSDK(cfg *Config, log Logger) (*SDKImpl, error)随后即可通过调用该实例的方法进行指向BaaS的接口调用：
import(
"github.com/XunleiBlockchain/baas-sdk-go"
)
func foobar() {
// ------- INIT -------
// 1. get sdk Config
sdkConf := &sdk.Config{
...
}
// 2. init log
logger := log.NewLogger()
// 3. init sdk
mySDK := sdk.NewSDK(sdkConf, logger)
// ------- USE -------
// encode params
resp, xerr := mySDK.GetBalance(params...)
if xerr != nil || xerr.Code != 0 {
// handle error
}
// parse resp
}SDK提供以下接口：
type SDK interface {
// 新建用户账户
NewAccount(params interface{}) (interface{}, *Error)
// 获取SDK管理的所有用户账户
Accounts(params interface{}) (interface{}, *Error)
// 获取某账户地址的余额
GetBalance(params interface{}) (interface{}, *Error)
// 获取某账户地址的Nonce
GetTransactionCount(params interface{}) (interface{}, *Error)
// 获取当前区块高度
BlockNumber() (interface{}, *Error)
// 获取指定交易的信息
GetTransactionByHash(params interface{}) (interface{}, *Error)
// 获取指定交易收据
GetTransactionReceipt(params interface{}) (interface{}, *Error)
// 根据区块高度获取区块详情
GetBlockByNumber(params interface{}) (interface{}, *Error)
// 根据区块hash获取区块详情
GetBlockByHash(params interface{}) (interface{}, *Error)
// 发送交易
SendTransaction(params interface{}) (interface{}, *Error)
// 发送合约交易
SendContractTransaction(params interface{}) (interface{}, *Error)
// 执行消息调用（无需创建交易）
Call(params interface{}) (interface{}, *Error)
}SDK接口的输入和输出参数均以JSON格式编码，该格式定义于 args.go。如有需要，开发者可以在源码中看到更底层的内容。
接口说明如下：
功能描述： 获取钱包管理的全部账户地址
参数： none
返回结果： 账户地址数组
示例：
//request
[
{}
]
//result
{
"0x33d4fcb75ce608920c7e5755304c282141dfc4dc", "0x7a4877494b59c0bd929747800ab86a8b89380ac5", "0x36419474a02a507e236dc473648197f07ab4722e", "0x7fc423bd7ed1f5d17a92bdb8c39ed620f48f7559", "0x8f470d7f2b2db7b83accd008ddabc5423c06044b",
"0x622bc0938fae8b028fcf124f9ba8580719009fdc"
}
功能描述： 创建新的账户
参数： 账户密码
返回结果： 新账户地址
示例：
//request
[
{
"123456"
}
]
//result
{
"0x84d8698746dbe68c97965c48c7b56979c577df11"
}
功能描述： 查询账户余额
参数： 账户地址
返回结果： 账户地址余额
示例：
//request
[
{
"0x33d4fcb75ce608920c7e5755304c282141dfc4dc"
}
]
//result
{
99030093892100000000170
}
功能描述： 查询账户nonce值
参数： 账户地址
返回结果： 账户地址当前nonce值
示例：
//request
[
{
"0x622bc0938fae8b028fcf124f9ba8580719009fdc"
}
]
//result
{
26
}
功能描述： 查询当前区块链高度
参数： 无
返回结果： 当前链已同步的区块高度
示例：
//result
{
"0x1"
}
功能描述： 普通转账交易
参数：
- Object： 交易对象
- from: 转出账户地址
- to: 转入账户地址
- value: 转账金额 (推荐使用十进制)
- nonce: (可选) from地址nonce值
- from账户密码(可选)
示例：
[
{
"from": "0x622bc0938fae8b028fcf124f9ba8580719009fdc",
"to": "0x33d4fcb75ce608920c7e5755304c282141dfc4dc",
"value": "0x10", // 16 wei
}，"12345678"
]说明：如果启动服务时，已经解锁了from账户，可以不用再传密码参数
返回结果： 交易hash
示例：
//request
[
{
"from": "0x622bc0938fae8b028fcf124f9ba8580719009fdc",
"to": "0x33d4fcb75ce608920c7e5755304c282141dfc4dc",
"value":"1200"
},
"12345678"
]
//result
{
"0x517490b857200702453f32ed0574487b44587958ff39b26554df4f4991cae18c"
}
功能描述：
合约执行交易，支持传1个参数，2个参数和3个参数:
- 1个参数则只穿交易对象
- 2个参数则传交易对象和扩展对象
- 3个参数则传交易对象、账户密码、扩展对象
参数：
- Object： 交易对象
- from: 转出账户地址
- to: 转入账户地址
- gas：(可选，默认90000)手续费
- gasPrice：(可选，默认1e11)
- value: 转账金额
- data：执行合约code
- nonce: (可选) from地址nonce值
- from账户密码(可选)
示例：
[
{
"from": "0x622bc0938fae8b028fcf124f9ba8580719009fdc",
"to": "0x7f7f7dbf351d4272eb282f16091c96b4819007f5",
"data": "0x49f3870b0000000000000000000000000000000000000000000000000000000000000001"
},
"12345678"
]说明：如果启动服务时，已经解锁了from账户，可以不用再传密码参数
返回结果： 交易hash
示例：
//request
[
{
"from": "0x622bc0938fae8b028fcf124f9ba8580719009fdc",
"to": "0x7f7f7dbf351d4272eb282f16091c96b4819007f5",
"data": "0x49f3870b0000000000000000000000000000000000000000000000000000000000000001"
},
"12345678"
]
//result
{
"0x517490b857200702453f32ed0574487b44587958ff39b26554df4f4991cae18c"
}
功能描述： 根据交易hash获取交易详情
参数：
- hash 交易hash
返回结果： 交易详情
示例：
//request
[
"0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
]
//result
{
"hash":"0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b",
"nonce":"0x",
"blockHash": "0xbeab0aa2411b7ab17f30a99d3cb9c6ef2fc5426d6ad6fd9e2a26a6aed1d1055b",
"blockNumber": "0x15df", // 5599
"transactionIndex": "0x1", // 1
"from":"0x407d73d8a49eeb85d32cf465507dd71d507100c1",
"to":"0x85h43d8a49eeb85d32cf465507dd71d507100c1",
"value":"0x7f110", // 520464
"gas": "0x7f110", // 520464
"gasPrice":"0x09184e72a000",
"input":"0x603880600c6000396000f300603880600c6000396000f3603880600c6000396000f360",
}
功能描述： 根据交易hash获取交易回执
参数：
- hash 交易hash
返回结果： 交易receipt
示例：
//request
[
"0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
]
//result
{
"from": "0x3fc2c8dc5831d1ac43be0ba45bdc5b780b277fe8",
"signHash": "0x85841d70bde75b4e582e97012a92cd043e75ed37f64d0bb233d39b64054ab572",
"tx": {
"type": "tx",
"value": {
"gas": "0x186a0",
"gasPrice": "0x0",
"hash": "0x114631dad58102d7b8b9dcdc06e6ae49a9d1f72fa359a56bad8e0b0ff4baf11e",
"input": "0x",
"nonce": "0xb17",
"r": "0x1b0588746fff89d56cedf5bdd97048cbefc361b8c682f681d6ffffa7793eaa0f",
"s": "0x54f72eb8bcfcb6b6a34df243940ed85604c837217fe26e50f3b219e802377e15",
"to": "0x0000000000000000000000000000000000000000",
"v": "0x64606886",
"value": "0x0"
}
},
"txEntry": {
"blockHash": "0x8f349e245b2bd898a201296795fc856ec4a81de57e224d337b9af7a98a1dc100",
"blockHeight": "4377",
"txIndex": "1895",
"txRole": "0",
"zoneID": "0"
},
"txHash": "0x114631dad58102d7b8b9dcdc06e6ae49a9d1f72fa359a56bad8e0b0ff4baf11e",
"txType": "tx"
}
功能描述： 根据区块高度获取区块详情
参数：
- string blockNumber区块高度
- bool true返回完整交易对象，false只返回交易hash
返回结果： 区块详情
示例：
//request
[
"0x1b4", // 436
true
]
//result
{
"crossIn": [],
"gasLimit": "0x12a05f200",
"gasUsed": "0x0",
"hash": "0x82da6d77db11887ad6432cd62f10f181b3e2c2e1592d6d5c91ab475acb5bd54a",
"lenCrossIn": 0,
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"miner": "0x54fb1c7d0f011dd63b08f85ed7b518ab82028100",
"number": "0x1122",
"parentHash": "0xdd7edf3051b0b8fe34ef97fbfc5bef90a675a937ca27a9d045cc92c405da59f2",
"receiptsRoot": "0x0000000000000000000000000000000000000000000000000000000000000000",
"stateRoot": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470",
"timestamp": "0x5ff2d4fa",
"transactions": [{},],
"transactionsRoot": "0x3db59484ce80cd3a09e2d05e2df6c3ef357b11cf1c4f094097e4e8811f059355"
}
| 错误码 | 错误信息 | 说明 |
|---|---|---|
| 0 | success | 请求成功 |
| -1000 | invalid method | 接口请求方法错误 |
| -1001 | params err | 参数错误， 一般由Params参数个数不一致导致 |
| -1002 | find account err | 账号查找错误 |
| -1003 | rpc getBalance err | 查看余额 rpc调用失败 |
| -1004 | ks.NewAccount err | 新建账号错误 |
| -1005 | rpc getNonce err | 获取Nonce值 rpc调用失败 |
| -1006 | SDK SignTx err | 交易签名错误 |
| -1007 | bal EncodeToBytes err | RLP编码错误 |
| -1008 | rpc sendTransaction err | 发送交易 rpc调用失败 |
| -1009 | SDK SignTxWithPassphrase err | 钱包签名交易错误 |
| -1012 | ContractExtension err | 合约交易参数解析错误 |
| -1013 | rpc sendContractTransaction err | 发送合约交易 rpc调用失败 |
| -1018 | json unmarshal err | json解析错误 |
| -1019 | rpc getTransactionByHash err | 查询交易 rpc调用失败 |
| -1020 | rpc getTransactionReceipt err | 查询收据 rpc调用失败 |
| -1021 | SendTxArgs err | 发送交易参数解析错误 或 获取Nonce值错误 |
注：其他错误码由BaaS透传返回