Cardano Rest 3.1.2

The release upgrade dependencies to more recent version of the Cardano eco-system. It is compatible with cardano-node-1.25.1 and cardano-db-sync-8.0.0.

Getting Started

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

Changelog

explorer-api

• Upgrade dependencies to more recent versions of the Cardano eco-system (cardano-node 1.25.1, cardano-db-sync 8.0.0)

submit-api

• Upgrade dependencies to more recent versions of the Cardano eco-system (cardano-node 1.25.1, cardano-db-sync 8.0.0)

Signatures

role	approval
Technical Team Lead	✔️
Release Manager	✔️
Ops	⌛

Cardano Rest 3.1.1

This release fixes a bug introduced in cardano-submit-api in the previous release (3.1.0) and therefore deprecates 3.1.0. It is compatible with cardano-node-1.24.2 and cardano-db-sync-7.1.0.

Getting Started

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

Changelog

explorer-api

• ø (patch in submit-api).

submit-api

• Revert the MIME-type encoding addition from 3.1.0. Turns out there's a bug with an underlying dependency
  causing the feature to misbehave. Removing for now. Will rework later if time allows.

Signatures

role	approval
Technical Team Lead	✔️
Release Manager	✔️

(❌ DEPRECATED - Use 3.1.1) Cardano Rest 3.1.0

❌ This release is deprecated as it introduces a bug in cardano-submit-api. ❌

Use https://github.com/input-output-hk/cardano-rest/releases/tag/3.1.1 instead

---

The release upgrade dependencies to more recent version of the Cardano eco-system as well as a few bug fixes. It is compatible with cardano-node-1.24.2 and cardano-db-sync-7.1.0.

Getting Started

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

Changelog

explorer-api

• Upgrade dependencies to more recent version of the Cardano eco-system (cardano-db-sync-7.1.0 & cardano-node 1.24.2)
• Fix an internal error with 'InnerJoin' requests on block's transaction summary.
• Fix inconsistency in the OpenAPI 2.0 specification (and consequently, the documentation).

submit-api

• Upgrade dependencies to more recent version of the Cardano eco-system (cardano-db-sync-7.1.0 & cardano-node 1.24.2)

• Allow clients to define an extra outer-encoding for the submit endpoint using a MIME-type parameter encoding.
  When set, the parameter must be set to either base16 or base64 and the data payload must be encoded accordingly.
  When not set, then the present behaviour remains applicable and a raw octet stream is expected.

  Examples:

  • Content-Type: application/cbor;encoding=base16
  • Content-Type: application/cbor;encoding=base64
  • Content-Type: application/cbor

Additional Notes

The dependency upgrade has caused some results to be ordered slightly differently when their ordering key is equal. For example,
when ordering: [{a: 1, b:1}, {a:2, b:1}, {a:3, b:2}] by ascending b, the order of the first two elements may not match the
order on previous releases.

It is the case of:

• Transaction inputs.
• Redemption addresses from genesis.

These may now be ordered differently than in the previous release. Applications relying on that order and/or pagination of related requests are advised to double-check their integration.

Signatures

role	approval
Technical Team Lead	✔️
Release Manager	✔️

Cardano Rest 3.0.0

The release upgrade dependencies to more recent version of the Cardano eco-system. It is compatible with cardano-node-1.21.1 and cardano-db-sync-6.0.0.

Getting Started

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

Breaking Changes

• Interface breaking change in the submit-api: the command-line no longer accept a --security-param option.

Signatures

role	approval
Technical Team Lead	✔️
Automated Testing	✔️

Cardano Rest 2.1.3

This bug fix release provides a few fixes for cardano-explorer-api.

Compatible with Cardano Node 1.18.0 with Cardano DB Sync 3.1.0.

Resolved

• Fixed bug regarding Shelley addresses not being decoded correctly (#75)
• Fixed block number overflow (#79)

Getting Started

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

Signatures

Role	Approval
Technical Team Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano Rest 2.1.2

This bug fix release provides a few fixes for cardano-explorer-api.

Compatible with Cardano Node 1.18.0 with Cardano DB Sync 3.1.0.

Resolved

#77 cbeSlot calculated incorrectly #78
#71 cardano-rest explorer api connection failed: listen address is set to 0.0.0.0 in both Docker images cardano-explorer-api and cardano-submit-api #74

Getting Started

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

Signatures

Role	Approval
Technical Team Lead	✔️
QA Engineer	✔️
Ops	✔️
Release Manager	✔️

Cardano Rest 2.1.1

This bug fix release provides a fix for the submit-api Docker issue.

Compatible with Cardano Node 1.18.0 with Cardano DB Sync 3.1.0.

Resolved

#61 #63 Fixed cardano-submit-api docker image #64
#68 Fixed broadcasting of signed transactions with Byron input failure #65

Improved

Updated dependencies #65, #67

Getting Started

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

Signatures

Role	Approval
Technical Team Lead	✔️
QA Engineer	✔️
Release Manager	✔️

Cardano REST 2.1.0

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

Role	Approval
Technical Team Lead	✔️
QA Engineer	✔️
Release Manager	✔️

Cardano ReST 2.0.0

This release is the first release after separating the web API components from cardano-explorer. It follows Cardano Explorer 1.3.0 release.

Compatible with Cardano Node 1.8.0.

Added

• Added swagger documentation for cardano-submit-api

Changed

• Moved Cardano Explorer web API components into a separate repository
• Renamed services and build artifacts
  • cardano-explorer-webapi → cardano-explorer-api
  • cardano-tx-submit → cardano-submit-api

API breaking changes

• cardano-submit-api returns now:
  • 400 Bad Request on errors, and 202 for successful submission.
  • plain text transaction id on success, and plain text error on errors (cf API documentation)

Removed

• Obsolete README and documentation instructions

Getting Started

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

Signatures

Name	Role	Approval
Matthias Benkort @KtorZ	Technical Team Lead	✔️
Arthur Wieczorek @ArturWieczorek	QA Engineer	✔️
Edward Haigh	QA Engineer	✔️
Tatyana Valkevych @tatyanavych	Release Manager	✔️