Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 38 additions & 11 deletions docs/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,20 @@

请务必为来自 API 的所有数据实施 XSS 防护,以确保用户数据的安全。我们了解您可能需要有关 XSS 防护的更多信息。建议您参考以下资源:[OWASP XSS Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html)。

首先,对HTTP API中地址格式的选择进行说明:TRON网络账户地址格式有两种:HexString格式和Base58格式。节点HTTP API支持地址格式选择,用户可以通过visible参数设置地址格式,默认值为false,参数及返回值中的地址格式均为hex格式,当visible设置为true时,参数及返回值中的地址格式均为Base58格式。如果参数格式与visible设置不匹配,将会报错。设置方式:
首先,对HTTP API中地址格式的选择进行说明:TRON网络账户地址格式有两种:HexString格式和Base58格式。
像TronLink钱包地址`TUXAoxQ8PwFAtfQet7Akc8HaV5ciC6WkjY`就是Base58格式。可以使用[TranScan](https://nile.tronscan.org/#/tools/code-converter/base58check)工具方便格式之间的转换。

节点HTTP API支持地址格式选择,用户可以通过visible参数设置地址格式,默认值为false,参数及返回值中的地址格式均为hex格式,当visible设置为true时,参数及返回值中的地址格式均为Base58格式。如果参数格式与visible设置不匹配,将会报错。设置方式:

- 对于GET方式请求接口或者不需要参数的查询接口,通过在url中增加参数`visible=true`
```text
http://127.0.0.1:8090/wallet/listexchanges?visible=true
```
- 对于POST方式请求接口,通过在json结构体最外层中增加参数`"visible": true`
```json
curl -X POST http://127.0.0.1:8090/wallet/createtransaction -d
'{
curl --location 'http://127.0.0.1:8090/wallet/createtransaction' \
--header 'Content-Type: application/json' \
--data '{
"owner_address": "TRGhNNfnmgLegT4zHNjEqDSADjgmnHvubJ",
"to_address": "TJCnKsPa7y5okkXvQAidZBzqx3QyQ6sxMW",
"amount": 1000000,
Expand Down Expand Up @@ -63,16 +67,29 @@ FullNode HTTP API分类如下:
#### wallet/validateaddress
作用:检查地址是否正确
```
curl -X POST http://127.0.0.1:8090/wallet/validateaddress -d '{"address": "4189139CB1387AF85E3D24E212A008AC974967E561"}'
curl -X POST http://127.0.0.1:8090/wallet/validateaddress
--header 'Content-Type: application/json'
-d '{"address": "4189139CB1387AF85E3D24E212A008AC974967E561"}'
```
参数说明:地址,可以是base58checksum、hexString、base64格式

返回值:地址正确或者错误
```
{
"result": true,
"message": "Hex string format"
}
```

#### wallet/createaccount
作用:创建账号,一个已经激活的账号创建一个新账号。如果创建者账号有足够的通过质押TRX获得的带宽,那么创建账户只会消耗带宽,否则,会烧掉0.1个TRX来支付带宽费用,同时需要额外支付 1 TRX的创建费用
```
curl -X POST http://127.0.0.1:8090/wallet/createaccount -d '{"owner_address":"41d1e7a6bc354106cb410e65ff8b181c600ff14292", "account_address": "41e552f6487585c2b58bc2c9bb4492bc1f17132cd0"}'
curl -X POST http://127.0.0.1:8090/wallet/createaccount
--header 'Content-Type: application/json'
-d '{
"owner_address":"41d1e7a6bc354106cb410e65ff8b181c600ff14292",
"account_address": "41e552f6487585c2b58bc2c9bb4492bc1f17132cd0"
}'
```
参数:

Expand All @@ -85,7 +102,9 @@ curl -X POST http://127.0.0.1:8090/wallet/createaccount -d '{"owner_address":"4
#### wallet/getaccount
作用:查询一个账户的信息
```
curl -X POST http://127.0.0.1:8090/wallet/getaccount -d '{"address": "41E552F6487585C2B58BC2C9BB4492BC1F17132CD0"}'
curl -X POST http://127.0.0.1:8090/wallet/getaccount
--header 'Content-Type: application/json'
-d '{"address": "41E552F6487585C2B58BC2C9BB4492BC1F17132CD0"}'
```
参数:`address` 账户地址

Expand All @@ -94,7 +113,12 @@ curl -X POST http://127.0.0.1:8090/wallet/getaccount -d '{"address": "41E552F64
#### wallet/updateaccount
作用:修改账号名称
```
curl -X POST http://127.0.0.1:8090/wallet/updateaccount -d '{"account_name": "0x7570646174654e616d6531353330383933343635353139" ,"owner_address":"41d1e7a6bc354106cb410e65ff8b181c600ff14292"}'
curl -X POST http://127.0.0.1:8090/wallet/updateaccount
--header 'Content-Type: application/json'
-d '{
"account_name": "0x7570646174654e616d6531353330383933343635353139" ,
"owner_address":"41d1e7a6bc354106cb410e65ff8b181c600ff14292"
}'
```
参数:

Expand All @@ -108,8 +132,9 @@ curl -X POST http://127.0.0.1:8090/wallet/updateaccount -d '{"account_name": "0
#### wallet/accountpermissionupdate
作用:修改账户权限
```
curl -X POST http://127.0.0.1:8090/wallet/accountpermissionupdate -d
'{
curl -X POST http://127.0.0.1:8090/wallet/accountpermissionupdate
--header 'Content-Type: application/json'
-d '{
"owner_address": "TRGhNNfnmgLegT4zHNjEqDSADjgmnHvubJ",
"owner": {
"type": 0,
Expand Down Expand Up @@ -343,7 +368,9 @@ curl -X POST http://127.0.0.1:8090/wallet/getapprovedlist -d '{
#### wallet/getaccountresource
作用:查询账户的资源信息
```
curl -X POST http://127.0.0.1:8090/wallet/getaccountresource -d {"address" : "419844f7600e018fd0d710e2145351d607b3316ce9"}
curl -X POST http://127.0.0.1:8090/wallet/getaccountresource
--header 'Content-Type: application/json'
-d {"address" : "419844f7600e018fd0d710e2145351d607b3316ce9"}
```
参数:

Expand Down Expand Up @@ -429,7 +456,7 @@ curl -X POST http://127.0.0.1:8090/wallet/freezebalancev2 -d
}'
```

参数:
参数:

- `owner_address`: 质押TRX 账号的地址, HEX 格式或 Base58check 格式
- `frozen_balance`: 质押TRX 的数量, 单位为sun
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
TIP: [https://github.com/tronprotocol/TIPs/issues/12](https://github.com/tronprotocol/TIPs/issues/12)

### 事件类型
波场事件订阅支持四种类型的事件
当交易被打包进区块后,波场会对外发送四种类型的事件

- 交易相关事件

Expand Down
2 changes: 1 addition & 1 deletion docs/clients/wallet-cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

# 什么是Wallet-Cli?
Wallet-Cli是一个支持TRON网络的交互式命令行钱包,用于在安全的本地环境中签名和广播交易,也可以获取链上数据。Wallet-Cli支持密钥管理,您可以将私钥导入钱包中,Wallet-Cli会使用对称加密算法加密您的私钥,并存储到一个keystore文件中。Wallet-Cli本地不存储链上数据,它采用gRPC的方式与某一个Java-tron节点进行通信,您需要在配置文件中配置需要链接的Java-tron节点,下图是使用Wallet-Cli签名和广播TRX转账交易的流程:
Wallet-Cli是一个支持TRON网络的交互式命令行钱包,用于在安全的本地环境中签名和广播交易,也可以获取链上数据。Wallet-Cli支持密钥创建和管理,您可以将私钥导入钱包中,Wallet-Cli会使用对称加密算法加密您的私钥,并存储到一个keystore文件中。Wallet-Cli本地不存储链上数据,它采用gRPC的方式与某一个Java-tron节点进行通信,您需要在配置文件中配置需要链接的Java-tron节点,下图是使用Wallet-Cli签名和广播TRX转账交易的流程:
![](https://i.imgur.com/NRKmZmE.png)

用户首先运行`Login`命令解锁钱包,然后运行`SendCoin`命令发送TRX,Wallet-Cli会本地构建和签名交易,然后将调用Java-tron节点的BroadcastTransaction gRPC API将交易广播的网络中,广播成功后Java-tron节点会返回交易hash给Wallet-Cli,Wallet-Cli将交易hash展示给用户。
Expand Down
Loading