Tellor Docs
Search…
Tellor Docs
Welcome
Whitepaper
Introduction
How Tellor Works
Security
Use Cases
Integration
Introduction
Data feed IDs
Tellor Playground
Using Tellor
Contracts
Reference
Telliot
Introduction
Internal architecture
Setup and usage
Configuration reference
Contributing
Coding style guide
Release process
Changelog
Token Holders
What you can do
Initiating a Dispute
Security
Vulnerability Disclosure
Powered By GitBook
Configuration reference
Telliot tweaks and settings to keep your rig running smoothly.

CLI reference

Telliot commands and config file options are as the following:

Required Flags

  • --config (path to your config file.)

Telliot Commands

  • accounts
1
Usage: telliot accounts
2
​
3
Show accounts
4
​
5
Flags:
6
-h, --help Show context-sensitive help.
7
​
8
--config=CONFIG-PATH path to config file
Copied!
  • approve
1
Usage: telliot approve --from=STRING --to=STRING <amount>
2
​
3
Approve tokens
4
​
5
Arguments:
6
<amount>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
12
--gas-price=INT gas price to use when running the command
13
--from=STRING
14
--to=STRING
Copied!
  • balance
1
Usage: telliot balance [<address>]
2
​
3
Check the balance of an address
4
​
5
Arguments:
6
[<address>]
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
Copied!
  • dataserver
1
Usage: telliot dataserver
2
​
3
launch only a dataserver instance
4
​
5
Flags:
6
-h, --help Show context-sensitive help.
7
​
8
--config=CONFIG-PATH path to config file
Copied!
  • dispute
1
Usage: telliot dispute <command>
2
​
3
Perform commands related to disputes
4
​
5
Flags:
6
-h, --help Show context-sensitive help.
7
​
8
Commands:
9
dispute new <addr> <request-id> <timestamp> <miner-index>
10
start a new dispute
11
​
12
dispute vote <addr> <dispute-id> <support>
13
vote on a open dispute
14
​
15
dispute list <addr>
16
list open disputes
17
​
18
dispute tally <dispute-id>
19
tally votes for a dispute ID
Copied!
  • dispute list
1
Usage: telliot dispute list <addr>
2
​
3
list open disputes
4
​
5
Arguments:
6
<addr>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
Copied!
  • dispute new
1
Usage: telliot dispute new <addr> <request-id> <timestamp> <miner-index>
2
​
3
start a new dispute
4
​
5
Arguments:
6
<addr>
7
<request-id> the request id to dispute it
8
<timestamp> the submitted timestamp to dispute
9
<miner-index> the miner index to dispute
10
​
11
Flags:
12
-h, --help Show context-sensitive help.
13
​
14
--config=CONFIG-PATH path to config file
15
--gas-price=INT gas price to use when running the command
Copied!
  • dispute tally
1
Usage: telliot dispute tally <dispute-id>
2
​
3
tally votes for a dispute ID
4
​
5
Arguments:
6
<dispute-id> the dispute id
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
12
--gas-price=INT gas price to use when running the command
Copied!
  • dispute vote
1
Usage: telliot dispute vote <addr> <dispute-id> <support>
2
​
3
vote on a open dispute
4
​
5
Arguments:
6
<addr>
7
<dispute-id> the dispute id
8
<support> true or false
9
​
10
Flags:
11
-h, --help Show context-sensitive help.
12
​
13
--config=CONFIG-PATH path to config file
14
--gas-price=INT gas price to use when running the command
Copied!
  • mine
1
Usage: telliot mine
2
​
3
Submit data to oracle contracts
4
​
5
Flags:
6
-h, --help Show context-sensitive help.
7
​
8
--config=CONFIG-PATH path to config file
Copied!
  • stake
1
Usage: telliot stake <command>
2
​
3
Perform one of the stake operations
4
​
5
Flags:
6
-h, --help Show context-sensitive help.
7
​
8
Commands:
9
stake deposit <addr>
10
deposit a stake
11
​
12
stake request <addr>
13
request to withdraw stake
14
​
15
stake withdraw <addr>
16
withdraw stake
17
​
18
stake status <addr>
19
show stake status
Copied!
  • stake deposit
1
Usage: telliot stake deposit <addr>
2
​
3
deposit a stake
4
​
5
Arguments:
6
<addr>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
12
--gas-price=INT gas price to use when running the command
Copied!
  • stake request
1
Usage: telliot stake request <addr>
2
​
3
request to withdraw stake
4
​
5
Arguments:
6
<addr>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
12
--gas-price=INT gas price to use when running the command
Copied!
  • stake status
1
Usage: telliot stake status <addr>
2
​
3
show stake status
4
​
5
Arguments:
6
<addr>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
Copied!
  • stake withdraw
1
Usage: telliot stake withdraw <addr>
2
​
3
withdraw stake
4
​
5
Arguments:
6
<addr>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
12
--gas-price=INT gas price to use when running the command
Copied!
  • transfer
1
Usage: telliot transfer --from=STRING --to=STRING <amount>
2
​
3
Transfer tokens
4
​
5
Arguments:
6
<amount>
7
​
8
Flags:
9
-h, --help Show context-sensitive help.
10
​
11
--config=CONFIG-PATH path to config file
12
--gas-price=INT gas price to use when running the command
13
--from=STRING
14
--to=STRING
Copied!
  • version
1
Usage: telliot version
2
​
3
Show the CLI version information
4
​
5
Flags:
6
-h, --help Show context-sensitive help.
Copied!

.env file options:

Config file options:

1
{
2
"Aggregator": {
3
"LogLevel": "Required:false, Default:info",
4
"ManualDataFile": "Required:false, Default:configs/manualData.json"
5
},
6
"Db": {
7
"LogLevel": "Required:false, Default:info",
8
"Path": "Required:false, Default:db",
9
"RemoteHost": "Required:false, Default:",
10
"RemotePort": "Required:false, Default:0",
11
"RemoteTimeout": {
12
"Duration": "Required:false, Default:5s"
13
}
14
},
15
"DisputeTracker": {
16
"LogLevel": "Required:false, Default:info"
17
},
18
"GasStation": {
19
"TimeWait": {
20
"Duration": "Required:false, Default:1m0s"
21
}
22
},
23
"IndexTracker": {
24
"IndexFile": "Required:false, Default:configs/index.json",
25
"Interval": {
26
"Duration": "Required:false, Default:30s"
27
},
28
"LogLevel": "Required:false, Default:info"
29
},
30
"Mining": {
31
"Heartbeat": "Required:false, Default:1m0s",
32
"LogLevel": "Required:false, Default:info"
33
},
34
"ProfitTracker": {
35
"LogLevel": "Required:false, Default:info"
36
},
37
"PsrTellor": {
38
"MinConfidence": "Required:false, Default:70"
39
},
40
"PsrTellorMesosphere": {
41
"MinConfidence": "Required:false, Default:0"
42
},
43
"SubmitterTellor": {
44
"Enabled": "Required:false, Default:true",
45
"LogLevel": "Required:false, Default:info",
46
"MinSubmitPeriod": {
47
"Duration": "Required:false, Default:15m1s"
48
},
49
"ProfitThreshold": "Required:false, Default:0, Description:Minimum percent of profit when submitting a solution. For example if the tx cost is 0.01 ETH and current reward is 0.02 ETH a ProfitThreshold of 200% or more will wait until the reward is increased or the gas cost is lowered a ProfitThreshold of 199% or less will submit."
50
},
51
"SubmitterTellorMesosphere": {
52
"Enabled": "Required:false, Default:false",
53
"LogLevel": "Required:false, Default:info",
54
"MinSubmitPeriod": {
55
"Duration": "Required:false, Default:15s"
56
},
57
"MinSubmitPriceChange": "Required:false, Default:0.05, Description: Submit only if that price changed at least that much percent."
58
},
59
"Tasker": {
60
"LogLevel": "Required:false, Default:info"
61
},
62
"Transactor": {
63
"GasMax": "Required:false, Default:10",
64
"GasMultiplier": "Required:false, Default:1",
65
"LogLevel": "Required:false, Default:info"
66
},
67
"Web": {
68
"ListenHost": "Required:false, Default:",
69
"ListenPort": "Required:false, Default:9090",
70
"LogLevel": "Required:false, Default:info",
71
"ReadTimeout": {
72
"Duration": "Required:false, Default:0s"
73
}
74
},
75
"envFile": "Required:false, Default:configs/.env"
76
}
Copied!
Here are the config defaults in json format:
1
{
2
"Aggregator": {
3
"LogLevel": "info",
4
"ManualDataFile": "configs/manualData.json"
5
},
6
"Db": {
7
"LogLevel": "info",
8
"Path": "db",
9
"RemoteHost": "",
10
"RemotePort": 0,
11
"RemoteTimeout": "5s"
12
},
13
"DisputeTracker": {
14
"LogLevel": "info"
15
},
16
"GasStation": {
17
"TimeWait": "1m0s"
18
},
19
"IndexTracker": {
20
"IndexFile": "configs/index.json",
21
"Interval": "30s",
22
"LogLevel": "info"
23
},
24
"Mining": {
25
"Heartbeat": 60000000000,
26
"LogLevel": "info"
27
},
28
"ProfitTracker": {
29
"LogLevel": "info"
30
},
31
"PsrTellor": {
32
"MinConfidence": 70
33
},
34
"PsrTellorMesosphere": {
35
"MinConfidence": 0
36
},
37
"SubmitterTellor": {
38
"Enabled": true,
39
"LogLevel": "info",
40
"MinSubmitPeriod": "15m1s",
41
"ProfitThreshold": 0
42
},
43
"SubmitterTellorMesosphere": {
44
"Enabled": false,
45
"LogLevel": "info",
46
"MinSubmitPeriod": "15s",
47
"MinSubmitPriceChange": 0.05
48
},
49
"Tasker": {
50
"LogLevel": "info"
51
},
52
"Transactor": {
53
"GasMax": 10,
54
"GasMultiplier": 1,
55
"LogLevel": "info"
56
},
57
"Web": {
58
"ListenHost": "",
59
"ListenPort": 9090,
60
"LogLevel": "info",
61
"ReadTimeout": "0s"
62
},
63
"envFile": "configs/.env"
64
}
Copied!

Log levels

Note the default level is "INFO", so to turn down the number of logs, enter "WARN" or "ERROR".
DEBUG - logs everything in INFO and additional developer logs
INFO - logs most information about the mining operation
WARN - logs all warnings and errors
ERROR - logs only serious errors
Telliot - Previous
Setup and usage
Next - Telliot
Contributing
Last modified 27d ago
Copy link
Contents
CLI reference
Log levels