Remove mentions to explicit eras in lib-wrapper and the newConwayTx function

Author: palas

cardano-wasm/cardano-wasm.cabal

@@ -40,6 +40,7 @@ library cardano-wasi-lib
     Cardano.Wasm.ExceptionHandling
 
   other-modules:
+    Cardano.Wasm.Internal.Api.Era
     Cardano.Wasm.Internal.Api.Random
 
   build-depends:

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

@@ -30,12 +30,6 @@ declare interface CardanoApi {
          * @returns A promise that resolves to a new `UnsignedTx` object.
          */
         newExperimentalEraTx(): Promise<UnsignedTx>;
-
-        /**
-         * Create a new unsigned transaction in the Conway era.
-         * @returns A promise that resolves to a new `UnsignedTx` object.
-         */
-        newConwayTx(): Promise<UnsignedTx>;
     }
 
     /**
@@ -50,27 +44,27 @@ declare interface CardanoApi {
      */
     certificate: {
         /**
-         * Methods for creating certificates in Conway era.
+         * Methods for creating certificates in the current era.
          */
-        conway: {
+        currentEra: {
             /**
-             * Make a certificate that delegates a stake address to a stake pool in Conway era.
+             * Make a certificate that delegates a stake address to a stake pool in the current era.
              * @param stakeKeyHash The stake key hash in base16 format.
              * @param poolId The pool ID in base16 format.
              * @returns A promise that resolves to the CBOR-encoded certificate as a hex string.
              */
             makeStakeAddressStakeDelegationCertificate(stakeKeyHash: string, poolId: string): Promise<string>;
 
             /**
-             * Make a stake address registration certificate in Conway era.
+             * Make a stake address registration certificate in the current era.
              * @param stakeKeyHash The stake key hash in base16 format.
              * @param deposit The deposit amount in lovelaces.
              * @returns A promise that resolves to the CBOR-encoded certificate as a hex string.
              */
             makeStakeAddressRegistrationCertificate(stakeKeyHash: string, deposit: bigint): Promise<string>;
 
             /**
-             * Make a stake address unregistration certificate in Conway era.
+             * Make a stake address unregistration certificate in the current era.
              * @param stakeKeyHash The stake key hash in base16 format.
              * @param deposit The deposit amount in lovelaces.
              * @returns A promise that resolves to the CBOR-encoded certificate as a hex string.

cardano-wasm/src-lib/Cardano/Wasm/Api/Certificate/StakeCertificate.hs

@@ -30,27 +30,29 @@ import Cardano.Api.Experimental.Certificate (Certificate (..))
 import Cardano.Api.Serialise.Raw qualified as Api
 
 import Cardano.Ledger.Api (Delegatee (DelegStake))
-import Cardano.Wasm.ExceptionHandling (rightOrError)
+import Cardano.Wasm.ExceptionHandling (justOrError, rightOrError)
+import Cardano.Wasm.Internal.Api.Era (currentEra, experimentalEra)
 
 import Control.Monad.Catch (MonadThrow)
 import Data.ByteString.Base16 qualified as Base16
 import Data.Text qualified as Text
 import Data.Text.Encoding qualified as Text
 
--- | Make a certificate that delegates a stake address to a stake pool in Conway era.
+-- | Make a certificate that delegates a stake address to a stake pool in the current era.
 makeStakeAddressStakeDelegationCertificateImpl :: MonadThrow m => String -> String -> m String
 makeStakeAddressStakeDelegationCertificateImpl skHashStr poolIdStr = do
   stakeCertHash <- readHash skHashStr
   poolId <- readPoolId poolIdStr
-  makeStakeAddressStakeDelegationCertificate Exp.ConwayEra stakeCertHash poolId
+  makeStakeAddressStakeDelegationCertificate currentEra stakeCertHash poolId
 
 -- | Make a certificate that delegates a stake address to a stake pool in the current experimental era.
 makeStakeAddressStakeDelegationCertificateExperimentalEraImpl
   :: MonadThrow m => String -> String -> m String
 makeStakeAddressStakeDelegationCertificateExperimentalEraImpl skHashStr poolIdStr = do
   stakeCertHash <- readHash skHashStr
   poolId <- readPoolId poolIdStr
-  makeStakeAddressStakeDelegationCertificate Exp.DijkstraEra stakeCertHash poolId
+  era <- justOrError "No experimental era available" experimentalEra
+  makeStakeAddressStakeDelegationCertificate era stakeCertHash poolId
 
 makeStakeAddressStakeDelegationCertificate
   :: forall era m. MonadThrow m => Exp.Era era -> Hash StakeKey -> PoolId -> m String
@@ -65,18 +67,19 @@ makeStakeAddressStakeDelegationCertificate era stakeCertHash poolId =
             )
     return $ serialiseCertificateToCBOR era cert
 
--- | Make a stake address registration certificate in Conway era.
+-- | Make a stake address registration certificate in the current era.
 makeStakeAddressRegistrationCertificateImpl :: MonadThrow m => String -> Integer -> m String
 makeStakeAddressRegistrationCertificateImpl skHashStr deposit = do
   skHash <- readHash skHashStr
-  makeStakeAddressRegistrationCertificateWrapper Exp.ConwayEra skHash deposit
+  makeStakeAddressRegistrationCertificateWrapper currentEra skHash deposit
 
 --  | Make a stake address registration certificate in the current experimental era.
 makeStakeAddressRegistrationCertificateExperimentalEraImpl
   :: MonadThrow m => String -> Integer -> m String
 makeStakeAddressRegistrationCertificateExperimentalEraImpl skHashStr deposit = do
   skHash <- readHash skHashStr
-  makeStakeAddressRegistrationCertificateWrapper Exp.DijkstraEra skHash deposit
+  era <- justOrError "No experimental era available" experimentalEra
+  makeStakeAddressRegistrationCertificateWrapper era skHash deposit
 
 makeStakeAddressRegistrationCertificateWrapper
   :: forall era m. MonadThrow m => Era era -> Hash StakeKey -> Integer -> m String
@@ -88,18 +91,19 @@ makeStakeAddressRegistrationCertificateWrapper era skHash deposit =
             (Coin deposit)
     return $ serialiseCertificateToCBOR era cert
 
--- | Make a stake address unregistration certificate in Conway era.
+-- | Make a stake address unregistration certificate in the current era.
 makeStakeAddressUnregistrationCertificateImpl :: MonadThrow m => String -> Integer -> m String
 makeStakeAddressUnregistrationCertificateImpl skHashStr deposit = do
   skHash <- readHash skHashStr
-  makeStakeAddressUnregistrationCertificateWrapper Exp.ConwayEra skHash deposit
+  makeStakeAddressUnregistrationCertificateWrapper currentEra skHash deposit
 
 -- | Make a stake address unregistration certificate in the current experimental era.
 makeStakeAddressUnregistrationCertificateExperimentalEraImpl
   :: MonadThrow m => String -> Integer -> m String
 makeStakeAddressUnregistrationCertificateExperimentalEraImpl skHashStr deposit = do
   skHash <- readHash skHashStr
-  makeStakeAddressUnregistrationCertificateWrapper Exp.DijkstraEra skHash deposit
+  era <- justOrError "No experimental era available" experimentalEra
+  makeStakeAddressUnregistrationCertificateWrapper era skHash deposit
 
 makeStakeAddressUnregistrationCertificateWrapper
   :: forall era m. MonadThrow m => Era era -> Hash StakeKey -> Integer -> m String

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

@@ -12,7 +12,7 @@ import Data.ByteString.Char8 qualified as BS
 newtype GrpcObject grpcClient
   = GrpcObject grpcClient
 
--- | Create a new unsigned transaction object for making a Conway era transaction.
+-- | Create a new gRPC or GRPC-web connection to the Cardano Node.
 newGrpcConnectionImpl :: (String -> IO grpcClient) -> String -> IO (GrpcObject grpcClient)
 newGrpcConnectionImpl createClientFunc host = GrpcObject <$> createClientFunc host
 

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

@@ -458,14 +458,6 @@ apiInfo =
                                   , methodReturnType = NewObject (virtualObjectName unsignedTxObj)
                                   , methodReturnDoc = "A promise that resolves to a new `UnsignedTx` object."
                                   }
-                            , MethodInfoEntry $
-                                MethodInfo
-                                  { methodName = "newConwayTx"
-                                  , methodDoc = "Create a new unsigned transaction in the Conway era."
-                                  , methodParams = []
-                                  , methodReturnType = NewObject (virtualObjectName unsignedTxObj)
-                                  , methodReturnDoc = "A promise that resolves to a new `UnsignedTx` object."
-                                  }
                             ]
                         }
                   , MethodInfoEntry $
@@ -483,13 +475,13 @@ apiInfo =
                         , groupMethods =
                             [ MethodGroupEntry $
                                 MethodGroup
-                                  { groupName = "conway"
-                                  , groupDoc = ["Methods for creating certificates in Conway era."]
+                                  { groupName = "currentEra"
+                                  , groupDoc = ["Methods for creating certificates in the current era."]
                                   , groupMethods =
                                       [ MethodInfoEntry $
                                           MethodInfo
                                             { methodName = "makeStakeAddressStakeDelegationCertificate"
-                                            , methodDoc = "Make a certificate that delegates a stake address to a stake pool in Conway era."
+                                            , methodDoc = "Make a certificate that delegates a stake address to a stake pool in the current era."
                                             , methodParams =
                                                 [ ParamInfo "stakeKeyHash" TSString "The stake key hash in base16 format."
                                                 , ParamInfo "poolId" TSString "The pool ID in base16 format."
@@ -500,7 +492,7 @@ apiInfo =
                                       , MethodInfoEntry $
                                           MethodInfo
                                             { methodName = "makeStakeAddressRegistrationCertificate"
-                                            , methodDoc = "Make a stake address registration certificate in Conway era."
+                                            , methodDoc = "Make a stake address registration certificate in the current era."
                                             , methodParams =
                                                 [ ParamInfo "stakeKeyHash" TSString "The stake key hash in base16 format."
                                                 , ParamInfo "deposit" TSBigInt "The deposit amount in lovelaces."
@@ -511,7 +503,7 @@ apiInfo =
                                       , MethodInfoEntry $
                                           MethodInfo
                                             { methodName = "makeStakeAddressUnregistrationCertificate"
-                                            , methodDoc = "Make a stake address unregistration certificate in Conway era."
+                                            , methodDoc = "Make a stake address unregistration certificate in the current era."
                                             , methodParams =
                                                 [ ParamInfo "stakeKeyHash" TSString "The stake key hash in base16 format."
                                                 , ParamInfo "deposit" TSBigInt "The deposit amount in lovelaces."

cardano-wasm/src-lib/Cardano/Wasm/Api/Tx.hs

@@ -13,7 +13,6 @@ module Cardano.Wasm.Api.Tx
   , ProtocolParamsJSON (..)
   , newTxImpl
   , newExperimentalEraTxImpl
-  , newConwayTxImpl
   , addTxInputImpl
   , addSimpleTxOutImpl
   , appendCertificateToTxImpl
@@ -35,6 +34,7 @@ import Cardano.Api.Tx qualified as TxBody
 
 import Cardano.Ledger.Api qualified as Ledger
 import Cardano.Wasm.ExceptionHandling (justOrError, rightOrError, toMonadFail)
+import Cardano.Wasm.Internal.Api.Era (currentEra, experimentalEra)
 
 import Control.Monad.Catch (MonadThrow)
 import Data.Aeson (ToJSON (toJSON), (.=))
@@ -81,16 +81,13 @@ instance FromJSON UnsignedTxObject where
 
 -- | Create a new unsigned transaction object for making a transaction in the current era.
 newTxImpl :: UnsignedTxObject
-newTxImpl = newConwayTxImpl
+newTxImpl = UnsignedTxObject currentEra (Exp.UnsignedTx (Ledger.mkBasicTx Ledger.mkBasicTxBody))
 
 -- | Create a new unsigned transaction object for making a transaction in the current experimental era.
 newExperimentalEraTxImpl :: MonadThrow m => m UnsignedTxObject
-newExperimentalEraTxImpl =
-  return $ UnsignedTxObject Exp.DijkstraEra (Exp.UnsignedTx (Ledger.mkBasicTx Ledger.mkBasicTxBody))
-
--- | Create a new unsigned transaction object for making a Conway era transaction.
-newConwayTxImpl :: UnsignedTxObject
-newConwayTxImpl = UnsignedTxObject Exp.ConwayEra (Exp.UnsignedTx (Ledger.mkBasicTx Ledger.mkBasicTxBody))
+newExperimentalEraTxImpl = do
+  era <- justOrError "No experimental era available" experimentalEra
+  return $ UnsignedTxObject era (Exp.UnsignedTx (Ledger.mkBasicTx Ledger.mkBasicTxBody))
 
 -- | Add a simple transaction input to an unsigned transaction object.
 addTxInputImpl :: UnsignedTxObject -> Api.TxId -> Api.TxIx -> UnsignedTxObject

cardano-wasm/src-lib/Cardano/Wasm/Internal/Api/Era.hs

@@ -0,0 +1,19 @@
+-- We disable missing signature because DijkstraEra type is not exported yet
+{-# OPTIONS_GHC -Wno-missing-signatures #-}
+
+-- | Module providing constants for the current and experimental eras
+-- used throughout the cardano-wasm library.
+module Cardano.Wasm.Internal.Api.Era
+  ( currentEra
+  , experimentalEra
+  )
+where
+
+import Cardano.Api.Experimental qualified as Exp
+
+-- | The current era used in mainnet.
+currentEra :: Exp.Era Exp.ConwayEra
+currentEra = Exp.ConwayEra
+
+-- | The experimental era, still under development or testing.
+experimentalEra = Just Exp.DijkstraEra

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

@@ -345,9 +345,6 @@ foreign export javascript "newTx"
 foreign export javascript "newExperimentalEraTx"
   newExperimentalEraTx :: IO JSUnsignedTx
 
-foreign export javascript "newConwayTx"
-  newConwayTx :: IO JSUnsignedTx
-
 foreign export javascript "addTxInput"
   addTxInput :: JSUnsignedTx -> JSTxId -> JSTxIx -> IO JSUnsignedTx
 
@@ -384,18 +381,14 @@ foreign export javascript "estimateMinFee"
 foreign export javascript "signWithPaymentKey"
   signWithPaymentKey :: JSUnsignedTx -> JSSigningKey -> IO JSSignedTx
 
--- | Create a new unsigned transaction.
+-- | Create a new unsigned transaction in the current era.
 newTx :: HasCallStack => IO JSUnsignedTx
 newTx = toJSVal Wasm.newTxImpl
 
 -- | Create a new experimental era unsigned transaction.
 newExperimentalEraTx :: HasCallStack => IO JSUnsignedTx
 newExperimentalEraTx = toJSVal =<< Wasm.newExperimentalEraTxImpl
 
--- | Create a new Conway era unsigned transaction.
-newConwayTx :: HasCallStack => IO JSUnsignedTx
-newConwayTx = toJSVal Wasm.newConwayTxImpl
-
 -- | Add a transaction input to an unsigned transaction.
 addTxInput :: HasCallStack => JSUnsignedTx -> JSTxId -> JSTxIx -> IO JSUnsignedTx
 addTxInput jsUnsignedTx jsTxId jsTxIx =
@@ -426,7 +419,7 @@ appendCertificateToTx jsUnsignedTx jsCertCbor =
           <*> fromJSVal jsCertCbor
       )
 
--- | Make a certificate that delegates a stake address to a stake pool in Conway era.
+-- | Make a certificate that delegates a stake address to a stake pool in the current era.
 makeStakeAddressStakeDelegationCertificate :: HasCallStack => JSString -> JSString -> IO JSString
 makeStakeAddressStakeDelegationCertificate jsStakeKeyHash jsPoolId =
   toJSVal
@@ -446,7 +439,7 @@ makeStakeAddressStakeDelegationCertificateExperimentalEra jsStakeKeyHash jsPoolI
           <*> fromJSVal jsPoolId
       )
 
--- | Make a stake address registration certificate in Conway era.
+-- | Make a stake address registration certificate in the current era.
 makeStakeAddressRegistrationCertificate :: HasCallStack => JSString -> JSCoin -> IO JSString
 makeStakeAddressRegistrationCertificate jsStakeKeyHash jsDeposit =
   toJSVal
@@ -466,7 +459,7 @@ makeStakeAddressRegistrationCertificateExperimentalEra jsStakeKeyHash jsDeposit
           <*> (fromInteger <$> fromJSBigInt jsDeposit)
       )
 
--- | Make a stake address unregistration certificate in Conway era.
+-- | Make a stake address unregistration certificate in the current era.
 makeStakeAddressUnregistrationCertificate :: HasCallStack => JSString -> JSCoin -> IO JSString
 makeStakeAddressUnregistrationCertificate jsStakeKeyHash jsDeposit =
   toJSVal
@@ -559,7 +552,7 @@ foreign export javascript "getUtxosForAddress"
 foreign export javascript "submitTx"
   submitTx :: JSGrpc -> JSString -> IO JSString
 
--- | Create a new gRPC object for making Conway era transactions.
+-- | Create a new gRPC object.
 newGrpcConnection :: HasCallStack => JSString -> IO JSGrpc
 newGrpcConnection webGrpcUrl = toJSVal =<< join (Wasm.newGrpcConnectionImpl js_newWebGrpcClient <$> fromJSVal webGrpcUrl)