Reporting Options
Options to report or manage your reporter with Telliot
telliot report --help and it will explain more details about 'report' optionStaking and Unstaking
We reccomend to quickly do this from Fetch Dashbord's Staking section, but Telliot also has built in functions you can use.
Staking
Using telliot stake you can stake additional tokens to your current stake. Select your account with -a and --amount, like this:
telliot stake -a <yourAccName> --amount 600000
It will ask you to confirm your password and it will deposit the extra amount you typed on top of your current stake amount. For example, if your previous amount was 500,000 and you use --amount 600000 you'll end up with 1,100,000 tokens deposited.
After staking you get a successful deposit transaction URL and telliot stops.
NOTE: If the reporter account's actual stake is reduced after a dispute, the reporter will attempt to stake the difference in FETCH to return to the original desired stake amount if the -s is present.
To avoid this, run it without the -s flag. It may stop reporting when there's deduction in stake amount depending on your total stake.
Requesting Withdraw
To start the unstake process we use telliot request-withdraw to put the tokens in the 7 days lock period state before actually withdrawing them. Process is similar to staking.
telliot request-withdraw -a <yourAccName> --amount 200000
After confirming the password you get a requestStakingWithdraw transaction URL if successful and Telliot stops.
Withdrawing Locked Balance
Remember you can check Fetch Dashboard's Staking section for detailed info on the state of your locked balance and withdrawal.
To use Telliot to withdraw we need telliot withdraw and the acc name. After the 7 days have passed, calling this function withdraws ALL the tokens in Locked Balance.
Everytime tokens in locked balance are moved, by unstaking or staking/re-staking, the 7 days reset!
Be mindful of that and only unstake the amount you actually won't need for the next 7 days and when you are sure you won't need to stake any more tokens to that reporter during the unstake period.
Also, tokens you stake while having tokens in 'locked balance' are deducted from 'locked balance' prior to your actual wallet balance.
telliot withdraw -a <yourAccName>
If the 7 days are gone since you requested the withdraw, you'll get a transaction URL confirming the withdrawal. Otherwise, you'll get a revert saying the 7 days haven't passed yet.
Submitting Once
To submit a simple single report, add the --submit-once option, like this:
telliot report -a <yourAccName> -qt pls-usd-spot --submit-onceAfter one value is submitted to Fetch Oracle, the Telliot process will terminate.
Reporting in Intervals
To stop trying to report every 7 seconds, we can use the -wp option and specify what interval, in seconds, we want Telliot to try to submit a report. Here' how:
telliot report -a <yourAccName> -qt pls-usd-spot -wp 3600Here, Telliot will submit the first report and then wait 3,600 seconds (1 hour) to try to submit the next one. If you are out of report lock period it will succeed, otherwise, it will try again 3,600 seconds later.
Stop reporting based on Native token balance
telliot report -a <yourAccName> -qt pls-usd-spot -mnb 40000You can use the -mnb option to stop Telliot when it detects your native token balance (PLS in PulseChain) reached the threshold you set.
The example above would have stopped Telliot from submitting when reaching <40,000 PLS balance. If you send more PLS to the account it will resume reporting.
Reporting When Profitable
Telliot can submit when there's a percentage profit or USD profit from time based rewards and tips.
Using the -p option we set 2 parameters: % and USD thresholds. If we don't want to check for profits and just submit we can use -p YOLO 0 which would report straight away and not check for profits at all.
By default Telliot checks for at least 100% profit above 0 USD. The profit is calculated using the FETCH price of fetch-usd-spot source against the gas cost to submit the transaction.
Example:
-p 1000 2 would only submit a report if the profit after calculating the gas price is above 1000% or 2 Dollars (based on the FETCH price at the time of reporting).
If you want to use only percentage profit or only USD, set the un-desired value to something really high, so it never passes the validation and only the desired one is checked, example:
-p 200 999 would only submit with a 200% profit, since 999 USD will very unlikely ever happen.
Here are more examples:
telliot report -a <yourAccName> -qt pls-usd-spot -p 300 5
Here we're going to submit a report if the percentage profit is above 300% or $5 dollars. If one of these two conditions are met, it reports.
p was 200000 and 5 it would not submit, since both parameters would be above the actual profit.Enforcing no profit checks:
telliot report -a <yourAccName> -qt pls-usd-spot -p YOLO 0
Reporting for tips
If you leave the -qt option out of the command, Telliot will try to report only when someone tips for an already existing tag. If the tip value matches your profit settings, it will try to submit. Here you'll receive the TBRs + Tips.
Tips can be claimed after 12h of submission. This period is to confirm the data submitted is valid.
telliot report -a <yourAccName>Reporting Random Feeds
To support the ecosystem and have a larger chance of getting time based rewards (by not clashing with another reporter submitting the same QueryID as you at the same timestamp) you may want to report to multiple random feeds.
Use the -rf option to report to a random feed from the list found in ~/telliot-feeds/src/telliot_feeds/feeds directory. Open the file __init__.py to check and edit the queries.
Always check what you're randomly reporting before starting Telliot, to make sure you're comfortable with the queries in there and their sources!
Only report for feeds you have previously tested and checked within the community what they are considering as truth for data submitted.
Look for the line containing RANDOM_FEEDS and the feeds listed there are the ones you'll be submitting, randomly, when using -rf.
Comment out the ones you don't want to report to (by adding a # in the start of the line) or copy and paste new ones, following the same pattern of the list, from the CATALOG_FEEDS below it. Remember to save the file when you're done.
To report, the command line will look like this:
telliot report -a <yourAccName> -rfConditional Reporting
Telliot can report when some conditions are met, like a percent price change or when a price has become stale.
Reporting when there's a % change
Enables reporting if there’s a percent change in the query tag selected.
Used with ‘conditional’ option, like this:
telliot conditional -a <yourAccName> -qt btc-usd-spot --percent-change 0.1Above, if there’s a 10% change in price reported, it will try to report a new one:
Reporting when the price is Stale
If the feed is stale by X amount of seconds, it will trigger a report on the query tag selected. By default in the 'conditional' option it will consider a price stale after ~24h of no new reports.
Used with ‘conditional’ option, like this:
telliot conditional -a myacc_ts -qt btc-usd-spot -st 6400
Build Feed Flag (advanced)
Use the build-a-feed flag (--build-feed) to build a DataFeed of a QueryType with one or more QueryParameters.
When reporting, the CLI will list the QueryTypes this flag supports. To select a QueryType, enter a number from the list provided. Then, enter the corresponding QueryParameters for the QueryType you have selected.
This way you'll be submitting a manual value to Fetch Oracle. Be mindful of submitting thrustful values, otherwise you may get disputed by others!
telliot report -a <yourAccName> --build-feedLast updated