TronTool.Go开发包适用于为Go应用快速增加对Tron/USDT-TRC20数字资产的支持能力,即支持使用自有Tron区块链节点的应用场景,也支持基于Tron官方公共API服务的轻量级部署场景。官方下载地址:TronTool for Golang。
TronTool.Go开发包主要包含以下特性:
TronTool.Go开发包采用 Go 1.13 开发,当前版本1.0.0,主要数据类型及关系如下图所示:
TronTool.Go开发包的主要代码文件清单如下:
代码文件 | 说明 |
---|---|
trontool/tron/address.go | Tron地址编解码方法 |
trontool/tron/contract.go | Tron合约封装类 |
trontool/tron/credential.go | Tron身份类 |
trontool/tron/nodeclient.go | Tron节点客户端类 |
trontool/tron/trc20.go | TRC20合约封装类 |
trontool/tron/tronapi.go | Tron多节点客户端 |
trontool/tron/tronkit.go | TronKit入口类 |
trontool/tron/types.go | 杂项类型 |
trontool/api/account.go | 账户相关API数据结构 |
trontool/api/apiresult.go | 一般性API结构 |
trontool/api/contract.go | 合约相关API数据结构 |
trontool/api/contractevent.go | 合约事件相关API数据结构 |
trontool/api/contracttransaction.go | 合约交易相关API数据结构 |
trontool/api/transaction.go | TRX交易相关API数据结构 |
trontool/demo/addressdemo.go | Tron地址演示 |
trontool/demo/trc20demo.go | TRC20查询与交易演示 |
trontool/demo/trc20eventdemo.go | TRC20事件查询演示 |
trontool/demo/trxdemo.go | Trx余额查询与转账交易演示 |
trontool/go.mod | Go模块管理文件 |
trontool/go.sum | Go模块管理文件 |
demo/ | 演示项目代码目录 |
demo/build.gradle | 演示项目Gradle配置文件 |
demo/src/main/java/demo/NewAddressDemo.java | 演示代码,创建新的Tron区块链地址 |
demo/src/main/java/demo/TrxDemo.java | 演示代码,Trx转账交易及余额查询 |
demo/src/main/java/demo/Trc20Demo.java | 演示代码,Trc20代币转账、余额查询、事件监听等 |
build.gradle | 根项目配置文件 |
settings.gradle | 根项目配置文件 |
进入trontool
目录运行示例代码。
示例代码 addressdemo.go
演示如何创建一个新地址,或者导入已有的私钥。
执行如下命令运行示例代码:
go run demo/addressdemo.go
执行结果如下:
示例代码 trxdemo.go
演示如何进行TRX转账并查询指定Tron账号的TRX余额。
执行如下命令运行示例代码:
go run demo/trxdemo.go
执行结果如下:
示例代码 trc20demo.go
演示如何查询指定的TRC20代币的相关信息并进行转账。
执行如下命令运行示例代码:
go run demo/trc20demo.go
执行结果如下:
示例代码 trc20eventdemo.go
演示如何查询指定TRC20代币的事件。
执行如下命令运行示例代码:
go run demo/trc20eventdemo.go
执行结果如下:
TronKit是开发包的入口,使用这个类可以快速实现如下功能:
TronKit实例化需要传入TronApi
对象和Credential
对象,这两个参数分别封装了Tron节点提供的API,以及进行交易签名的用户身份信息。
例如,下面的代码创建一个接入Tron主链的TronKit实例,并使用指定的私钥进行交易签名:
//import "trontool/tron"
credential, _ := tron.HexKeyToCredential("8D914…71EB5F") //导入私钥
TronKit kit = tron.NewTronKit(
Tron.MainNetTronApi(), //接入主链
credential, //使用指定身份
)
使用TronKit的sendTrx()
方法进行Trx转账,例如发送1000 TRX:
//import "fmt"
//import "trontool/tron"
to := "TDN3QY85Jft3RwgyatjRNmrwRmwkn8qwqx" //转账目标地址
var amount int64 = 1000000000 //转账金额,单位:SUN
ret,_ := kit.SendTrx(to,amount) //提交Trx转账交易
fmt.Printf("tx id: %s\n", ret.TxId) //显示交易ID
fmt.Printf("tx state: %b\n", ret.State) //显示交易提交结果
注意:需要将金额单位转换为SUN,1 TRX = 1000000 SUN。
使用getTrxBalance()
方法查询指定地址的TRX余额,例如:
addr := "TDN3QY85Jft3RwgyatjRNmrwRmwkn8qwqx" //要查询的Tron地址
balance := kit.GetTrxBlanace(addr) //查询Trx余额,单位:SUN
fmt.Printf("balance: %d\n",balance) //显示余额
使用TronKit对象的Trc20()
方法获取指定TRC20代币合约实例,然后调用合约的transfer()
方法进行TRC20代币转账。
例如,下面的代码在指定地址间转账1315300个最小单位的TRC20-USDT代币,即1.3153 USDT:
//import "trontool/tron"
//import "math/big"
to := "TDN3QY85Jft3RwgyatjRNmrwRmwkn8qwqx" //转账目标地址
value := big.NewInt(1315300) //转账Trc20代币数量
contractAddress := "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t" //USDT代币地址
usdt, _ := kit.Trc20(contractAddress) //创建Trc20代币合约实例
ret,_ := usdt.Transfer(to, value) //转账Trc20代币
fmt.Printf("tx id: %s\n",ret.txId) //显示转账交易ID
fmt.Printf("tx state: %b\n",ret.state) //显示转账交易结果
使用TronKit对象的Trc20()
方法获取指定TRC20代币合约实例,然后调用合约的BalanceOf()
方法查询指定地址的TRC20代币余额。
例如,下面的代码查询指定地址的USDT代币余额:
//import "trontool/tron"
//impot "math/big"
usdt,_ := kit.Trc20("TR7NhqjeK…zgjLj6t") //创建USDT-TRC20代币实例
balance,_ := usdt.BalanceOf("TDN3Q…8qwqx") //查询Trc20代币余额
fmt.Printf("balance: %s\n",balance) //显示代币余额
使用TronKit对象的Trc20()
方法获取指定TRC20代币合约实例,然后调用合约的GetEvents()
方法查询指定合约触发事件。
例如查询USDT代币合约最近10秒的事件:
//import "trontool/tron"
//import "time"
//import "fmt"
usdt,_ := kit.Trc20("TR7Nhqje…zgjLj6t") //创建Trc20代币合约实例
since := time.Now().Unix()*1000 - 10000 //计算检查时间点
events,_ := usdt.GetEvents(since) //提取合约事件
for _,event := range events {
fmt.Printf("event name: %s\n",e.EventName) //显示事件名称
fmt.Printf("block height: %d\n",e.BlockNumber) //显示事件触发区块高度
}
在开发包中,使用Credential
表征Tron区块链中的一个用户身份,它与地址的区别在于, Credential包含了用户的私钥信息,可以用来签名交易,而地址则是可以公开的信息。
使用tron包的NewCredential()
方法创建新账户。例如,下面的代码创建一个新的账户并显示其私钥、公钥和地址:
//import "fmt"
//import "trontool/tron"
c,_ := tron.NewCredential() //创建新身份
fmt.Printf("private key: %s\n",c. PrivateKeyHex()); //显示私钥
fmt.Printf("public key: %s\n",c. PublicKeyHex()); //显示公钥
fmt.Printf("address: %s\n",c.AddressBase58()); //显示地址
需要指出的是,对于任何新创建的账号,Tron要求向其注入0.1 TRX进行激活后才可以使用。具体说明请参考How to create an account。
可以使用包方法HexKeyToCredential()
导入已有的私钥来实例化Credential。
例如下面的代码导入已有私钥并显示地址:
//Import "fmt"
//import "trontool/tron"
c,_ := tron.HexKeyToCredential("7889...023a") //导入已有私钥
fmt.Printf("address: %s\n",c. AddressBase58()) //显示相应地址
在Tron区块链中,地址有两种表示:16进制和base58表示,例如下面是同一个地址的两种表示:
tron包中提供了相应的编解码方法,可以在两种格式之间进行转化。例如:
//import "fmt"
//import "trontool/tron"
a1,_ := tron.DecodeBase58Address("TDN3QY85Jft3RwgyatjRNmrwRmwkn8qwqx");
fmt.Println(a1) //输出:412539EF4F3EB733C105A957EEBB20FD60AD8C9A43
a2,_ := := tron.EncodeHexAddress("412539EF4F3EB733C105A957EEBB20FD60AD8C9A43")
fmt.Println(a2) //输出:TDN3QY85Jft3RwgyatjRNmrwRmwkn8qwqx
使用TronApi
实例访问Tron的各种节点API。TronApi聚合了多种Tron节点提供的API,例如tron全节点、solidity节点和事件服务节点的API。
实例化TronApi时,可以分别为不同类型的Tron节点指定不同的连接URL,例如:
//import "trontool/tron"
tronApi := tron.NewTronApi(
"https://api.trongrid.io", //全节点URL
"https://api.trongrid.io", //合约节点URL
"https://api.trongrid.io", //事件节点URL
)
如果用的是Tron官方提供的TronGrid节点,那么可以直接使用tron包提供的两个方法分别接入主链和shasta测试链:
MainNetTronApi()
:接入主链TestNetTronApi()
:接入shasta测试链例如,下面的代码是等效的:
urlM := "https://api.trongrid.io"
tronApiM1 := tron.NewTronApi( urlM, urlM, urlM)
tronApiM2 := Tron.MainNetTronApi() //与上面等效
urlT := "https://api.shasta.trongrid.io"
tronApiT1 = tron.NewTronApi(urlT, urlT, urlT)
tronApiT2 =tron.TestNetTronApi() //与上面等效
TronApi封装了Tron官方多种节点提供的API的一个子集,提供了常用的访问Tron区块链的API的封装。
例如查询指定账户的TRX余额,可以利用Tron节点的getaccount
接口,这对应于TronApi中的getAccount()
方法:
//import "fmt"
//import "trontool/tron"
account,_ := tronApi.getAccount("TEgM5CPeqow...7vcBgVkD4tP") //查询账户信息
fmt.Printf("balance: %d\n", account.Balance) //显示账户余额
TronApi依赖于NodeCllient访问Tron的节点API。因此如果需要扩展TronApi使其支持更多的Tron节点API,可参考TronApi的现有代码并结合TRON提供的节点API的技术资料进行实现。
Tron区块链Go开发包官方下载:http://sc.hubwiz.com/codebag/tron-go-lib/