Merge pull request #988 from IntersectMBO/abstract-grpc-module

Abstract out GRPC module

Author: palas

cardano-wasm/src/Cardano/Wasm/Internal/Api/GRPC.hs

@@ -2,56 +2,54 @@ module Cardano.Wasm.Internal.Api.GRPC where
 
 import Cardano.Wasm.Internal.Api.Tx qualified as Wasm
 import Cardano.Wasm.Internal.ExceptionHandling (rightOrError, toMonadFail)
-import Cardano.Wasm.Internal.JavaScript.GRPCTypes
-  ( JSGRPCClient
-  , JSUtxos
-  )
 
 import Data.ByteString.Base16 qualified as Base16
 import Data.ByteString.Base64 qualified as Base64
 import Data.ByteString.Char8 qualified as BS
 
--- | Internal data for the GrpcConnection virtual object. Currently, it is just a wrapper around the JSGRPCClient,
--- which is a JavaScript object that allows us to interact with the Cardano Node via gRPC-web.
-newtype GrpcObject
-  = GrpcObject JSGRPCClient
+-- | Internal data for the GrpcConnection virtual object. Currently, it is just a wrapper around the grpcClient,
+-- which is some object that allows us to interact with the Cardano Node via gRPC or GRPC-web.
+newtype GrpcObject grpcClient
+  = GrpcObject grpcClient
 
 -- | Create a new unsigned transaction object for making a Conway era transaction.
-newGrpcConnectionImpl :: (String -> IO JSGRPCClient) -> String -> IO GrpcObject
-newGrpcConnectionImpl createClientJsFunc host = GrpcObject <$> createClientJsFunc host
+newGrpcConnectionImpl :: (String -> IO grpcClient) -> String -> IO (GrpcObject grpcClient)
+newGrpcConnectionImpl createClientFunc host = GrpcObject <$> createClientFunc host
 
--- | Get the era from the Cardano Node using GRPC-web.
-getEraImpl :: (JSGRPCClient -> IO Int) -> GrpcObject -> IO Int
-getEraImpl getEraJsFunc (GrpcObject client) = getEraJsFunc client
+-- | Get the era from the Cardano Node using gRPC or GRPC-web.
+getEraImpl :: (grpcClient -> IO Int) -> GrpcObject grpcClient -> IO Int
+getEraImpl getEraFunc (GrpcObject client) = getEraFunc client
 
--- | Get the protocol parameters from the Cardano Node using GRPC-web.
+-- | Get the protocol parameters from the Cardano Node using gRPC or GRPC-web.
 getProtocolParamsImpl
-  :: (JSGRPCClient -> IO Wasm.ProtocolParamsJSON) -> GrpcObject -> IO Wasm.ProtocolParamsJSON
-getProtocolParamsImpl getProtocolParamsJsFunc (GrpcObject client) = getProtocolParamsJsFunc client
+  :: (grpcClient -> IO Wasm.ProtocolParamsJSON)
+  -> GrpcObject grpcClient
+  -> IO Wasm.ProtocolParamsJSON
+getProtocolParamsImpl getProtocolParamsFunc (GrpcObject client) = getProtocolParamsFunc client
 
--- | Get all UTXOs from the node using a GRPC-web client.
+-- | Get all UTXOs from the node using a gRPC or GRPC-web client.
 getAllUtxosImpl
-  :: (JSGRPCClient -> IO JSUtxos)
-  -> GrpcObject
-  -> IO JSUtxos
-getAllUtxosImpl getUtxosJsFunc (GrpcObject client) = getUtxosJsFunc client
+  :: (grpcClient -> IO utxos)
+  -> GrpcObject grpcClient
+  -> IO utxos
+getAllUtxosImpl getUtxosFunc (GrpcObject client) = getUtxosFunc client
 
--- | Get UTXOs for a given address using a GRPC-web client.
+-- | Get UTXOs for a given address using a gRPC or GRPC-web client.
 getUtxosForAddressImpl
-  :: (JSGRPCClient -> String -> IO JSUtxos)
-  -> GrpcObject
+  :: (grpcClient -> String -> IO utxos)
+  -> GrpcObject grpcClient
   -> String
-  -> IO JSUtxos
-getUtxosForAddressImpl getUtxosForAddressJsFunc (GrpcObject client) = getUtxosForAddressJsFunc client
+  -> IO utxos
+getUtxosForAddressImpl getUtxosForAddressFunc (GrpcObject client) = getUtxosForAddressFunc client
 
--- | Submit a transaction to the Cardano Node using GRPC-web.
+-- | Submit a transaction to the Cardano Node using gRPC or GRPC-web.
 submitTxImpl
-  :: (JSGRPCClient -> String -> IO (Either String String))
-  -> GrpcObject
+  :: (grpcClient -> String -> IO (Either String String))
+  -> GrpcObject grpcClient
   -> String
   -> IO String
-submitTxImpl submitTxJsFunc (GrpcObject client) tx =
-  toMonadFail . rightOrError . (base64ToBase16 =<<) =<< submitTxJsFunc client tx
+submitTxImpl submitTxFunc (GrpcObject client) tx =
+  toMonadFail . rightOrError . (base64ToBase16 =<<) =<< submitTxFunc client tx
  where
   -- We reencode as Base16 because it is a more common format for txIds
   base64ToBase16 :: String -> Either String String

cardano-wasm/src/Cardano/Wasm/Internal/JavaScript/Bridge.hs

@@ -147,8 +147,8 @@ instance ToJSVal String JSString where
 instance ToJSVal Wasm.ProtocolParamsJSON JSProtocolParams where
   toJSVal (Wasm.ProtocolParamsJSON json) = js_parse $ toJSString json
 
-instance ToJSVal Wasm.GrpcObject JSGrpc where
-  toJSVal :: Wasm.GrpcObject -> IO JSGrpc
+instance ToJSVal (Wasm.GrpcObject JSGRPCClient) JSGrpc where
+  toJSVal :: (Wasm.GrpcObject JSGRPCClient) -> IO JSGrpc
   toJSVal (Wasm.GrpcObject client) = return client
 
 instance ToJSVal Ledger.Coin JSCoin where
@@ -192,8 +192,8 @@ instance FromJSVal JSTxIx Api.TxIx where
 instance FromJSVal JSProtocolParams Wasm.ProtocolParamsJSON where
   fromJSVal = fmap Wasm.ProtocolParamsJSON . jsValToJSONString
 
-instance FromJSVal JSGrpc Wasm.GrpcObject where
-  fromJSVal :: JSGrpc -> IO Wasm.GrpcObject
+instance FromJSVal JSGrpc (Wasm.GrpcObject JSGRPCClient) where
+  fromJSVal :: JSGrpc -> IO (Wasm.GrpcObject JSGRPCClient)
   fromJSVal jsVal = return $ Wasm.GrpcObject jsVal
 
 -- * WalletObject