Navigation Menu

Skip to content

Commit

Permalink
Fee Provider Docs (#1641)
Browse files Browse the repository at this point in the history
  • Loading branch information
benthecarman committed Jul 8, 2020
1 parent 68bbee3 commit e393854
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/fee-provider/fee-provider.md
@@ -0,0 +1,21 @@
---
id: fee-provider
title: Fee Provider
---

# Fee Provider

Bitcoin-S has a `FeeProvider` that is used to fetch fee rates.
Currently, Bitcoin-s has a couple implemented, one being a `BitcoindRpcClient`, which will use `estimateSmartFee` to calculate a fee rate.
Another uses [bitcoiner.live's api](https://bitcoiner.live/) to get a fee rate.

Any `FeeProvider` can be passed to a `Wallet` which will be used to calculate fees for transactions when one is not specified.

## HttpFeeRateProvider

A `HttpFeeRateProvider` is a `FeeProvider` that uses an outside API to get fee rates.
These can be hooked up to any website's API as long as you can provide a `URI` and a function to convert the response to a `FeeUnit`.

There also exists `CachedHttpFeeRateProvider`, which will cache the response for the `cacheDuration` as to prevent hitting request limits and save on api calls.

Checkout [`BitcoinerLiveFeeRateProvider`'s implementation](https://github.com/bitcoin-s/bitcoin-s/blob/master/fee-provider/src/main/scala/org/bitcoins/feeprovider/BitcoinerLiveFeeRateProvider.scala) for an example.
3 changes: 3 additions & 0 deletions website/sidebars.json
Expand Up @@ -28,6 +28,9 @@
"crypto/crypto-intro",
"crypto/sign"
],
"Fee Provider": [
"fee-provider/fee-provider"
],
"Key Manager": [
"key-manager/key-manager"
],
Expand Down

0 comments on commit e393854

Please sign in to comment.