manifest.yaml

id: bitcoind
title: "Bitcoin Core"
version: 28.0.0
eos-version: 0.3.4.4
release-notes: |
  * Update Bitcoin to [v28.0](https://github.com/bitcoin/bitcoin/releases/tag/v28.0)
license: MIT
wrapper-repo: https://github.com/Start9Labs/bitcoind-startos
upstream-repo: https://github.com/bitcoin/bitcoin
support-site: https://github.com/bitcoin/bitcoin/issues
marketing-site: https://bitcoincore.org/
build: ["make"]
description:
  short: A Bitcoin Full Node by Bitcoin Core
  long: Bitcoin is an innovative payment network and a new kind of money. Bitcoin uses peer-to-peer technology to operate with no central authority or banks; managing transactions and the issuing of bitcoins is carried out collectively by the network. Bitcoin is open-source; its design is public, nobody owns or controls Bitcoin and everyone can take part. Through many of its unique properties, Bitcoin allows exciting uses that could not be covered by any previous payment system.
assets:
  license: LICENSE
  icon: icon.png
  instructions: instructions.md
main:
  type: docker
  image: main
  entrypoint: "docker_entrypoint.sh"
  args: []
  mounts:
    main: /root/.bitcoin
    compat: /mnt/assets
  sigterm-timeout: 5m
health-checks:
  rpc:
    name: RPC
    success-message: The RPC server is ready for connections
    type: docker
    image: main
    system: false
    entrypoint: check-rpc.sh
    args: []
    mounts: {}
    io-format: yaml
    inject: true
  synced:
    name: Synced
    success-message: Bitcoin Core is synced with the network
    type: docker
    image: main
    system: false
    entrypoint: check-synced.sh
    args: []
    mounts: {}
    io-format: yaml
    inject: true
config:
  get:
    type: script
  set:
    type: script
properties:
  type: script
volumes:
  main:
    type: data
  compat:
    type: assets
alerts:
  intall: Notice! If Bitcoin ever gets stuck in "stopping" status, the solution is to restart your server. System -> Restart.
  uninstall: Uninstalling Bitcoin Core will result in permanent loss of data. Without a backup, any funds stored on your node's default hot wallet will be lost forever. If you are unsure, we recommend making a backup, just to be safe.
  restore: Restoring Bitcoin Core will overwrite its current data. You will lose any transactions recorded in watch-only wallets, and any funds you have received to the hot wallet, since the last backup.
interfaces:
  rpc:
    name: RPC Interface
    description: Listens for JSON-RPC commands
    tor-config:
      port-mapping:
        8332: "8332"
    lan-config:
      443:
        ssl: true
        internal: 8332
    ui: false
    protocols:
      - tcp
      - http
      - json-rpc
  peer:
    name: Peer Interface
    description: Listens for incoming connections from peers on the bitcoin network
    tor-config:
      port-mapping:
        8333: "8333"
    ui: false
    protocols:
      - tcp
      - bitcoin
  zmq:
    name: ZeroMQ Interface
    description: Listens for subscriptions to the ZeroMQ raw block and raw transaction event streams
    tor-config:
      port-mapping:
        28332: "28332"
        28333: "28333"
    ui: false
    protocols:
      - tcp
      - zmq
dependencies: {}
backup:
  create:
    type: docker
    image: compat
    system: true
    entrypoint: compat
    args:
      - duplicity
      - create
      - /mnt/backup
      - /root/.bitcoin
    mounts:
      BACKUP: /mnt/backup
      main: /root/.bitcoin
  restore:
    type: docker
    image: compat
    system: true
    entrypoint: compat
    args:
      - duplicity
      - restore
      - /mnt/backup
      - /root/.bitcoin
    mounts:
      BACKUP: /mnt/backup
      main: /root/.bitcoin
actions:
  reindex:
    name: "Reindex Blockchain"
    description: "Rebuilds the block and chainstate databases starting from genesis. If blocks already exist on disk, these are used rather than being redownloaded. For pruned nodes, this means downloading the entire blockchain over again."
    warning: Blocks not stored on disk will be redownloaded in order to rebuild the database. If your node is pruned, this action is equivalent to syncing the node from scratch, so this process could take weeks on low-end hardware.
    allowed-statuses:
      - running
      - stopped
    implementation:
      type: docker
      image: main
      system: false
      entrypoint: reindex.sh
      args: []
      mounts:
        main: /root/.bitcoin
      io-format: json
  reindex-chainstate:
    name: "Reindex Chainstate"
    description: "Rebuilds the chainstate database using existing block index data; as the block index is not rebuilt, 'reindex_chainstate' should be strictly faster than 'reindex'. This action should only be used in the case of chainstate corruption; if the blocks stored on disk are corrupted, the 'reindex' action will need to be run instead."
    warning: While faster than 'Reindex', 'Reindex Chainstate' can still take several days or more to complete. Pruned nodes do not allow 'reindex-chainstate'; if you are running a pruned node and suspect chainstate corruption the 'reindex' action (requiring redownloading the entire Blockchain) should be run instead.
    allowed-statuses:
      - running
      - stopped
    implementation:
      type: docker
      image: main
      system: false
      entrypoint: reindex_chainstate.sh
      args: []
      mounts:
        main: /root/.bitcoin
      io-format: json
  delete-txindex:
    name: "Delete Transaction Index"
    description: "Deletes the Transaction Index (txindex) in case it gets corrupted."
    warning: The Transaction Index will be rebuilt once Bitcoin Core is started again, unless you deactivate it in the config settings. Please don't do this unless instructed to by Start9 support staff.
    allowed-statuses:
      - stopped
    implementation:
      type: script
  delete-coinstatsindex:
    name: "Delete Coinstats Index"
    description: "Deletes the Coinstats Index (coinstatsindex) in case it gets corrupted."
    warning: The Coinstats Index will be rebuilt once Bitcoin Core is started again, unless you deactivate it in the config settings. Please don't do this unless instructed to by Start9 support staff.
    allowed-statuses:
      - stopped
    implementation:
      type: script
  delete-peers:
    name: "Delete Peer List"
    description: "Deletes the Peer List (peers.dat) in case it gets corrupted."
    allowed-statuses:
      - stopped
    implementation:
      type: script
migrations:
  from:
    "*":
      type: script
      args: ["from"]
  to:
    "*":
      type: script
      args: ["to"]