diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,211 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright 2016-2021 Aleksandr Krupenkin + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + NOTE + +Individual files contain the following tag instead of the full license +text. + + SPDX-License-Identifier: Apache-2.0 + +This enables machine processing of license information based on the SPDX +License Identifiers that are here available: http://spdx.org/licenses/ diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/jsonrpc-tinyclient.cabal b/jsonrpc-tinyclient.cabal new file mode 100644 --- /dev/null +++ b/jsonrpc-tinyclient.cabal @@ -0,0 +1,45 @@ +cabal-version: 1.12 +name: jsonrpc-tinyclient +version: 1.0.0.0 +license: Apache-2.0 +license-file: LICENSE +copyright: (c) Aleksandr Krupenkin 2016-2021 +maintainer: mail@akru.me +author: Aleksandr Krupenkin +homepage: https://github.com/airalab/hs-web3#readme +bug-reports: https://github.com/airalab/hs-web3/issues +synopsis: Tiny JSON-RPC client for Haskell Web3 library. +description: Client library for Third Generation of Web. +category: Network +build-type: Simple + +source-repository head + type: git + location: https://github.com/airalab/hs-web3 + +library + exposed-modules: Network.JsonRpc.TinyClient + hs-source-dirs: src + other-modules: Paths_jsonrpc_tinyclient + default-language: Haskell2010 + ghc-options: + -funbox-strict-fields -Wduplicate-exports -Whi-shadowing + -Widentities -Woverlapping-patterns -Wpartial-type-signatures + -Wunrecognised-pragmas -Wtyped-holes -Wincomplete-patterns + -Wincomplete-uni-patterns -Wmissing-fields -Wmissing-methods + -Wmissing-exported-signatures -Wmissing-monadfail-instances + -Wmissing-signatures -Wname-shadowing -Wunused-binds + -Wunused-top-binds -Wunused-local-binds -Wunused-pattern-binds + -Wunused-imports -Wunused-matches -Wunused-foralls -Wtabs + + build-depends: + aeson >1.2 && <1.6, + base >4.11 && <4.15, + bytestring >0.10 && <0.11, + exceptions >0.8 && <0.11, + http-client >0.5 && <0.7, + http-client-tls >0.3 && <0.4, + mtl >2.2 && <2.3, + random >1.0 && <1.3, + text >1.2 && <1.3, + websockets >0.10 && <0.13 diff --git a/src/Network/JsonRpc/TinyClient.hs b/src/Network/JsonRpc/TinyClient.hs new file mode 100644 --- /dev/null +++ b/src/Network/JsonRpc/TinyClient.hs @@ -0,0 +1,217 @@ +{-# LANGUAGE CPP #-} +{-# LANGUAGE ConstraintKinds #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE FunctionalDependencies #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UndecidableInstances #-} + +-- | +-- Module : Network.JsonRpc.TinyClient +-- Copyright : Aleksandr Krupenkin 2016-2018 +-- License : Apache-2.0 +-- +-- Maintainer : mail@akru.me +-- Stability : experimental +-- Portability : portable +-- +-- Tiny JSON-RPC 2.0 client. +-- Functions for implementing the client side of JSON-RPC 2.0. +-- See . +-- +-- If you have monad with 'MonadIO', 'MonadThrow' and 'MonadReader' instances, +-- it can be used as base for JSON-RPC calls. +-- +-- Example: +-- +-- @ +-- newtype MyMonad a = ... +-- +-- instance JsonRpc MyMonad +-- +-- foo :: Mymonad Text +-- foo = remote "foo" +-- @ +-- +-- Arguments of function are stored into @params@ request array. +-- +-- Example: +-- +-- @ +-- myMethod :: JsonRpc m => Int -> Bool -> m String +-- myMethod = remote "myMethod" +-- @ +-- + +module Network.JsonRpc.TinyClient + ( + -- * The JSON-RPC remote call monad + JsonRpc(..) + , MethodName + + -- * JSON-RPC client settings + , JsonRpcClient(..) + , defaultSettings + + -- * Error handling + , JsonRpcException(..) + , RpcError(..) + ) where + +import Control.Applicative ((<|>)) +import Control.Exception (Exception) +import Control.Monad ((<=<)) +import Control.Monad.Catch (MonadThrow (..)) +import Control.Monad.IO.Class (MonadIO (..)) +import Control.Monad.State (MonadState, get) +import Data.Aeson (FromJSON (..), ToJSON (..), + Value (String), eitherDecode, encode, + object, withObject, (.:), (.:?), (.=)) +import Data.ByteString.Lazy (ByteString) +import Data.Text (Text, unpack) +import Network.HTTP.Client (Manager, RequestBody (RequestBodyLBS), + httpLbs, method, newManager, + parseRequest, requestBody, + requestHeaders, responseBody) +import Network.HTTP.Client.TLS (tlsManagerSettings) +import qualified Network.WebSockets as WS (Connection, receiveData, + sendTextData) +import System.Random (randomRIO) + +-- | JSON-RPC monad constrait. +type JsonRpcM m = (MonadIO m, MonadThrow m, MonadState JsonRpcClient m) + +-- | JSON-RPC client state vars. +data JsonRpcClient = JsonRpcHttpClient + { jsonRpcManager :: Manager + -- ^ HTTP connection manager. + , jsonRpcServer :: String + -- ^ Remote server URI. + } + | JsonRpcWsClient + { jsonRpcWsConnection :: WS.Connection + -- ^ WebSocket connection. + } + +-- | Create default 'JsonRpcClient' settings. +defaultSettings :: MonadIO m + => String -- ^ JSON-RPC server URI + -> m JsonRpcClient +defaultSettings srv = liftIO $ JsonRpcHttpClient + <$> newManager tlsManagerSettings + <*> pure srv + +instance Show JsonRpcClient where + show JsonRpcHttpClient{..} = "" + show JsonRpcWsClient{..} = "" + +-- | JSON-RPC request. +data Request = Request + { rqMethod :: !Text + , rqId :: !Int + , rqParams :: !Value + } + deriving (Eq, Show) + +instance ToJSON Request where + toJSON rq = object [ "jsonrpc" .= String "2.0" + , "method" .= rqMethod rq + , "params" .= rqParams rq + , "id" .= rqId rq + ] + +-- | JSON-RPC response. +data Response = Response + { rsResult :: !(Either RpcError Value) + } + deriving (Eq, Show) + +instance FromJSON Response where + parseJSON = + withObject "JSON-RPC response object" $ + \v -> Response <$> + (Right <$> v .: "result" <|> Left <$> v .: "error") + +-- | JSON-RPC error message +data RpcError = RpcError + { errCode :: !Int + , errMessage :: !Text + , errData :: !(Maybe Value) + } + deriving Eq + +instance Show RpcError where + show (RpcError code msg dat) = + "JSON-RPC error " ++ show code ++ ": " ++ unpack msg + ++ ". Data: " ++ show dat + +instance FromJSON RpcError where + parseJSON = withObject "JSON-RPC error object" $ + \v -> RpcError <$> v .: "code" + <*> v .: "message" + <*> v .:? "data" + +data JsonRpcException = ParsingException String + | CallException RpcError + deriving (Show, Eq) + +instance Exception JsonRpcException + +class JsonRpcM m => Remote m a | a -> m where + remote' :: ([Value] -> m ByteString) -> a + +instance (ToJSON a, Remote m b) => Remote m (a -> b) where + remote' f x = remote' (\xs -> f (toJSON x : xs)) + +instance {-# INCOHERENT #-} (JsonRpcM m, FromJSON b) => Remote m (m b) where + remote' f = decodeResponse =<< f [] + +-- | Name of called method. +type MethodName = Text + +-- | JSON-RPC call monad. +class JsonRpcM m => JsonRpc m where + -- | Remote call of JSON-RPC method. + remote :: Remote m a => MethodName -> a + {-# INLINE remote #-} + remote = remote' . call + +call :: JsonRpcM m + => MethodName + -> [Value] + -> m ByteString +call m r = do + rid <- liftIO $ randomRIO (0, maxInt) + connection . encode $ Request m (fromInteger rid) (toJSON r) + where + maxInt = toInteger (maxBound :: Int) + connection body = do + jsonRpcInstance <- get + case jsonRpcInstance of + JsonRpcHttpClient{..} -> do + request <- parseRequest jsonRpcServer + let request' = request { + requestBody = RequestBodyLBS body + , requestHeaders = [("Content-Type", "application/json")] + , method = "POST" + } + responseBody <$> liftIO (httpLbs request' jsonRpcManager) + + JsonRpcWsClient{..} -> liftIO $ do + WS.sendTextData jsonRpcWsConnection body + WS.receiveData jsonRpcWsConnection + + + +decodeResponse :: (MonadThrow m, FromJSON a) + => ByteString + -> m a +decodeResponse = (tryParse . eitherDecode . encode) + <=< tryResult . rsResult + <=< tryParse . eitherDecode + where + tryParse = either (throwM . ParsingException) return + tryResult = either (throwM . CallException) return