Tron deployments #1303

ezynda3 · 2025-07-25T14:15:00Z

Which Jira task belongs to this PR?

Why did I implement it this way?

Checklist before requesting a review

I have performed a self-review of my code
This pull request is as small as possible and only tackles one problem
I have added tests that cover the functionality / test the bug
For new facets: I have checked all points from this list: https://www.notion.so/lifi/New-Facet-Contract-Checklist-157f0ff14ac78095a2b8f999d655622e
I have updated any required documentation

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

I have checked that any arbitrary calls to external contracts are validated and or restricted
I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

coderabbitai · 2025-07-25T14:15:07Z

Warning

Rate limit exceeded

@ezynda3 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a3da011 and 84ded58.

📒 Files selected for processing (4)

script/deploy/healthCheck.ts (8 hunks)
script/troncast/commands/call.ts (1 hunks)
script/troncast/commands/send.ts (1 hunks)
script/troncast/utils/tronweb.ts (1 hunks)

Walkthrough

Adds Tron support across the repo: network configs, deployment tooling, CLI utilities (TronCast), and deployment metadata. Introduces Tron deployment scripts (deploy/register facets and periphery), a Tron contract deployer, health-check integration, config additions for Symbiosis/AllBridge, env-var utilities, CI/script updates, and new deployment JSONs.

Changes

Cohort / File(s)	Summary
Tron networks config `config/networks.json`, `script/deploy/_targetState.json`, `config/symbiosis.json`, `config/allbridge.json`	Adds tron and tronshasta network entries; defines target facet versions; adds Symbiosis and AllBridge config for Tron.
Tron deployment core `script/deploy/tron/constants.ts`, `script/deploy/tron/types.ts`, `script/deploy/tron/utils.ts`, `script/deploy/tron/TronContractDeployer.ts`, `script/deploy/tron/deploy-core-facets.ts`, `script/deploy/tron/register-facets-to-diamond.ts`, `script/deploy/tron/deploy-and-register-periphery.ts`, `script/deploy/tron/deploy-and-register-symbiosis-facet.ts`, `script/deploy/tron/deploy-and-register-allbridge-facet.ts`	Introduces Tron deployer, types, utilities, constants, and multiple CLI scripts for deploying core facets, periphery, and registering facets (including Symbiosis and AllBridge).
TronCast CLI `script/troncast/index.ts`, `script/troncast/README.md`, `script/troncast/types.ts`, `script/troncast/commands/call.ts`, `script/troncast/commands/send.ts`, `script/troncast/utils/abi.ts`, `script/troncast/utils/formatter.ts`, `script/troncast/utils/parser.ts`, `script/troncast/utils/tronweb.ts`, `script/troncast/postinstall-tronweb-fix.mjs`	Adds a Cast-like CLI for Tron (read-only calls and transactions), supporting ABI parsing/encoding, formatting, TronWeb init, confirmation, and a postinstall patch for TronWeb.
Deployments data `deployments/tron.json`, `deployments/tron.diamond.json`, `deployments/tronshasta.json`, `deployments/_deployments_log_file.json`	Adds Tron and TronShasta deployment manifests and addresses; appends Tron production deployment logs across many facets/contracts.
Health check integration `script/deploy/healthCheck.ts`	Integrates Tron into health checks with TronWeb path, Tron facet/periphery checks, Shasta bypass, and troncast-based facet discovery.
Env/CI helpers `.github/workflows/networkRpcsChecker.yml`, `script/helperFunctions.sh`, `script/utils/network.ts`, `script/utils/diamondEMERGENCYPauseGitHub.sh`, `script/mongoDb/fetch-rpcs.ts`	Centralizes RPC env-var naming via getRPCEnvVarName; updates workflow and scripts to use it; enriches RPC endpoint shape; aligns fallback handling.
Build/tooling `package.json`, `tsconfig.json`	Adds tronweb dependency, troncast script, postinstall patch; includes Bun types in tsconfig.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~75 minutes

Possibly related PRs

Remove duplicate SAFE information and hardhat from codebase #935 — Modifies script/deploy/healthCheck.ts; overlaps with this PR’s Tron-specific health-check integration.
LF-12919 - Move network rpc urls into mongodb #1091 — Introduces/uses getRPCEnvVarName and Mongo-backed RPC handling; matches this PR’s env-var utility adoption and fetch-rpcs changes.
updates network names in networks.json #866 — Updates config/networks.json entries; related to adding tron and tronshasta network configurations here.

Suggested labels

NewNetwork, AuditRequired

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch tron

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 11

🔭 Outside diff range comments (1)

script/deploy/tron/TronContractDeployer.ts (1)
1-467: Replace console.log with consola for consistent logging

According to the coding guidelines, all TypeScript scripts must use consola for consistent logging. This file uses console.log, console.warn, and console.error throughout.

Import consola at the beginning of the file:
import { TronWeb } from 'tronweb'
+import consola from 'consola'

import type {
Then replace all console methods with consola equivalents throughout the file. For example:

console.log → consola.info or consola.log

console.warn → consola.warn

console.error → consola.error

🧹 Nitpick comments (5)

script/deploy/tron/types.ts (1)
30-30: Consider stronger typing for transaction objects.

The deploymentTransaction and receipt fields use any type. Consider defining more specific interfaces for these Tron-specific objects to improve type safety and developer experience.
-  deploymentTransaction: any
-  receipt: any
+  deploymentTransaction: TronTransaction
+  receipt: TronTransactionReceipt
You could define these interfaces based on TronWeb's transaction structure.
script/deploy/tron/deploy-core-facets.ts (2)
190-191: Address the TODO for constructor arguments encoding.

The TODO comment indicates incomplete constructor argument encoding. This could cause issues during deployment logging and verification.

Would you like me to help implement proper constructor argument encoding for Tron? The encoding should convert the owner address and DiamondCutFacet address into the appropriate hex format for logging purposes.

53-56: Consider extracting magic numbers to constants.

The configuration values like safetyMargin: 1.5, maxRetries: 3, and confirmationTimeout: 120000 could be extracted to named constants for better maintainability.
+const DEFAULT_SAFETY_MARGIN = 1.5
+const DEFAULT_MAX_RETRIES = 3
+const DEFAULT_CONFIRMATION_TIMEOUT = 120000

 const config: ITronDeploymentConfig = {
   fullHost: network,
   privateKey,
   verbose,
   dryRun,
-  safetyMargin: 1.5,
-  maxRetries: 3,
-  confirmationTimeout: 120000,
+  safetyMargin: DEFAULT_SAFETY_MARGIN,
+  maxRetries: DEFAULT_MAX_RETRIES,
+  confirmationTimeout: DEFAULT_CONFIRMATION_TIMEOUT,
 }
script/deploy/tron/TronContractDeployer.ts (2)
175-175: Make default energy value configurable

The hardcoded fallback value of 50000 for energy estimation should be configurable or at least documented.

Consider making this a configurable constant:
+const DEFAULT_ENERGY_ESTIMATE = 50000 // Default energy units for failed estimations
+
private async estimateEnergyConsumption(
  // ...
): Promise<number> {
  try {
    // ...
-    return result.energy_required || result.energy_used || 50000
+    return result.energy_required || result.energy_used || DEFAULT_ENERGY_ESTIMATE
  } catch (error: any) {
    throw new Error(`Energy estimation failed: ${error.message}`)
  }
}
213-219: Document or make energy factor thresholds configurable

The bytecode complexity thresholds are hardcoded without explanation.

Add constants with documentation:
+// Energy factor thresholds based on bytecode complexity
+const ENERGY_FACTOR_HIGH_COMPLEXITY_THRESHOLD = 50000 // ~25KB bytecode
+const ENERGY_FACTOR_MEDIUM_COMPLEXITY_THRESHOLD = 20000 // ~10KB bytecode
+const ENERGY_FACTOR_HIGH = 0.5
+const ENERGY_FACTOR_MEDIUM = 0.3
+const ENERGY_FACTOR_LOW = 0.1
+
private getEnergyFactor(bytecode: string): number {
  const complexity = bytecode.length / 2

-  if (complexity > 50000) return 0.5
-  if (complexity > 20000) return 0.3
-  return 0.1
+  if (complexity > ENERGY_FACTOR_HIGH_COMPLEXITY_THRESHOLD) return ENERGY_FACTOR_HIGH
+  if (complexity > ENERGY_FACTOR_MEDIUM_COMPLEXITY_THRESHOLD) return ENERGY_FACTOR_MEDIUM
+  return ENERGY_FACTOR_LOW
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e08ab8 and cb239ef.

⛔ Files ignored due to path filters (1)

bun.lock is excluded by !**/*.lock

📒 Files selected for processing (7)

config/networks.json (1 hunks)
package.json (1 hunks)
script/deploy/tron/TronContractDeployer.ts (1 hunks)
script/deploy/tron/deploy-core-facets.ts (1 hunks)
script/deploy/tron/types.ts (1 hunks)
script/deploy/tron/utils.ts (1 hunks)
tsconfig.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

script/**/*.ts

📄 CodeRabbit Inference Engine (conventions.md)

script/**/*.ts: All TypeScript scripts must follow the rules defined in .eslintrc.cjs.
All TypeScript scripts must use async/await for asynchronous operations.
All TypeScript scripts must use citty for CLI argument parsing.
All TypeScript scripts must use consola for consistent logging.
Environment variables in TypeScript scripts should be validated using getEnvVar() helper.
TypeScript scripts should exit with appropriate exit codes (0 for success, 1 for error).
All scripts should use bunx tsx for TypeScript execution.

Files:

script/deploy/tron/deploy-core-facets.ts
script/deploy/tron/types.ts
script/deploy/tron/TronContractDeployer.ts
script/deploy/tron/utils.ts

🧬 Code Graph Analysis (2)

script/deploy/tron/TronContractDeployer.ts (2)

script/deploy/tron/types.ts (4)

ITronDeploymentConfig (1-12)

IForgeArtifact (40-64)

ITronDeploymentResult (27-38)

ITronCostEstimate (14-25)

script/deploy/tron/utils.ts (4)

DEFAULT_SAFETY_MARGIN (8-8)

ENERGY_PRICE (6-6)

BANDWIDTH_PRICE (7-7)

calculateTransactionBandwidth (202-219)

script/deploy/tron/utils.ts (2)

script/deploy/tron/types.ts (1)

IForgeArtifact (40-64)

script/helperFunctions.sh (1)

error (2730-2732)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: run-unit-tests

🔇 Additional comments (15)

package.json (1)

125-125: tronweb dependency version and security verified

The project’s package.json specifies "tronweb": "^6.0.3".

Confirmed via npm registry that 6.0.3 is the latest stable release.

No known security advisories found for TronWeb in the NPM ecosystem.

config/networks.json (1)

1133-1133: Tron Mainnet Chain ID Confirmed
The chain ID 728126428 is correct for Tron mainnet (hex 0x2b6653dc per RPC)[4][9]. No update required.

tsconfig.json (1)

19-21: LGTM! TypeScript configuration properly updated for Bun support.

The addition of "bun" to the types array correctly enables Bun runtime types for the new Tron deployment scripts, and the formatting change to the include array maintains functionality. These changes appropriately support the new TypeScript files under script/deploy/tron/.

script/deploy/tron/types.ts (2)

1-12: Well-designed deployment configuration interface.

The ITronDeploymentConfig interface provides comprehensive configuration options with appropriate optional parameters and sensible defaults implied. The structure supports both production and development workflows effectively.

40-64: Comprehensive Forge artifact interface definition.

The IForgeArtifact interface accurately represents the structure of compiled Solidity artifacts from Forge, including all necessary metadata for deployment and verification. The nested structure properly captures compiler output format.

script/deploy/tron/deploy-core-facets.ts (4)

1-4: LGTM! Proper script setup following coding guidelines.

The script correctly uses #!/usr/bin/env bun shebang and imports consola for logging as required by the coding guidelines for TypeScript scripts.

34-45: Excellent private key and environment handling.

The script properly handles environment-specific private key retrieval with clear error messages and graceful failure. The error handling provides helpful guidance to users about which environment variable to set.

80-92: Good safety measures for production deployments.

The deployment warnings and delays for production/staging environments provide important safeguards against accidental deployments. The different timeouts (10s for production, 5s for staging) are well-thought-out.

258-259: LGTM! Proper script execution pattern.

The script correctly uses import.meta.main to detect direct execution and includes proper error handling with consola.error as required by the coding guidelines.

script/deploy/tron/TronContractDeployer.ts (3)

44-100: Well-structured deployment method with proper error handling

The deployment method follows a clear sequence with proper separation of concerns and comprehensive error handling.

255-277: Proper balance validation with clear error messages

The balance validation correctly checks for sufficient funds and provides clear error messages.

363-414: Well-implemented transaction confirmation with proper retry logic

The confirmation polling logic includes timeout handling, configurable retries, and proper error detection for failed transactions.

script/deploy/tron/utils.ts (3)

113-139: Well-implemented contract address persistence

The function properly handles file creation and updates with appropriate error handling.

173-197: Good implementation of version extraction with multiple path handling

The function properly searches multiple paths and extracts version information with clear error messages.

199-219: Correct implementation of Tron bandwidth calculation

The function properly implements Tron's bandwidth calculation with appropriate protocol constants.

config/networks.json

script/deploy/tron/TronContractDeployer.ts

script/deploy/tron/utils.ts

coderabbitai

Actionable comments posted: 12

♻️ Duplicate comments (4)

script/deploy/tron/TronContractDeployer.ts (4)

20-42: Private key validation and logging issues remain unaddressed

The previous review comments about private key validation and secure logging are still applicable to this code.

118-123: Energy factor calculation clarity issue remains

The previous review comment about the energy factor calculation formula is still applicable.

321-323: Transaction ID extraction validation issue remains

The previous review comment about validating the transaction ID extraction is still applicable.

339-339: Mock transaction ID format issue remains

The previous review comment about removing the '0x' prefix from Tron transaction IDs is still applicable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb239ef and 9a2dbb8.

📒 Files selected for processing (3)

script/deploy/tron/TronContractDeployer.ts (1 hunks)
script/deploy/tron/deploy-core-facets.ts (1 hunks)
script/deploy/tron/utils.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

script/deploy/tron/deploy-core-facets.ts
script/deploy/tron/utils.ts

🧰 Additional context used

📓 Path-based instructions (1)

script/**/*.ts

📄 CodeRabbit Inference Engine (conventions.md)

script/**/*.ts: All TypeScript scripts must follow the rules defined in .eslintrc.cjs.
All TypeScript scripts must use async/await for asynchronous operations.
All TypeScript scripts must use citty for CLI argument parsing.
All TypeScript scripts must use consola for consistent logging.
Environment variables in TypeScript scripts should be validated using getEnvVar() helper.
TypeScript scripts should exit with appropriate exit codes (0 for success, 1 for error).
All scripts should use bunx tsx for TypeScript execution.

Files:

script/deploy/tron/TronContractDeployer.ts

🧬 Code Graph Analysis (1)

script/deploy/tron/TronContractDeployer.ts (2)

script/deploy/tron/types.ts (4)

ITronDeploymentConfig (1-12)

IForgeArtifact (40-64)

ITronDeploymentResult (27-38)

ITronCostEstimate (14-25)

script/deploy/tron/utils.ts (4)

DEFAULT_SAFETY_MARGIN (8-8)

ENERGY_PRICE (6-6)

BANDWIDTH_PRICE (7-7)

calculateTransactionBandwidth (202-219)

script/deploy/tron/TronContractDeployer.ts

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (16)

script/deploy/tron/TronContractDeployer.ts (16)

1-2: Add missing consola import

The file uses console for logging but should use consola per coding guidelines. Add the import statement.

 import { TronWeb } from 'tronweb'
+import { consola } from 'consola'

22-44: Add private key validation and use consola for logging

The constructor should validate the private key format and use consola instead of console.log.

   public constructor(config: ITronDeploymentConfig) {
+    // Validate private key format (strip optional 0x prefix)
+    const rawKey = config.privateKey?.replace(/^0x/i, '')
+    if (!rawKey || !/^[0-9a-fA-F]{64}$/.test(rawKey)) {
+      throw new Error('Invalid Tron private key format')
+    }
+
     this.config = {
       safetyMargin: DEFAULT_SAFETY_MARGIN,
       maxRetries: 3,
       confirmationTimeout: 60000,
       verbose: false,
       dryRun: false,
       userFeePercentage: 100,
       originEnergyLimit: 0,
       ...config,
+      privateKey: rawKey,
     }

     this.tronWeb = new TronWeb({
       fullHost: this.config.fullHost,
       privateKey: this.config.privateKey,
     })

     if (this.config.verbose)
-      console.log('🔧 TronWeb initialized:', {
+      consola.info('🔧 TronWeb initialized:', {
         network: this.config.fullHost,
-        address: this.tronWeb.defaultAddress.base58,
+        address: `${this.tronWeb.defaultAddress.base58.slice(0, 6)}...${this.tronWeb.defaultAddress.base58.slice(-4)}`,
       })
   }

57-62: Use consola instead of console.log