Skip to content

Commit efabffa

Browse files
authored
Merge pull request #128 from CardanoSolutions/release/4-1-0
Release/ 4-1-0
2 parents ccb291d + 4cb33b5 commit efabffa

7 files changed

Lines changed: 14 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ pre: "<b>6. </b>"
1717

1818
##### TypeScript Client
1919

20-
- 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.
20+
- 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.
2121

2222
- New helpers `isByronEpochBoundaryBlock` and `isByronStandardBlock`.
2323

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

3637
#### Removed
3738

@@ -65,13 +66,13 @@ N/A
6566

6667
- 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`.
6768

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

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

7273
- 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.
7374

74-
- 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`.
75+
- 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`.
7576

7677
- 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.
7778

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

111112
- Changes in the TypeScript's client:
112-
- 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!
113+
- 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!
113114

114115

115116
- `SubmitTx` no-longer returns Byron errors. Consequently, submit errors are no longer scoped under `errors.byron` or `errors.shelley` but simply `errors`.

clients/TypeScript/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cardano-ogmios",
3-
"version": "4.0.0",
3+
"version": "4.1.0",
44
"private": true,
55
"description": "TypeScript monorepo with client libraries for Cardano Ogmios",
66
"engines": {
@@ -29,7 +29,7 @@
2929
"repl:pkg": "yarn workspace @cardano-ogmios/repl run pkg",
3030
"repl:start": "yarn workspace @cardano-ogmios/repl run start",
3131
"test": "yarn workspaces run test",
32-
"testnet:up": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 OGMIOS_PORT=1338 NETWORK=testnet docker-compose -p ogmios-testnet up --build",
32+
"testnet:up": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 OGMIOS_PORT=1338 NETWORK=testnet docker-compose -p ogmios-testnet up",
3333
"testnet:down": "docker-compose -p ogmios-testnet down",
3434
"tags": "ctags $(find packages -type f -name '*.ts' ! -path 'dist/*' ! -name '*.test.ts' ! -name '*.d.ts' ! -path 'node_modules/*')",
3535
"docs": "tar -C docs -xf docs/ogmios-typedoc-theme.tar.gz && typedoc --packages ."

clients/TypeScript/packages/client/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@cardano-ogmios/client",
3-
"version": "4.0.0",
3+
"version": "4.1.0",
44
"description": "TypeScript client library for Cardano Ogmios",
55
"engines": {
66
"node": "^14"
@@ -51,7 +51,7 @@
5151
"typescript": "^4.2.3"
5252
},
5353
"dependencies": {
54-
"@cardano-ogmios/schema": "4.0.0",
54+
"@cardano-ogmios/schema": "4.1.0",
5555
"@types/json-bigint": "^1.0.1",
5656
"cross-fetch": "^3.1.4",
5757
"fastq": "^1.11.0",

clients/TypeScript/packages/repl/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@cardano-ogmios/repl",
3-
"version": "4.0.0",
3+
"version": "4.1.0",
44
"description": "REPL for Cardano Ogmios",
55
"engines": {
66
"node": "^14"
@@ -39,7 +39,7 @@
3939
"typescript": "^4.2.3"
4040
},
4141
"dependencies": {
42-
"@cardano-ogmios/client": "4.0.0",
42+
"@cardano-ogmios/client": "4.1.0",
4343
"chalk": "^4.1.0",
4444
"yargs-parser": "^20.2.7"
4545
},

clients/TypeScript/packages/schema/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@cardano-ogmios/schema",
3-
"version": "4.0.0",
3+
"version": "4.1.0",
44
"description": "Generated TypeScript from the Cardano Ogmios schema",
55
"engines": {
66
"node": "^14"

server/ogmios.cabal

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

server/package.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
_config: !include ".hpack.config.yaml"
22

33
name: ogmios
4-
version: 4.0.0
4+
version: 4.1.0
55
stability: stable
66
github: "cardanosolutions/ogmios"
77
license: MPL-2.0

0 commit comments

Comments
 (0)