Skip to content

docs: fix outdated content in deployment and actuator tutorial docs#1

Merged
Little-Peony merged 5 commits intodevelopfrom
clean_docs
Apr 9, 2026
Merged

docs: fix outdated content in deployment and actuator tutorial docs#1
Little-Peony merged 5 commits intodevelopfrom
clean_docs

Conversation

@Little-Peony
Copy link
Copy Markdown
Owner

Summary

  • implement-a-customized-actuator (EN+ZH)

    • Fix SumContract field number: 52 was already taken by MarketSellAssetContract; changed to 60 (next after CancelAllUnfreezeV2Contract = 59)
    • Add missing import "core/contract/math_contract.proto" step in api.proto — without it the proto compiler cannot resolve SumContract in the InvokeSum RPC definition
    • Add missing static import for TRANSFER_FEE from Parameter.ChainConstant (not inherited from AbstractActuator)
    • Fix test lifecycle: @Before/@After@BeforeClass/@AfterClass; Spring context was rebuilt per test method
    • Fix Args initialization order: Args.setParam() must be called before Args.getInstance() to avoid passing a stale instance to initServices()
    • Replace hardcoded "output-directory" path with @ClassRule TemporaryFolder
    • Replace non-existent addService()/initServices()/startServices()/shutdownServices() calls with the actual Application.startup() / shutdown() API
    • Add registration note: TransactionRegister auto-discovers AbstractActuator subclasses in org.tron.core.actuator at startup via Reflections — no manual registration needed
    • Remove pinned protoc v3.4.0 note; point readers to build.gradle for the version
    • Add @Rule Timeout to guard against hanging tests
  • modular-deployment (EN+ZH)

    • Remove stale "will be deprecated" note for java -jar FullNode.jar; README shows it as a fully supported launch method
    • Remove *.bat / Windows startup instructions; README line 39 explicitly states Windows is not supported
    • Add platform note: Linux and macOS only
    • Replace CMS GC flags removed in JDK 14 (-XX:+UseConcMarkSweepGC, -XX:+CMSParallelRemarkEnabled, -XX:+CMSScavengeBeforeRemark) with JDK 8/17-compatible options; using the old flags causes JVM startup failure on JDK 17 (required for ARM64)
  • modular-introduction (EN+ZH)

    • Update module count from six to eight; add crypto and plugins module descriptions

Test plan

  • Verify all six docs render correctly in Markdown
  • Confirm SumContract = 60 does not conflict with any existing ContractType value
  • Confirm proto compiler accepts the updated api.proto import
  • Confirm JVM starts without errors using the updated vmoptions example on JDK 8 and JDK 17

🤖 Generated with Claude Code

Little-Peony and others added 5 commits April 9, 2026 10:29
implement-a-customized-actuator (EN+ZH):
- Fix test lifecycle: @Before/@after → @BeforeClass/@afterclass so the
  Spring context is created only once per test class, not per test method
- Fix Args initialization order: Args.setParam() must be called before
  Args.getInstance() to avoid passing a stale unconfigured instance to
  appTest.initServices()
- Replace hardcoded dbPath with @ClassRule TemporaryFolder to keep
  test directories isolated and auto-cleaned
- Add @rule Timeout to guard against hangs
- Remove the specific protoc v3.4.0 version note; point readers to the
  version declared in build.gradle instead

modular-deployment (EN+ZH):
- Replace CMS GC flags (-XX:+UseConcMarkSweepGC, -XX:+CMSParallelRemarkEnabled,
  -XX:+CMSScavengeBeforeRemark) that were removed in JDK 14 and would
  cause startup failures on JDK 17 (required for ARM64)
- Add -Xms/-Xmx to the example and note JDK 8/17 compatibility

modular-introduction (EN+ZH):
- Update module count from six to eight
- Add descriptions for the crypto and plugins modules

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
implement-a-customized-actuator (EN+ZH):
- SumContract field number: 52 is already taken by MarketSellAssetContract;
  change to 60 (next available number after CancelAllUnfreezeV2Contract=59)
- SumActuator: add missing static import for TRANSFER_FEE from
  Parameter.ChainConstant (not inherited from AbstractActuator)
- SumActuatorTest: Application does not have addService()/initServices()/
  startServices()/shutdownServices(); replace with startup()/shutdown()
  which are the actual API methods

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
implement-a-customized-actuator (EN+ZH):
- Add the missing 'import "core/contract/math_contract.proto"' step in
  api.proto; without it the proto compiler cannot resolve SumContract in
  the InvokeSum RPC definition (compile failure)
- Add a note explaining that SumActuator must live in org.tron.core.actuator:
  TransactionRegister.registerActuator() uses Reflections to scan that
  package at startup and auto-registers every AbstractActuator subclass
  via the super() constructor call into TransactionFactory

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…t guide

modular-deployment (EN+ZH):
- Remove 'will be deprecated' note for java -jar FullNode.jar: README
  shows it as a fully supported launch method alongside the script
- Add explicit platform note: Linux and macOS only, Windows not supported
- Remove '*.bat on Windows' startup instruction: Windows is not supported
  per README line 39

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Little-Peony Little-Peony merged commit 83937a2 into develop Apr 9, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant