Skip to content

Commit 180ca4d

Browse files
committed
Update docs to detail bitcoin core source
1 parent 92c1e19 commit 180ca4d

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ This project provides bitcoin fee estimates using a blend of mempool-based and h
44

55
## Fee Estimates
66

7-
This application uses two APIs to get fee estimates for Bitcoin transactions:
7+
This application combines data from multiple APIs to provide fee estimates for Bitcoin transactions:
88

99
- [**Mempool API**](https://github.com/mempool/mempool): This API is used to get mempool-based fee estimates for upcoming blocks. The application fetches the fastestFee, halfHourFee, hourFee, economyFee, and minimumFee from the Mempool API and uses these estimates to calculate the fee for upcoming blocks.
1010

1111
- [**Esplora API**](https://github.com/Blockstream/esplora/blob/master/API.md): This API is used to get history-based fee estimates for further future blocks. The application fetches fee estimates from the Esplora API (which gets its data from bitcoind) and adds them to the fee estimates if they are lower than the lowest fee estimate from the Mempool API.
1212

13+
- [**Bitcoin Core API**](https://bitcoincore.org/en/doc/0.20.0/rpc/util/estimatesmartfee/): This API provides an alternative source for fee estimates for further future blocks. The application fetches fee estimates directly from bitcoind and adds them to the fee estimates. You can choose between economical and conservative estimates.
14+
1315
Fee estimates are multipled by a configurable multiplier (1 by default) to allow a more conservative or aggressive approach, and cached for a configurable amount of time (15 seconds by default).
1416

1517
## API
@@ -18,15 +20,18 @@ This application exposes a single API endpoint at `/v1/fee-estimates`. This endp
1820

1921
```json
2022
{
21-
"current_block_hash": "0000000000000000000044ab897830778c73d33fdeddde1f21e875fae2150378",
23+
"current_block_height": 831800,
24+
"current_block_hash": "000000000000000000028ff0332953ffd90c7146938231f4f2008e5e47f78754",
2225
"fee_by_block_target": {
23-
"1": 81900,
24-
"2": 78750,
25-
"3": 74550,
26-
"6": 68700,
27-
"144": 64951,
28-
"504": 53464,
29-
"1008": 28175
26+
"1": 16000,
27+
"3": 15000,
28+
"6": 14000,
29+
"7": 13012,
30+
"11": 12278,
31+
"25": 11969,
32+
"144": 11030,
33+
"432": 10599,
34+
"504": 10598
3035
}
3136
}
3237
```
@@ -95,11 +100,11 @@ Here are the available configuration options:
95100
| `esplora.baseUrl` | The base URL of the Esplora API instance to connect to. Set to `null` to disable. | `https://blockstream.info` | `ESPLORA_BASE_URL` |
96101
| `esplora.fallbacekBaseUrl` | The base URL of the Esplora API instance to fallback to if the primary instance is unavailable | - | `ESPLORA_FALLBACK_BASE_URL` |
97102

98-
### Bitcoind settings
103+
### Bitcoin Core settings
99104

100105
| Config Key | Description | Default Value | Environment Variable |
101106
| ----------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
102-
| `bitcoind.baseUrl` | The base URL of the bitcoind instance to connect to. Set to `null` to disable. | `http://localhost:8332` | `BITCOIND_BASE_URL` |
107+
| `bitcoind.baseUrl` | The base URL of the bitcoind instance to connect to. | - | `BITCOIND_BASE_URL` |
103108
| `bitcoind.username` | The username to use for authenticating with the bitcoind instance | - | `BITCOIND_USERNAME` |
104109
| `bitcoind.password` | The password to use for authenticating with the bitcoind instance | - | `BITCOIND_PASSWORD` |
105110
| `bitcoind.confTargets` | The block targets to use for history-based fee estimates | `[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 144, 288, 432, 504, 576, 720, 864, 1008]` | `BITCOIND_CONF_TARGETS` |

0 commit comments

Comments
 (0)