Skip to content

Commit d3afd7d

Browse files
authored
README: adding new features
1 parent 80b6e30 commit d3afd7d

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,8 @@ This repository contains the code and configuration files of the metadata oracle
2020
- Fetching and scraping data with error handling and retries
2121
- Transaction construction, including dynamic fee estimation
2222
- Support for remote API [Blockfrost.io](https://blockfrost.io)
23-
24-
### Planning
25-
26-
- Support for full local Cardano node (using `cardano-cli`) ([#6](https://github.com/fivebinaries/cardano-metadata-oracle/issues/6))
27-
- Prometheus style endpoint for monitoring and Grafana integration ([#7](https://github.com/fivebinaries/cardano-metadata-oracle/issues/7))
23+
- Support for full local Cardano node (using `cardano-cli`)
24+
- Prometheus style endpoint for monitoring and Grafana integration
2825

2926
## Installation
3027

@@ -71,6 +68,8 @@ export BLOCKFROST_PROJECT_ID=your_blockfrost_project_id
7168

7269
To post your datapoint to the Cardano network, you need to provide at least `origin-file` and `seed-file` of the wallet containing the funds to do posting. You can use files in the `test` folder.
7370

71+
When using the Cardano full node, make sure you set the environmental variable `CARDANO_NODE_SOCKET_PATH` to the socket file of the node.
72+
7473
## Configuration
7574

7675
### Origins
@@ -88,7 +87,7 @@ ADAUSD:
8887
path: '$.ADA.USD'
8988
```
9089

91-
Have a look in the [`examples/`](./examples/) directory for inspiration.
90+
Have a look in the [`test/data/`](test/data/) directory for inspiration.
9291

9392
### Wallet
9493

@@ -105,3 +104,7 @@ By default, the node uses Cardano mainnet network. To post to testnet network, u
105104
### Metadata label (optional)
106105

107106
By default, we're using matadata label `1968` as per [nut.link](https://nut.link) specification. If you have a specific use case, it might be a good idea to use a different label.
107+
108+
### Prometheus endpoint (optional)
109+
110+
You have the possibility to export prometheus-style file with the current address balance, the time of last run and the execution time. This will help you a lot with monitoring of your oracle.

0 commit comments

Comments
 (0)