Tenderly SDK

Table of contents

• Introduction
• Documentation
• Quick start
  • Installation
  • Basic usage
• Contributors

Introduction

The Tenderly SDK provides an easy-to-use interface for interacting with the Tenderly platform.

It allows you to simulate transactions, simulate transaction bundles, manage contracts and wallets, and verify smart contracts from your code. The SDK is particularly useful for blockchain developers who want to integrate Tenderly's powerful tools into their dapp or development workflow.

List of supported networks can be found here

Documentation

Full documentation with example snippets here:
Tenderly SDK docs

Quick start

Installation

Available on npm as tenderly-sdk npm

npm i @tenderly/sdk

yarn

yarn add @tenderly/sdk

pnpm

pnpm add @tenderly/sdk

Quick start

Instantiate a new tenderly instance with your project details. We highly recommend using environment variables for sensitive data such as access keys during your local development!

import { Tenderly, Network } from '@tenderly/sdk';

const tenderlyInstance = new Tenderly({
  accessKey: process.env.TENDERLY_ACCESS_KEY,
  accountName: process.env.TENDERLY_ACCOUNT_NAME,
  projectName: process.env.TENDERLY_PROJECT_NAME,
  network: Network.MAINNET,
});

Fetch project contracts

const contracts = await tenderlyInstance.contracts.getAll();

console.log(contracts.map(contract => contract.address).join(', '));
// 0x63456...5689, 0x54j2...23890, 0x211e...289n

Examples

• Add contracts
• Add wallets
• Allow and Transfer
• Contract verification
• Simulate transaction
• Simulate bundle

Contributors

License

MIT

@tenderly/sdk

0.3.1

Patch Changes

• 79f564f: Deprecate fantom

0.3.0

Minor Changes

• d9951fa: Add missing networks

0.2.8

Patch Changes

• 6076dbc: Add Polygon Amoy

0.2.7

Patch Changes

• e358968: Deprecate Mumbai network

0.2.6

Patch Changes

• 064ed94: add mode and moonbase alpha networks support
• 10d3cf6: lisk and immutable networks

0.2.5

Patch Changes

• f212198: deprecate Goerli

0.2.4

Patch Changes

• a80ca93: add linea sepolia support

0.2.3

Patch Changes

• 3ad9f00: add missing networks support

0.2.2

Patch Changes

• b6829cc: mantle sepolia and boba sepolia networks

0.2.1

Patch Changes

• 7cdf08f: Added Base and Base Goerli networks to Network enum

0.2.0

Minor Changes

• 6e93f3b: enabled typescript strict mode

0.1.15

Patch Changes

• 4ca0753: Update value type in Simulator types to be string or number

0.1.14

Patch Changes

• a6f4fb5: Repack libraries without TenderlySolcConfig
• 7ce6a2b: Make TenderlySolcConfig dependent on SolcConfig

0.1.13

Patch Changes

• 23d79f0: Renamed user-agent to x-user-agent

0.1.12

Patch Changes

• 9f24eb7: Added @deprecated to error_messages Populate error_reason

0.1.11

Patch Changes

• b1ad7e8: TIC-498 getAll method should target v2 API

0.1.10

Patch Changes

• 595093b: Fixed error while performing simulated transaction with state overrides
• 64e9578: Enabling external contributors to run tests in target repository context

0.1.9

Patch Changes

• a54bcec: Added more examples that elaborate contract verification.

0.1.8

Patch Changes

• 54fe4bd: [docs] update readme intro

0.1.7

Patch Changes

• 6b11f1b: Fixed readme example

0.1.6

Patch Changes

• 7f5602f: Changed npm shield for readme.md
• 67b0785: Adding JSDOC for verify and simulate methods

0.1.5

Patch Changes

• 56c21fb: [fix] remove deprecated network enums

0.1.4

Patch Changes

• c09fc9a: Making helper types available from root import

0.1.3

Patch Changes

• 8a56132: Adding all supported networks

0.1.2

Patch Changes

• 5b54588: Shrinkng npm bundle by whitelisting lib and dist folders

0.1.1

Patch Changes

• 3cee5aa: Adding examples for simulating transactions

0.1.0

Minor Changes

• e1c5595: Fixed bumping version automatically

0.0.7

Patch Changes

• b795d39: Implemented verification and added tests.

0.0.6

Patch Changes

• 827ab8f: Accepting plain numbers as input for tenderly network configuration

0.0.5

Patch Changes

• 4481283: Adding env variables correctly
• 66a8e1a: adding changeset file to release
• 7fef38e: Restoring .env variables

0.0.2

Patch Changes

• 2b2195f: Added initial code to the public repo
• 2272fc1: cleaning not used files
• 0a04a8b: Switching from yarn to pnpm
• dc5c8d5: Removing old yarn calls from package.json
• 8555cdb: Fixing branch name inside the github workflow