Skip to content

docs: update masternode setup and maintenance for ext addr #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thephez merged 7 commits into from
Nov 12, 2025
Merged

docs: update masternode setup and maintenance for ext addr #533

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7603128
docs: update masternode setup and maintenance for ext addr
thephez Nov 11, 2025
cc2f2a1
docs: admonition update
thephez Nov 12, 2025
50d0c2c
docs(p2p): update isdlock
thephez Nov 12, 2025
26ba35f
docs: fix typo
thephez Nov 12, 2025
b5e1570
docs: typo fix
thephez Nov 12, 2025
32b2d34
docs: update proto version table
thephez Nov 12, 2025
3036395
docs: update cli info and script
thephez Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 38 additions & 21 deletions docs/user/masternodes/maintenance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,18 @@ Regular masternodes
A masternode ProUpServTx can be created from DMT by clicking the **Update service**
button, or from Dash Core using the following syntax::

protx update_service proTxHash ipAndPort operatorKey (operatorPayoutAddress feeSourceAddress)
protx update_service proTxHash coreP2PAddrs operatorKey (operatorPayoutAddress feeSourceAddress)

Where:

.. note::

As of Dash Core v23.0, the ``coreP2PAddrs`` field accepts backwards-compatible input.


- ``proTxHash``: The transaction id of the initial ProRegTx
- ``ipAndPort``: IP and port in the form "ip:port"
- ``coreP2PAddrs``: Array of masternode address(es), in the format
``x.x.x.x:yyyy``
- ``operatorKey``: The operator BLS private key associated with the
registered operator public key
- ``operatorPayoutAddress`` (optional): The address used for operator
Expand All @@ -133,8 +139,11 @@ Where:

Example::

protx update_service d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a 140.82.59.51:10002 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu
protx update_service d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a '["140.82.59.51:10002"]' 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu

::

# Transaction ID returned
fad61c5f21cf3c0832f782c1444d3d2e2a8dbff39c5925c38033730e64ecc598

The masternode is now removed from the PoSe-banned list, and the IP:port
Expand All @@ -148,17 +157,23 @@ Evonodes
An evonode ProUpServTx can be created from DMT by clicking the **Update service**
button, or from Dash Core using the following syntax::

protx update_service_evo proTxHash ipAndPort operatorKey platformNodeId platformP2PPort platformHTTPPort (operatorPayoutAddress feeSourceAddress)
protx update_service_evo proTxHash coreP2PAddrs operatorKey platformNodeId platformP2PAddrs platformHTTPSAddrs (operatorPayoutAddress feeSourceAddress)

Where:

.. note::

As of Dash Core v23.0, ``coreP2PAddrs``, ``platformP2PAddrs``, and ``platformHTTPSAddrs``
fields accept backwards-compatible input.

- ``proTxHash``: The transaction id of the initial ProRegTx
- ``ipAndPort``: IP and port in the form "ip:port"
- ``coreP2PAddrs``: Array of masternode address(es), in the format
``x.x.x.x:yyyy``
- ``operatorKey``: The operator BLS private key associated with the
registered operator public key
- ``platformNodeId``: The Platform node ID derived from Platform P2P public key.
- ``platformP2PPort``: TCP port for Platform peer-to-peer communication between nodes (26656 for mainnet).
- ``platformHTTPPort``: TCP port of Platform HTTP API interface (443 for mainnet).
- ``platformP2PAddrs``: Array of addresses in the form "ADDR:PORT" used by Platform for peer-to-peer connection (must include 26656 for mainnet). Must be unique on the network..
- ``platformHTTPSAddrs``: Array of addresses in the form "ADDR:PORT" used by Platform for their HTTPS API (must include 443 for mainnet). Must be unique on the network.
- ``operatorPayoutAddress`` (optional): The address used for operator
reward payments. Only allowed when the ProRegTx had a non-zero
``operatorReward`` value. Enter ``""`` to use the
Expand All @@ -169,8 +184,11 @@ Where:

Example::

protx update_service_evo d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a 140.82.59.51:10002 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 972a33056d57359de8acfa4fb8b29dc1c14f76b8 26656 443 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu
protx update_service_evo d6ec9a03e1251ac8c34178f47b6d763dc4ea6d96fd6eddb3c7aae2359e0f474a '["140.82.59.51:10002"]' 4308daa8de099d3d5f81694f6b618381e04311b9e0345b4f8b025392c33b0696 972a33056d57359de8acfa4fb8b29dc1c14f76b8 26656 443 yf6Cj6VcCfDxU5yweAT3NKKvm278rVbkhu

::

# Transaction ID returned
fad61c5f21cf3c0832f782c1444d3d2e2a8dbff39c5925c38033730e64ecc598

The evonode is now removed from the PoSe-banned list. The IP:port,
Expand All @@ -191,21 +209,21 @@ payout addr.** buttons, or from Dash Core using the following syntax::
protx update_registrar proTxHash operatorKeyAddr votingKeyAddr payoutAddress (feeSourceAddress)

.. warning::
After v19 hard fork activation, ``protx update_registrar_legacy`` must
be used if a legacy scheme BLS key is being used to registrar update a
masternode.

Previously, ``protx update_registrar_legacy`` could be used to register a masternode with
a legacy scheme BLS key. The legacy commands were deprecated as of Dash Core v23.0, so it
is now recommended to generate a new basic scheme BLS key instead. This can be done by
following the :ref:`Generate a BLS key pair <bls-generation>` instructions.

Where:

- ``proTxHash``: The transaction id of the initial ProRegTx
- ``operatorKeyAddr``: An updated BLS public key, or ``""`` to use the
last on-chain operator key
- ``votingKeyAddr``: An updated voting key address, or ``""`` to use the
last on-chain voting key
- ``payoutAddress``: An updated Dash address for owner payments, or
``""`` to use the last on-chain operator key
- ``feeSourceAddress`` (optional): An address used to fund ProTx fee.
``PayoutAddress`` will be used if not specified.
- ``operatorKeyAddr``: An updated BLS public key, or ``""`` to use the last on-chain operator key
- ``votingKeyAddr``: An updated voting key address, or ``""`` to use the last on-chain voting key
- ``payoutAddress``: An updated Dash address for owner payments, or ``""`` to use the last on-chain
operator key
- ``feeSourceAddress`` (optional): An address used to fund ProTx fee. ``PayoutAddress`` will be used
if not specified.

Example to update payout address::

Expand Down Expand Up @@ -233,8 +251,7 @@ Where:
- ``operatorKey``: The operator BLS private key associated with the
registered operator public key
- ``reason``: Integer value indicating the revocation `reason <https://github.com/dashpay/dips/blob/master/dip-0003.md#appendix-a-reasons-for-self-revocation-of-operators>`__
- ``feeSourceAddress`` (optional): An address used to fund ProTx fee.
``operatorPayoutAddress`` will be used if not specified.
- ``feeSourceAddress`` (optional): An address used to fund ProTx fee. If not specified, ``operatorPayoutAddress`` will be used.

Example::

Expand Down
38 changes: 15 additions & 23 deletions docs/user/masternodes/setup-testnet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,33 +492,25 @@ syntax::
operatorPubKey votingKeyAddr operatorReward payoutAddress (feeSourceAddress)

.. warning::
After v19 hard fork activation, ``protx register_prepare_legacy`` must
be used if a legacy scheme BLS key is being used to register a masternode.
It's recommended to instead generate a new basic scheme BLS key where
possible. This can be done by following the
:ref:`Generate a BLS key pair <testnet-bls-generation>` instructions.
Previously, ``protx register_prepare_legacy`` could be used to register a masternode with a legacy
scheme BLS key. The legacy commands were deprecated as of Dash Core v23.0, so it is now recommended
to generate a new basic scheme BLS key instead. This can be done by following the :ref:`Generate a
BLS key pair <bls-generation>` instructions.

Open a text editor such as notepad to prepare this command. Replace each
argument to the command as follows:

- ``collateralHash``: The txid of the 1000 Dash collateral funding
transaction
- ``collateralIndex``: The output index of the 1000 Dash funding
transaction
- ``coreP2PAddrs``: Array of masternode address(es), in the format
``x.x.x.x:yyyy``
- ``ownerKeyAddr``: The new Dash address generated above for the
owner/voting address
- ``operatorPubKey``: The BLS public key generated above (or provided
by your hosting service)
- ``votingKeyAddr``: The new Dash address generated above, or the
address of a delegate, used for proposal voting
- ``operatorReward``: The percentage of the block reward allocated to
the operator as payment
- ``payoutAddress``: A new or existing Dash address to receive the
owner's masternode rewards
- ``feeSourceAddress``: An (optional) address used to fund ProTx fee.
``payoutAddress`` will be used if not specified.
- ``collateralHash``: The txid of the 1000 Dash collateral funding transaction
- ``collateralIndex``: The output index of the 1000 Dash funding transaction
- ``coreP2PAddrs``: Array of masternode address(es), in the format ``x.x.x.x:yyyy``
- ``ownerKeyAddr``: The new Dash address generated above for the owner/voting address
- ``operatorPubKey``: The BLS public key generated above (or provided by your hosting service)
- ``votingKeyAddr``: The new Dash address generated above, or the address of a delegate, used for
proposal voting
- ``operatorReward``: The percentage of the block reward allocated to the operator as payment
- ``payoutAddress``: A new or existing Dash address to receive the owner's masternode rewards
- ``feeSourceAddress``: An (optional) address used to fund ProTx fee. ``payoutAddress`` will be used
if not specified.

Note that the operator is responsible for :ref:`specifying their own
reward <dip3-update-service>` address in a separate ``update_service``
Expand Down
42 changes: 19 additions & 23 deletions docs/user/masternodes/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,33 +560,29 @@ syntax::
operatorPubKey votingKeyAddr operatorReward payoutAddress (feeSourceAddress)

.. warning::
After v19 hard fork activation, ``protx register_prepare_legacy`` must
be used if a legacy scheme BLS key is being used to register a masternode.
It's recommended to instead generate a new basic scheme BLS key where
possible. This can be done by following the
:ref:`Generate a BLS key pair <bls-generation>` instructions.
Previously, ``protx register_prepare_legacy`` could be used to register a masternode with a legacy
scheme BLS key. The legacy commands were deprecated as of Dash Core v23.0, so it is now recommended
to generate a new basic scheme BLS key instead. This can be done by following the :ref:`Generate a
BLS key pair <bls-generation>` instructions.

Open a text editor such as notepad to prepare this command. Replace each
argument to the command as follows:

- ``collateralHash``: The txid of the 1000 Dash collateral funding
transaction
- ``collateralIndex``: The output index of the 1000 Dash funding
transaction
- ``coreP2PAddrs``: Array of masternode address(es), in the format
``x.x.x.x:yyyy``
- ``ownerKeyAddr``: The new Dash address generated above for the
owner/voting address
- ``operatorPubKey``: The BLS public key generated above (or provided
by your hosting service)
- ``votingKeyAddr``: The new Dash address generated above, or the
address of a delegate, used for proposal voting
- ``operatorReward``: The percentage of the block reward allocated to
the operator as payment
- ``payoutAddress``: A new or existing Dash address to receive the
owner's masternode rewards
- ``feeSourceAddress``: An (optional) address used to fund ProTx fee.
``payoutAddress`` will be used if not specified.
.. note::

As of Dash Core v23.0, the ``coreP2PAddrs`` field accepts backwards-compatible input.

- ``collateralHash``: The txid of the 1000 Dash collateral funding transaction
- ``collateralIndex``: The output index of the 1000 Dash funding transaction
- ``coreP2PAddrs``: Array of masternode address(es), in the format ``x.x.x.x:yyyy``
- ``ownerKeyAddr``: The new Dash address generated above for the owner/voting address
- ``operatorPubKey``: The BLS public key generated above (or provided by your hosting service)
- ``votingKeyAddr``: The new Dash address generated above, or the address of a delegate, used for
proposal voting
- ``operatorReward``: The percentage of the block reward allocated to the operator as payment
- ``payoutAddress``: A new or existing Dash address to receive the owner's masternode rewards
- ``feeSourceAddress``: An (optional) address used to fund ProTx fee. ``payoutAddress`` will be used
if not specified.

Note that the operator is responsible for :ref:`specifying their own
reward <dip3-update-service>` address in a separate ``update_service``
Expand Down