tronprotocol · Alexanderjoh · Nov 9, 2018 · Nov 9, 2018 · Nov 12, 2018 · Nov 12, 2018
diff --git a/English_Documentation/TRON_BUG-BOUNTY_Program/TRON_BUG-BOUNTY_Program.md b/English_Documentation/TRON_BUG-BOUNTY_Program/TRON_BUG-BOUNTY_Program.md
diff --git a/English_Documentation/TRON_Event_Subscribe/Tron-event_description.md b/English_Documentation/TRON_Event_Subscribe/Tron-event_description.md
@@ -0,0 +1,85 @@
+
+
+> Trigger 类别
+
+可支持订阅的Event类型：
+
+ - transactionTrigger:  transaction事件，区块时触发
+ - blockTrigger: 区块事件，提交区块时触发
+ - contractLogTrigger: 智能合约日志
+ - contractEventTrigger:智能合约事件
+
+
+> Filter定义
+
+只针对智能合约日志、事件的订阅，具体包括如下字段：
+
+fromBlock: 起始区块高度，可以设置为"", "earliest"或者具体的区块高度。
+toBlock: 结束区块高度，可以设置为""，"latest"或者具体的区块高度。
+contractAddress：智能合约地址列表
+contractTopics：智能合约主题列表
+**注意**: 不支持历史数据查询。
+
+
+> 交易Log
+
+交易信息用TransactionLogTrigger表示，包括如下参数:
+
+ - transactionId, transaction哈希 
+ - blockHash, 交易发生的区块hash 
+ - blockNumber,交易发生的block number 
+ - energyUsage, 能量使用 
+ - energyFee，能量费用 
+ - originEnergyUsage origin energy usage 
+ - energyUsageTotal, total energy usage total
+
+
+> 智能合约Log
+
+智能合约日志对象用ContractLogTrigger表示，包括如下参数：
+
+ - transactionId, transaction id 
+ - contractAddress:  合约地址 
+ - callerAddress:合约调用者地址 
+ - blockNumber: 交易所在的块号 
+ - blockTimestamp: 交易所在块的打包时间
+ - contractTopics: Solidity 语言中 Log 能够输出的 topic 列表 
+ - data: Solidity 语言中,Log 能够输出的 data
+ - removed，如果日志已被删除则为true，有效日志则为false
+
+
+> 智能合约Event
+
+ - transactionId, transaction id 
+ - contractAddress:  合约地址 
+ - callerAddress:合约调用者地址 
+ - blockNumber: 交易所在的块号 
+ - blockTimestamp: 交易所在块的打包时间
+ - eventSignature: Event 的签名字符串
+ - topicMap: Solidity 语言中 Event 能够输出的 topic名称 => topic 值的映射
+ - data: Solidity 语言中, Event 能够输出的 data 字段
+ - removed，如果日志已被删除则为true，有效日志则为false
+
+
+> Trigger触发
+
+ - 区块事件的触发，区块插入时创建blockTrigger
+ - 交易事件的触发，交易执行之前创建transactionTrigger
+ - 智能合约日志的触发，在合约执行并且解析之后创建contractLogTrigger
+ - 智能合约事件的触发，在合约执行并且解析之后创建contractEventTrigger
+
+
+> Trigger发送
+
+java-tron以异步方式将Trigger发送给插件，Trigger必须满足Filter的条件。
+
+如下所示是一个Filter，Trigger的blockNumber必须在fromBlock与toBlock之间，contractAddresses必须是addressA，topics必须包括topicA，只有满足条件的Trigger才会被发送。
+
+fromBlock: 0x1000000
+
+toBlock: 0x1200000
+
+contractAddresses: "addressA"
+
+contractTopics: "TopicA"
+
diff --git a/English_Documentation/TRON_Event_Subscribe/Tron-eventsubscribe.md b/English_Documentation/TRON_Event_Subscribe/Tron-eventsubscribe.md
@@ -1,6 +1,6 @@
 # Tron event subscribe support 
 ## 1.  Background
-TRON has implemented the event subscription mechanism to support developer community, we have finished the testing. The featured will be released on version 3.5 of Java-tron. Developers could start experiencing right now, although it's still in beta stage.
+TRON has implemented the event subscription mechanism to support developer community, we have finished the testing. The featured has been released on version 3.5 of Java-tron, and developers could start experiencing now.
 
 
 ## 2.  New features
@@ -11,12 +11,13 @@ TRON has implemented the event subscription mechanism to support developer commu
 3. Event query service tron-eventquery, online Event query service provided. Developers can query trigger information in the last seven days through https, and the query address is https://api.tronex.io.
 
 ## 3. github project
-- [java-tron](https://github.com/tronprotocol/java-tron) develop branch  (Now it's still in 3.5 beta)
+- [java-tron](https://github.com/tronprotocol/java-tron) master branch 
 - [eventplugin](https://github.com/tronprotocol/event-plugin) master branch
 - [tron-eventquery](https://github.com/tronprotocol/tron-eventquery) master branch
 
 ## 4. event subscribe
-- https://github.com/tronprotocol/TIPs/issues/12
+- TIP: https://github.com/tronprotocol/TIPs/issues/12
+- Description: https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/TRON_Event_Subscribe/Tron-event_description.md
 
 ## 5. event plugin
 - kafka plugin: https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/TRON_Event_Subscribe/eventplugin_deploy.md

diff --git a/English_Documentation/TRON_Event_Subscribe/tron-eventquery.md b/English_Documentation/TRON_Event_Subscribe/tron-eventquery.md
@@ -134,7 +134,6 @@ limit: each page size, default is 25
 sort: sort Field, default is sort by timeStamp descending order
 start: start page, default is 1
 
-Note: if developers wants to check whether this event is confirmed or not, they could check the blocknumber is small than the solidified block number(get from url https://api.tronex.io/blocks/latestblockNum). If it is smaller than block number, it is conformed
 
 Example: https://api.tronex.io/events/confirmed?since=1544483426749&limit=1&start=1&sort=timeStamp
 ```
@@ -161,7 +160,7 @@ block: block number, block number >= block will be shown
 
 Example: https://api.tronex.io/blocks?limit=1&sort=timeStamp&start=0&block=0
 ```
-Function: get latest solidified block number
+Function: get latest block number
 ```
 subpath: $baseUrl/blocks/latestSolidifiedBlockNumber
 
@@ -170,3 +169,73 @@ none
 
 Example: https://api.tronex.io/blocks/latestSolidifiedBlockNumber
 ```
+Function: get contract log list
+```
+subpath: $baseUrl/contractlogs
+
+parameters   
+limit: each page size, default is 25
+sort: sort Field, default is sort by timeStamp descending order
+start: start page, default is 1
+block: block number, block number >= block will be shown 
+
+Example: https://api.tronex.io/contractlogs
+```
+Function: get contract log list based on transactionId
+```
+subpath: $baseUrl/contractlogs/transaction/{transactionId}
+
+parameters   
+transactionId
+
+Example: https://api.tronex.io/contractlogs/transaction/{transactionId}
+```
+Function: post abi string and get contract log list based on transactionId(release on 3.6)
+```
+subpath: $baseUrl/contract/transaction/{transactionId}
+
+parameters   
+transactionId
+body:
+abi: user self upload abi
+
+Example: https://api.tronex.io/contract/transaction/{transactionId}
+```
+Function: get contract log list based on contractAddress
+```
+subpath: $baseUrl/contractlogs/contract/{contractAddress}
+
+parameters   
+contractAddress
+
+Example: https://api.tronex.io/contractlogs/contract/{contractAddress}
+```
+Function: post abi string and get contract log list based on contractAddress(release on 3.6)
+```
+subpath: $baseUrl/contract/contractAddress/{contractAddress}
+
+parameters   
+contractAddress
+abi: user self upload abi
+
+Example: https://api.tronex.io/contract/contractAddress/{contractAddress}
+```
+Function: get contract log list based on uniqueId
+```
+subpath: $baseUrl/contractlogs/uniqueId/{uniqueId}
+
+parameters   
+uniqueId
+
+Example: https://api.tronex.io/contractlogs/uniqueId/{uniqueId}
+```
+Function: post abi string and get contract log list based on uniqueId(release on 3.6)
+```
+subpath: $baseUrl/contract/uniqueId/{uniqueId}
+
+parameters   
+uniqueId
+abi: user self upload abi
+
+Example: https://api.tronex.io/contract/uniqueId/{uniqueId}
+```
diff --git a/English_Documentation/TRON_Protocol/TRON_Wallet_RPC-API.md b/English_Documentation/TRON_Protocol/TRON_Wallet_RPC-API.md
@@ -455,7 +455,7 @@ EasyTransferResponse: the transaction of a transfer and the result of broadcasti
 
 ## 37. Generate address and private key  
 37.1 Interface statement  
-rpc GenerateAddress (EmptyMessage) returns (AddressPrKeyPairMessage) {};  
+rpc DeployContract (CreateSmartContract) returns (TransactionExtention) {};\
 37.2 Nodes  
 FullNode and SolidityNode.  
 37.3 Parameters  
@@ -464,3 +464,27 @@ EmptyMessage: null.
 AddressPrKeyPairMessage: generate address and private key.  
 37.5 Function  
 Address and private key generation. Please invoke this API only on a trusted offline node to prevent private key leakage.
+
+//todo:translate https://github.com/tronprotocol/Documentation/edit/master/中文文档/波场协议/波场钱包RPC-API.md
+
+## 80. Deploy a smart contract 
+80.1 Interface statement  
+rpc DeployContract (CreateSmartContract) returns (TransactionExtention) {};\
+80.2 Nodes  
+FullNode.  
+80.3 Parameters  
+CreateSmartContract: message type for creating a new smart contract, including owner_address(transaction sender address), new_contract(a SmartContract Object), call_token_value(trc10), token_id(trc10) \
+>new_contract: origin_address(contract deployer address), contract_address, abi, bytecode, call_value(trx), consume_user_resource_percent(user energy consume percentage), name(contract name), origin_energy_limit(the energy limit developer willing to afford for a trigger operation).
+
+80.4 Returns  
+TransactionExtention: a message type contains transaction, transaction_id, constant_result and on-block result.
+
+## 81. Trigger a smart contract
+81.1 Interface statement  
+rpc TriggerContract (TriggerSmartContract) returns (TransactionExtention) {};\
+81.2 Nodes  
+FullNode.  
+81.3 Parameters  
+TriggerSmartContract: message type for triggering an existing contract, including owner_address(transaction sender address), contract_address, call_value(trx), data(triggered function signature and parameter), call_token_value(trc10), token_id(trc10)\
+81.4 Returns  
+TransactionExtention: a message type contains transaction, transaction_id, constant_result and on-block result.
diff --git a/English_Documentation/TRON_Virtual_Machine/TRC10_IN_SMARTCONTRACT.MD b/English_Documentation/TRON_Virtual_Machine/TRC10_IN_SMARTCONTRACT.MD
@@ -84,23 +84,28 @@ contract transferTokenContract {
 
 - **IMPORTANT**: tokenId valide value must > 1000000. The best-practice would be use a require function to guarantee its correctness.
 
-- **IMPORTANT**: tokenId = 0 (Only in this function) is preserved here, which is presented TRX. This is a experimental feature, we **DO NOT** recommend to use this logic to transfer TRX at least for now for your safety. Please use the widely used transfer() function to send TRX.
+- @deprecated **IMPORTANT**: tokenId = 0 (Only in this function) is preserved here, which is presented TRX. This is a experimental feature, we **DO NOT** recommend to use this logic to transfer TRX at least for now for your safety. Please use the widely used transfer() function to send TRX.
+
+- In Odyssey_v3.5 tokenId is NOT allowed to be 0 in this function. So, the function is only related to trc10 token.
 
 ## 3.4 address.tokenBalance(trcToken) returns(uint256 tokenAmount)native function
 
 - Odyssey_v3.2 defined a new tokenBalance function for TRC10 token balance querying.
 
 - An address type variable can invoke this native function which returns the amount of target token owned by the account with the address.
 
-- **IMPORTANT**: Query tokenBalance(0) doesn't represent trx balance, instead it will return 0. 
+- @deprecated **IMPORTANT**: Query tokenBalance(0) doesn't represent trx balance, instead it will return 0. 
+
+- In Odyssey_v3.5 tokenId is NOT allowed to be 0 in tokenBalance(trcToken) function. 
 
 ## 3.5 msg.tokenvalue & msg.tokenid
 
 - msg.tokenvalue, represent the tokenvalue in current msg call, default 0.
 
 - msg.tokenid, represent the token id in current msg call, default 0.
 
-- **IMPORTANT**: msg.tokenid = 0 doesn't represent trx in current version.
+- **IMPORTANT**: msg.tokenid = 0 is just a default value, means no token transferring.
+
 
 # 4 solidity compiler
 

diff --git a/README.md b/README.md
@@ -1,70 +1,4 @@
-# Documentation
+#### This documentation project is DEPRECATED, if you want to update or add a new documentation, please go to our new documentation project:
+- [documentation-en](https://github.com/tronprotocol/documentation-en) 
+- [documentation-zh](https://github.com/tronprotocol/documentation-zh) 
 
-#### Please visit the new [TRON Developers Hub](https://developers.tron.network/) for detailed guides, interactive APIs, and much more!
-
-# Documentation Guide
-
-+ If you want to know more about the recent progress of the TRON project, please check out [TRON Introduction](https://github.com/tronprotocol/Documentation/tree/master/English_Documentation/TRON_Introduction).  
-+ If you want to know more about the protocol documentation, please check out [TRON Protocol](https://github.com/tronprotocol/Documentation/tree/master/English_Documentation/TRON_Protocol).  
-+ If you want to know more about the SR information, vote, or token creation, please check out [TRON blockchain explorer](https://github.com/tronprotocol/Documentation/tree/master/English_Documentation/TRON_Blockchain_Explorer). 
-+ If you want to know more about TRON Wallet, please check out [Android Wallet](https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/Android_Wallet/Guide_to_Android_Wallet.md).
-+ If you want to know more about the programming contest, please check out [TRON programming contest](https://github.com/tronprotocol/Documentation/tree/master/English_Documentation/TRON_Programming_Contest).
-+ If you want to know more about the TRX migration, please check out [TRX](https://github.com/tronprotocol/Documentation/tree/master/TRX).
-+ For more information about Virtual Machine, please check out [TVM](https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/TRON_Virtual_Machine/Virtual_Machine_Introduction.md).
-+ For latest process of TRON, please follow the [TRON documentation](https://github.com/tronprotocol/Documentation/tree/master/English_Documentation).
-
-# Super Representative Guide
-
-## What is a Super Representative?
-
-To learn about Super Representatives, please read  [What is a Super Representative](https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/TRON_Blockchain_Explorer/What_is_a_Super_Representative.md).
-
-## How to become a Super Representative
-
-**Step1.**
-
-First of all, you need to run a Super Representative. For more information about running a Super Representative, please visit [java-tron Guide](https://github.com/tronprotocol/java-tron/blob/develop/README.md) and take *Running a local node and connecting to the public testnet* -> *Running a Super Node* as reference.
-
-**Step2.** 
-
-Visit our blockchain explorer to apply for Super Representative, please take [Running a Super Representative](https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/TRON_Blockchain_Explorer_Introduction/How_to_run_a_Super_Representative.md).
-
-**Step3.** 
-
-After approval voting, the top 27 Super Representatives by total approval will be selected. The voting of Super Representatives is held once every 6 hours. Please read [How to vote](https://github.com/ybhgenius/Documentation/blob/master/English_Documentation/TRON_Blockchain_Explorer/Guide_to_voting_on_the_new_blockchain_explorer.md).
-
-
-
-
-# 文档
-
-# 文档指引
-
-+ 如果你想了解波场的发展进程以及最新动态，请查看[波场介绍](https://github.com/tronprotocol/Documentation/tree/master/中文文档/波场介绍)相关文档。  
-+ 如果你想了解波场的相关技术协议，请查看[波场协议](https://github.com/tronprotocol/Documentation/tree/master/中文文档/波场协议)相关文档。
-+ 如果你想了解有关超级节点、投票和发行资产的相关信息，请查看[波场区块链浏览器](https://github.com/tronprotocol/Documentation/tree/master/中文文档/波场区块链浏览器介绍)。
-+ 如果你想了解关于波场钱包的相关信息，请查看[Android钱包使用指导](https://github.com/tronprotocol/Documentation/blob/master/中文文档/Android钱包/Android钱包使用指导.md)。
-+ 如果你想了解编程大赛，请查看[波场编程大赛](https://github.com/tronprotocol/Documentation/tree/master/中文文档/波场编程大赛)。
-+ 如果你想了解波场TRX迁移，请查看[TRX](https://github.com/tronprotocol/Documentation/tree/master/TRX)相关文档。
-+ 对于波场虚拟机的更多信息，请查看[TVM](https://github.com/tronprotocol/Documentation/blob/master/English_Documentation/TRON_Virtual_Machine/Virtual_Machine_Introduction.md)相关文档。
-+ 对于波场发展的最新进展，请时刻关注[波场文档](https://github.com/tronprotocol/Documentation/tree/master/中文文档)。
-
-# 超级代表文档指引
-
-## 什么是超级代表？  
-
-请参见:[超级代表介绍](https://github.com/tronprotocol/Documentation/blob/master/中文文档/波场区块链浏览器介绍/什么是超级代表.md)。
-
-## 如何申请成为一个超级代表？
-
-**Step1.**
-
-首先，你需要运行一个超级代表节点。如何运行超级代表节点请参见[java-tron 指引](https://github.com/tronprotocol/java-tron/blob/develop/README.md)里的*Running a local node and connecting to the public testnet* -> *Running a Super Node*。
-
-**Step2.** 
-
-对于如何使用波场区块链浏览器，请参见[波场区块链浏览器使用指南](https://github.com/tronprotocol/Documentation/blob/master/中文文档/波场区块链浏览器介绍/区块链浏览器使用指南.md)。
-
-## 常见问题
-
-有关超级代表、超级代表节点运行、申请、竞选的相关问题请查看[关于SR的常见问题解答](https://github.com/tronprotocol/Documentation/blob/master/中文文档/常见问题解答/关于SR的常见问题解答.md)。