Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tenderly/tenderly-snap
Tenderly TX Preview allows you to see the exact transaction outcomes before sending them on-chain using the Tenderly Simulation Infrastructure. 🦊
https://github.com/tenderly/tenderly-snap
metamask metamask-snap tenderly transaction-simulator
Last synced: about 1 month ago
JSON representation
Tenderly TX Preview allows you to see the exact transaction outcomes before sending them on-chain using the Tenderly Simulation Infrastructure. 🦊
- Host: GitHub
- URL: https://github.com/tenderly/tenderly-snap
- Owner: Tenderly
- License: apache-2.0
- Created: 2023-08-22T21:27:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-23T11:55:24.000Z (3 months ago)
- Last Synced: 2024-10-18T08:59:43.631Z (2 months ago)
- Topics: metamask, metamask-snap, tenderly, transaction-simulator
- Language: TypeScript
- Homepage: https://docs.tenderly.co/how-to-install-tenderly-tx-preview-snap
- Size: 2.11 MB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.APACHE2
- Audit: audits/2023-08-Metamask-Snap-PT-for-Tenderly.pdf
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Tenderly Snap
Tenderly TX Preview allows you to see the exact transaction outcomes before sending them on-chain using the Tenderly Simulation Infrastructure.
# Introduction
Tenderly [TX Preview](https://docs.tenderly.co/simulations-and-forks/transaction-preview) enables you to see the exact outcomes of your transactions before sending them on-chain. Powered by the Tenderly Simulation Infrastructure, this feature gives you detailed and human-readable information about your transactions, including transferred assets with exact dollar values for ERC-20 tokens and NFTs.
By previewing transactions before sending, you can avoid unnecessary gas costs, prevent failed transactions, and identify potential security risks. With Tenderly TX Preview, you can make an informed decision thanks to the following information:
| Feature | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Asset Changes with Dollar Values** | See the exact asset transfers within your ERC-20 and ERC-721 transactions, including their corresponding dollar values. |
| **Link to Simulation in Tenderly Dashboard** | Get detailed information about your transaction simulations in the Tenderly Dashboard. |
| **Link to Publicly Shared Simulation in Tenderly Dashboard** | Share your simulated transactions with others using a public URL. The recipient doesn’t need to have a Tenderly account to view the shared transaction in read-only mode. |
With this in-depth information about your transactions, you can understand their exact financial implications, avoid any hidden security risks, and save valuable resources.
# Setup
To start using Tenderly TX Preview, you can set it up using the Tenderly Dashboard or run it locally. Follow a few simple steps to get started.
## 1. Get Tenderly access
First, you need a Tenderly account to start using the TX Preview feature. To set up your account, [register by following a few simple steps](https://dashboard.tenderly.co/register).
### Install Tenderly Snap from the Dashboard
Next, generate a Tenderly access token to allow Tenderly Snap to connect to your Tenderly account. This is a unique identifier that you can on the following link https://dashboard.tenderly.co/account/authorization.
By clicking the **Connect to Tenderly Snap** button, you’ll automatically install Tenderly Snap and be able to use Tenderly TX Preview.
## 2. Run Tenderly Snap locally
You can also set up Tenderly Snap locally. To achieve this, follow the steps below.
### Clone the Repository
First, download the app code onto your local machine by cloning this repository. For more information, find detailed instructions in the GitHub documentation.
Note that you need a Tenderly account to use Tenderly Snap, so make sure to create it as described above.
### Start the app
After cloning the repository, go to the root project directory in your terminal. Next, run the `yarn start` command to start the app. Once done, you can access it on http://localhost:8000.
Use the following command to clone the repository:
```
git clone https://github.com/Tenderly/tenderly-snap.git
```
Next, go to the root project directory:
```
cd tenderly-snap
```
Finally, start the app using:
```
yarn install && yarn start
```
Congrats, you’ve successfully installed Tenderly Snap on your local machine. You can now use Tenderly TX Preview. If you come across any issues, feel free to reach out to our support team at [email protected]. We're happy to help! 💜
# Author
- Vanja Paunović ([@dzimiks](https://twitter.com/dzimiks))
The repo was made using the [@metamask/template-snap-monorepo](https://github.com/MetaMask/template-snap-monorepo) and
inspired by the [open-source repo](https://github.com/halo3mic/tenderly-snap) by [Miha Lotric](https://twitter.com/mihalotric).