Sync system-contracts doc with java-tron proto#601
Open
abn2357 wants to merge 3 commits into
Open
Conversation
…ctType overview - Add missing contracts: MarketSellAssetContract, MarketCancelOrderContract, CancelAllUnfreezeV2Contract - Expand the Account Permission Management link into a full AccountPermissionUpdateContract message section - Fix ParticipateAssetIssueContract field name: account_name -> asset_name - Reorder all sections to match the ContractType enum order - Move the ContractType overview table from multi-signatures.md to system-contracts.md as the canonical index, leaving a link reference behind
- ClearABIContract: rename account_address to contract_address to match proto - AccountPermissionUpdateContract: clarify that witness permission is required for SR accounts and must be empty otherwise; note 8-entry cap on actives - Drop (Deprecated) prefix from FreezeBalanceContract heading for consistency with other disabled contracts (status is already in the overview table)
3 tasks
- AssetIssueContract: add missing precision=7 and id=41 fields; fix the
order=11 comment ("useless"); document the id field.
- UnfreezeBalanceContract: correct receiver_address field number from 13
to 15.
- DelegateResourceContract: add missing lock_period=6 field and document
its interaction with the MAX_DELEGATE_LOCK_PERIOD proposal.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
system-contracts.mdthat lists everyContractType(enum value fromTron.proto) together with its Proto Message, Actuator class, current status, and the business it triggers; the per-contract message definitions stay in the sections below.UpdateEnergyLimitContract,AccountPermissionUpdateContract,MarketSellAssetContract,MarketCancelOrderContract,CancelAllUnfreezeV2Contract.ParticipateAssetIssueContract:account_name→asset_nameClearABIContract:account_address→contract_addressAccountPermissionUpdateContractfield constraints to matchAccountPermissionUpdateActuator.validate():witnessis required for SR accounts and must be empty for non-witness accountsactivesis capped at 8 entries(Deprecated)prefix from theFreezeBalanceContractheading so it lines up with the other disabled contracts (ExchangeTransactionContract,ShieldedTransferContract,MarketSellAssetContract, ...); status is already conveyed in the overview table.ContractTypetable inmulti-signatures.mdwith a link back to the new overview section to keep a single source of truth.All entries were cross-checked against
protocol/src/main/protos/core/Tron.proto, the per-contract*.protofiles, and each*Actuator.javain java-tron.Test plan
mkdocs serve(or the project's docs build) renders the new## ContractType Overviewtable and the new per-contract sections without warningsmulti-signatures.md(./system-contracts.md#contracttype-overview) resolvesTron.protoand the corresponding*Actuator.javaconstructor in java-tron