Skip to content

Commit d9fcbc4

Browse files
authored
Fix healthcheck run spec (#58)
* Add missing return type * Update CHANGELOG
1 parent 7f43fd2 commit d9fcbc4

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## Unreleased
99

10+
### Fixed
11+
12+
- Fixed a type mismatch on `Xogmios.HealthCheck.run/1` that was causing a warning on calls to `use Xogmios, :chain_sync`.
13+
1014
### Added
1115

1216
- Current tip information is now included in the block data passed to `handle_block/2` under the `current_tip` key. This allows clients to calculate the time needed for chainsync to sync from the current position. Adding this to the existing block for now to quickly enable other features, but we should consider implementing a new callback (like `handle_forward/2`) to better handle a new top level entity with both "block" and "tip" as properties.

lib/xogmios/health_check.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ defmodule Xogmios.HealthCheck do
66

77
@http_client :httpc
88

9-
@spec run(url :: String.t()) :: :ok | {:error, String.t()}
9+
@spec run(url :: String.t()) :: :ok | {:error, String.t()} | {:incomplete, String.t()}
1010
def run(ogmios_url) do
1111
url = parse_url(ogmios_url)
1212

0 commit comments

Comments
 (0)