Skip to content

Commit 93bd235

Browse files
palaspalas
committed
Rename references to "experimental" era to "upcoming" era
1 parent fafbced commit 93bd235

File tree

6 files changed

+75
-75
lines changed

6 files changed

+75
-75
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ declare interface CardanoApi {
2626
newTx(): Promise<UnsignedTx>;
2727

2828
/**
29-
* Create a new unsigned transaction in the current experimental era (currently Dijkstra).
29+
* Create a new unsigned transaction in the current upcoming era (currently Dijkstra).
3030
* @returns A promise that resolves to a new `UnsignedTx` object.
3131
*/
32-
newExperimentalEraTx(): Promise<UnsignedTx>;
32+
newUpcomingEraTx(): Promise<UnsignedTx>;
3333
}
3434

3535
/**
@@ -73,32 +73,32 @@ declare interface CardanoApi {
7373
}
7474

7575
/**
76-
* Methods for creating certificates in the current experimental era (currently Dijkstra).
76+
* Methods for creating certificates in the current upcoming era (currently Dijkstra).
7777
*/
78-
experimentalEra: {
78+
upcomingEra: {
7979
/**
80-
* Make a certificate that delegates a stake address to a stake pool in the current experimental era (currently Dijkstra).
80+
* Make a certificate that delegates a stake address to a stake pool in the current upcoming era (currently Dijkstra).
8181
* @param stakeKeyHash The stake key hash in base16 format.
8282
* @param poolId The pool ID in base16 format.
8383
* @returns A promise that resolves to the CBOR-encoded certificate as a hex string.
8484
*/
85-
makeStakeAddressStakeDelegationCertificateExperimentalEra(stakeKeyHash: string, poolId: string): Promise<string>;
85+
makeStakeAddressStakeDelegationCertificateUpcomingEra(stakeKeyHash: string, poolId: string): Promise<string>;
8686

8787
/**
88-
* Make a stake address registration certificate in the current experimental era (currently Dijkstra).
88+
* Make a stake address registration certificate in the current upcoming era (currently Dijkstra).
8989
* @param stakeKeyHash The stake key hash in base16 format.
9090
* @param deposit The deposit amount in lovelaces.
9191
* @returns A promise that resolves to the CBOR-encoded certificate as a hex string.
9292
*/
93-
makeStakeAddressRegistrationCertificateExperimentalEra(stakeKeyHash: string, deposit: bigint): Promise<string>;
93+
makeStakeAddressRegistrationCertificateUpcomingEra(stakeKeyHash: string, deposit: bigint): Promise<string>;
9494

9595
/**
96-
* Make a stake address unregistration certificate in the current experimental era (currently Dijkstra).
96+
* Make a stake address unregistration certificate in the current upcoming era (currently Dijkstra).
9797
* @param stakeKeyHash The stake key hash in base16 format.
9898
* @param deposit The deposit amount in lovelaces.
9999
* @returns A promise that resolves to the CBOR-encoded certificate as a hex string.
100100
*/
101-
makeStakeAddressUnregistrationCertificateExperimentalEra(stakeKeyHash: string, deposit: bigint): Promise<string>;
101+
makeStakeAddressUnregistrationCertificateUpcomingEra(stakeKeyHash: string, deposit: bigint): Promise<string>;
102102
}
103103
}
104104

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
module Cardano.Wasm.Api.Certificate.StakeCertificate
99
( makeStakeAddressStakeDelegationCertificateImpl
10-
, makeStakeAddressStakeDelegationCertificateExperimentalEraImpl
10+
, makeStakeAddressStakeDelegationCertificateUpcomingEraImpl
1111
, makeStakeAddressRegistrationCertificateImpl
12-
, makeStakeAddressRegistrationCertificateExperimentalEraImpl
12+
, makeStakeAddressRegistrationCertificateUpcomingEraImpl
1313
, makeStakeAddressUnregistrationCertificateImpl
14-
, makeStakeAddressUnregistrationCertificateExperimentalEraImpl
14+
, makeStakeAddressUnregistrationCertificateUpcomingEraImpl
1515
)
1616
where
1717

@@ -31,7 +31,7 @@ import Cardano.Api.Serialise.Raw qualified as Api
3131

3232
import Cardano.Ledger.Api (Delegatee (DelegStake))
3333
import Cardano.Wasm.ExceptionHandling (justOrError, rightOrError)
34-
import Cardano.Wasm.Internal.Api.Era (currentEra, experimentalEra)
34+
import Cardano.Wasm.Internal.Api.Era (currentEra, upcomingEra)
3535

3636
import Control.Monad.Catch (MonadThrow)
3737
import Data.ByteString.Base16 qualified as Base16
@@ -62,13 +62,13 @@ makeStakeAddressStakeDelegationCertificateImpl skHashStr poolIdStr = do
6262
poolId <- readPoolId poolIdStr
6363
makeStakeAddressStakeDelegationCertificate currentEra stakeCertHash poolId
6464

65-
-- | Make a certificate that delegates a stake address to a stake pool in the current experimental era.
66-
makeStakeAddressStakeDelegationCertificateExperimentalEraImpl
65+
-- | Make a certificate that delegates a stake address to a stake pool in the current upcoming era.
66+
makeStakeAddressStakeDelegationCertificateUpcomingEraImpl
6767
:: MonadThrow m => StakeKeyHashBase16 -> PoolIdBase16 -> m CertificateCBORBase16
68-
makeStakeAddressStakeDelegationCertificateExperimentalEraImpl skHashStr poolIdStr = do
68+
makeStakeAddressStakeDelegationCertificateUpcomingEraImpl skHashStr poolIdStr = do
6969
stakeCertHash <- readHash skHashStr
7070
poolId <- readPoolId poolIdStr
71-
era <- justOrError "No experimental era available" experimentalEra
71+
era <- justOrError "No upcoming era available" upcomingEra
7272
makeStakeAddressStakeDelegationCertificate era stakeCertHash poolId
7373

7474
makeStakeAddressStakeDelegationCertificate
@@ -91,12 +91,12 @@ makeStakeAddressRegistrationCertificateImpl skHashStr deposit = do
9191
skHash <- readHash skHashStr
9292
makeStakeAddressRegistrationCertificateWrapper currentEra skHash deposit
9393

94-
--  | Make a stake address registration certificate in the current experimental era.
95-
makeStakeAddressRegistrationCertificateExperimentalEraImpl
94+
--  | Make a stake address registration certificate in the upcoming era.
95+
makeStakeAddressRegistrationCertificateUpcomingEraImpl
9696
:: MonadThrow m => StakeKeyHashBase16 -> DepositLovelace -> m CertificateCBORBase16
97-
makeStakeAddressRegistrationCertificateExperimentalEraImpl skHashStr deposit = do
97+
makeStakeAddressRegistrationCertificateUpcomingEraImpl skHashStr deposit = do
9898
skHash <- readHash skHashStr
99-
era <- justOrError "No experimental era available" experimentalEra
99+
era <- justOrError "No upcoming era available" upcomingEra
100100
makeStakeAddressRegistrationCertificateWrapper era skHash deposit
101101

102102
makeStakeAddressRegistrationCertificateWrapper
@@ -116,12 +116,12 @@ makeStakeAddressUnregistrationCertificateImpl skHashStr deposit = do
116116
skHash <- readHash skHashStr
117117
makeStakeAddressUnregistrationCertificateWrapper currentEra skHash deposit
118118

119-
-- | Make a stake address unregistration certificate in the current experimental era.
120-
makeStakeAddressUnregistrationCertificateExperimentalEraImpl
119+
-- | Make a stake address unregistration certificate in the upcoming era.
120+
makeStakeAddressUnregistrationCertificateUpcomingEraImpl
121121
:: MonadThrow m => StakeKeyHashBase16 -> DepositLovelace -> m CertificateCBORBase16
122-
makeStakeAddressUnregistrationCertificateExperimentalEraImpl skHashStr deposit = do
122+
makeStakeAddressUnregistrationCertificateUpcomingEraImpl skHashStr deposit = do
123123
skHash <- readHash skHashStr
124-
era <- justOrError "No experimental era available" experimentalEra
124+
era <- justOrError "No upcoming era available" upcomingEra
125125
makeStakeAddressUnregistrationCertificateWrapper era skHash deposit
126126

127127
makeStakeAddressUnregistrationCertificateWrapper

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ where
1717
import Cardano.Api (pretty)
1818
import Cardano.Api.Experimental.Era qualified as Exp
1919

20-
import Cardano.Wasm.Internal.Api.Era (currentEra, experimentalEra)
20+
import Cardano.Wasm.Internal.Api.Era (currentEra, upcomingEra)
2121

2222
import Data.Aeson qualified as Aeson
2323
import Data.Text qualified as Text
@@ -450,10 +450,10 @@ apiInfo =
450450
}
451451
, MethodInfoEntry $
452452
MethodInfo
453-
{ methodName = "newExperimentalEraTx"
453+
{ methodName = "newUpcomingEraTx"
454454
, methodDoc =
455-
"Create a new unsigned transaction in the current experimental era "
456-
++ getEraCommentFor experimentalEra
455+
"Create a new unsigned transaction in the current upcoming era "
456+
++ getEraCommentFor upcomingEra
457457
++ "."
458458
, methodParams = []
459459
, methodReturnType = NewObject (virtualObjectName unsignedTxObj)
@@ -527,19 +527,19 @@ apiInfo =
527527
}
528528
, MethodGroupEntry $
529529
MethodGroup
530-
{ groupName = "experimentalEra"
530+
{ groupName = "upcomingEra"
531531
, groupDoc =
532-
[ "Methods for creating certificates in the current experimental era "
533-
++ getEraCommentFor experimentalEra
532+
[ "Methods for creating certificates in the current upcoming era "
533+
++ getEraCommentFor upcomingEra
534534
++ "."
535535
]
536536
, groupMethods =
537537
[ MethodInfoEntry $
538538
MethodInfo
539-
{ methodName = "makeStakeAddressStakeDelegationCertificateExperimentalEra"
539+
{ methodName = "makeStakeAddressStakeDelegationCertificateUpcomingEra"
540540
, methodDoc =
541-
"Make a certificate that delegates a stake address to a stake pool in the current experimental era "
542-
++ getEraCommentFor experimentalEra
541+
"Make a certificate that delegates a stake address to a stake pool in the current upcoming era "
542+
++ getEraCommentFor upcomingEra
543543
++ "."
544544
, methodParams =
545545
[ ParamInfo "stakeKeyHash" TSString "The stake key hash in base16 format."
@@ -550,10 +550,10 @@ apiInfo =
550550
}
551551
, MethodInfoEntry $
552552
MethodInfo
553-
{ methodName = "makeStakeAddressRegistrationCertificateExperimentalEra"
553+
{ methodName = "makeStakeAddressRegistrationCertificateUpcomingEra"
554554
, methodDoc =
555-
"Make a stake address registration certificate in the current experimental era "
556-
++ getEraCommentFor experimentalEra
555+
"Make a stake address registration certificate in the current upcoming era "
556+
++ getEraCommentFor upcomingEra
557557
++ "."
558558
, methodParams =
559559
[ ParamInfo "stakeKeyHash" TSString "The stake key hash in base16 format."
@@ -564,10 +564,10 @@ apiInfo =
564564
}
565565
, MethodInfoEntry $
566566
MethodInfo
567-
{ methodName = "makeStakeAddressUnregistrationCertificateExperimentalEra"
567+
{ methodName = "makeStakeAddressUnregistrationCertificateUpcomingEra"
568568
, methodDoc =
569-
"Make a stake address unregistration certificate in the current experimental era "
570-
++ getEraCommentFor experimentalEra
569+
"Make a stake address unregistration certificate in the current upcoming era "
570+
++ getEraCommentFor upcomingEra
571571
++ "."
572572
, methodParams =
573573
[ ParamInfo "stakeKeyHash" TSString "The stake key hash in base16 format."

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module Cardano.Wasm.Api.Tx
1212
( UnsignedTxObject (..)
1313
, ProtocolParamsJSON (..)
1414
, newTxImpl
15-
, newExperimentalEraTxImpl
15+
, newUpcomingEraTxImpl
1616
, addTxInputImpl
1717
, addSimpleTxOutImpl
1818
, appendCertificateToTxImpl
@@ -34,7 +34,7 @@ import Cardano.Api.Tx qualified as TxBody
3434

3535
import Cardano.Ledger.Api qualified as Ledger
3636
import Cardano.Wasm.ExceptionHandling (justOrError, rightOrError, toMonadFail)
37-
import Cardano.Wasm.Internal.Api.Era (currentEra, experimentalEra)
37+
import Cardano.Wasm.Internal.Api.Era (currentEra, upcomingEra)
3838

3939
import Control.Monad.Catch (MonadThrow)
4040
import Data.Aeson (ToJSON (toJSON), (.=))
@@ -83,10 +83,10 @@ instance FromJSON UnsignedTxObject where
8383
newTxImpl :: UnsignedTxObject
8484
newTxImpl = UnsignedTxObject currentEra (Exp.UnsignedTx (Ledger.mkBasicTx Ledger.mkBasicTxBody))
8585

86-
-- | Create a new unsigned transaction object for making a transaction in the current experimental era.
87-
newExperimentalEraTxImpl :: MonadThrow m => m UnsignedTxObject
88-
newExperimentalEraTxImpl = do
89-
era <- justOrError "No experimental era available" experimentalEra
86+
-- | Create a new unsigned transaction object for making a transaction in the current upcoming era.
87+
newUpcomingEraTxImpl :: MonadThrow m => m UnsignedTxObject
88+
newUpcomingEraTxImpl = do
89+
era <- justOrError "No upcoming era available" upcomingEra
9090
return $ UnsignedTxObject era (Exp.UnsignedTx (Ledger.mkBasicTx Ledger.mkBasicTxBody))
9191

9292
-- | Add a simple transaction input to an unsigned transaction object.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
-- We disable missing signature because DijkstraEra type is not exported yet
22
{-# OPTIONS_GHC -Wno-missing-signatures #-}
33

4-
-- | Module providing constants for the current and experimental eras
4+
-- | Module providing constants for the current and upcoming eras
55
-- used throughout the cardano-wasm library.
66
module Cardano.Wasm.Internal.Api.Era
77
( currentEra
8-
, experimentalEra
8+
, upcomingEra
99
)
1010
where
1111

@@ -15,5 +15,5 @@ import Cardano.Api.Experimental qualified as Exp
1515
currentEra :: Exp.Era Exp.ConwayEra
1616
currentEra = Exp.ConwayEra
1717

18-
-- | The experimental era, still under development or testing.
19-
experimentalEra = Just Exp.DijkstraEra
18+
-- | The upcoming era, still under development or testing.
19+
upcomingEra = Just Exp.DijkstraEra

0 commit comments

Comments
 (0)