dcrd/internal/fees/README.md
Dave Collins eb4a0a06ac
fees: Move to internal.
This makes the fees package an internal package such that it will no
longer be an exported module.  The only place its functionality is
really needed is for the internal implementation of dcrd itself and thus
having an unnecessary exported module significantly increases the
maintenance burden.

This is part of the overall effort to reduce the total number of modules
and eventually get to the point that it will be possible to follow
semver for the root module.

It is worth noting that there are a few constants, which will be listed
below, that were exported from this module that callers might have
previously relied upon.  However, due to previous discussions about the
goal of removing the module, a code search has revealed that there are
no known callers that rely on them.

The aforementioned constants are:

- DefaultMaxBucketFeeMultiplier
- DefaultMaxConfirmations
- DefaultFeeRateStep

Overview of the major changes:

- Move the following files from fees -> internal/fees:
  - README.md
  - cmd/dumpfeedb/dumpfeedb.go
  - doc.go
  - estimator.go
  - log.go
- Remove fees/go.mod and fees/go.sum
- Make the README.md and doc.go files match the new reality
- Update all import paths in the repository accordingly
- Remove the dependency from the root go.mod
- Run go mod tidy on all modules
2020-07-25 18:10:39 -05:00

926 B

fees

Build Status ISC License Doc

Package fees provides decred-specific methods for tracking and estimating fee rates for new transactions to be mined into the network. Fee rate estimation has two main goals:

  • Ensuring transactions are mined within a target confirmation range (expressed in blocks);
  • Attempting to minimize fees while maintaining be above restriction.

This package was started in order to resolve issue decred/dcrd#1412 and related. See that issue for discussion of the selected approach.

License

Package dcrutil is licensed under the copyfree ISC License.