Skip to content

Commit

Permalink
Add readme file for RedStone price feed monitoring
Browse files Browse the repository at this point in the history
  • Loading branch information
matjazv committed Nov 15, 2024
1 parent 188108f commit 148ecd0
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions web3-actions/priceFeedMonitor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# RedStone Price Feed Monitoring

Inside this folder, you will find the code for the RedStone Price Feed monitoring using Tenderly Web3 Actions. This code is used to monitor the price feed of the RedStone smart contracts for different token pairs and trigger alerts if the price feed was not updated for a certain period of time. In this case, the alert is sent to the Opsgenie.

## Install Tenderly CLI
If you haven't already, install [Tenderly CLI](https://github.com/Tenderly/tenderly-cli#installation).

Before you go on, you need to login with CLI, using your Tenderly credentials:

```bash
tenderly login
```

## Build and Publish/Deploy Web3 Actions

Before you can build and publish/deploy the Web3 Actions, you need modify the configuration `.yaml` file for the project.
Some configuration files inside this folder are:
- `lskUsd.yaml` - configuration file for the RedStone price feed monitoring for the LSK/USD token pair
- `ethUSD.yaml` - configuration file for the RedStone price feed monitoring for the ETH/USD token pair
- `usdtUsd.yaml` - configuration file for the RedStone price feed monitoring for the USDT/USD token pair

You need to provide the following information in the configuration file:
- `YOUR_USERNAME` - your Tenderly account
- `YOUR_PROJECT_SLUG` - your Tenderly project

To build different Web3 Actions, run the following command:

```bash
tenderly actions build --project-config [yaml_file]
```

To publish/deploy the Web3 Actions, run the following command:

```bash
tenderly actions publish --project-config [yaml_file]
or
tenderly actions deploy --project-config [yaml_file]
```
`publish` is used to publish the Web3 Actions to the Tenderly platform without deploying them.

0 comments on commit 148ecd0

Please sign in to comment.