Prerequisites
Before you begin, make sure you have:- Tenderly CLI installed (see Installation)
- A Tenderly account (sign up at dashboard.tenderly.co)
- A smart contract project (Hardhat, Truffle, Foundry, or Brownie)
Step 1: Authenticate
First, log in to your Tenderly account using the CLI:For CI/CD environments, use the access key method. You can generate an access key in your Tenderly Dashboard.
Step 2: Initialize Your Project
Navigate to your smart contract project directory and initialize Tenderly:- Detect your project type (Hardhat, Truffle, Foundry, or Brownie)
- Prompt you to select or create a Tenderly project
- Create a
tenderly.yamlconfiguration file
- Interactive Mode
- Non-Interactive Mode
The CLI will guide you through:
- Selecting an existing project or creating a new one
- Configuring your project settings
Example tenderly.yaml
After initialization, yourtenderly.yaml file will look like this:
Step 3: Configure Your Framework
Depending on your framework, you may need additional setup:- Hardhat
- Truffle
- Foundry
Install the Tenderly Hardhat plugin:Add to your Or for TypeScript (See the Hardhat Integration Guide for complete details.
hardhat.config.js:hardhat.config.ts):Step 4: Deploy and Verify Your Contracts
Now you’re ready to deploy and push your contracts to Tenderly!Deploy your contracts
Deploy your contracts to your target network using your framework’s deployment tools:
Push contracts to Tenderly
After deployment, push your contracts to the Tenderly Dashboard:You can specify networks:Or add a tag for organization:
Step 5: View Your Contracts
After pushing, you’ll see output like this:- Debug transactions
- Monitor contract activity
- Set up alerts
- Simulate transactions
Common Workflows
Development Workflow
Development Workflow
For local development and testing:
Production Deployment
Production Deployment
For mainnet or testnet deployments:
Multi-Network Deployment
Multi-Network Deployment
For deploying across multiple networks:Configure in
tenderly.yaml:Next Steps
Now that you’ve completed the quickstart, explore more features:Contract Management
Learn advanced contract management features
Web3 Actions
Automate workflows with Web3 Actions
DevNets
Create development networks on-demand
Configuration
Customize your tenderly.yaml configuration
Troubleshooting
Authentication fails
Authentication fails
If login fails, try:
- Check your credentials
- Use
--forceto override existing login - Generate a new access key from the Dashboard
Project not initialized
Project not initialized
If you see “You need to initiate the project first”:
No contracts found
No contracts found
Ensure your project has:
- Compiled artifacts (build files)
- Deployment records
- Valid project structure for your framework
@tenderly/hardhat-tenderly plugin.Getting Help
- Read the full CLI Reference
- Check out the Configuration Guide
- Contact support at [email protected]