Merge pull request #924 from IntersectMBO/mgalazyn/feature/add-pparams-json-query-wasm

cardano-wasm | Add getProtocolParams query to cardano-wasm

Author: carbolymer

cardano-wasm/grpc-example/example.js

@@ -46,6 +46,11 @@ async function do_async_work() {
     log("Era number:");
     log(eraNum);
 
+    let pparams = await grpcApi.getProtocolParams();
+    log("Protocol Parameters:");
+    log(pparams);
+    console.log(typeof pparams);
+
     finish_test();
 }
 

cardano-wasm/lib-wrapper/cardano-api.d.ts

@@ -102,6 +102,12 @@ declare interface GrpcConnection {
      * @returns A promise that resolves to the transaction ID.
      */
     submitTx(txCbor: string): Promise<string>;
+
+    /**
+     * Get the protocol parameters in the cardano-ledger format from the Cardano Node using a GRPC-web client.
+     * @returns A promise that resolves to the current protocol parameters.
+     */
+    getProtocolParams(): Promise<any>;
 }
 
 /**

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

@@ -1,5 +1,6 @@
 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)
 
@@ -20,6 +21,11 @@ newGrpcConnectionImpl createClientJsFunc host = GrpcObject <$> createClientJsFun
 getEraImpl :: (JSGRPCClient -> IO Int) -> GrpcObject -> IO Int
 getEraImpl getEraJsFunc (GrpcObject client) = getEraJsFunc client
 
+-- | Get the protocol parameters from the Cardano Node using GRPC-web.
+getProtocolParamsImpl
+  :: (JSGRPCClient -> IO Wasm.ProtocolParamsJSON) -> GrpcObject -> IO Wasm.ProtocolParamsJSON
+getProtocolParamsImpl getProtocolParamsJsFunc (GrpcObject client) = getProtocolParamsJsFunc client
+
 -- | Submit a transaction to the Cardano Node using GRPC-web.
 submitTxImpl
   :: (JSGRPCClient -> String -> IO (Either String String))

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

@@ -266,6 +266,14 @@ apiInfo =
                   , methodReturnType = OtherType "string"
                   , methodReturnDoc = "A promise that resolves to the transaction ID."
                   }
+              , MethodInfo
+                  { methodName = "getProtocolParams"
+                  , methodDoc =
+                      "Get the protocol parameters in the cardano-ledger format from the Cardano Node using a GRPC-web client."
+                  , methodParams = []
+                  , methodReturnType = OtherType "any"
+                  , methodReturnDoc = "A promise that resolves to the current protocol parameters."
+                  }
               ]
           }
    in ApiInfo

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

@@ -21,11 +21,11 @@ import Cardano.Wasm.Internal.Api.GRPC qualified as Wasm
 import Cardano.Wasm.Internal.Api.Info (apiInfo)
 import Cardano.Wasm.Internal.Api.Tx qualified as Wasm
 import Cardano.Wasm.Internal.ExceptionHandling (rightOrError)
-import Cardano.Wasm.Internal.JavaScript.GRPC (js_getEra, js_newWebGrpcClient, js_submitTx)
+import Cardano.Wasm.Internal.JavaScript.GRPC (js_getEra, js_newWebGrpcClient, js_submitTx, js_getProtocolParams)
 import Cardano.Wasm.Internal.JavaScript.GRPCTypes (JSGRPCClient)
 
 import Control.Exception (evaluate)
-import Control.Monad (join)
+import Control.Monad 
 import Data.Aeson qualified as Aeson
 import Data.ByteString.UTF8 (fromString, toString)
 import Data.Text (Text)
@@ -133,6 +133,9 @@ instance ToJSVal String JSString where
   toJSVal :: String -> IO JSString
   toJSVal = return . toJSString
 
+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
   toJSVal (Wasm.GrpcObject client) = return client
@@ -171,7 +174,7 @@ instance FromJSVal JSTxIx Api.TxIx where
   fromJSVal :: JSTxIx -> IO Api.TxIx
   fromJSVal = return . Api.TxIx . fromIntegral
 
-instance FromJSVal JSVal Wasm.ProtocolParamsJSON where
+instance FromJSVal JSProtocolParams Wasm.ProtocolParamsJSON where
   fromJSVal = fmap Wasm.ProtocolParamsJSON . jsValToJSONString
 
 instance FromJSVal JSGrpc Wasm.GrpcObject where
@@ -357,6 +360,9 @@ foreign export javascript "newGrpcConnection"
 foreign export javascript "getEra"
   getEra :: JSGrpc -> IO Int
 
+foreign export javascript "getProtocolParams"
+  getProtocolParams :: JSGrpc -> IO JSVal
+
 foreign export javascript "submitTx"
   submitTx :: JSGrpc -> JSString -> IO JSString
 
@@ -368,6 +374,10 @@ newGrpcConnection webGrpcUrl = toJSVal =<< join (Wasm.newGrpcConnectionImpl js_n
 getEra :: HasCallStack => JSGrpc -> IO Int
 getEra grpcObject = Wasm.getEraImpl js_getEra =<< fromJSVal grpcObject
 
+-- | Get the protocol parameters from the Cardano Node using GRPC-web.
+getProtocolParams :: HasCallStack => JSGrpc -> IO JSProtocolParams
+getProtocolParams = toJSVal <=< Wasm.getProtocolParamsImpl js_getProtocolParams <=< fromJSVal
+
 -- | Submit a transaction to the Cardano Node using GRPC-web.
 submitTx :: HasCallStack => JSGrpc -> JSString -> IO JSString
 submitTx grpcObject tx = toJSVal =<< join (Wasm.submitTxImpl js_submitTx <$> fromJSVal grpcObject <*> fromJSVal tx)
@@ -380,4 +390,4 @@ foreign export javascript "getApiInfo"
 getApiInfo :: IO JSApiInfo
 getApiInfo = toJSVal apiInfo
 
-#endif
+#endif

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

@@ -4,9 +4,10 @@
 module Cardano.Wasm.Internal.JavaScript.GRPC where
 #else
 
-module Cardano.Wasm.Internal.JavaScript.GRPC (js_newWebGrpcClient, js_getEra, js_submitTx) where
+module Cardano.Wasm.Internal.JavaScript.GRPC (js_newWebGrpcClient, js_getEra, js_submitTx, js_getProtocolParams) where
 
 import GHC.Wasm.Prim
+import Cardano.Wasm.Internal.Api.Tx (ProtocolParamsJSON(..))
 
 -- | Create a GRPC-web client for the Cardano API.
 foreign import javascript safe "{ node: new cardano_node.node.NodePromiseClient($1, null, null), \
@@ -22,6 +23,13 @@ js_newWebGrpcClient = js_newWebGrpcClientImpl . toJSString
 foreign import javascript safe "($1).node.getEra(new proto.Empty(), {})"
   js_getEra :: JSVal -> IO Int
 
+foreign import javascript safe "atob((await ($1).node.getProtocolParamsJson(new proto.Empty(), {})).toObject().json)"
+  js_getProtocolParamsImpl :: JSVal -> IO JSString
+
+js_getProtocolParams :: JSVal -> IO ProtocolParamsJSON
+js_getProtocolParams client =
+  ProtocolParamsJSON . fromJSString <$> js_getProtocolParamsImpl client
+
 -- | Submit a transaction to the Cardano API using a GRPC-web client.
 foreign import javascript safe "{ let tx = new cardano_node.submit.AnyChainTx(); \
                                   tx.setRaw(new Uint8Array($2.match(/[0-9a-fA-F]{2}/g).map((byte) => parseInt(byte, 16)))); \