Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
caike committed Mar 27, 2024
1 parent 7d2adcc commit a7e70b7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
18 changes: 13 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- StateQuery.send_query interface. Now accepts queries as strings from user input.

### Fixed

- Avoid race condition on state queries by blocking until connection with the Ogmios server is established.

## [v0.2.0](https://github.com/wowica/xogmios/releases/tag/v0.2.0) (2024-02-24)

## Added

- Support for Tx Submission procotol
- Submit signed transactions
- Evaluate execution units of given transaction
- Submit signed transactions
- Evaluate execution units of given transaction

## [v0.1.0](https://github.com/wowica/xogmios/releases/tag/v0.1.0) (2024-02-13)

### Added

- Support for Chain Sync protocol
- Partial support for Ledger State Queries:
- epoch
- eraStart
- Partial support for Ledger State Queries:
- epoch
- eraStart
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@

[Docs](https://hexdocs.pm/xogmios/)

An Elixir client for [Ogmios](https://github.com/CardanoSolutions/ogmios).
An Elixir client for [Ogmios](https://github.com/CardanoSolutions/ogmios).

> Ogmios is a lightweight bridge interface for a Cardano node. It offers a WebSockets API that enables local clients to speak Ouroboros' mini-protocols via JSON/RPC. - https://ogmios.dev/
Mini-Protocols supported by this library:

- [x] Chain Synchronization
- [x] State Query (partially supported)
- [x] State Query
- [x] Tx Submission
- [ ] Mempool Monitoring


See [Examples](#examples) section below for information on how to use this library.

## Installing
Expand Down Expand Up @@ -92,11 +91,11 @@ defmodule StateQueryClient do
end

def get_current_epoch(pid \\ __MODULE__) do
StateQuery.send_query(pid, :get_current_epoch)
StateQuery.send_query(pid, "epoch")
end

def get_era_start(pid \\ __MODULE__) do
StateQuery.send_query(pid, :get_era_start)
def send_query(pid \\ __MODULE__, query_name) do
StateQuery.send_query(pid, query_name)
end
end
```
Expand Down Expand Up @@ -127,4 +126,3 @@ For examples of applications using this library, see [Blocks](https://github.com
## Test

Run `mix test`. Tests do NOT rely on a running Ogmios instance.

0 comments on commit a7e70b7

Please sign in to comment.