docs: fix governance voting period and glossary inaccuracies#348
docs: fix governance voting period and glossary inaccuracies#348abn2357 wants to merge 3 commits into
Conversation
The on-chain voting period is no longer fixed at 3 days; it is determined by the network parameter PROPOSAL_EXPIRE_TIME (default 3 days), which can be modified through governance.
- energyFee/net_fee: clarify the amount is measured in sun (1 TRX = 1,000,000 sun) - energyUsage: note EnergyFee is not included - consume_user_resource_percent: state it is the share paid by the caller - Energy: describe per-instruction deterministic cost instead of microseconds - FeeLimit: fix casing - Super Representative: top 27 witnesses by votes
| **energyFee** | ||
|
|
||
| 此次调用中，合约调用者消耗的Energy中，需要TRX支付的数目(SUN为单位) | ||
| 此次调用中，合约调用者消耗的Energy中，需要TRX支付的数目(以SUN为单位，1 TRX = 1,000,000 SUN) |
There was a problem hiding this comment.
energyFee / net_fee — SUN Should Be Lowercase sun
TRON's minimum unit should be written as lowercase sun to distinguish it from the TRC20 SUN token (which is an entirely different asset on the TRON network). Capitalizing it as "SUN" causes ambiguity.
Suggested fix: Use lowercase sun throughout: "以 sun 为单位，1 TRX = 1,000,000 sun"
| **energyUsage** | ||
|
|
||
| 此次调用中，合约调用者消耗的Energy的总量 | ||
| 此次调用中，合约调用者消耗的Energy(不含 EnergyFee 对应的部分) |
There was a problem hiding this comment.
此次合约调用所消耗的合约调用者账户内的 Energy 数量
| **Feelimit** | ||
| **FeeLimit** | ||
|
|
||
| 用户在调用或者创建智能合约时，指定的最高可接受的trx费用消耗，包含消耗质押获得资源的trx和消耗用户本身持有的trx两部分，优先使用质押获得的资源。 |
There was a problem hiding this comment.
Problem: feeLimit is denominated in SUN and the VM uses it to cap energy, not TRX fees.
Suggested fix: Rephrase to clarify that feeLimit caps the energy the caller is willing to consume (expressed in SUN, converted to energy units internally).
There was a problem hiding this comment.
Thx for your review. This issue, along with the capitalization of "SUN", only appears in the Chinese documentation and has now been fixed.
The phrase "此次调用中，合约调用者消耗的Energy(不含 EnergyFee 对应的部分)" was left unchanged to maintain consistency with the explanation of net_usage. Your review comment is valid, as the two expressions carry the same meaning.
…un unit - Redefine FeeLimit as the cap on Energy obtained from burning or staking TRX (staked Energy used first), matching the EN glossary, instead of the inaccurate 'max acceptable TRX fee' wording. - Use lowercase 'sun' for the unit in energyFee and net_fee to disambiguate from the TRC20 SUN token.
2 participants
Summary
Corrects several inaccuracies in the developer docs after cross-checking against the java-tron source.
Governance
PROPOSAL_EXPIRE_TIME(default 3 days), which can itself be modified through governance.Glossary
energyFee/net_fee: clarify the amount is measured in sun (1 TRX = 1,000,000 sun).energyUsage: note that EnergyFee is not included.consume_user_resource_percent: state it is the share paid by the contract caller; the remaining part is paid by the developer.Energy: describe the deterministic per-instruction cost (Energy cost schedule) instead of the inaccurate "1 Energy = 1 microsecond".FeeLimit: fix casing.Super Representative: top 27 witnesses by votes, responsible for producing blocks.Test plan