Skip to content

Commit

Permalink
Merge pull request #128 from CardanoSolutions/release/4-1-0
Browse files Browse the repository at this point in the history
Release/ 4-1-0
  • Loading branch information
rhyslbw authored Oct 1, 2021
2 parents ccb291d + 4cb33b5 commit efabffa
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 13 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pre: "<b>6. </b>"

##### TypeScript Client

- The `ConnectionConfig` has an additional, optional, configuration parameter `maxPayload` to configure the maximum allowed message size in bytes. The default is chosen quite large as the `utxo` query can result in large payloads.
- The `ConnectionConfig` has an additional, optional, configuration parameter `maxPayload` to configure the maximum allowed message size in bytes. The default is chosen quite large as the `utxo` query can result in large payloads.

- New helpers `isByronEpochBoundaryBlock` and `isByronStandardBlock`.

Expand All @@ -32,6 +32,7 @@ N/A
- The `StateQueryClient` now wraps every query in a try/catch to cope with malformed queries leading to client `fault` results from the server.
- Type definitions for `QueryResponse[poolIds]` and `QueryResponse[poolParameters]` are no longer marked as "optional".
- Fixed bug #125 where empty results of `delegationAndRewards` would cause the client to throw an exception.
- Handled some floating promises.

#### Removed

Expand Down Expand Up @@ -65,13 +66,13 @@ N/A

- The TypeScript `ChainSyncClient` now implements an in-memory queue to ensure `requestNext` responses are processed sequentially when there are async operations in the message handlers. This behaviour can be bypassed where sequential processsing is not required, by setting the new construction option `sequential` to `false`.

- The TypeScript `StateQueryClient` can now re-acquire new points at will, useful for long-running clients for which previously acquired points may expire.
- The TypeScript `StateQueryClient` can now re-acquire new points at will, useful for long-running clients for which previously acquired points may expire.

- The TypeScript client is now [fully documented](https://ogmios.dev/api/modules/_cardano_ogmios_client.html)!

- Nested logs are now also structured, in particular those coming from the `Handshake` or `TxSubmission` protocols. Before, any message from these layers where actually plain strings with unintelligible gibberish. Now, the submitted transaction payload is shown encoded as hexadecimals and errors are also serialized to json using the same model / codec as the one used for websockets. The handshake is also more verbose now clearly showing what version is being requested and what the node replies / select. All in all, better logs.

- The Dockerfile now includes a build definition for building `cardano-node` and `ogmios` into the **same image**, which is the default and suggested mode of operation. To build an image with only Ogmios, use the build `--target ogmios`. Docker Hub now hosts two image repositories: `cardanosolutions/cardano-node-ogmios` and `cardanosolutions/ogmios`.
- The Dockerfile now includes a build definition for building `cardano-node` and `ogmios` into the **same image**, which is the default and suggested mode of operation. To build an image with only Ogmios, use the build `--target ogmios`. Docker Hub now hosts two image repositories: `cardanosolutions/cardano-node-ogmios` and `cardanosolutions/ogmios`.

- Docker Hub images are now tagged with a network suffix (e.g. `-mainnet`). In the case of mainnet, the `-mainnet` suffix is optional, and points to the same build as the defaults.

Expand Down Expand Up @@ -109,7 +110,7 @@ N/A
- Asset quantities and transaction metadata's integers are now parsed as native `BigInt`.

- Changes in the TypeScript's client:
- State queries (resp. the `StateQueryClient`) now automatically runs queries against the last known tip if no explicit point is provided. It used to acquire a point on the first query which would eventually become too old. The behavior is now equivalent to acquiring a new point on **every** query!
- State queries (resp. the `StateQueryClient`) now automatically runs queries against the last known tip if no explicit point is provided. It used to acquire a point on the first query which would eventually become too old. The behavior is now equivalent to acquiring a new point on **every** query!


- `SubmitTx` no-longer returns Byron errors. Consequently, submit errors are no longer scoped under `errors.byron` or `errors.shelley` but simply `errors`.
Expand Down
4 changes: 2 additions & 2 deletions clients/TypeScript/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cardano-ogmios",
"version": "4.0.0",
"version": "4.1.0",
"private": true,
"description": "TypeScript monorepo with client libraries for Cardano Ogmios",
"engines": {
Expand Down Expand Up @@ -29,7 +29,7 @@
"repl:pkg": "yarn workspace @cardano-ogmios/repl run pkg",
"repl:start": "yarn workspace @cardano-ogmios/repl run start",
"test": "yarn workspaces run test",
"testnet:up": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 OGMIOS_PORT=1338 NETWORK=testnet docker-compose -p ogmios-testnet up --build",
"testnet:up": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 OGMIOS_PORT=1338 NETWORK=testnet docker-compose -p ogmios-testnet up",
"testnet:down": "docker-compose -p ogmios-testnet down",
"tags": "ctags $(find packages -type f -name '*.ts' ! -path 'dist/*' ! -name '*.test.ts' ! -name '*.d.ts' ! -path 'node_modules/*')",
"docs": "tar -C docs -xf docs/ogmios-typedoc-theme.tar.gz && typedoc --packages ."
Expand Down
4 changes: 2 additions & 2 deletions clients/TypeScript/packages/client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cardano-ogmios/client",
"version": "4.0.0",
"version": "4.1.0",
"description": "TypeScript client library for Cardano Ogmios",
"engines": {
"node": "^14"
Expand Down Expand Up @@ -51,7 +51,7 @@
"typescript": "^4.2.3"
},
"dependencies": {
"@cardano-ogmios/schema": "4.0.0",
"@cardano-ogmios/schema": "4.1.0",
"@types/json-bigint": "^1.0.1",
"cross-fetch": "^3.1.4",
"fastq": "^1.11.0",
Expand Down
4 changes: 2 additions & 2 deletions clients/TypeScript/packages/repl/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cardano-ogmios/repl",
"version": "4.0.0",
"version": "4.1.0",
"description": "REPL for Cardano Ogmios",
"engines": {
"node": "^14"
Expand Down Expand Up @@ -39,7 +39,7 @@
"typescript": "^4.2.3"
},
"dependencies": {
"@cardano-ogmios/client": "4.0.0",
"@cardano-ogmios/client": "4.1.0",
"chalk": "^4.1.0",
"yargs-parser": "^20.2.7"
},
Expand Down
2 changes: 1 addition & 1 deletion clients/TypeScript/packages/schema/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cardano-ogmios/schema",
"version": "4.0.0",
"version": "4.1.0",
"description": "Generated TypeScript from the Cardano Ogmios schema",
"engines": {
"node": "^14"
Expand Down
2 changes: 1 addition & 1 deletion server/ogmios.cabal

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion server/package.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
_config: !include ".hpack.config.yaml"

name: ogmios
version: 4.0.0
version: 4.1.0
stability: stable
github: "cardanosolutions/ogmios"
license: MPL-2.0
Expand Down

0 comments on commit efabffa

Please sign in to comment.