Commit Graph

253 Commits

Author SHA1 Message Date
Dave Collins
fcae044a5f
docs: Add release notes for v1.8.1. 2023-10-08 23:01:00 -05:00
Jonathan Chappelow
b103569209 docs: Update JSON-RPC API for powhash. 2023-07-19 15:09:16 -05:00
Dave Collins
cc33b719bc
docs: Update for blockchain v5 module.
This updates the module hierarchy graphviz and module hierarchy diagram
to accurately reflect the latest blockchain module dependencies.

In particular, blockchain/v5 no longer relies on the gcs, stake, or
database modules.

It also rearranges the definitions a bit in the graphviz to produce a
more balanced diagram.
2023-06-26 17:33:01 -05:00
Dave Collins
0ec847f45a
docs: Add release notes templates.
This adds starting templates for major and patch releases.  Providing
these serves both as a convenience for developers and as a way to help
make the release notes more consistent across releases.
2023-06-15 23:27:51 -05:00
Dave Collins
38f38bbe02
docs: Add release notes for v1.8.0. 2023-06-15 15:01:00 -05:00
Dave Collins
50d77f5a80
docs: Update for rpcclient v8 module.
This updates the following to reflect the new module version:

- The rpcclient/README.md file
- The docs/README.md file
- The JSON-RPC API documentation
- The module hierarchy graphviz
- The module hierarchy diagram
2023-06-08 14:49:54 -05:00
Dave Collins
97936ab7e2
docs: Update for blockchain v5 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2023-06-08 14:28:23 -05:00
Dave Collins
1d76035f21
docs: Update for gcs v4 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2023-06-08 14:16:02 -05:00
Dave Collins
ee559cd03a
docs: Update for blockchain/stake v5 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2023-06-08 13:36:36 -05:00
Dave Collins
8f3e249555
docs: Update simnet env docs for subsidy split r2.
This updates the simnet environment documentation to account for the
different expected initial balances due to the subsidy split round 2
agenda since it is always active on simnet.
2023-04-30 16:35:32 -05:00
Dave Collins
d8143d9a22
docs: Update for rpc/jsonrpc/types/v4 module.
This updates the following to reflect the new module version:

- The rpc/jsonrpc/types/README.md file
- The docs/README.md file
- The module hierarchy graphviz
- The module hierarchy diagram
2023-04-14 11:56:20 -05:00
Dave Collins
ca02bcaf5a
docs: Add release notes for v1.7.7. 2023-04-07 00:49:36 -05:00
Dave Collins
2fe34aa1d1
docs: Don't use deprecated ioutil package.
This updates the example code in the JSON-RPC API documentation to
replace usage of ioutil.ReadFile with os.ReadFile since "io/ioutil" is
deprecated as of Go 1.16.
2023-01-20 00:27:23 -06:00
Dave Collins
b243cb5a76
docs: Remove redeemingtx ntfn JSON-RPC API.
This removes the redeemingtx notification from the JSON-RPC API
documentation since it no longer exists.
2022-12-05 13:32:52 -06:00
Dave Collins
8de15489d9
docs: Remove {stop,}notifyspent JSON-RPC API.
This removes the notifyspent and stopnotifyspent methods from the
JSON-RPC API documentation since they no longer exist.
2022-12-05 13:32:51 -06:00
Dave Collins
0b88b4c0be
docs: Remove recvtx ntfn JSON-RPC API.
This removes the recvtx notification from the JSON-RPC API
documentation since it no longer exists.
2022-12-05 13:32:51 -06:00
Dave Collins
832713e8e8
docs: Remove {stop,}notifyreceived JSON-RPC API.
This removes the notifyreceived and stopnotifyrecieved methods from the
JSON-RPC API documentation since they no longer exist.
2022-12-05 13:32:48 -06:00
Dave Collins
21f13654f7
docs: Make JSON-RPC rescan docs match reality.
The semantics for discovering transactions that involve specific
addresses and outpoints that a client is interested in changed some time
ago to be based on loading transaction filters.

It appears that the JSON-RPC API documentation was not updated to match
the new reality at that time, so this updates the documentation
accordingly.

In particular, it updates the JSON-RPC API documentation for the
loadtxfilter, notifynewtransactions, and rescan methods as well as the
blockconnected and blockdisconnected notifications to match the correct
parameters and semantics.

Next, since rescan now blocks until it finishes and therefore no
longer is involved with or sends notifications, this removes references
to rescan from all notifications and removes the longer available
rescanprogress and rescanfinished notifications.

Finally, it adds documentation for the releveanttxaccepted notification
sent in response to a transaction that matches the loaded transaction
filter being added to the mempool.
2022-12-05 11:22:49 -06:00
Dave Collins
34be23dfea
docs: Add release notes for v1.7.5. 2022-10-11 10:53:44 -05:00
Dave Collins
58aad4bb7b
docs: Deprecate JSON-RPC API getrawmempool prio.
This deprecates the startingpriority and currentpriority fields of the
getrawmempool verbose response in the JSON-RPC API documentation.
2022-09-28 12:49:29 -05:00
Dave Collins
6f94b325ad
docs: Add release notes for v1.7.4. 2022-08-03 12:43:32 -05:00
Dave Collins
e0a8f01cb0
docs: Remove getinfo addrindex field JSON-RPC API.
This removes the deprecated getinfo method addrindex field from the
JSON-RPC API documentation.

This is part of the overall removal of the deprecated address index.
2022-05-19 17:08:06 -05:00
Dave Collins
100701c9e9
docs: Remove searchrawtransactions JSON-RPC API.
This removes the deprecated searchrawtransactions method from the
JSON-RPC API documentation.

This is part of the overall removal of the deprecated address index.
2022-05-19 17:07:59 -05:00
Dave Collins
d1417864ab
docs: Add release notes for v1.7.2. 2022-05-11 17:59:00 -05:00
Dave Collins
bf162712d9
multi: Ensure newline at end of file. 2022-05-09 19:38:24 -05:00
Dave Collins
f13d03cf3a
docs: Remove (notify)spentandmissed JSON-RPC API.
This removes the deprecated notifyspentandmissedtickets method and
associated spentandmissedtickets notification from the JSON-RPC API
documentation.
2022-04-30 00:16:24 -05:00
Dave Collins
5f8936c7fb
docs: Remove existsexpiredtickets JSON-RPC API.
This removes the deprecated existsexpiredtickets method from the
JSON-RPC API documentation.

This is part of the overall removal of deprecated RPCs related to missed
and expired tickets.
2022-04-30 00:16:22 -05:00
Dave Collins
77cbb2cdca
docs: Remove existsmissedtickets JSON-RPC API.
This removes the deprecated existsmissedtickets method from the JSON-RPC
API documentation.

This is part of the overall removal of deprecated RPCs related to missed
and expired tickets.
2022-04-30 00:16:20 -05:00
Dave Collins
1f7c6b2a6d
docs: Remove rebroadcastmissed JSON-RPC API.
This removes the deprecated rebroadcastmissed method from the JSON-RPC
API documentation.

This is part of the overall removal of deprecated RPCs related to missed
and expired tickets.
2022-04-30 00:16:18 -05:00
Dave Collins
201f266028
docs: Remove missedtickets JSON-RPC API.
This removes the deprecated missedtickets method from the JSON-RPC API
documentation.

This is part of the overall removal of deprecated RPCs related to missed
and expired tickets.
2022-04-30 00:16:16 -05:00
Donald Adu-Poku
37dea95657 docs: add backport documentation.
This adds a documentation section detailing what is
expected for backported pull requests.
2022-04-29 13:30:35 -05:00
Dave Collins
81255ee698
docs: Add release notes for v1.7.1. 2022-02-18 12:48:20 -06:00
Dave Collins
819805fc56
docs: Add release notes for v1.7.0. 2022-01-20 13:31:00 -06:00
Dave Collins
57c711cf3c
docs: Update for rpcclient v7 module.
This updates the following to reflect the new module version:

* The rpcclient/README.md file
* The docs/README.md file
* The JSON-RPC API documentation
* The module hierarchy graphviz
* The module hierarchy diagram
2021-12-17 13:58:30 -06:00
Dave Collins
b1d6e55f17
docs: Update for blockchain v4 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-12-17 13:27:07 -06:00
Dave Collins
259b51be4b
docs: Update simnet env docs for subsidy split.
This updates the simnet environment documentation to account for the
different expected initial balances due to the subsidy split agenda
since it is always active on simnet.
2021-12-16 12:26:21 -06:00
Dave Collins
4aadab7260
docs: Update for math/uint256 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module.
2021-12-09 17:25:55 -06:00
Ryan Staudt
fa3518bb2c docs: Add max line length and wrapping guidelines.
This adds maximum line length and wrapping guidelines to the code
contribution guidelines documentation.
2021-12-08 18:25:38 -06:00
Ryan Staudt
4d25573b77 docs: Fix typos and trailing whitespace.
This fixes a few typos and removes trailing whitespace.
2021-12-08 18:25:38 -06:00
Dave Collins
c8f4596540
docs: Update for gcs v3 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-22 10:34:59 -06:00
Dave Collins
9efbe8c694
docs: Update for blockchain/stake v4 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-21 16:09:21 -06:00
Dave Collins
5f7eb93f64
docs: Update for database v3 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-19 23:32:34 -06:00
Dave Collins
78d3590592
docs: Update for peer v3 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-19 23:26:26 -06:00
Dave Collins
025d083dd3
docs: Update for dcrutil v4 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-19 11:54:58 -06:00
Dave Collins
be6551473e
docs: Update for txscript v3 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.

Since dcrutil is no longer is required dependency for txscript, the
graphviz is also updated to account for the relevant transitive
relationships among the modules.
2021-11-18 23:14:01 -06:00
Dave Collins
664f18b86f
docs: Update for rpc/jsonrpc/types v3 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-11 14:53:25 -06:00
Dave Collins
fbc87ac8cb
docs: Update for addrmgr v2 module.
This updates the docs/README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-11-11 13:31:52 -06:00
Dave Collins
9428512e77
docs: Update for new modules.
This updates the main README.md file, module hierarchy graphviz, and
module hierarchy diagram to reflect new modules introduced.
2021-09-16 11:12:51 -05:00
Dave Collins
1eac4b6260
docs: Update for dcrjson v4 module.
This updates the various README.md files, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version.
2021-09-14 14:30:31 -05:00
Dave Collins
c715b8e308
docs: Update for secp256k1 v4 module.
This updates the various README.md files, module hierarchy graphviz, and
module hierarchy diagram to reflect the new module version and the
removal of the chaincfg/chainhash dependency.
2021-09-14 14:23:23 -05:00