tenderly/tenderly-sdk

With the Tenderly SDK, you can simulate individual transactions or bundles of transactions, manage contracts and wallets, and verify contracts from your code.

Tenderly SDK

SDK for working with your favorite Web3 development platform

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's Issues

Add method for `/simulations/:id/share` endpoint in Simulator.ts

from docs:

  // Make the simulation publicly accessible
  if (parsedResponse?.simulation?.id) {
    await fetch(
      `https://api.tenderly.co/api/v1/account/${credentials.accountId}/project/${credentials.projectId}/simulations/${parsedResponse.simulation.id}/share`,
      {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
          'X-Access-Key': credentials.accessToken,
        },
      },
    );
  }

endpoint detailed in https://docs.tenderly.co/simulations-and-forks/integration-guides/how-to-add-transaction-preview-to-a-metamask-snap-using-tenderly-simulation-api#simulation

TransactionParameters type does not have `save` or `save_if_fails`

We're trying to use the SDK to simulate a transaction bundle and save the results to the dashboard, and it appears that the save and save_if_fails options are not available in the SDK.

TransactionParameters types where I would expect save and save_if_fails: https://github.com/Tenderly/tenderly-sdk/blob/master/lib/executors/Simulator.types.ts#L3-L13

Where I would expect save and save_if_fails for tx simulation bundles: https://github.com/Tenderly/tenderly-sdk/blob/master/lib/executors/Simulator.ts#L128-L138

Where I would expect save and save_if_fails for an individual tx simulation: https://github.com/Tenderly/tenderly-sdk/blob/master/lib/executors/Simulator.ts#L153-L163

We're happy to make this change if these are the right places to update.

Support Taraxa Chain in Tenderly

Hi guys! We at Taraxa are looking into connecting to the most relevant EVM development tools as the first EVM-compatible BlockDAG. Check us out at www.taraxa.io.

I'd be looking for some support material and would be glad to do the hands-on integration if you guys have docs on it.

I reached out via your webpage but got no response yet, so trying my luck here.
Cheers 👋🏼

contract add: internal_server_error

Hi, I'm trying to add contracts to my tenderly project, but I keep getting server error:

Tenderly: ApiError: Internal server error
    at Function.handle (contractsnode_modules\@tenderly\sdk\dist\index.js:142:13)
    at contractsnode_modules\@tenderly\sdk\dist\index.js:247:46
    at Array.forEach (<anonymous>)
    at handleError (contractsnode_modules\@tenderly\sdk\dist\index.js:247:17)
    at ContractRepository.<anonymous> (contractsnode_modules\@tenderly\sdk\dist\index.js:347:9)
    at Generator.throw (<anonymous>)
    at rejected (contractsnode_modules\@tenderly\sdk\dist\index.js:74:29)
    at processTicksAndRejections (node:internal/process/task_queues:95:5) {
  id: '50cebf37-28ec-465a-a9d1-b3b5f517df18',
  slug: 'internal_server_error',
  data: undefined,
  status: 500
}

• "@tenderly/sdk": "^0.2.1"
• "hardhat": "2.19.4"

SimulationCallArguments value type should be string not number

https://github.com/Tenderly/tenderly-sdk/blob/master/lib/executors/Simulator.types.ts#L57

should this value type be string? wei values can overflow as numbers in js.

(i can make this pr if we agree on the change)

Example with OZ / imports

Hello,

Would you be able to provide an example of verifying a contract that has multiple imports, including some OpenZeppelin imports?