docs: add Tron ecosystem baseline (tron-contracts) - #198
Open
pepebndc wants to merge 2 commits into
Open
Conversation
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Add a baseline docs section for OpenZeppelin Contracts for Tron, mirroring the structure of the Solidity contracts docs. Content is ported from the tron-contracts and tron-contracts-upgradeable repositories' AsciiDoc docs. - New content/tron-contracts/ section (16 pages): Overview, TVM Differences, Extending Contracts, Using with Upgrades, Backwards Compatibility, Access Control, Tokens (TRC-20 + Creating Supply, TRC-721, TRC-1155, TRC-4626, TRC-6909), Governance, Utilities, FAQ. - New "TVM Differences" page summarizing EVM<->TVM divergences (CREATE2 0x41 prefix, P256/RIP-7212, TRX 6 decimals, USDT-TRON transfer, TIP-712 address format, EIP-7702/4337, resource model, block cadence). - TRON branding: logomark icon, ecosystem tab, homepage card, nav wiring (navigation tree, ecosystem detection, path -> tree hook). - Diagrams copied under public/tron/. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sync the Tron pages with tron-contracts and tron-contracts-upgradeable at the 5.6.0-rc.1 release: - index: link the published npm packages, port the versioning policy, drop bug-bounty claims, point security reports at GitHub advisories, and replace the @dev install example with @next (npm publishes only latest and next). - utilities: P256 verifies in Solidity (TIP-7951 cited, verifyNative gone), TRC165/TRC1271/trc7201Slot renames, TIP-2935 blockhash note, correct TRC165 usage (no _registerInterface). - governance: TRON 3-second block arithmetic (28800/201600) plus the block-time callout, TRC-6372/TRC-5805 names, TRX instead of ETH, remove the nonexistent TRC20VotesComp variant. - tvm-differences: safeTransferChecked default (H-01), corrected P256, EIP-7702 and ERC-4337 rows, new TRC-10 row and section, new callout on 20-byte addresses inside bytes payloads. - trc4626: fee example uses safeTransferChecked. - access-control: TimelockController self-administration, AccessManager cancellation rights incl. role admins (#141). - upgradeable, backwards-compatibility: recommend the Tron Upgrades plugins; upgradeable versioning note. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
pepebndc
force-pushed
the
docs/tron-ecosystem-baseline
branch
from
August 24, 2026 09:47
b5276b1 to
9647c86
Compare
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Adds a baseline documentation section for OpenZeppelin Contracts for Tron, mirroring the structure of the existing Solidity contracts docs. Content is ported from the
tron-contractsandtron-contracts-upgradeablerepositories' AsciiDoc docs and converted to MDX, and is aligned with the released npm packages:@openzeppelin/tron-contractsand@openzeppelin/tron-contracts-upgradeable(currently5.6.0-rc.1on thelatesttag).The new section is available at
/tron-contracts, selectable via the Tron entry in the ecosystem switcher.What's included
16 pages under
content/tron-contracts/:TRON branding — official logomark icon, ecosystem tab, homepage ecosystem card + brand color (
#EF0027), and full navigation wiring.Release alignment (second commit)
The pages were re-verified against both source repos at the 5.6.0-rc.1 release, covering the full audit-fix wave that landed after the original port:
npm install @openzeppelin/tron-contracts(taglatest, audited) and@nextfor release candidates. The@devexample was dropped: npm publishes nodevtag (the release-tag policy table itself is kept as published in the repo docs).SafeTRC20.safeTransferCheckedas the USDT-safe default (H-01, Sui v1.0.0 #131) including the TRC-4626 fee example;trc7201Slot(L-04, chore: Updating favicon and OG image #115); TRC165/TRC1271 artifact renames (Update confidential contracts changelog #126); TRON block-time governance arithmetic and TRC-6372/TRC-5805 (fix: Fixing navigation #116); AccessManager cancellation rights including role admins (docs: fix EntryPoint address override and viem destructuring in WebAu… #141); TimelockController self-administration; Tron Upgrades plugins recommendations (Add your project to the Midnight ecosystem map #132).bytespayloads (Stellar: replace deprecated macro #117/Write Sui v1 learn sections w/ math & access #136).Notes / decisions
contracts/mocks/docs/sources.index.adocstill shows anpm install @openzeppelin/tron-contracts@devexample although nodevdist-tag is published.Validation
pnpm buildpasses (full static generation).main(Tron + Canton ecosystem entries merged).🤖 Generated with Claude Code