mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 01:36:13 +00:00
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
This commit is contained in:
parent
17c265f5fd
commit
703c54ffbc
183 changed files with 9570 additions and 1373 deletions
15
scripts/build_preview.sh
Executable file
15
scripts/build_preview.sh
Executable file
|
@ -0,0 +1,15 @@
|
|||
#!/bin/bash
|
||||
# Note: run init_env.sh first to prepare Ruby
|
||||
|
||||
# See docs/setting-up-your-environment.md for more info
|
||||
export BITCOINORG_BUILD_TYPE=preview
|
||||
|
||||
# Update summaries.md
|
||||
make manual-update-summaries-file
|
||||
|
||||
# Build preview with minimal plugins
|
||||
ENABLED_PLUGINS="glossary" ENABLED_LANGS="" make preview
|
||||
|
||||
## Fast build and tests, takes less than 50 seconds
|
||||
## Some tests may fail in fast mode; use -i to continue despite them
|
||||
#ENABLED_PLUGINS="" ENABLED_LANGS="" make -i valid
|
11
scripts/build_publish_preview.sh
Normal file
11
scripts/build_publish_preview.sh
Normal file
|
@ -0,0 +1,11 @@
|
|||
#!/bin/bash
|
||||
# Build static preview site that can be hosted on Github pages (https://pages.github.com/)
|
||||
# Note: run init_env.sh first to prepare Ruby
|
||||
|
||||
export BITCOINORG_BUILD_TYPE=preview
|
||||
|
||||
# Update summaries.md
|
||||
make manual-update-summaries-file
|
||||
|
||||
# Build preview with all plugins, but minimal language support
|
||||
ENABLED_LANGS="" make preview
|
81
scripts/create_empty_rpc_md.sh
Normal file
81
scripts/create_empty_rpc_md.sh
Normal file
|
@ -0,0 +1,81 @@
|
|||
#!/bin/bash
|
||||
#echo "$# parameters"
|
||||
#echo "$@";
|
||||
|
||||
PARAMCOUNT=$#
|
||||
#echo "$PARAMCOUNT parameters"
|
||||
|
||||
if [ "$PARAMCOUNT" == 1 ]; then
|
||||
FILENAME=${1,,}.md
|
||||
RPCNAME=$1
|
||||
|
||||
echo "{% comment %}" >> $FILENAME
|
||||
echo "This file is licensed under the MIT License (MIT) available on" >> $FILENAME
|
||||
echo "http://opensource.org/licenses/MIT." >> $FILENAME
|
||||
echo "{% endcomment %}" >> $FILENAME
|
||||
echo '{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/'$FILENAME'" %}' >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
echo "##### $RPCNAME" >> $FILENAME
|
||||
echo "{% include helpers/subhead-links.md %}" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
echo "{% assign summary_${RPCNAME,}=\"\""" %}" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
echo "{% autocrossref %}" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
echo "The \`${RPCNAME,,}\` RPC {{summary_${RPCNAME,}}}" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
# Parameters
|
||||
echo "*Parameter #1---PARAMETER DESCRIPTION*" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
# Results
|
||||
echo "*Result---RESULT DESCRIPTION*" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
echo "*Example from Dash Core 0.12.2*" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
# Example
|
||||
echo "{% highlight bash %}" >> $FILENAME
|
||||
echo "dash-cli -testnet ${RPCNAME,,}" >> $FILENAME
|
||||
echo "{% endhighlight %}" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
# Example results
|
||||
echo "Result:" >> $FILENAME
|
||||
echo "{% highlight json %}" >> $FILENAME
|
||||
echo " *INSERT RESULTS HERE*" >> $FILENAME
|
||||
echo "{% endhighlight %}" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
echo "*See also:*" >> $FILENAME
|
||||
echo "" >> $FILENAME
|
||||
|
||||
echo "{% endautocrossref %}" >> $FILENAME
|
||||
|
||||
cat $FILENAME
|
||||
|
||||
echo " "
|
||||
echo "Next copy the created file ('$FILENAME') to ../_includes/devdoc/dash-core/rpcs/rpcs"
|
||||
else
|
||||
echo "Incorrect number of parameters (Should be exactly 1)"
|
||||
echo "Usage: create_empty_rpc_md RPCNAME"
|
||||
echo "Example: create_empty_rpc_md GetBlock"
|
||||
fi
|
||||
|
||||
#This file is licensed under the MIT License (MIT) available on
|
||||
#http://opensource.org/licenses/MIT.
|
||||
#{% endcomment %}
|
||||
#{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/getaddressutxos.md" %}#
|
||||
#
|
||||
###### GetAddressUtxos
|
||||
#{% include helpers/subhead-links.md %}
|
||||
#
|
||||
#{% autocrossref %}
|
||||
#
|
||||
#{% assign summary_getAddressUtxos="" %}
|
||||
#
|
||||
#
|
||||
#{% endautocrossref %}
|
Loading…
Add table
Add a link
Reference in a new issue