DEPOLYMERIZER-BITCOIN(1)

NAME
depolymerizer-bitcoin - implementation of a bitcoin depolymerizer

SYNOPSIS

depolymerizer-bitcoin [-h | --help] [--version] COMMAND [ARGS...]

Subcommands: dbinit, setup, serve, worker, config

DESCRIPTION

depolymerizer-bitcoin is a Taler depolymerizer for the Bitcoin blockhain.

Its options are as follows:

-h | --help
    Print short help on options.

--version
    Print version information.

    The interaction model is as follows:

•   Configure the database with commands dbinit.

•   Setup node access with commands setup. Setting the access means checking node RPC access and validating worker config.

•   After a successful setup, the subcommands worker can be run to both send payments and sync the wallet transactionhistory.

•   Start the HTTP server with command serve. Let this run in a shell, writing logs to stderr.

    The following sections describe each command in detail.

  dbinit

This command defines the database schema for depolymerizer-bitcoin. It is mandatory to run this command before invoking the setup or serve commands.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-r | --reset
    Reset database (DANGEROUS: All existing data is lost)

-h | --help
    Print short help on options.

  setup

This command setup a working node connection. This command check RPC access and validate worker config.

It is mandatory to run this command before invoking the worker command.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-r | --reset
    Reset sync state to the blockhain genesis.

-h | --help
    Print short help on options.

  worker

This subcommand sync the wallet history, submit transaction and bump stuck transactions. Incoming payments with an invalid Taler subject are bounced.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--transient
    Execute once and return.

-h | --help
    Print short help on options.

  serve

This command starts the HTTP server.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--check
    Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1.

-h | --help
    Print short help on options.

  config

This command inspect or change the configuration.

-h | --help
    Print short help on options.

    Subcommands: get, dump, pathsub

  config get

This command lookup config value.

It takes two arguments, the section name and the option name

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-f | --filename
    Interpret value as path with dollar-expansion.

-h | --help
    Print short help on options.

  config dump

This command dump the configuration.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options.

  config pathsub

This command substitute variables in a path.

It takes one argument, a path expression.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options.

SEE ALSO

depolymerizer-bitcoin.conf(5)

BUGS

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.

AUTHOR
GNU Taler contributors

COPYRIGHT
2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+)