Skip to content

Latest commit

 

History

History
111 lines (92 loc) · 3.37 KB

update.md

File metadata and controls

111 lines (92 loc) · 3.37 KB

Updating Dashmate

This guide explains how to update Dashmate and your node to the latest version.

Basic Update

The update command is used to quickly get the latest patches for dashmate components. It is necessary to restart the node after the update is complete.

USAGE
  $ dashmate update [-v] [--config <value>]

FLAGS
  -v, --verbose     use verbose mode for output
  --config=<value>  configuration name to use
  --format=<option>  [default: plain] display output format
                   <options: json|plain>

Example update process:

$ dashmate stop
$ npm install -g dashmate
$ dashmate update
╔══════════════════╤══════════════════════════════╤════════════╗
║ Service          │ Image                        │ Updated    ║
╟──────────────────┼──────────────────────────────┼────────────╢
║ Core             │ dashpay/dashd:19.1.0         │ up to date ║
║ Drive ABCI       │ dashpay/drive:0.24           │ updated    ║
║ Drive Tenderdash │ dashpay/tenderdash:0.11.2    │ up to date ║
║ rs-dapi          │ dashpay/rs-dapi:0.24         │ updated    ║
║ Gateway          │ dashpay/envoy:0.24           │ updated    ║
║ Dashmate Helper  │ dashpay/dashmate-helper:0.24 │ updated    ║
╚══════════════════╧══════════════════════════════╧════════════╝
$ dashmate start

You can also use JSON format for programmatic access:

$  dashmate update --format=json --config local_1 | jq
[
  {
    "name": "dashmate_helper",
    "title": "Dashmate Helper",
    "updated": "error",
    "image": "dashpay/dashmate-helper:3.0.0-dev.1"
  },
  {
    "name": "core",
    "title": "Core",
    "updated": "up to date",
    "image": "dashpay/dashd:23"
  },
  {
    "name": "drive_abci",
    "title": "Drive ABCI",
    "updated": "error",
    "image": "drive:local"
  },
  {
    "name": "drive_tenderdash",
    "title": "Drive Tenderdash",
    "updated": "up to date",
    "image": "dashpay/tenderdash:1.5"
  },
  {
    "name": "rs_dapi",
    "title": "rs-dapi (Rust DAPI)",
    "updated": "error",
    "image": "rs-dapi:local"
  },
  {
    "name": "gateway",
    "title": "Gateway",
    "updated": "up to date",
    "image": "dashpay/envoy:1.30.2-impr.1"
  }
]

Major Updates with Platform Reset

In some cases, you must also additionally reset platform data:

  • When the upgrade contains non-compatible changes (e.g. switching between v22/v23)
  • When the dashmate setup command exited with errors or was interrupted
  • When the platform layer was wiped on the network

The reset and update process for major updates:

$ dashmate stop
$ npm install -g dashmate
$ dashmate reset --platform --hard
$ dashmate update
$ dashmate setup
$ dashmate start

Local Network Updates

Before applying an upgrade to a local network, the network should be stopped and reset with dashmate reset --hard.

Notes on Compatibility

When upgrading between major versions, always check the release notes for any breaking changes or special upgrade instructions.