This repository has been archived by the owner on Sep 21, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
336 additions
and
326 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) | ||
| and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). | ||
|
|
||
| NOTE: As semantic versioning states all 0.y.z releases can contain breaking changes in API (flags, grpc API, any backward compatibility) | ||
|
|
||
| We use *breaking :warning:* to mark changes that are not backward compatible (relates only to v0.y.z releases.) | ||
|
|
||
| ## Unreleased | ||
| - [#272](https://github.com/tellor-io/telliot/pull/272) Automated Docker images on every push to master and with every tagged release. | ||
|
|
||
| ## [v5.2.0](https://github.com/tellor-io/telliot/releases/tag/v5.2.0) - 2020.11.12 | ||
| - [#254](https://github.com/tellor-io/telliot/pull/254) | ||
| - Added support for expanding variables in the indexer api url. | ||
| - Added config to specify the `.env` file location. The default is now `configs/.env` so users should either specify a custom location in the `config.json` or move it inside the default config folder. | ||
|
|
||
| ## [v5.0.0](https://github.com/tellor-io/telliot/releases/tag/v5.0.0) - 2020.11.02 | ||
|
|
||
| ### Added | ||
| - Profitability calculations which is set through the `ProfitThreshold`(in percents) settings in the config, | ||
| - Docs how to contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,70 @@ | ||
| # Introduction | ||
|
|
||
| [](https://www.tellor.io/) | ||
| <p align="center"> | ||
| <a href='https://www.tellor.io/'> | ||
| <img src= '../assets/Tellor.png' width="250" height="200" alt='tellor.io' /> | ||
| </a> | ||
| </p> | ||
|
|
||
| [](https://twitter.com/WeAreTellor) | ||
| <p align="center"> | ||
| <a href='https://twitter.com/WeAreTellor'> | ||
| <img src= 'https://img.shields.io/twitter/url/http/shields.io.svg?style=social' alt='Twitter WeAreTellor' /> | ||
| </a> | ||
| </p> | ||
|
|
||
| > ### ⚠️ Note! | ||
| > | ||
| > Telliot docs are synced from the project repository. To edit please visit: | ||
| > [Telliot gitbook space](https://docs.tellor.io/telliot) | ||
| > or | ||
| > [Telliot github repo](https://github.com/tellor-io/telliot/tree/master/docs) | ||
|
|
||
| ## Telloit | ||
| > ## ⚠️ Note! | ||
| > Telliot docs are synced from the project repository. | ||
| To edit please visit:<br/> | ||
| [Telliot gitbook space](https://docs.tellor.io/telliot)<br/> | ||
| or<br/> | ||
| [Telliot github repo](https://github.com/tellor-io/telliot/tree/master/docs) | ||
|
|
||
| This is the main cli of the project. One if its commands is to run in mining mode\(solve a POW challenge\) and submit values to the tellor oracle contract. It's built on Go and utilizes a split structure. The database piece is a LevelDB that keeps track of all variables \(challenges, difficulty, values to submit, etc.\) and the miner simply solves the PoW challenge. This enables parties to split the pieces for optimization. | ||
|
|
||
| The Tellor system is a way to push data on-chain. What pieces of data are pushed are specificied in the `configs/indexes.json`. Note that the data corresponds to a specific API. The tellor mining system is set up to pull api data to generate these values to submit on-chain once a correct nonce is mined. These specific apis are just suggestions. The system is not guarunteed to work for everyone. It is up to the consnesus of the Tellor token holders to determine what a correct value is. As an example, request ID 4 is BTC/USD. If the api's all go down, it is the responsibility of the miner to still submit a valid BTC/USD price. If they do not, they risk being disputed and slashed. For these reasons, please contribute openly to the official Tellor miner \(or an open source variant\), as consensus here is key. If you're miner gets a different value than the majority of the of the other miners, you risk being punished. | ||
|
|
||
| A list of all PSR's\(pre specified requests\) and the expected data can be found [here](https://github.com/tellor-io/telliot/tree/f6791d8fb61f7d49051624a70a96b7d6a3f77345/pkg/tracker/psrs.go). | ||
| # Telloit | ||
|
|
||
|  | ||
| This is the main cli of the project. One if its commands is to run in mining mode(solve a POW challenge) and submit values to the tellor oracle contract. | ||
| It's built on Go and utilizes a split structure. The database piece is a LevelDB that keeps track of all variables (challenges, difficulty, values to submit, etc.) and the miner simply solves the PoW challenge. This enables parties to split the pieces for optimization. | ||
|
|
||
| ### Instructions for deployment | ||
| The Tellor system is a way to push data on-chain. What pieces of data are pushed are specificied in the `configs/indexes.json`. Note that the data corresponds to a specific API. The tellor mining system is set up to pull api data to generate these values to submit on-chain once a correct nonce is mined. These specific apis are just suggestions. The system is not guarunteed to work for everyone. It is up to the consnesus of the Tellor token holders to determine what a correct value is. As an example, request ID 4 is BTC/USD. If the api's all go down, it is the responsibility of the miner to still submit a valid BTC/USD price. If they do not, they risk being disputed and slashed. For these reasons, please contribute openly to the official Tellor miner (or an open source variant), as consensus here is key. If you're miner gets a different value than the majority of the of the other miners, you risk being punished. | ||
|
|
||
| * [Telliot Instructions](https://github.com/tellor-io/telliot/tree/f6791d8fb61f7d49051624a70a96b7d6a3f77345/docs/docs/setup-and-usage.md) | ||
| A list of all PSR's(pre specified requests) and the expected data can be found [here](../pkg/tracker/psrs.go). | ||
|
|
||
| ### Contributing and building from source | ||
| <p align="center"> | ||
| <img src= '../assets/minerspecs.png' width="450" alt='MinerSpecs' /> | ||
| </p> | ||
|
|
||
| Contributions are very welcome! | ||
| See our [04\_contributing.md](telliot-documentation/contributing.md) for more information. | ||
|
|
||
| ### Run with Docker | ||
| ## Instructions for deployment | ||
| - [Telliot Instructions](docs/setup-and-usage.md) | ||
|
|
||
| Available tags: [https://hub.docker.com/u/tellor](https://hub.docker.com/u/tellor) docker run -v $\(pwd\)/.local:/configs tellor/telliot:master mine | ||
| ## Contributing and building from source | ||
| Contributions are very welcome!<br/> | ||
| See our [04_contributing.md](contributing.md) for more information. | ||
|
|
||
| ### Maintainers | ||
| ## Run with Docker | ||
| Available tags: https://hub.docker.com/u/tellor | ||
| docker run -v $(pwd)/.local:/configs tellor/telliot:master mine | ||
|
|
||
| ## Maintainers <a name="maintainers"> </a> | ||
| This repository is maintained by the [Tellor team](https://github.com/orgs/tellor-io/people) | ||
|
|
||
| #### DISCLAIMER | ||
| ### DISCLAIMER | ||
|
|
||
| ------- | ||
|
|
||
| Mine at your own risk. | ||
|
|
||
| Mining requires you deposit 1000 Tellor Tributes. These are a security deposity. If you are a malicious actor \(aka submit a bad value\), the community can vote to slash your 1000 tokens. | ||
| Mining requires you deposit 1000 Tellor Tributes. These are a security deposity. If you are a malicious actor (aka submit a bad value), the community can vote to slash your 1000 tokens. | ||
|
|
||
| Mining also requires submitting on-chain transactions on Ethereum. These transactions cost gas \(ETH\) and can sometimes be signifiant if the cost of gas on EThereum is high \(i.e. the network is clogged\). Please reach out to the community to find the best tips for keeping gas costs under control or at least being aware of the costs. | ||
| Mining also requires submitting on-chain transactions on Ethereum. These transactions cost gas (ETH) and can sometimes be signifiant if the cost of gas on EThereum is high (i.e. the network is clogged). Please reach out to the community to find the best tips for keeping gas costs under control or at least being aware of the costs. | ||
|
|
||
| If you are building a competing client, please contact us. The miner specifications are off-chain and the validity of the mining process hinges on the consensus of the Tellor community to determine what proper values are. Competing clients that change different pieces run the risk of being disputed by the commmunity. | ||
|
|
||
| There is no guaruntee of profit from mining. | ||
|
|
||
| There is no promise that Tellor Tributes currently hold or will ever hold any value. | ||
|
|
||
| ---------- | ||
| ### Copyright | ||
| Tellor Inc. 2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,8 @@ | ||
| # Table of contents | ||
|
|
||
| * [Introduction](README.md) | ||
|
|
||
| ## Telliot Documentation | ||
|
|
||
| * [Introduction](telliot-documentation/readme.md) | ||
| * [Setup and usage](telliot-documentation/setup-and-usage.md) | ||
| * [Configuation](telliot-documentation/configuation.md) | ||
| * [Contributing](telliot-documentation/contributing.md) | ||
| * [Coding style guide](telliot-documentation/coding-style-guide.md) | ||
| * [Release process](telliot-documentation/release-process.md) | ||
| * [Changelog](telliot-documentation/changelog.md) | ||
|
|
||
| * [Introduction](README.md) | ||
| * [Setup and usage](setup-and-usage.md) | ||
| * [Configuation](configuation.md) | ||
| * [Contributing](contributing.md) | ||
| * [Coding style guide](coding-style-guide.md) | ||
| * [Release process](release-process.md) | ||
| * [Changelog](CHANGELOG.md) |
Oops, something went wrong.