Hackage :: [Package]

api-rpc-pegnet: simple json-rpc client for PegNet

[ library, mit, web ] [ Propose Tags ] [ Report a vulnerability ]

simple json-rpc client for PegNet integration

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.1.0, 0.1.1.1, 0.1.1.2
Dependencies aeson, aeson-casing, base (>=4.7 && <5), bytestring, http-client, http-client-tls, http-conduit, json-alt, network, remote-json, remote-json-client, remote-monad, text, time, transformers [details]
License MIT
Copyright Copyright: (c) 2019 Sergey Bushnyak
Author Sergey Bushnyak
Maintainer sergey.bushnyak@sigrlami.eu
Category Web
Home page https://github.com/sigrlami/api-rpc-pegnet#readme
Bug tracker https://github.com/sigrlami/api-rpc-pegnet/issues
Source repo head: git clone https://github.com/sigrlami/api-rpc-pegnet
Uploaded by sigrlami at 2020-01-13T18:14:38Z
Distributions
Downloads 1423 total (8 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for api-rpc-pegnet-0.1.1.2

[back to package description]

Haskell JSON-RPC client for PegNet daemon

Build Status Coverage Status Hackage License

A JSON-RPC Haskell client for the PegNet API daemon. Allows retrieval of data from PegNet dApp. Each response has special ADT(algebraic data type) that automatically converted from JSON response. Using Remote Monad pattern multiple request can be batched and executed simulatenously, following more robust approach and reducing usage of expensive RPC calls.

Choosing a batching strategy. There are two strategies:

  • Weak - a single command or a single procedure, or
  • Strong - a sequence of commands, optionally terminated by a procedure
  1. Installation
  2. Usage
  3. Contributions

Installation

You can install package from Hackage and build with Cabal, but we recommend to use Stack tool. Add to you dependencies in stack.yaml and cabal file dependency - api-rpc-pegnet.

To run and test from repository:

  1. Build with stack 
$ stack build
  1. Load REPL with stack for evaluation 
$ stack repl
  1. execute required methods

Usage

for basic daemon functionality

  1. import with 
import PegNet.RPC.Api

or load in REPL.

  1. build communication session with 
weakSession (traceSendAPI "" $ clientSendAPIWithAlt endpoint)
  1. run required methods inside RPC monad

Usage

You can construct simple session with all methods available for further processings. Check following execution

main = do
  -- build communication session
  let s = weakSession $ traceSendAPI "" $ clientSendAPIWithAlt endpointRemote
  (h, i) <- send s $ do
         h <- reqGetSyncStatus
         i <- reqPegNetIssuance
         b <- reqPegNetBalances "FA38cwer93mmPw1HxjScLmK1yF9iJTu5P87T2vdkbuLovm2YXyss"
         t <- reqGetTransaction "0-e4380e6334b0c42d4d6155fbd1378050b91c02a0df93d7fdfe6656f94c61e7eb"
         r <- reqPegNetRates 213000
         s <- reqGetTransactionStatus "a33d4f334a2658c17d3f44158af75f1c32cc6b2f3de9ddc337064c93043d8db0"
         rich <- reqGetRichList (Just "PEG") 5

         -- return values as N-ary tuple
         return (h, i)
  -- process resulted values
  print h
  -- or use for special business logic

Variables h and i mapped to exact data stucture. All types available for detailed overview in Types directory.

Contributions

Please, feel free to contribute, fork the repo and submit PR.

Say thanks, send a tip:

  • btc: 39oVXpsgsyW8ZgzsnX3sV7HLdtXWfT96qN
  • fct: FA38cwer93mmPw1HxjScLmK1yF9iJTu5P87T2vdkbuLovm2YXyss
  • eth: 0x9cDBA6bb44772259B3A3fb89cf233A147a720f34
  • xlm: GD2FROTYXYSNOQQREYXHCXVOYWV556EM6PAHMVUHJNJEUYTUXUSNUZQ3