Commit graph

50 commits

Author SHA1 Message Date
thephez
ded0b9a8ce
[Content] v12.3 RPC changes (#38)
* content - Mempool related RPC updates
 - Add getmempoolancestors, getmempooldescendants, and getmempoolentry
RPCs
 - Update Ref and Table

* content - Generate RPCs updated
 - Mark get/setgenerate as removed
 - Add generatetoaddress details
 - Update Ref and Table

* content - Debug RPC updated
 - Change delimiter to + instead of comma
 - Update Ref and Table

* content - GetInfo RPCs updated
 - getaddednodeinfo, getmemoryinfo, getnetworkinfo
 - Update Ref and Table

* content - Added PreciousBlock RPC
 - Update Ref and Table

* content - Added and update RPCs
 - Debug, estimatepriority, estimatesmartpriority, listunspent,
signmessagewithprivkey, validateaddress
 - Update Ref and Table

* Update GObject Getcurrentvotes with shortened outpoint output
 - Update example and Vote Info field
 - Ref #24

* content - Update generate RPC
 - Add iterations parameter
 - Ref dashpay/dash#1790 (and bitcoin/bitcoin#7663)

* content - Update rawtransaction and generate RPCs
 - CreateRawTransaction, GetRawTransaction, and FundRawTransaction minor
updates
 - Some minor generate RPC updates for removed commands

* content - Update RPCs
 - Update GetBlockChainInfo and GetBlockTemplate
 - Add ImportMulti
 - Some minor generate RPC updates for removed commands

* content - Update Dash RPCs
 - Update GetGovernanceInfo and MasternodeList

* content - Update Pruning related RPCs
 - Update PruneBlockchain, ImportPrunedFunds, and RemovePrunedFunds

* content - RPC table
 - Minor updates

* content - Add SetBIP69Enabled RPC

* build - Update Makefile check to allow numbers in summary name

* content - Add example of RPC with named parameter
2018-02-27 16:01:30 -05:00
thephez
02244aa5f6 Update links to point at correct GH account / repo after rename/move 2018-01-24 14:43:12 -05:00
thephez
fe5a7d3c21 Typo updates 2018-01-11 14:02:38 -05:00
thephez
c94eab5390 Update discuss sub-heading link to point to Dash Forum 2017-12-07 16:41:00 -05:00
thephez
61e478a335 Updates based on bitcoin-dot-org changes
- Blockchain guide typo (bitcoin-dot-org/#1920)
 - GetTxOut correction (bitcoin-dot-org/#1891)
 - Tx Guide (bitcoin-dot-org/#1819)
 - Vars.md (bitcoin-dot-org/#1825)
 - signrawtransaction typo
2017-12-07 12:31:34 -05:00
thephez
dc542202f4 Typo fixes and corrections from bitcoin-dot-org 2017-12-07 10:52:27 -05:00
thephez
f9cb656a33 Summary update from previous commit 2017-12-07 09:09:11 -05:00
thephez
6fd6f8b8ab Dash RPCs - Add details to the keepass RPC 2017-12-07 09:09:11 -05:00
thephez
b3fc565eba Dash RPCs - Add details to the voteraw RPC 2017-12-07 09:09:11 -05:00
thephez
fb98f6f2f2 Dash RPCs - Add details to all masternode RPC sub-commands 2017-12-07 09:09:11 -05:00
thephez
04a062f5d8 Dash RPCs
- Finish details for GObject (voting related)
2017-12-07 09:09:11 -05:00
thephez
a71277cdee Wallet RPCs (new)
- Add details for ImportPubKey and ImportElectrumWallet
2017-12-07 09:09:11 -05:00
thephez
db89358b0a Wallet RPC updates
- Convert more existing RPCs to Dash (move->sendtoaddress)

Added var for Add Lock Conf parameter
2017-12-07 09:09:11 -05:00
thephez
022808165c Wallet RPC updates
- Comment out detail of non-implemented wallet RPCs
2017-12-07 09:09:11 -05:00
thephez
8c175dfdff Wallet RPC updates
- Convert more existing RPCs to Dash
(listsinceblock->listunspent)
2017-12-07 09:09:11 -05:00
thephez
8202b61162 Wallet RPC updates
- Convert more existing RPCs to Dash (gettransaction->listaccounts)
2017-12-07 09:09:11 -05:00
thephez
2e46278b3c Minor items missed in previous commit 2017-12-07 09:09:11 -05:00
thephez
e825730910 P2P reference - Add sentinelping RPC
Update template for creating new RPCs
2017-12-07 09:09:11 -05:00
thephez
9b76d62b0c P2P reference
- Update validateaddress RPC
2017-12-07 09:09:11 -05:00
thephez
7b42b6b8ba P2P reference
- Add masternodebroadcast RPC details
 - Comment out payment processing guide section
2017-12-07 09:09:11 -05:00
thephez
a08e48eff9 P2P updates (guide/reference)
- Mining guide (bitcoin->dash)
 - Guide - remove payment section that is not very relevant
 - Minor spork RPC
2017-12-07 09:09:11 -05:00
thephez
96684f8644 RPCs (Utility)
- Update Priority/fee related RPCs
2017-12-07 09:09:11 -05:00
thephez
b85d023be3 RPCs (Raw Tx / Utility)
- Update all raw transaction RPCs
 - Update CreateMultiSig Utility RPC
2017-12-07 09:09:11 -05:00
thephez
703c54ffbc Dev ref conversion (#2)
Developer reference/guide updates to this point

* Update some reference documents
 - Adjust ref_intro to reference Dash
 - Start updating p2p network ref
 - Adjust some items in references.md to point to Dash URLs

* Update P2P networking protocol versions and message headers sections
Update subheading-links
Update more items in references.md

* Update inventories to include Dash specific items
 - Update references.md with them also
Update disclaimer (Bitcoin -> Dash)

* Remove reference to bitcoin mailing list from ref_intro

* Add Spork/GetSporks message details
Add placeholders for Dash specific messages
 - Added subsections for InstantSend, PrivateSend, Masternodes, and
Governance

* Some Bitcoin->Dash conversions
 - Update title / section name for Dev Doc/Dev Reference
 - Updated favicon

* Updates for the Data Network section of P2P reference

* Added Alert message details from Bitcoin back and removed feefilter

* More updates for Control Messages section of P2P network
 - Bitcoin->Dash reference changes
 - Reject and Version message updates

* InstantSend subsection of P2P reference detail
 - Added ix, txlvote message details and associated references

* Governance subsection (P2P)
 - Start adding govobj, govobjvote details
 - Add spork references

* Missed spork xref in previous

* Governance (P2P) updates
 - Add details to govobjvote and govsync

* Governance object P2P messages
 - Add additional description/details

* PrivateSend P2P messages
 - Added details for dsa, dsc, dsf, dsi, dsq, dss, dssu, and dstx
messages
  - Added references also
  - Hexdump examples for all but dsi and dss

* PrivateSend P2P minor updates

* Masternode P2P messages
 - Add descriptions
 - Add hexdump details

* Masternode P2P messages (dseg, mnb, mnget, mnp, mnv, mnw, mnwb, ssc)
 - Add reference/crossref entries
 - Add message structure

* P2P messages - minor formatting and corrections

* Block chain reference
 - Version info updates

* Update Block Chain reference (Headers)
 - Update version details
 - Update block reward info

* Update Transactions reference
 - Add some Dash specific updates

* Minor Transactions reference change

* RPC reference updates

* RPC reference updates
 - Added/removed commands to match available Dash commands

* Core API updates

* Renamed devdocs/bitcoin-core to dash-core
 - Updated developer-reference.md to point at new location

* Update filename to use dash-core instead of bitcoin-core

* Add Dash-specific GetAddressBalance RPC command and associated updates
Update RPC quick reference list

* Added cross reference/reference placeholders for remaining GetAddress... RPC commands
Added RPC template placeholder files for remaining GetAddress...
commands

* Scripts for environment setup and frequently used builds

* Add details for GetAddressDeltas/Mempool RPCs
Update path in Makefile bitcoin-core -> dash-core

* Add GetAddressTxids/Utxos details
Update minor formatting, etc. for GetAddressBalance/Deltas/Mempool
Changed reference to Dash Core and updated denominations for Dash

* Misc minor cleanup

* Work on updating existing Block Chain RPCs
 - GetBestBlockHash, GetBlock, GetBlockChainInfo, GetBlockCount,
GetBlockHash

* Continue updating existing Block Chain RPCs
 - GetBlockHeader, GetChainTips, GetDifficulty, GetMemPoolInfo,
GetRawMemPool

* Update RPCs quick-ref
 - Added descriptions for Dash
 - Updated description for Bitcoin related items for clarity

* Comment out content of non-implemented Block chain RPCs (GetMemPoolAncestors, GetMemPoolDescendants, GetMemPoolEntry, PreciousBlock, PruneBlockChain)

* Continue updating existing Block Chain RPCs
 - GetTxOut, GetTxOutProof, GetTxOutSetInfo, VerifyChain,
VerifyTxOutProof
Update previous block hash type to indicate X11 instead of double SHA256

* Add script to create basic RPC md file
Set up empty GetBlockHashes/Headers and GetSpentInfo RPCs

* Add GetBlockhashes details
Minor correction in Empty RPC generation script

* Add GetBlockHeaders details
Minor formatting updates

* Update Address Index related RPCs to indicate the necessity of enabling addressindex to use them

* Actual details of GetBlockHeaders

* Add details for GetSpentInfo

* Update existing Control RPCs (GetInfo, Help, Stop)

* Add Debug RPC

* Expand empty RPC generation script to add example section and fix format

* Added empty RPC files and cross-ref details for all Dash RPCs

* Add details for some Dash RPCs
- GetGovernanceInfo, GetPoolInfo, GetSuperblockBudget

* Add details for MasternodeList RPC (Dash section)

* Add details for MnSync RPC (Dash section)

* Dash RPC updates
 - Add Result section to MasternodeList
 - Formatting updates to MnSync

* Expand script to add placeholders for parameters/resuls/example

* Add details for PrivateSend RPC (Dash section)

* Update Generating RPCs
 - Added details back for GetGenerate/SetGenerate which were deprecated
in Bitcoin

* Formatting and example updates

* Add result detail and example to GetBlockTemplate

* Update existing Mining RPCs
 - GetMiningInfo, GetNetworkHashPs, PrioritiseTransaction, SubmitBlock

* Minor formatting updates

* Update most existing Network RPCs
 - AddNode, ClearBanned, DisconnectNode, GetAddedNodeInfo,
GetConnectionCount, GetNetTotals,GetNetworkInfo, GetPeerInfo,
ListBanned, Ping, SetBan
 - Added some norefs as needed (Network RPCs only)

* Misc cleanup

* SetNetworkActive (Network RPC)

* Misc updates
 - Change logo
 - Disable some headers (alert, donation)
 - Disable footer

* Governance updates
 - Add description of govsync to P2P guide
 - Updates to P2P reference

* Governance
 - Add governance message SVG image
 - Typo fixes

* Dseg updates
 - Added clarifying details regarding how to request single/all nodes
 - Ban warning

* Minor governance updates

* Governance updates / MN sync
 - Correct some reference links
 - Add MN sync info to guide
 - Update dseg, mnget, ssc, and govsync messages to include more detail

* Governance updates
 - Guide updated to show both stages of govsync
 - Reference
  - Correcte ssc typo and add sync item detail
  - Update govobjvote to include detail about propagation
  - Update govsync details

* Governance updates
 - More clarification on govsync (guide and reference)

* Raw Transaction RPC
 - Previously uncommitted CreateRawTransaction update

* Dash RPC (Gobject)
 - Add details for count and get sub-commands

Also added description for govobj types

* P2P messages
 - Spork updated to include verification details and a hexdump

Minor typo / note updates

* P2P Message - mnv
 - Draft details regarding use and operation

* P2P message (mnv)
 - Additional detail updates based on info from Udjin

Minor update to mnp

* Guide - Masternode payment
 - Add section and start putting in details

* P2P Messages - deprecated
 - Move deprecated messages to their own group

* Misc minor non-content updates
2017-10-25 09:17:55 -04:00
David A. Harding
7a67a7c8cf
Dev Docs: edits to 0.14.0 RPC update 2017-05-08 14:44:33 -04:00
Michael Rotarius
ee3950ed12 Updated summaries.md 2017-05-05 17:01:03 +02:00
Michael Rotarius
3e80757193 Removed 0.10.0 mentions 2017-05-05 16:43:25 +02:00
Will Binns
dec45b8573 Merge pull request #1429 from Mirobit/v0131-ref-update
Devdoc RPC calls up-to-date as of 0.13.1
2017-02-15 20:30:59 -06:00
Michael Rotarius
8a93b97ce9 REST 0.11, 0.12, 0.13 update
references.md, developer-reference.md, _autocrossref.yaml and
_config.yml not yet updated
2017-02-09 11:20:06 +01:00
Michael Rotarius
9c9edae6f6 update transaction calls (blockindex, witness) 2017-01-07 20:11:56 +01:00
Michael Rotarius
3285ca7dc9 Devdoc RPC calls up-to-date as of 0.13.1 2016-12-08 23:40:23 +01:00
Michael Rotarius
c7a99a6084 RPC Developer reference updated based on 0.12.1
I updated all changes to the RPC API from 0.11.0 to 0.12.1.
An update based on 0.13.1 will follow soon.
2016-11-15 17:54:46 +01:00
David A. Harding
64e4c549bc
Dev docs: change "op code" to "opcode"
Closes #1068
2015-10-23 11:20:36 -04:00
ChainQuery
579e4064b1
Create gettxoutproof.md and verifytxoutproof.md
Closes #1012
2015-08-23 10:04:10 -04:00
David A. Harding
b347044eb2
Repository Move: Update Repository URLs
git ls-tree --full-tree -r HEAD \
  | sed 's/^.\{53\}//'          \
  | xargs sed -i 's^https://github.com/bitcoin/bitcoin.org^https://github.com/bitcoin-dot-org/bitcoin.org^g'
2015-06-23 09:08:40 -04:00
David A. Harding
224127f2f0
Merge pulls #824 and #830
* 824: Dev Docs: Update For New 'generate' RPC
* 830: Link "quantum computing" in FAQ to related Bitcoin Magazine article
2015-04-22 17:38:44 -04:00
David A. Harding
a2a5f454cb
Revert "Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box""
This reverts commit 961d6c988f.
2015-04-14 08:55:53 -04:00
David A. Harding
ab7ca1f26f
Dev Docs: RPCs: Add New 'generate' & Note 'getgenerate' Change 2015-04-12 20:30:59 -04:00
David A. Harding
961d6c988f
Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box"
This reverts commit e3dcf0ce1f, reversing
changes made to c71e9fdf2d.

Once again we had a broken new plugin that Travis CI and local building
didn't catch.
2015-04-10 19:33:39 -04:00
David A. Harding
037cd4553a
Add New Glossary Page And Developer Search Feature
This commit adds the code necessary to generate a new
en/developre-glossary page with entry pages in the en/glossary/
directory, e.g. en/glossary/51-percent-attack.

The glossary page and the individual term pages feature a JavaScript
search engine (no CGI) for just glossary terms.  This search box has
also been added to the following pages:

    * Developer Documentation (the index page)
    * Developer Guide
    * Developer Reference
    * Developer Examples

The search box requires the following MIT-licensed libraries:

    * JQuery
    * JQuery UI
    * JQuery UI CSS stylesheet

These allow our JS code to be almost trivially simple in js/devsearch.js

This commit adds only code.  Actual glossary entry data will be added in
a subsequent commit.
2015-03-19 15:31:28 -04:00
David A. Harding
2c44b59d88
Dev Docs: Use Sed To Convert Tables To YAML
Run sed -i -f <this_file.sed> _includes/ref/bitcoin-core/rpcs/rpcs/* _includes/ref/bitcoin-core/rest/requests/get_* _includes/helpers/vars.md

    ## On lines that start with a pipe:
    /^|/ {
        ## Delete all table header/table body divider lines
        /|----/d;

        ## Escape all double quotes
        s/"/\\"/g;

        ## Replace lines that look like NTPD headers with a itemplate start block
        s/^| Name *| Type.*/{% itemplate ntpd1 %}/;

        ## Delete extraneous whitespace
        s/ *|/|/g;

        ## Replace the first pipe with "- name:" plus a start quote
        s/^| */- n: "/;

        ## Replace the remaining pipes, starting each one with a newline and two spaces
        s/| */"\n  t: "/;
        s/| */"\n  p: "/;
        s/| */"\n  d: "/;

        ## Add a close quote and an empty line after the last list item
        ## built from a single table row, except for the header row. This
        ## improves readability/maintainability
        /[^}]$/s/$/"\n/;
    }

    ## Replace the old table class with the itemplate close tag
    s/{:.ntpd}/{% enditemplate %}/
2015-02-20 15:39:10 -05:00
David A. Harding
79fd671e90
Add New Inline-Template Plugin
Also add inline template for RPC and REST tables
2015-02-20 15:38:53 -05:00
David A. Harding
848429f0c9
Dev Docs: Tweak GetHashesPerSec Deprecation
* Ran `make manual-updates` to grab new summary

* Clarified that GHPS is part of 0.10.0 and is removed in master

* Autocrossref'd "Bitcoin Core master" to GitHub repo

* Removed GHPS from list of Mining RPCs now that it's in Removed RPCs
2015-02-02 09:59:20 -05:00
David A. Harding
a1b7d1e532
Dev Docs: Put summary_ variables in alphabetical order
* Simply ran `make manual-updates` using previously-commited sort patch
2015-02-01 18:21:51 -05:00
David A. Harding
73eb097dd4
Dev Docs: REST: Add Security Note & Reindex Note
Added both notes to both JSON-RPC and REST docs.

Suggested by Jonas Schnelli (thanks!)
2015-01-26 14:41:05 -05:00
David A. Harding
5f532c59da
Dev Docs: Add REST Documentation
* Uses same basic format as JSON-RPC documentation.

Closes #715
2015-01-26 11:29:07 -05:00
David A. Harding
9329c69cf8
Dev Docs: Put RPC Tables In Separate CSS Class
Suggested by Saivann: RPC tables with Name/Type/Presence/Description
format are now in .ntpd CSS class so that we can format them specially.

We also change the style of all dev doc tables to replace bold table
headings (thead) with a double-line border-bottom.  This makes the
theads look less like section headings and prevents us from over-using
bold.

Minor: a Makefile warning message has been made more explicit (also
suggested by Saivann) and another Makefile rule was updated to catch
more broken tables.
2014-12-30 16:03:19 -05:00
David A. Harding
b8abfb2dcd
Dev Docs: Add 114 Pages Of New/Rewritten RPC Docs
* All previously-documented RPCs have had their text completely
  rewritten.

* All new RPCs and changed RPCs in Bitcoin Core 0.10.0 have been
  documented, except for hidden RPCs.

* A new RPC "Quick Reference" section has been added to make finding the
  right RPC easier.

* A "See Also" subsection has been added to the end of every RPC
  pointing to other relevant information.

* All previous examples in the RPC section have been re-run and updated
  as necessary.

* Syntax highlighting has been added wherever possible.

* Hash byte order has been specified as RPC byte order everywhere it's
  used in RPCs.
2014-12-24 18:46:03 -05:00
David A. Harding
53d4a6eebe
Dev Docs: Move Manual Sourcefile Lines To Auto Helper (thanks saivann!) 2014-12-14 08:12:12 -05:00
David A. Harding
f368d38e04
Dev Docs: Add "Edit|History|Report Issue|Discuss" Links To Subheads 2014-12-13 17:35:21 -05:00