Skip to content

Commit 9ad265b

Browse files
committed
Fix doc links
1 parent c03a7e5 commit 9ad265b

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

mithril-common/src/crypto_helper/cardano/key_certification.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ pub enum ProtocolInitializerErrorWrapper {
7979
#[error("KES key cannot be updated for period {0}")]
8080
KesUpdate(KESPeriod),
8181
}
82-
/// Wrapper structure for [MithrilStm:StmInitializer](mithril::stm::StmInitializer).
82+
/// Wrapper structure for [MithrilStm:StmInitializer](mithril_stm::stm::StmInitializer).
8383
/// It now obtains a KES signature over the Mithril key. This allows the signers prove
8484
/// their correct identity with respect to a Cardano PoolID.
8585
#[derive(Debug, Clone, Serialize, Deserialize)]
@@ -88,7 +88,7 @@ pub struct StmInitializerWrapper {
8888
kes_signature: Option<ProtocolSignerVerificationKeySignature>, // todo: The option is ONLY for a smooth transition. We have to remove this.
8989
}
9090

91-
/// Wrapper structure for [MithrilStm:KeyReg](mithril::key_reg::KeyReg).
91+
/// Wrapper structure for [MithrilStm:KeyReg](mithril_stm::key_reg::KeyReg).
9292
/// The wrapper not only contains a map between `Mithril vkey <-> Stake`, but also
9393
/// a map `PoolID <-> Stake`. This information is recovered from the node state, and
9494
/// is used to verify the identity of a Mithril signer. Furthermore, the `register` function

mithril-common/src/crypto_helper/types.rs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,43 +24,43 @@ type D = Blake2b<U32>;
2424
/// The id of a mithril party.
2525
pub type ProtocolPartyId = String;
2626

27-
/// Alias of [MithrilStm:Stake](type@mithril::stm::Stake).
27+
/// Alias of [MithrilStm:Stake](type@mithril_stm::stm::Stake).
2828
pub type ProtocolStake = Stake;
2929

3030
/// A list of [Party Id][ProtocolPartyId] associated with its [Stake][ProtocolStake].
3131
pub type ProtocolStakeDistribution = Vec<(ProtocolPartyId, ProtocolStake)>;
3232

33-
/// Alias of [MithrilStm::StmParameters](struct@mithril::stm::StmParameters).
33+
/// Alias of [MithrilStm::StmParameters](struct@mithril_stm::stm::StmParameters).
3434
pub type ProtocolParameters = StmParameters;
3535

36-
/// Alias of [MithrilStm::Index](type@mithril::stm::Index).
36+
/// Alias of [MithrilStm::Index](type@mithril_stm::stm::Index).
3737
pub type ProtocolLotteryIndex = Index;
3838

39-
/// Alias of [MithrilStm:StmSigner](struct@mithril::stm::StmSigner).
39+
/// Alias of [MithrilStm:StmSigner](struct@mithril_stm::stm::StmSigner).
4040
pub type ProtocolSigner = StmSigner<D>;
4141

42-
/// Alias of a wrapper of [MithrilStm:StmInitializer](struct@mithril::stm::StmInitializer).
42+
/// Alias of a wrapper of [MithrilStm:StmInitializer](struct@mithril_stm::stm::StmInitializer).
4343
pub type ProtocolInitializer = StmInitializerWrapper;
4444

45-
/// Alias of [MithrilStm:StmClerk](struct@mithril::stm::StmClerk).
45+
/// Alias of [MithrilStm:StmClerk](struct@mithril_stm::stm::StmClerk).
4646
pub type ProtocolClerk = StmClerk<D>;
4747

48-
/// Alias of a wrapper of [MithrilStm:KeyReg](struct@mithril::key_reg::KeyReg).
48+
/// Alias of a wrapper of [MithrilStm:KeyReg](struct@mithril_stm::key_reg::KeyReg).
4949
pub type ProtocolKeyRegistration = KeyRegWrapper;
5050

51-
/// Alias of [MithrilStm:StmSig](struct@mithril::stm::StmSig).
51+
/// Alias of [MithrilStm:StmSig](struct@mithril_stm::stm::StmSig).
5252
pub type ProtocolSingleSignature = StmSig;
5353

54-
/// Alias of [MithrilStm:StmAggrSig](struct@mithril::stm::StmAggrSig).
54+
/// Alias of [MithrilStm:StmAggrSig](struct@mithril_stm::stm::StmAggrSig).
5555
pub type ProtocolMultiSignature = StmAggrSig<D>;
5656

57-
/// Alias of [MithrilStm:StmVerificationKeyPoP](type@mithril::stm::StmVerificationKeyPoP).
57+
/// Alias of [MithrilStm:StmVerificationKeyPoP](type@mithril_stm::stm::StmVerificationKeyPoP).
5858
pub type ProtocolSignerVerificationKey = StmVerificationKeyPoP;
5959

6060
/// Alias of [KES:Sum6KesSig](https://github.com/input-output-hk/kes/blob/master/src/kes.rs).
6161
pub type ProtocolSignerVerificationKeySignature = Sum6KesSig;
6262

63-
/// Alias of [MithrilStm:StmAggrVerificationKey](struct@mithril::stm::StmAggrVerificationKey).
63+
/// Alias of [MithrilStm:StmAggrVerificationKey](struct@mithril_stm::stm::StmAggrVerificationKey).
6464
pub type ProtocolAggregateVerificationKey = StmAggrVerificationKey<D>;
6565

6666
/// Alias of [Ed25519:PublicKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.PublicKey.html).
@@ -73,17 +73,17 @@ pub type ProtocolGenesisSecretKey = ed25519_dalek::SecretKey;
7373
pub type ProtocolGenesisSignature = ed25519_dalek::Signature;
7474

7575
// Error alias
76-
/// Alias of a wrapper of [MithrilStm:RegisterError](enum@mithril::RegisterError).
76+
/// Alias of a wrapper of [MithrilStm:RegisterError](enum@mithril_stm::RegisterError).
7777
pub type ProtocolRegistrationError = ProtocolRegistrationErrorWrapper;
7878

79-
/// Alias of [MithrilStm:AggregationError](enum@mithril::AggregationError).
79+
/// Alias of [MithrilStm:AggregationError](enum@mithril_stm::AggregationError).
8080
pub type ProtocolAggregationError = AggregationError;
8181

8282
// Test only
83-
/// (Test only) Alias of [MithrilStm:StmInitializer](struct@mithril::stm::StmInitializer).
83+
/// (Test only) Alias of [MithrilStm:StmInitializer](struct@mithril_stm::stm::StmInitializer).
8484
#[cfg(any(test, feature = "allow_skip_signer_certification"))]
8585
pub type ProtocolInitializerNotCertified = StmInitializer;
8686

87-
/// (Test only) Alias of [MithrilStm:KeyReg](struct@mithril::key_reg::KeyReg). (Test only)
87+
/// (Test only) Alias of [MithrilStm:KeyReg](struct@mithril_stm::key_reg::KeyReg). (Test only)
8888
#[cfg(any(test, feature = "allow_skip_signer_certification"))]
8989
pub type ProtocolKeyRegistrationNotCertified = KeyReg;

0 commit comments

Comments
 (0)