Skip to content

Commit ec719c5

Browse files
authored
Merge pull request #868 from tronprotocol/release_v4.9.1
Release v4.9.1
2 parents ab2c86e + ebbe262 commit ec719c5

File tree

2 files changed

+78
-35
lines changed

2 files changed

+78
-35
lines changed

README.md

Lines changed: 76 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
# wallet-cli
1+
# Wallet-cli
22

3-
Welcome to use the Wallet-CLI.
3+
Welcome to use the Wallet-cli.
44

5-
If you need any help, please join the [Telegram](https://t.me/TronOfficialDevelopersGroupEn)
5+
Wallet-cli now supports [GasFree](https://gasfree.io) addresses, enable users to transfer tokens without paying gas fees. For more details, please check the [GasFree](#Gas-Free-Support) section below.
6+
7+
The underlying implementation of all Wallet-cli gRPC APIs has all migrated to the [Trident SDK](https://github.com/tronprotocol/trident). This strategic move consolidates the underlying implementation of the Wallet-cli's remote procedure calls, standardizing them under the robust and optimized Trident framework.
8+
9+
If you need any help, please join the [Telegram](https://t.me/TronOfficialDevelopersGroupEn).
610

711
## Get started
812

9-
### Download wallet-cli
13+
### Download Wallet-cli
1014

1115
git clone https://github.com/tronprotocol/wallet-cli.git
1216

1317
### Edit config.conf in src/main/resources
1418

1519
```
1620
net {
17-
type = mainnet
18-
# type = testnet
21+
type = mainnet
1922
}
2023
2124
fullnode = {
@@ -24,27 +27,55 @@ fullnode = {
2427
]
2528
}
2629
27-
soliditynode = {
28-
// the IPs in this list can only be totally set to solidity or pBFT.
29-
ip.list = [
30-
"ip : solidity port" // default solidity
31-
]
30+
#soliditynode = {
31+
# //The IPs in this list can only be totally set to solidity.
3232
# ip.list = [
33-
# "ip : pBFT port" // or pBFT
33+
# "ip : solidity port" // default solidity
3434
# ]
35-
} // NOTE: solidity node is optional
35+
# // NOTE: solidity node is optional
36+
#}
37+
38+
# open ledger debug
39+
# ledger_debug = true
40+
41+
# To use the lock and unlock function of the login account, it is necessary to configure
42+
# lockAccount = true in the config.conf. The current login account is locked, which means that
43+
# signatures and transactions are not allowed. After the current login account is locked, it can be
44+
# unlocked. By default, it will be unlocked again after 300 seconds. Unlocking can specify
45+
# parameters in seconds.
46+
47+
# lockAccount = true
48+
49+
# To use the gasfree feature, please first apply for an APIkey and apiSecret.
50+
# For details, please refer to
51+
# https://docs.google.com/forms/d/e/1FAIpQLSc5EB1X8JN7LA4SAVAG99VziXEY6Kv6JxmlBry9rUBlwI-GaQ/viewform
52+
gasfree = {
53+
mainnet = {
54+
apiKey = ""
55+
apiSecret = ""
56+
}
57+
testnet = {
58+
apiKey = ""
59+
apiSecret = ""
60+
}
61+
}
62+
63+
# If gRPC requests on the main network are limited in speed, you can apply for an apiKey of Trongrid to improve the user experience
64+
grpc = {
65+
mainnet = {
66+
apiKey = ""
67+
}
68+
}
3669
37-
blockNumberStartToScan = 22690588 // NOTE: this field is optional
3870
```
3971

4072
### Run a web wallet
4173

42-
- connect to fullNode and solidityNode
74+
- connect to fullNode
4375

4476
Take a look at: [java-tron deployment](https://tronprotocol.github.io/documentation-en/developers/deployment/)
45-
Run both fullNode and solidity node in either your local PC or remote server.
77+
Run fullNode on either your local PC or a remote server.
4678

47-
NOTE: These nodes would consume a lot of memory and CPU. Please be aware if you do not use wallet, just kill them.
4879
- compile and run web wallet
4980

5081
```console
@@ -54,15 +85,16 @@ blockNumberStartToScan = 22690588 // NOTE: this field is optional
5485
$ java -jar wallet-cli.jar
5586
```
5687

57-
### Connect to java-tron
88+
### Connect to Java-tron
5889

59-
Wallet-cli connect to java-tron via gRPC protocol, which can be deployed locally or remotely. Check **Run a web Wallet** section.
60-
We can configure java-tron node IP and port in ``src/main/resources/config.conf``, so that wallet-cli server can successfully talk to java-tron nodes.
90+
Wallet-cli connects to Java-tron via the gRPC protocol, which can be deployed locally or remotely. Check **Run a web Wallet** section.
91+
We can configure Java-tron node IP and port in ``src/main/resources/config.conf``, so that wallet-cli server can successfully talk to java-tron nodes.
92+
Besides that, you can simply use `SwitchNetwork` command to switch among the mainnet, testnets(Nile and Shasta) and custom networks. Please refer to the Switch Network section.
6193

6294
## Wallet-cli supported command list
6395

6496
Following is a list of Tron Wallet-cli commands:
65-
For more information on a specific command, just type the command on terminal when you start your Wallet.
97+
For more information on a specific command, just type the command in the terminal when you start your Wallet.
6698

6799
| [AddTransactionSign](#How-to-use-the-multi-signature-feature-of-wallet-cli) | [ApproveProposal](#Approve--disapprove-a-proposal) | [AssetIssue](#Issue-trc10-tokens) |
68100
|:-----------------------------------------------------------------------------------:|:-------------------------------------------------------------------:|:---------------------------------------------------------------------------------:|
@@ -1842,10 +1874,22 @@ wallet> currentnetwork
18421874
current network: CUSTOM
18431875
fullNode: EMPTY, solidityNode: localhost:50052
18441876
```
1877+
## Gas Free Support
1878+
1879+
Wallet-cli now supports GasFree integration. This guide explains the new commands and provides instructions on how to use them.
1880+
1881+
For more details, please refer to [GasFree Documentation](https://gasfree.io/specification) and [TronLink User Guide For GasFree](https://support.tronlink.org/hc/en-us/articles/38903684778393-GasFree-User-Guide).
18451882

1846-
## gas free info
1847-
> GasFreeInfo
1848-
>Get gasfree info of the current address.
1883+
Prerequisites
1884+
API Credentials: Users must obtain the API Key and API Secret from GasFree for authentication. Please refer to the official [application form](https://docs.google.com/forms/d/e/1FAIpQLSc5EB1X8JN7LA4SAVAG99VziXEY6Kv6JxmlBry9rUBlwI-GaQ/viewform) for instructions on setting up API authentication.
1885+
1886+
New Commands:
1887+
1888+
### Gas Free info
1889+
> GasFreeInfo
1890+
Query GasFree Information
1891+
Function: Retrieve the basic info, including the GasFree address associated with your current wallet address.
1892+
Note: The GasFree address is automatically activated upon the first transfer, which may incur an activation fee.
18491893

18501894
Example:
18511895
```console
@@ -1875,10 +1919,10 @@ balanceOf(address):70a08231
18751919
}
18761920
gasFreeInfo: successful !!
18771921
```
1878-
1879-
## gas free transfer
1880-
> GasFreeTransfer
1881-
>Transfer funds through gas-free.
1922+
### Gas Free transfer
1923+
> GasFreeTransfer
1924+
Submit GasFree Transfer
1925+
Function: Submit a gas-free token transfer request.
18821926

18831927
Example:
18841928
```console
@@ -1910,9 +1954,10 @@ GasFreeTransfer result: {
19101954
GasFreeTransfer successful !!!
19111955
```
19121956

1913-
## gas free trace
1914-
> GasFreeTrace
1915-
>Query GasFreeTrace to obtain transfer details by using the transaction ID returned by GasFreeTransfer as the traceId.
1957+
### Gas Free trace
1958+
> GasFreeTrace
1959+
Track Transfer Status
1960+
Function: Check the progress of a GasFree transfer using the traceId obtained from GasFreeTransfer.
19161961

19171962
Example:
19181963
```console

src/main/resources/config.conf

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,11 @@ fullnode = {
99
}
1010

1111
#soliditynode = {
12-
# // the IPs in this list can only be totally set to solidity or pBFT.
12+
# // the IPs in this list can only be totally set to solidity.
1313
# ip.list = [
1414
# "127.0.0.1:50052" // default solidity
1515
# ]
16-
# ip.list = [
17-
# "127.0.0.1:50071" // or pBFT
18-
# ]
16+
# // NOTE: solidity node is optional
1917
#}
2018

2119
# open ledger debug

0 commit comments

Comments
 (0)