input-output-hk/cardano-rest 2.1.0

Cardano REST 2.1.0

on GitHub

This release provides support for multiple protocol modes including Shelley, defaulted to the Cardano mode. It, also, delivers new command-line interfaces cardano-explorer-api and cardano-submit-api with various options to configure the web-servers, and improvements in the startup printout and resolved issues.

Compatible with Cardano Node 1.18.0 with Cardano DB Sync 3.0.0.

Added

• Added support for multiple protocol modes, defaulting to Cardano

• Added command-line interfaces with various options to configure the web-servers

  $ cardano-explorer-api --help
  cardano-explorer-api - A block explorer for the cardano network
  
  Usage: cardano-explorer-api [--listen-address HOST] [--random-port] [--port INT]
  
  Available options:
    -h,--help                Show this help text
    --listen-address HOST    Specification of which host to the bind API server
                             to. Can be an IPv[46] address, hostname, or
                             '*'. (default: "127.0.0.1")
    --random-port            Serve API on any available port (overrides --port)
    --port INT               Port used for the API server. (default: 8100)
  

  $ cardano-submit-api --help
  Usage: cardano-submit-api --config FILEPATH ([--shelley-mode] | [--byron-mode]
                            [--epoch-slots NATURAL] [--security-param NATURAL] |
                            [--cardano-mode] [--epoch-slots NATURAL]
                            [--security-param NATURAL]) (--mainnet |
                            --testnet-magic NATURAL) --socket-path FILEPATH
                            [--listen-address HOST] [--random-port] [--port INT]
    Cardano transaction submission web API.
  
  Available options:
    --config FILEPATH        Path to the tx-submit web API configuration file
    --shelley-mode           For talking to a node running in Shelley-only mode.
    --byron-mode             For talking to a node running in Byron-only mode.
    --epoch-slots NATURAL    The number of slots per epoch for the Byron
                             era. (default: 21600)
    --security-param NATURAL The security parameter. (default: 2160)
    --cardano-mode           For talking to a node running in full Cardano mode
                             (default).
    --epoch-slots NATURAL    The number of slots per epoch for the Byron
                             era. (default: 21600)
    --security-param NATURAL The security parameter. (default: 2160)
    --mainnet                Use the mainnet magic id.
    --testnet-magic NATURAL  Specify a testnet magic id.
    --socket-path FILEPATH   Path to a cardano-node socket
    --listen-address HOST    Specification of which host to the bind API server
                             to. Can be an IPv[46] address, hostname, or
                             '*'. (default: "127.0.0.1")
    --random-port            Serve API on any available port (overrides --port)
    --port INT               Port used for the API server. (default: 8090)
    -h,--help                Show this help text
  

Changed

• Improved the way the explorer prints its connection details on startup.
• Moved some shareable code into a cardano-rest-common package.

Resolved

• Fixed bugs for cardano-explorer-api-validate
• Fixed defaults for the command line flags
• Fixed a cabal warning caused by flags in the wrong place

Getting Started

https://github.com/input-output-hk/cardano-rest#getting-started

Signatures