https://github.com/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.
https://github.com/tenderly/tenderly-sdk
sdk tenderly web3
Last synced: about 1 month ago
JSON representation
With the Tenderly SDK, you can simulate individual transactions or bundles of transactions, manage contracts and wallets, and verify contracts from your code.
- Host: GitHub
- URL: https://github.com/tenderly/tenderly-sdk
- Owner: Tenderly
- License: mit
- Created: 2023-03-01T16:16:42.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T13:48:57.000Z (8 months ago)
- Last Synced: 2024-10-30T14:54:41.628Z (7 months ago)
- Topics: sdk, tenderly, web3
- Language: TypeScript
- Homepage: https://docs.tenderly.co/tenderly-sdk
- Size: 1.29 MB
- Stars: 40
- Watchers: 4
- Forks: 13
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Tenderly SDK
SDK for working with your favorite Web3 development platform
[](./LICENSE)
[](https://www.npmjs.org/package/@tenderly/sdk)
[](https://twitter.com/intent/follow?screen_name=TenderlyApp)
[](https://github.com/Tenderly/tenderly-sdk)
## Table of contents
## 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
```sh
npm i @tenderly/sdk
```
yarn
```sh
yarn add @tenderly/sdk
```
pnpm
```sh
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!_
```ts
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
```ts
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](LICENSE)