Skip to content

Commit f3cc491

Browse files
doc: correct Full preset description
The configuration doc claimed the `full` preset enables every option, but since 13.7.0.1 it leaves `offchain_pool_data` and `offchain_vote_data` disabled by default.
1 parent 63dbf19 commit f3cc491

1 file changed

Lines changed: 33 additions & 3 deletions

File tree

doc/configuration.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ Below is a sample `insert_options` section that shows the recommended defaults:
7575
## Preset
7676

7777
Preset is an aggregate setting that overrides all other properties. For example, setting
78-
preset to `"full"` will enable all insert options except `"tx_cbor"`.
78+
preset to `"full"` will enable all insert options except `"tx_cbor"`, `"offchain_pool_data"`,
79+
and `"offchain_vote_data"` (the last two default to `"disable"` since 13.7.0.1).
7980

8081
`preset`
8182

@@ -85,14 +86,43 @@ preset to `"full"` will enable all insert options except `"tx_cbor"`.
8586

8687
| Value | Explanation |
8788
| :----------- | :----------------------------------------------------------- |
88-
| ["full"](#Full) | Enable all options |
89+
| ["full"](#Full) | Enable all options except `tx_cbor`, `offchain_pool_data`, and `offchain_vote_data` |
8990
| ["only_utxo"](#only-utxo) | Only load `block`, `tx`, `tx_out` and `ma_tx_out`. |
9091
| ["only_governance"](#only-governance) | Disable most data except governance data. |
9192
| ["disable_all"](#disable-all) | Only load `block`, `tx` and data related to the ledger state |
9293

9394
### Full
9495

95-
This is equivalent to enabling all other settings.
96+
This is equivalent to setting:
97+
98+
```
99+
"tx_cbor": "disable",
100+
"tx_out": {
101+
"value": "enable",
102+
"use_address_table": false
103+
},
104+
"ledger": "enable",
105+
"shelley": {
106+
"enable": true
107+
},
108+
"multi_asset": {
109+
"enable": true
110+
},
111+
"metadata": {
112+
"enable": true
113+
},
114+
"plutus": {
115+
"enable": true
116+
},
117+
"governance": "enable",
118+
"offchain_pool_data": "disable",
119+
"offchain_vote_data": "disable",
120+
"pool_stat": "enable",
121+
"json_type": "text"
122+
```
123+
124+
`offchain_pool_data` and `offchain_vote_data` default to `"disable"` since 13.7.0.1 - set
125+
them to `"enable"` explicitly if you need offchain metadata fetching.
96126

97127
### Only UTxO
98128

0 commit comments

Comments
 (0)