Skip to content

Commit 82d5896

Browse files
committed
Delete public Cardano.Api.Certificate module and update consumers
The public `Cardano.Api.Certificate` module exists only to re-export deprecated names. Delete it (and the cabal `exposed-modules` entry, and the `Cardano.Api` re-export) and migrate every remaining consumer to `Cardano.Api.Experimental.Certificate`. Test modules pick up `KESPeriod`, `OperationalCertificate`, `OperationalCertificateIssueCounter`, `issueOperationalCertificate`, `AsOperationalCertificate`, `AsOperationalCertificateIssueCounter`, `DRepMetadata`, `OperationalCertIssueError`, and `StakePoolMetadataValidationError` from the experimental module directly. `cardano-wasm` switches its `PoolId` import to the experimental module. `Cardano.Api.Tx.Internal.Body` swaps its `Cardano.Api.Certificate` import for the internal module (where the re-exports still live for now). `Cardano.Api.Certificate.Internal` itself is unchanged in this commit — the slim-down happens next.
1 parent 1d95f89 commit 82d5896

9 files changed

Lines changed: 16 additions & 88 deletions

File tree

cardano-api/cardano-api.cabal

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ library
7272
Cardano.Api.Address
7373
Cardano.Api.Block
7474
Cardano.Api.Byron
75-
Cardano.Api.Certificate
7675
Cardano.Api.Compatible
7776
Cardano.Api.Compatible.Certificate
7877
Cardano.Api.Compatible.Tx

cardano-api/gen/Test/Gen/Cardano/Api/Typed.hs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,12 @@ import Cardano.Api qualified as Api
157157
import Cardano.Api.Byron qualified as Byron
158158
import Cardano.Api.Experimental qualified as Exp
159159
import Cardano.Api.Experimental.AnyScriptWitness
160+
import Cardano.Api.Experimental.Certificate
161+
( KESPeriod (..)
162+
, OperationalCertificate (..)
163+
, OperationalCertificateIssueCounter (..)
164+
, issueOperationalCertificate
165+
)
160166
import Cardano.Api.Experimental.Plutus qualified as Exp
161167
import Cardano.Api.Ledger qualified as L
162168
import Cardano.Api.Parser.Text qualified as P

cardano-api/src/Cardano/Api.hs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ module Cardano.Api
1111
( -- * Address
1212
module Cardano.Api.Address
1313

14-
-- * Certificate
15-
, module Cardano.Api.Certificate
16-
1714
-- * Genesis
1815
, module Cardano.Api.Genesis
1916

@@ -78,7 +75,6 @@ where
7875

7976
import Cardano.Api.Address
8077
import Cardano.Api.Block
81-
import Cardano.Api.Certificate
8278
import Cardano.Api.Consensus
8379
import Cardano.Api.Era
8480
import Cardano.Api.Error

cardano-api/src/Cardano/Api/Certificate.hs

Lines changed: 0 additions & 79 deletions
This file was deleted.

cardano-api/src/Cardano/Api/Tx/Internal/Body.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ where
238238

239239
import Cardano.Api.Address
240240
import Cardano.Api.Byron.Internal.Key
241-
import Cardano.Api.Certificate
241+
import Cardano.Api.Certificate.Internal
242242
import Cardano.Api.Era.Internal.Case
243243
import Cardano.Api.Era.Internal.Core
244244
import Cardano.Api.Era.Internal.Eon.AllegraEraOnwards

cardano-api/test/cardano-api-golden/Test/Golden/ErrorsSpec.hs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ module Test.Golden.ErrorsSpec
3131
where
3232

3333
import Cardano.Api
34+
import Cardano.Api.Experimental.Certificate
35+
( OperationalCertIssueError (..)
36+
, StakePoolMetadataValidationError (..)
37+
)
3438

3539
import Cardano.Binary as CBOR
3640
import Cardano.Crypto.Seed qualified as Crypto

cardano-api/test/cardano-api-test/Test/Cardano/Api/CBOR.hs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ where
1414

1515
import Cardano.Api
1616
import Cardano.Api.Experimental qualified as Exp
17+
import Cardano.Api.Experimental.Certificate
18+
( AsType (AsOperationalCertificate, AsOperationalCertificateIssueCounter)
19+
)
1720
import Cardano.Api.Ledger qualified as Ledger
1821

1922
import Cardano.Binary qualified as CBOR

cardano-api/test/cardano-api-test/Test/Cardano/Api/GovAnchorValidation.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import Cardano.Api
1414
, FileError
1515
, readByteStringFile
1616
)
17-
import Cardano.Api.Certificate (DRepMetadata (..))
17+
import Cardano.Api.Experimental.Certificate (DRepMetadata (..))
1818
import Cardano.Api.Governance (validateGovActionAnchorData)
1919

2020
import Data.ByteString (ByteString)

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@ where
1818
import Cardano.Api
1919
( Coin (..)
2020
, Hash
21-
, PoolId
2221
, StakeKey
2322
, serialiseToCBOR
2423
, unStakePoolKeyHash
2524
)
2625
import Cardano.Api.Address (StakeCredential (..))
2726
import Cardano.Api.Experimental (Era (..), obtainCommonConstraints)
2827
import Cardano.Api.Experimental qualified as Exp
29-
import Cardano.Api.Experimental.Certificate (Certificate (..))
28+
import Cardano.Api.Experimental.Certificate (Certificate (..), PoolId)
3029
import Cardano.Api.Serialise.Raw qualified as Api
3130

3231
import Cardano.Ledger.Api (Delegatee (DelegStake))

0 commit comments

Comments
 (0)