🏗 Scaffold-TRON

Documentation | Website

🧪 A dual-blockchain development toolkit built with Scaffold-ETH 2 for both Ethereum and Tron networks. This toolkit makes it easier for developers to create and deploy smart contracts on both blockchains and build user interfaces that interact with those contracts.

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, TronBox, TronWeb, and Typescript.

✨ Enhanced Features

Ethereum Support (Original)

✅ Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
🪝 Custom hooks: Collection of React hooks wrapper around wagmi to simplify interactions with smart contracts with typescript autocompletion.
🧱 Components: Collection of common web3 components to quickly build your frontend.
🔥 Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum network.

Tron Support (New)

🚀 TronBox Integration: Deploy smart contracts to Tron networks (Shasta, Nile, Mainnet)
🔑 Account Management: Automated Tron account generation with QR codes
💰 Balance Checking: Real-time TRX balance monitoring across networks
🧪 Testnet Support: Easy deployment and testing on Tron testnets
⚡ TVM Compatibility: Leverage Tron Virtual Machine's EVM compatibility
🔄 Unified Components: Address and balance components that work seamlessly with both Ethereum and Tron
📋 Copy Functionality: One-click copy for all address types with proper formatting
🔗 Block Explorer Links: Direct links to appropriate block explorers for each network

Configuration Management

⚙️ Unified Network Config: Configure both Ethereum and Tron networks in a single scaffold.config.ts
🌐 Network Switching: Easy switching between different Tron networks (Shasta, Nile, Mainnet)
🎯 Target Network Selection: Set your preferred Tron network just like Ethereum networks

🔍 Tron vs Ethereum: Key Differences for Developers

Understanding the fundamental differences between Tron and Ethereum is crucial for effective dual-blockchain development. While both networks support smart contracts and use similar development tools, they have distinct characteristics that affect how you build and deploy applications.

🏗️ Network Architecture

Aspect	Ethereum	Tron
Consensus	Proof of Stake (PoS)	Delegated Proof of Stake (DPoS)
Block Time	~12 seconds	~3 seconds
TPS	~15 transactions/second	~2,000 transactions/second
Validators	Unlimited validators	27 Super Representatives
Finality	Probabilistic	Near-instant

💰 Cost Structure

Ethereum:

Gas Model: Pay gas fees in ETH for all operations
Variable Costs: Fees fluctuate based on network congestion
Contract Deployment: Can cost $50-500+ depending on network conditions

Tron:

Energy/Bandwidth Model: Three resource types:
- TRX: Native token for transactions
- Energy: Consumed by smart contract execution
- Bandwidth: Used for transaction data
Free Daily Allowance: Users get free bandwidth daily
Predictable Costs: More stable pricing, deployment typically costs 50-100 TRX (~$5-10)

📍 Address Formats

// Ethereum addresses (20 bytes, hexadecimal)
0x742d35Cc6634C0532925a3b8D9C24A8c9A4c7c7b

// Tron addresses (21 bytes, Base58 encoded)
T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb

// Both can be used interchangeably in smart contracts
// Tron also supports hex format internally

⚙️ Smart Contract Differences

Deployment & Execution

Ethereum:

// Standard deployment
contract MyContract {
    constructor() {
        // Initialization code
    }
}

Tron:

// Same Solidity code, but different execution context
contract MyContract {
    constructor() {
        // Initialization - executed on TVM (Tron Virtual Machine)
    }

    // Tron-specific considerations:
    // - Lower gas costs for computation
    // - Different opcodes for some operations
    // - Energy instead of gas
}

Key Technical Differences

1. Transaction Types

Ethereum: Simple transactions and contract calls
Tron: 30+ transaction types (Transfer, TriggerSmartContract, CreateSmartContract, etc.)

2. Resource Management

// Ethereum: Gas estimation
uint256 gasRequired = estimateGas(functionCall);

// Tron: Energy consumption is more predictable
// Energy cost depends on instruction complexity, not network congestion

3. Built-in Functions

// Tron has additional built-in functions:
// - freeze/unfreeze for staking
// - vote for Super Representatives
// - energy and bandwidth queries

Development Considerations

Solidity Compatibility:

Ethereum: Latest Solidity versions (0.8.x)
Tron: TVM supports most Solidity features with some limitations:
- Some newer opcodes may not be available
- Different gas cost structure for operations
- Events and logs work similarly but with different indexing

Testing Differences:

// Ethereum testing (Hardhat)
describe("Contract", function () {
    it("Should deploy and work", async function () {
        const contract = await MyContract.deploy();
        // Standard Web3.js/Ethers.js patterns
    });
});

// Tron testing (TronBox + TronWeb)
describe("Contract", function () {
    it("Should deploy and work", async function () {
        const contract = await tronWeb.contract().new({
            // TronWeb-specific deployment
        });
        // TronWeb has different API patterns
    });
});

🔧 Development Tools

Ethereum Ecosystem:

Hardhat/Foundry: Development frameworks
Web3.js/Ethers.js: JavaScript libraries
MetaMask: Primary wallet integration
Etherscan: Block explorer

Tron Ecosystem:

TronBox: Development framework (similar to Truffle)
TronWeb: JavaScript library (similar to Web3.js)
TronLink: Primary wallet integration
TronScan: Block explorer

🌐 Network Selection

Ethereum Networks:

// scaffold.config.ts
targetNetworks: [
    chains.hardhat, // Local development
    chains.sepolia, // Testnet
    chains.mainnet, // Production
];

Tron Networks:

// scaffold.config.ts
targetTronNetwork: tronShasta,  // Testnet
// targetTronNetwork: tronNile,    // Alternative testnet
// targetTronNetwork: tronMainnet, // Production

📊 Performance Characteristics

Ethereum:

Higher security through decentralization
Slower transaction finality
More expensive operations
Larger developer ecosystem

Tron:

Faster transaction processing
Lower transaction costs
More centralized consensus
Growing DeFi ecosystem

🚀 Migration Considerations

When porting contracts between networks:

Gas → Energy: Review resource consumption patterns
Address handling: Ensure proper address format conversion
Event indexing: May require adjustments for different explorers
Wallet integration: Different connection patterns (MetaMask vs TronLink)
Testing: Network-specific test patterns and tools

💡 Best Practices

For Dual-Chain Development:

Write network-agnostic smart contracts when possible
Use Scaffold-TRON's unified components for consistent UX
Test thoroughly on both networks' testnets
Consider cost implications when choosing primary network
Implement proper error handling for network-specific features

Performance Tips:

Ethereum: Optimize for gas efficiency, batch operations
Tron: Leverage faster block times, utilize free bandwidth
Both: Use events for indexing, implement proper access controls

This dual-blockchain approach gives you the best of both worlds: Ethereum's security and ecosystem with Tron's speed and low costs!

Requirements

Before you begin, you need to install the following tools:

Quickstart

🚀 Initial Setup

Clone the repository:

git clone https://github.com/kmjones1979/scaffold-tron.git tron-dapp

Install dependencies:

cd tron-dapp
yarn install

⚙️ Configure Your Networks

Configure your target networks in packages/nextjs/scaffold.config.ts:

const scaffoldConfig = {
    // Ethereum networks (existing)
    targetNetworks: [chains.hardhat],

    // Tron network (new!)
    // Available options:
    // - tronShasta: Shasta testnet (for development)
    // - tronNile: Nile testnet (for development)
    // - tronMainnet: Tron mainnet (for production)
    targetTronNetwork: tronShasta,

    // ... other config
};

🔷 Ethereum Development (Original Workflow)

Run a local Ethereum network:

yarn chain

Deploy Ethereum contracts:

yarn deploy

Start the NextJS frontend:

yarn start

Visit your app on: http://localhost:3000. You can interact with your smart contract using the Debug Contracts page.

🔺 Tron Development (Enhanced Workflow)

Step 1: Generate Tron Accounts

Generate Tron accounts for all networks (includes QR codes for easy wallet import):

yarn tron:setup

This creates accounts for:

Shasta Testnet (primary for testing)
Nile Testnet (alternative testnet)
Mainnet (production)
Development (local)

Step 2: Fund Your Testnet Accounts

Get free TRX from faucets for testing:

Shasta Testnet Faucets:

https://shasta.tronex.io/join/getJoinPage - Get 2000 test TRX
https://www.trongrid.io/shasta/ - Alternative faucet

Nile Testnet Faucet:

https://nileex.io/join/getJoinPage

Copy your Shasta testnet address from the setup output and request test TRX.

Step 3: Check Your Balances

yarn tron:balance

This shows real-time balances for all your Tron accounts.

Step 4: Compile Tron Contracts

yarn tron:compile

Step 5: Deploy to Tron Networks

Deploy to Shasta Testnet:

yarn tron:deploy:testnet

Deploy to Nile Testnet:

yarn tron:deploy:nile

Deploy to Mainnet (requires real TRX):

yarn tron:deploy:mainnet

Step 6: Run Tests

yarn tron:test

Tests run against the Shasta testnet to verify contract functionality.

🎨 Enhanced UI Components

UnifiedAddress Component

The UnifiedAddress component automatically detects and handles both Ethereum and Tron addresses:

import { UnifiedAddress } from "~~/components/scaffold-eth";

// Works with both Ethereum (0x...) and Tron (T...) addresses
<UnifiedAddress
    address="T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb"
    format="short"
    size="base"
/>;

Features:

✅ Auto-detection: Automatically detects address type
📋 Copy functionality: One-click copy for all addresses
🔗 Block explorer links: Direct links to appropriate explorers
🎨 Consistent styling: Matches Ethereum address styling
📱 Responsive design: Works across all screen sizes

Network Configuration

Configure your preferred Tron network in scaffold.config.ts:

// For development
targetTronNetwork: tronShasta,

// For production
targetTronNetwork: tronMainnet,

The entire application will automatically use your configured network!

📋 Available Scripts

Ethereum Commands

yarn chain - Start local Ethereum network
yarn deploy - Deploy to local Ethereum network
yarn start - Start NextJS frontend
yarn hardhat:test - Run Ethereum contract tests

Tron Commands

yarn tron:setup - Generate Tron accounts with QR codes
yarn tron:account - Display account information
yarn tron:balance - Check TRX balances across networks
yarn tron:compile - Compile contracts for Tron
yarn tron:deploy:testnet - Deploy to Shasta testnet
yarn tron:deploy:nile - Deploy to Nile testnet
yarn tron:deploy:mainnet - Deploy to Tron mainnet
yarn tron:test - Run Tron contract tests
yarn tron:console - Open TronBox console

🌐 Network Information

Tron Networks

Shasta Testnet: Primary testing network
- Explorer: https://shasta.tronscan.org
- Faucets: Shasta Faucet 1 | Shasta Faucet 2
Nile Testnet: Alternative testing network
- Explorer: https://nile.tronscan.org
- Faucet: Nile Faucet
Mainnet: Production network
- Explorer: https://tronscan.org
- Requires real TRX from exchanges

🏗️ Project Structure

tron-dapp/
├── packages/
│   ├── hardhat/                 # Ethereum & Tron smart contracts
│   │   ├── contracts/           # Solidity contracts (compatible with both chains)
│   │   ├── deploy/             # Ethereum deployment scripts
│   │   ├── tron-migrations/    # Tron deployment scripts
│   │   ├── test/               # Ethereum tests
│   │   ├── tron-test/          # Tron tests
│   │   ├── scripts/            # Utility scripts for Tron
│   │   ├── hardhat.config.ts   # Ethereum configuration
│   │   └── tronbox.js          # Tron configuration
│   └── nextjs/                 # Frontend application
│       ├── app/                # Next.js app router
│       ├── components/         # React components
│       │   └── scaffold-eth/   # Enhanced components
│       │       ├── UnifiedAddress.tsx     # Unified address component
│       │       ├── UnifiedBalance.tsx     # Unified balance component
│       │       └── UnifiedConnectButton.tsx # Dual-blockchain connect button
│       ├── hooks/              # Custom React hooks
│       │   └── scaffold-eth/   # Enhanced hooks
│       │       ├── useTronReadContract.ts   # Tron contract reading
│       │       ├── useTronWriteContract.ts  # Tron contract writing
│       │       └── useUnifiedWriteContract.ts # Unified contract interactions
│       ├── services/           # Web3 services
│       │   └── web3/          # Web3 providers
│       │       ├── tronConfig.tsx          # Tron provider
│       │       └── unifiedWeb3Context.tsx  # Unified Web3 context
│       └── scaffold.config.ts  # Unified network configuration

🔧 Configuration Files

Main Configuration

Unified Config: packages/nextjs/scaffold.config.ts - Configure both Ethereum and Tron networks
Ethereum: packages/hardhat/hardhat.config.ts - Ethereum-specific configuration
Tron: packages/hardhat/tronbox.js - Tron-specific configuration
Environment: packages/hardhat/.env - Auto-generated by setup

Network Configuration Example

// packages/nextjs/scaffold.config.ts
import {
    tronShasta,
    tronNile,
    tronMainnet,
} from "~~/utils/scaffold-eth/networks";

const scaffoldConfig = {
    // Ethereum networks
    targetNetworks: [chains.hardhat],

    // Tron network selection
    targetTronNetwork: tronShasta, // Easy to change!

    // Other configuration...
};

💡 Development Tips

For Ethereum Development:

Use yarn chain for local development
Deploy contracts with yarn deploy
Test with yarn hardhat:test

For Tron Development:

Always fund testnet accounts before deploying
Use yarn tron:balance to check funding status
Test on Shasta testnet before mainnet deployment
Contract deployment costs ~50-100 TRX on testnets

Dual-Blockchain Development:

Smart contracts are compatible with both Ethereum and Tron
Same Solidity code deploys to both networks
Use network-specific tools for deployment and testing
Configure target networks in scaffold.config.ts
Use UnifiedAddress component for consistent address display

UI/UX Best Practices:

Use UnifiedAddress instead of Address for better Tron support
Configure your preferred Tron network in scaffold config
Test address copying and block explorer links
Ensure proper network switching in your dApp

🆕 Latest Enhancements

December 2024 Updates:

🎨 Rebranded to Scaffold-TRON with proper Scaffold-ETH attribution
⚙️ Unified Configuration: Configure Tron networks in scaffold.config.ts
🔄 Enhanced Components: Improved UnifiedAddress with copy functionality and block explorer links
📱 Better UX: Consistent address formatting and interaction patterns
🏗️ Component Renaming: Updated internal component names for consistency
🌐 Network Utilities: Added getTargetTronNetwork() utility function

📚 Documentation & Resources

Scaffold-ETH 2 Docs - Learn about the original framework
Scaffold-ETH 2 Website - Feature overview
TronBox Documentation - Tron development toolkit
TronWeb API - Tron JavaScript SDK
Tron Developer Hub - Complete Tron development resources

🤝 Contributing

We welcome contributions to Scaffold-TRON!

Please see CONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.

🎯 What's Next?

Configure your networks in scaffold.config.ts
Deploy your contracts to both Ethereum and Tron testnets
Test extensively using the provided test suites
Build your frontend using the enhanced Scaffold-TRON components
Go multi-chain by deploying to production networks

Happy building! 🚀

Built with ❤️ on Scaffold-ETH 2

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.cursor/rules		.cursor/rules
.github/workflows		.github/workflows
.husky		.husky
.yarn		.yarn
packages		packages
.gitignore		.gitignore
.lintstagedrc.js		.lintstagedrc.js
.yarnrc.yml		.yarnrc.yml
CONTRIBUTING.md		CONTRIBUTING.md
DEBUG_DUAL_BLOCKCHAIN.md		DEBUG_DUAL_BLOCKCHAIN.md
DUAL_BLOCKCHAIN_SETUP.md		DUAL_BLOCKCHAIN_SETUP.md
LICENCE		LICENCE
README.md		README.md
package.json		package.json
yarn.lock		yarn.lock

License

kmjones1979/scaffold-tron

Folders and files

Latest commit

History

Repository files navigation

🏗 Scaffold-TRON

Documentation | Website

✨ Enhanced Features

Ethereum Support (Original)

Tron Support (New)

Configuration Management

🔍 Tron vs Ethereum: Key Differences for Developers

🏗️ Network Architecture

💰 Cost Structure

📍 Address Formats

⚙️ Smart Contract Differences

Deployment & Execution

Key Technical Differences

Development Considerations

🔧 Development Tools

🌐 Network Selection

📊 Performance Characteristics

🚀 Migration Considerations

💡 Best Practices

Requirements

Quickstart

🚀 Initial Setup

⚙️ Configure Your Networks

🔷 Ethereum Development (Original Workflow)

🔺 Tron Development (Enhanced Workflow)

Step 1: Generate Tron Accounts

Step 2: Fund Your Testnet Accounts

Step 3: Check Your Balances

Step 4: Compile Tron Contracts

Step 5: Deploy to Tron Networks

Step 6: Run Tests

🎨 Enhanced UI Components

UnifiedAddress Component

Network Configuration

📋 Available Scripts

Ethereum Commands

Tron Commands

🌐 Network Information

Tron Networks

🏗️ Project Structure

🔧 Configuration Files

Main Configuration

Network Configuration Example

💡 Development Tips

For Ethereum Development:

For Tron Development:

Dual-Blockchain Development:

UI/UX Best Practices:

🆕 Latest Enhancements

December 2024 Updates:

📚 Documentation & Resources

🤝 Contributing

🎯 What's Next?

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages