manifest.yaml

# v0.3.0 and up Manifest example written in yaml (toml and json are also acceptable)

id: electrs
title: "electrs"
version: 0.9.7
release-notes: "Initial release for EmbassyOS"
license: mit
wrapper-repo: "https://github.com/Start9Labs/electrs-wrapper"
upstream-repo: "https://github.com/romanz/electrs"
support-site: "https://github.com/romanz/electrs/issues"
marketing-site: "https://github.com/romanz/electrs"
build: ["make"]
description:
  short: An efficient re-implementation of Electrum Server in Rust 
  long: |
    An efficient re-implementation of Electrum Server, inspired by ElectrumX, Electrum Personal Server and bitcoincore-indexd. The motivation behind this project is to enable a user to self host an Electrum server, with required hardware resources not much beyond those of a full node. The server indexes the entire Bitcoin blockchain, and the resulting index enables fast queries for any given user wallet, allowing the user to keep real-time track of balances and transaction history using the Electrum wallet. Since it runs on the users own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of the users addresses and balances.
assets:
  license: LICENSE
  icon: icon.png
  instructions: instructions.md
  docker-images: image.tar
main:
  type: docker
  image: main
  entrypoint: "docker_entrypoint.sh"
  args: []
  mounts:
    main: /data
health-checks:
  electrum:
    name: Electrum RPC Interface
    success-message: The electrum RPC interface is alive and responding to basic commands.
    type: docker
    image: main
    entrypoint: "check-electrum.sh"
    args: []
    inject: true
    system: false
    io-format: json
  synced:
    name: Synced
    success-message: The indexes are built and the electrum interface is fully operational. You may now connect a wallet.
    type: docker
    image: main
    entrypoint: "check-synced.sh"
    args: []
    inject: true
    system: false
    io-format: json
config:
  get:
    type: docker
    image: compat
    system: true
    entrypoint: compat
    args:
      - config
      - get
      - /root
      - "/mnt/assets/config_spec.yaml"
    mounts:
      compat: /mnt/assets
      main: /root
    io-format: yaml
  set:
    type: docker
    image: compat
    system: true
    entrypoint: compat
    args:
      - config
      - set
      - electrs
      - /root
      - "/mnt/assets/config_rules.yaml"
      - "/mnt/assets/dependencies.yaml"
    mounts:
      compat: /mnt/assets
      main: /root
    io-format: yaml
properties:
  type: docker
  image: compat
  system: true
  entrypoint: compat
  args:
    - properties
    - /root
  mounts:
    main: /root
    compat: /mnt/assets
  io-format: yaml
volumes:
  main:
    type: data
  compat:
    type: assets 
interfaces:
  electrum:
    name: Electrum Interface
    description: Serves an electrum API for use with compatible wallets
    tor-config:
      port-mapping:
        50001: "50001"
    # lan-config:
    #   443:
    #     ssl: true
    #     internal: 50001
    ui: false
    protocols:
      - tcp
      - http
      - electrum
alerts:
  install: "INSTABILITY WARNING: Electrs uses up to 1GB of RAM when syncing. Please make sure you have at least this much free RAM before starting Electrs, or you will cause your system to become unresponsive! This is especially risky if running alongside Mastodon on a 4GB system!"
  start: "INSTABILITY WARNING: Electrs uses up to 1GB of RAM when syncing. Please make sure you have at least this much free RAM before starting Electrs, or you will cause your system to become unresponsive! This is especially risky if running alongside Mastodon on a 4GB system!"
dependencies:
  btc-rpc-proxy:
    version: ">=0.3.2.1 <0.4.0"
    requirement:
      type: "opt-out"
      how: Set "Bitcoin Core" to "Internal (Bitcoin Core)" or "External"
    description: Provides bitcoin rpc interface needed for info about fees, blockchain, mempool, network, and transactions. Can also use bitcoind for rpc interface, or an external node for both.
    config:
      check:
        type: docker
        image: compat
        system: true
        entrypoint: compat
        args:
          - dependency
          - check
          - electrs
          - "btc-rpc-proxy"
          - /data
          - "/mnt/assets/btc-rpc-proxy.rules.yaml"
        mounts:
          compat: /mnt/assets
          main: /data
        io-format: yaml
      auto-configure:
        type: docker
        image: compat
        system: true
        entrypoint: compat
        args:
          - dependency
          - "auto-configure"
          - electrs
          - "btc-rpc-proxy"
          - /data
          - "/mnt/assets/btc-rpc-proxy.rules.yaml"
        mounts:
          compat: /mnt/assets
          main: /data
        io-format: yaml
  bitcoind:
    version: ">=0.21.1.2 <23.0.0"
    requirement:
      type: "opt-out"
      how: Set "Bitcoin Core" type to "External"
    description: Needed for peer interface and rpc interface. Can also use btc-rpc-proxy for rpc interface, or an external node for both.
    config:
      check:
        type: docker
        image: compat
        system: true
        entrypoint: compat
        args:
          - dependency
          - check
          - electrs
          - bitcoind
          - /data
          - "/mnt/assets/bitcoind.rules.yaml"
        mounts:
          compat: /mnt/assets
          main: /data
        io-format: yaml
      auto-configure:
        type: docker
        image: compat
        system: true
        entrypoint: compat
        args:
          - dependency
          - "auto-configure"
          - electrs
          - bitcoind
          - /data
          - "/mnt/assets/bitcoind.rules.yaml"
        mounts:
          compat: /mnt/assets
          main: /data
        io-format: yaml
backup:
  create:
    type: docker
    image: compat
    system: true
    entrypoint: compat
    args:
      - duplicity
      - create
      - /mnt/backup
      - /data
    mounts:
      BACKUP: /mnt/backup
      main: /data
  restore:
    type: docker
    image: compat
    system: true
    entrypoint: compat
    args:
      - duplicity
      - restore
      - /mnt/backup
      - /data
    mounts:
      BACKUP: /mnt/backup
      main: /data
migrations:
  from:
    "<=0.9.7":
        type: docker
        image: main
        entrypoint: sh
        args: ["-c", 'json=''{"configured": true }'' && echo "$json"']
        io-format: json
        inject: true
  to:
    "<=0.9.7":
        type: docker
        image: main
        entrypoint: sh
        args: ["-c", 'json=''{"configured": true }'' && echo "$json"']
        io-format: json
        inject: true