-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Partially updating ogmios client after breaking changes on v6
- Loading branch information
Showing
12 changed files
with
306 additions
and
346 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 3 additions & 5 deletions
8
...st/parsing/JsonWsp/UtxoQueryResponse.json → ...t/parsing/JsonRpc2/UtxoQueryResponse.json
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| -- | Provides basics types and operations for working with JSON RPC protocol | ||
| -- | used by Ogmios | ||
| module Ctl.Internal.QueryM.JsonRpc2 | ||
| ( JsonRpc2Request | ||
| , JsonRpc2Response | ||
| , JsonRpc2Call | ||
| , mkCallType | ||
| , buildRequest | ||
| , parseJsonRpc2Response | ||
| , parseJsonRpc2ResponseId | ||
| ) where | ||
|
|
||
| import Prelude | ||
|
|
||
| import Aeson | ||
| ( class DecodeAeson | ||
| , class EncodeAeson | ||
| , Aeson | ||
| , JsonDecodeError(TypeMismatch) | ||
| , caseAesonObject | ||
| , encodeAeson | ||
| , getField | ||
| , getFieldOptional | ||
| ) | ||
| import Ctl.Internal.QueryM.UniqueId (ListenerId, uniqueId) | ||
| import Data.Either (Either(Left)) | ||
| import Data.Maybe (Maybe) | ||
| import Effect (Effect) | ||
| import Foreign.Object (Object) | ||
| import Record as Record | ||
|
|
||
| -- | Structure of all json rpc2.0 websocket requests | ||
| -- described in: https://ogmios.dev/getting-started/basics/ | ||
| type JsonRpc2Request (a :: Type) = | ||
| { jsonrpc :: String | ||
| , method :: String | ||
| , params :: a | ||
| , id :: ListenerId | ||
| } | ||
|
|
||
| -- | Convenience helper function for creating `JsonRpc2Request a` objects | ||
| mkJsonRpc2Request | ||
| :: forall (a :: Type) | ||
| . { jsonrpc :: String } | ||
| -> { method :: String | ||
| , params :: a | ||
| } | ||
| -> Effect (JsonRpc2Request a) | ||
| mkJsonRpc2Request service method = do | ||
| id <- uniqueId $ method.method <> "-" | ||
| pure | ||
| $ Record.merge { id } | ||
| $ Record.merge service method | ||
|
|
||
| -- | Structure of all json wsp websocket responses | ||
| -- described in: https://ogmios.dev/getting-started/basics/ | ||
| type JsonRpc2Response (a :: Type) = | ||
| { jsonrpc :: String | ||
| -- methodname is not always present if `error` is not empty | ||
| , method :: Maybe String | ||
| , result :: Maybe a | ||
| , error :: Maybe Aeson | ||
| , id :: ListenerId | ||
| } | ||
|
|
||
| -- | A wrapper for tying arguments and response types to request building. | ||
| newtype JsonRpc2Call :: Type -> Type -> Type | ||
| newtype JsonRpc2Call (i :: Type) (o :: Type) = JsonRpc2Call | ||
| (i -> Effect { body :: Aeson, id :: String }) | ||
|
|
||
| -- | Creates a "jsonwsp call" which ties together request input and response output types | ||
| -- | along with a way to create a request object. | ||
| mkCallType | ||
| :: forall (a :: Type) (i :: Type) (o :: Type) | ||
| . EncodeAeson (JsonRpc2Request a) | ||
| => { jsonrpc :: String } | ||
| -> { method :: String, params :: i -> a } | ||
| -> JsonRpc2Call i o | ||
| mkCallType service { method, params } = JsonRpc2Call $ \i -> do | ||
| req <- mkJsonRpc2Request service { method, params: params i } | ||
| pure { body: encodeAeson req, id: req.id } | ||
|
|
||
| -- | Create a JsonRpc2 request body and id | ||
| buildRequest | ||
| :: forall (i :: Type) (o :: Type) | ||
| . JsonRpc2Call i o | ||
| -> i | ||
| -> Effect { body :: Aeson, id :: String } | ||
| buildRequest (JsonRpc2Call c) = c | ||
|
|
||
| -- | Polymorphic response parser | ||
| parseJsonRpc2Response | ||
| :: forall (a :: Type) | ||
| . DecodeAeson a | ||
| => Aeson | ||
| -> Either JsonDecodeError (JsonRpc2Response a) | ||
| parseJsonRpc2Response = aesonObject $ \o -> do | ||
| jsonrpc <- getField o "jsonrpc" | ||
| method <- getFieldOptional o "method" | ||
| result <- getFieldOptional o "result" | ||
| error <- getFieldOptional o "error" | ||
| id <- getField o "id" | ||
| pure | ||
| { jsonrpc | ||
| , method | ||
| , result | ||
| , error | ||
| , id | ||
| } | ||
|
|
||
| -- | Parse just ID from the response | ||
| parseJsonRpc2ResponseId | ||
| :: Aeson | ||
| -> Either JsonDecodeError ListenerId | ||
| parseJsonRpc2ResponseId = | ||
| aesonObject $ flip getField "id" | ||
|
|
||
| -- | Helper for assuming we get an object | ||
| aesonObject | ||
| :: forall (a :: Type) | ||
| . (Object Aeson -> Either JsonDecodeError a) | ||
| -> Aeson | ||
| -> Either JsonDecodeError a | ||
| aesonObject = caseAesonObject (Left (TypeMismatch "expected object")) |
Oops, something went wrong.