Skip to content

Commit

Permalink
Move SeenSnapshot from api.yaml -> logs.yaml
Browse files Browse the repository at this point in the history
It was not used in the API and hence it can be defined in the logs
schema only to make sure it's not part of the user facing API.
  • Loading branch information
ch1bo committed Feb 24, 2023
1 parent 5be3758 commit cc46ab3
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 61 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,10 @@ changes.
+ Replace `fromConsensusPointHF` with `fromConsensusPointInMode` and
`toConsensusPointHF` with `toConsensusPointInMode`.
+ Re-export new `AcquiringFailure` type from `cardano-api`.

+ Introduce new `Hydra.Cardano.Api.Pretty` module and move functions
`renderTx`, `renderTxWithUTxO` and `renderTxs` from `hydra-node` package to
this new module.


- **BREAKING** Addressed short-comings in `hydra-plutus` scripts:
+ Check presence of state token (ST) and that it's consistent against datum.
+ Reduce cost of `commitTx` by using the initial script as input reference.
Expand Down Expand Up @@ -62,7 +60,9 @@ changes.
`NotEnoughFuel` when utxo was not found. Now `NotEnoughFuel` is used when
there is not enough fuel and `NoFuelUTXOFound` when utxo was not to be found.

- HeadLogic Outcome is now being traced on every protocol step transition.
- Changes to the logs:
- HeadLogic Outcome is now being logged on every protocol step transition.
- Added intermediate `LastSeenSnapshot` and extended `RequestedSnapshot` seen snapshot states.

- Switched to using [nix flakes](https://nixos.wiki/wiki/Flakes):
+ Allows us to use some CI services (cicero).
Expand All @@ -72,7 +72,7 @@ changes.

- Add script sizes to `hydra-node --script-info` and published transaction cost benchmarks.

- `hydra-cluster` executable can be used to provide a local cardano "network" with `--devnet` argument
- `hydra-cluster` executable can be used to provide a local cardano "network" with `--devnet` argument

## [0.8.1] - 2022-11-17

Expand Down
56 changes: 0 additions & 56 deletions hydra-node/json-schemas/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1175,62 +1175,6 @@ components:
failureReason:
type: string

SeenSnapshot:
oneOf:
- title: NoSeenSnapshot
type: object
additionalProperties: false
required:
- tag
properties:
tag:
type: string
enum: ["NoSeenSnapshot"]
- title: LastSeenSnapshot
type: object
additionalProperties: false
required:
- tag
- lastSeen
properties:
tag:
type: string
enum: ["LastSeenSnapshot"]
lastSeen:
$ref: "#/components/schemas/SnapshotNumber"
- title: RequestedSnapshot
type: object
additionalProperties: false
required:
- tag
- lastSeen
- requested
properties:
tag:
type: string
enum: ["RequestedSnapshot"]
lastSeen:
$ref: "#/components/schemas/SnapshotNumber"
requested:
$ref: "#/components/schemas/SnapshotNumber"
- title: SeenSnapshot
type: object
additionalProperties: false
required:
- tag
- snapshot
- signatories
properties:
tag:
type: string
enum: ["SeenSnapshot"]
snapshot:
$ref: "#/components/schemas/Snapshot"
signatories:
type: array
items:
$ref: "#/components/schemas/Party"

Signature:
type: string
description: >-
Expand Down
58 changes: 57 additions & 1 deletion hydra-node/json-schemas/logs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,63 @@ definitions:
confirmedSnapshot:
$ref: "api.yaml#/components/schemas/ConfirmedSnapshot"
seenSnapshot:
$ref: "api.yaml#/components/schemas/SeenSnapshot"
$ref: "#/definitions/SeenSnapshot"

SeenSnapshot:
oneOf:
- title: NoSeenSnapshot
type: object
additionalProperties: false
required:
- tag
properties:
tag:
type: string
enum: ["NoSeenSnapshot"]
- title: LastSeenSnapshot
type: object
additionalProperties: false
required:
- tag
- lastSeen
properties:
tag:
type: string
enum: ["LastSeenSnapshot"]
lastSeen:
$ref: "api.yaml#/components/schemas/SnapshotNumber"
- title: RequestedSnapshot
type: object
additionalProperties: false
required:
- tag
- lastSeen
- requested
properties:
tag:
type: string
enum: ["RequestedSnapshot"]
lastSeen:
$ref: "api.yaml#/components/schemas/SnapshotNumber"
requested:
$ref: "api.yaml#/components/schemas/SnapshotNumber"
- title: SeenSnapshot
type: object
additionalProperties: false
required:
- tag
- snapshot
- signatories
properties:
tag:
type: string
enum: ["SeenSnapshot"]
snapshot:
$ref: "api.yaml#/components/schemas/Snapshot"
signatories:
type: array
items:
$ref: "api.yaml#/components/schemas/Party"

Event:
description: >-
Expand Down

0 comments on commit cc46ab3

Please sign in to comment.