Skip to content

Commit 6b8420d

Browse files
authored
Merge pull request #403 from King31T/spellingNorm
fix: Normalize the spelling of TRON and java-tron
2 parents 98f3b1e + 934647c commit 6b8420d

38 files changed

+210
-210
lines changed

docs/architecture/database.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Database configuration
2-
Java-tron data storage supports LevelDB or RocksDB, and LevelDB is used by default. You can also choose RocksDB, which provides lots of configuration parameters, allowing nodes to be tuned according to their own machine configuration. The node database occupies less disk space than LevelDB. At the same time, RocksDB supports data backup during runtime, and the backup time only takes a few seconds.
2+
java-tron data storage supports LevelDB or RocksDB, and LevelDB is used by default. You can also choose RocksDB, which provides lots of configuration parameters, allowing nodes to be tuned according to their own machine configuration. The node database occupies less disk space than LevelDB. At the same time, RocksDB supports data backup during runtime, and the backup time only takes a few seconds.
33

4-
The following describes how to set the storage engine of the Java-tron node to RocksDB, and how to perform data conversion between leveldb and rocksdb.
4+
The following describes how to set the storage engine of the java-tron node to RocksDB, and how to perform data conversion between leveldb and rocksdb.
55

66
# RocksDB
77

docs/architecture/event.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### TIP
66

7-
The TIP: [TIP-12:Tron event subscribes model](https://github.com/tronprotocol/tips/blob/master/tip-12.md) .
7+
The TIP: [TIP-12:TRON event subscribes model](https://github.com/tronprotocol/tips/blob/master/tip-12.md) .
88

99
### Event Type
1010

@@ -98,21 +98,21 @@ contractTopics: contract topics list
9898

9999
#### Event query
100100

101-
Tron Event Query Service
101+
TRON Event Query Service
102102

103103
TronEventQuery is implemented with Tron's new event subscribe model. It uses same query interface with Tron-Grid. Users can also subscribe block trigger, transaction trigger, contract log trigger, and contract event trigger. TronEvent is independent of a particular branch of java-tron, the new event subscribes model will be released on version 3.5 of java-tron.
104104

105-
For more information of tron event subscribe model, please refer to [TIP-12](https://github.com/tronprotocol/TIPs/issues/12).
105+
For more information of TRON event subscribe model, please refer to [TIP-12](https://github.com/tronprotocol/TIPs/issues/12).
106106

107107
- [Event query deployment](https://tronprotocol.github.io/documentation-en/developers/deployment/#event-subscribe-plugin-deployment)
108108
- [Event query HTTP API](https://github.com/tronprotocol/documentation-en/tree/master/docs_without_index/plugin/event-query-http.md)
109109

110110

111-
## Using Java-tron's Built-in Message Queue for Event Subscription
111+
## Using java-tron's Built-in Message Queue for Event Subscription
112112

113-
TRON provides event subscription service. Developers can not only obtain on-chain events through event plugin, but also through [Java-tron’s built-in ZeroMQ message queue](https://github.com/tronprotocol/tips/blob/master/tip-28.md). The difference is that event plugin needs to be additionally deployed, which is used to implement event storage: developers can choose appropriate storage tools according to their needs, such as MongoDB, Kafka, etc., and the plugin help complete the storage of subscribed events. Java-tron's built-in ZeroMQ does not require additional deployment operations. Event subscribers can directly connect to the publisher's ip and port, set subscription topics, and receive subscribed events. However, this method does not provide event storage. Therefore, when developers want to subscribe to events directly from nodes for a short period of time, then using the built-in message queue will be a more appropriate choice.
113+
TRON provides event subscription service. Developers can not only obtain on-chain events through event plugin, but also through [java-tron’s built-in ZeroMQ message queue](https://github.com/tronprotocol/tips/blob/master/tip-28.md). The difference is that event plugin needs to be additionally deployed, which is used to implement event storage: developers can choose appropriate storage tools according to their needs, such as MongoDB, Kafka, etc., and the plugin help complete the storage of subscribed events. java-tron's built-in ZeroMQ does not require additional deployment operations. Event subscribers can directly connect to the publisher's ip and port, set subscription topics, and receive subscribed events. However, this method does not provide event storage. Therefore, when developers want to subscribe to events directly from nodes for a short period of time, then using the built-in message queue will be a more appropriate choice.
114114

115-
This article will introduce how to subscribe to events through Java-tron's built-in message queue in detail.
115+
This article will introduce how to subscribe to events through java-tron's built-in message queue in detail.
116116

117117

118118
### Configure node

docs/clients/tron-grid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ TronGrid provides TRON clients running in the cloud, so you don't have to run on
88

99
TronGrid offers an easy to use hosted API, load balanced full nodes, secure and reliable developer tools with direct access to the TRON Network.
1010

11-
TronGrid uses a set of NodeJS apps to talk with Redis and PostgreSQL to provide a simple, fast and reliable query interface for the Tron API.
11+
TronGrid uses a set of NodeJS apps to talk with Redis and PostgreSQL to provide a simple, fast and reliable query interface for the TRON API.
1212

1313
TronGrid supports 2 types of api:
1414

docs/clients/wallet-cli-command.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1884,9 +1884,9 @@ wallet> getproposal 34
18841884
18851885
### VoteWitness
18861886
1887-
Voting requires Tron Power, which can be obtained by freezing funds.
1887+
Voting requires TRON Power, which can be obtained by freezing funds.
18881888
```
1889-
wallet> votewitness [SR(Super Representatives) address] [Tron Power Amount]
1889+
wallet> votewitness [SR(Super Representatives) address] [TRON Power Amount]
18901890
```
18911891
18921892
* The share calculation method is: 1 unit of share can be obtained for every 1TRX frozen.
@@ -1896,7 +1896,7 @@ wallet> votewitness [SR(Super Representatives) address] [Tron Power Amount]
18961896
18971897
For example:
18981898
```shell
1899-
wallet> freezeBalance 100000000 3 1 address # Freeze 10TRX and acquire 10 units of Tron Power
1899+
wallet> freezeBalance 100000000 3 1 address # Freeze 10TRX and acquire 10 units of TRON Power
19001900
19011901
wallet> votewitness [SR1] 4 [SR2] 6 # Cast 4 votes for SR1 and 6 votes for SR2 at the same time
19021902

docs/clients/wallet-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
## What is Wallet-CLI?
3-
Wallet-Cli is an interactive command-line wallet that supports the TRON network for signing and broadcasting transactions in a secure local environment, as well as access to on-chain data. Wallet-Cli supports key management, you can import the private key into the wallet, Wallet-Cli will encrypt your private key with a symmetric encryption algorithm and store it in a keystore file. Wallet-Cli does not store on-chain data locally. It uses gRPC to communicate with a Java-tron node. You need to configure the Java-tron node to be linked in the configuration file. The following figure shows the process of the use of Wallet-Cli to sign and broadcast when transferring TRX:
3+
Wallet-Cli is an interactive command-line wallet that supports the TRON network for signing and broadcasting transactions in a secure local environment, as well as access to on-chain data. Wallet-Cli supports key management, you can import the private key into the wallet, Wallet-Cli will encrypt your private key with a symmetric encryption algorithm and store it in a keystore file. Wallet-Cli does not store on-chain data locally. It uses gRPC to communicate with a java-tron node. You need to configure the java-tron node to be linked in the configuration file. The following figure shows the process of the use of Wallet-Cli to sign and broadcast when transferring TRX:
44
![](https://i.imgur.com/NRKmZmE.png)
55

6-
The user first runs the `Login` command to unlock the wallet, and then runs the `SendCoin` command to send TRX, Wallet-Cli will build and sign the transaction locally, and then call the BroadcastTransaction gRPC API of the Java-tron node to broadcast the transaction to the network. After the broadcast is successful, the Java-tron node will return the transaction hash to Wallet-Cli, and Wallet-Cli will display the transaction hash to the user.
6+
The user first runs the `Login` command to unlock the wallet, and then runs the `SendCoin` command to send TRX, Wallet-Cli will build and sign the transaction locally, and then call the BroadcastTransaction gRPC API of the java-tron node to broadcast the transaction to the network. After the broadcast is successful, the java-tron node will return the transaction hash to Wallet-Cli, and Wallet-Cli will display the transaction hash to the user.
77

88
Install and run: [Wallet-Cli](https://github.com/tronprotocol/wallet-cli)
99

docs/contracts/contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Smart contract is a computerized transaction protocol that automatically implements its terms. Smart contract is the same as common contract, they all define the terms and rules related to the participants. Once the contract is started, it can runs in the way it is designed.
66

7-
TRON smart contract support Solidity language in (Ethereum). You can find the latest solidity version in the [Tron solidity repository](https://github.com/tronprotocol/solidity/releases). Write a smart contract, then build the smart contract and deploy it to TRON network. When the smart contract is triggered, the corresponding function will be executed automatically.
7+
TRON smart contract support Solidity language in (Ethereum). You can find the latest solidity version in the [TRON solidity repository](https://github.com/tronprotocol/solidity/releases). Write a smart contract, then build the smart contract and deploy it to TRON network. When the smart contract is triggered, the corresponding function will be executed automatically.
88

99
## Smart Contract Features
1010
TRON virtual machine is based on Ethereum solidity language, it also has TRON's own features.
@@ -135,7 +135,7 @@ Ethereum VM address is 20 bytes, but TRON's VM address is 21 bytes.
135135
Need to convert TRON's address while using in solidity (recommended):
136136
```text
137137
/**
138-
* @dev convert uint256 (HexString add 0x at beginning) tron address to solidity address type
138+
* @dev convert uint256 (HexString add 0x at beginning) TRON address to solidity address type
139139
* @param tronAddress uint256 tronAddress, begin with 0x, followed by HexString
140140
* @return Solidity address type
141141
*/

docs/contracts/tvm.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Currently, TVM is compatible with EVM and will be with more mainstream VMs in th
2222
4. Developer-friendly
2323

2424
Thanks to TVM’s bandwidth setup, developments costs are reduced and developers can focus on the logic of their contract code. TVM also offers all-in-one interfaces for contract deployment, triggering and viewing, for the convenience of developers.
25-
The following interfaces are available in Tron Wallet-CLI:
25+
The following interfaces are available in TRON Wallet-CLI:
2626

2727
+ deploycontract(password, contractAddress, ABI, code, data, value)
2828
+ triggercontract(password, contractAddress, selector, data, value)
@@ -31,10 +31,10 @@ Developers can call these interfaces to deploy, trigger or check smart contracts
3131

3232
## How TVM Works
3333

34-
![Flowchart of Tron Virtual Machine](https://raw.githubusercontent.com/tronprotocol/documentation/master/images/Virtual_Machine/虚拟机.png)
34+
![Flowchart of TRON Virtual Machine](https://raw.githubusercontent.com/tronprotocol/documentation/master/images/Virtual_Machine/虚拟机.png)
3535

3636
The above flowchart shows how TVM works:
37-
Compilation of Tron smart contract→execution and computing engines of VM→Interoperation service layer for external interfaces.
37+
Compilation of TRON smart contract→execution and computing engines of VM→Interoperation service layer for external interfaces.
3838

3939
Put simply, the flow is as follows:
4040
+ Currently, TVM is compatible mainly with Solidity. The compiler translates Solidity smart contract into bytecode readable and executable on TVM.
@@ -44,15 +44,15 @@ Put simply, the flow is as follows:
4444
## Future Development of TVM
4545
1. More developer-friendly debugging tools
4646

47-
Tron will be committed to the development of optimized debugging tools and the establishment of standardized symbol and data format, for improved developer efficiency.
47+
TRON will be committed to the development of optimized debugging tools and the establishment of standardized symbol and data format, for improved developer efficiency.
4848

4949
2. Fulfillment of diversified processing demands
5050

5151
Different from gas consumption mechanism for every transaction on EVM, there is no charge on TVM. Each operation only occupies bandwidth, which will be released within a certain amount of time after completion of transaction. It takes developers very little to develop smart contracts with more complex logic. It is our belief that besides being used for digital asset transactions, smart contracts could also be suitably applied to areas such as game development, financial risk modeling and scientific computing. The design of TVM inherently supports multi-scenario tasks, and further optimizations of processing speed, response time, and floating point compatibility.
5252

5353
3. Improvement of Just-In-Time (JIT) compilation speed and integration of WebAssembly
5454

55-
Improving JIT compilation speed is conducive to faster interpretation and optimized compilation of local code. Meanwhile, Tron is planning to further optimize its TVM based on WebAssembly (WASM). WebAssembly, spearheaded by Apple, Google, Microsoft and Mozilla, is designed to break bottlenecks of current Web browsers and can be generated through compiling C/C++ and other programming languages. Integrating WASM, TVM will be able to provide high performance and high throughput for blockchain to cope with complex scenarios.
55+
Improving JIT compilation speed is conducive to faster interpretation and optimized compilation of local code. Meanwhile, TRON is planning to further optimize its TVM based on WebAssembly (WASM). WebAssembly, spearheaded by Apple, Google, Microsoft and Mozilla, is designed to break bottlenecks of current Web browsers and can be generated through compiling C/C++ and other programming languages. Integrating WASM, TVM will be able to provide high performance and high throughput for blockchain to cope with complex scenarios.
5656

5757
## Usage Guide to TVM
5858

@@ -82,9 +82,9 @@ pragma solidity^0.4.11;
8282
3. Deploy contract
8383

8484
Wallet-cli-vm branch: [https://github.com/tronprotocol/wallet-cli/tree/wallet-cli-vm](https://github.com/tronprotocol/wallet-cli/tree/wallet-cli-vm)
85-
Java-tron-vm branch: [https://github.com/tronprotocol/java-tron/tree/develop_vm](https://github.com/tronprotocol/java-tron/tree/develop_vm)
85+
java-tron-vm branch: [https://github.com/tronprotocol/java-tron/tree/develop_vm](https://github.com/tronprotocol/java-tron/tree/develop_vm)
8686
Password: password of client-end wallet
87-
ContractAddress: customized contract address (in Tron’s required format)
87+
ContractAddress: customized contract address (in TRON’s required format)
8888
ABI: interface description
8989
Data: parameters of the initial function
9090
Value: reserved field
@@ -101,4 +101,4 @@ triggercontract(Password, ContractAddress, Selector, Data, Value)
101101
getcontract(ContractAddress)
102102
```
103103

104-
The above is an introduction of Tron Virtual Machine and a guide to deployment. We welcome everyone to check out TVM and give us your thoughts and suggestions. We will continue to perfect and update TVM for optimal performance on TRON mainnet.
104+
The above is an introduction of TRON Virtual Machine and a guide to deployment. We welcome everyone to check out TVM and give us your thoughts and suggestions. We will continue to perfect and update TVM for optimal performance on TRON mainnet.

0 commit comments

Comments
 (0)