Skip to content

Commit

Permalink
fix documentation for ismp-grandpa crates
Browse files Browse the repository at this point in the history
  • Loading branch information
seunlanlege committed Sep 19, 2024
1 parent d817801 commit cf3fd38
Show file tree
Hide file tree
Showing 17 changed files with 46 additions and 34 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ ismp-solidity-abi = { path = "./evm/abi", default-features = false }
simnode-tests = { path = "parachain/simtests" }
hyperclient = { path = "modules/hyperclient", default-features = false }
subxt-utils = { path = "modules/utils/subxt", default-features = false }
serde-utils = { path = "modules/utils/serde", default-features = false }
serde-utils = { version = "0.1.0", path = "modules/utils/serde", default-features = false }

# consensus provers & verifiers
beefy-verifier-primitives = { path = "./modules/consensus/beefy/primitives", default-features = false }
Expand Down
8 changes: 3 additions & 5 deletions modules/consensus/grandpa/primitives/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
documentation = "https://docs.rs/ismp-parachain"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/grandpa-verifier-primitives"
description = "Primitives for verifying GRANDPA consensus proofs"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
readme = "./README.md"

keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability", "GRANDPA"]

[dependencies]
# crates.io
Expand Down
7 changes: 3 additions & 4 deletions modules/consensus/grandpa/verifier/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
documentation = "https://docs.rs/ismp-parachain"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/grandpa-verifier"
description = "GRANDPA consensus proof verifier"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
readme = "./README.md"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability", "GRANDPA"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
Expand Down
6 changes: 3 additions & 3 deletions modules/ismp/clients/grandpa/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
documentation = "https://docs.rs/ismp-parachain"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/ismp-grandpa"
description = "GRANDPA consensus client for pallet-ismp"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability", "GRANDPA"]
readme = "./README.md"

[dependencies]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/clients/parachain/client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/ismp-parachain"
description = "Parachain consensus client for pallet-ismp"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/clients/parachain/inherent/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/ismp-parachain-inherent"
description = "ISMP parachain consensus client inherent provider"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/clients/parachain/runtime-api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/ismp-parachain"
description = "Substrate runtime API for the ISMP Parachain consensus client"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/pallets/hyperbridge/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/pallet-hyperbridge"
description = "Pallet hyperbridge mediates the connection between hyperbridge and substrate-based chains."
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/pallets/pallet/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/pallet-ismp"
description = "The substrate runtime implementation of the Interoperable State Machine Protocol"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/pallets/rpc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/pallet-ismp-rpc"
description = "RPC apis for pallet-ismp"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/pallets/runtime-api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/pallet-ismp"
description = "The substrate runtime API for pallet-ismp"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/ismp/state-machines/substrate/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/substrate-state-machine"
description = "ISMP state machine client implementation for substrate-based chains "
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
2 changes: 1 addition & 1 deletion modules/trees/mmr/primitives/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
homepage = "https://docs.hyperbridge.network/developers/polkadot/integration"
documentation = "https://docs.rs/ismp-parachain"
description = "Merkle mountain range primitives for pallet-ismp"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
Expand Down
7 changes: 3 additions & 4 deletions modules/utils/serde/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ edition = "2021"
authors = ["Polytope Labs <[email protected]>"]
license = "Apache-2.0"
repository = "https://github.com/polytope-labs/hyperbridge"
homepage = "https://docs.hyperbridge.network/integrations/polkadot-sdk"
documentation = "https://docs.rs/ismp-parachain"
description = "Serde utilities for ismp"
keywords = ["substrate", "polkadot-sdk", "ISMP", "interoperability"]
documentation = "https://docs.rs/serde-utils"
description = "Collection of useful (De)serialization utilities for serde"
keywords = ["serde", "utilities"]
readme = "./README.md"

[dependencies]
Expand Down
3 changes: 3 additions & 0 deletions modules/utils/serde/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# serde utilities

Collection of useful (De)serialization utilities for serde
25 changes: 17 additions & 8 deletions parachain/runtimes/messier/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ mod ismp;
mod weights;
pub mod xcm;

use alloc::sync::Arc;
use cumulus_primitives_core::AggregateMessageOrigin;
use frame_support::traits::TransformOrigin;
use parachains_common::message_queue::{NarrowOriginToSibling, ParaIdToSibling};
Expand Down Expand Up @@ -314,9 +313,9 @@ use pallet_collective::PrimeDefaultVote;
use pallet_ismp::mmr::Leaf;
#[cfg(feature = "runtime-benchmarks")]
use pallet_treasury::ArgumentsFactory;
use sp_core::crypto::{AccountId32, FromEntropy};
use sp_core::crypto::AccountId32;
use sp_runtime::traits::IdentityLookup;
use staging_xcm::latest::{Junction, Junctions::X1, Location};
use staging_xcm::latest::Location;

#[derive_impl(frame_system::config_preludes::ParaChainDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Runtime {
Expand Down Expand Up @@ -586,11 +585,16 @@ pub struct TreasuryAssetFactory {}
impl<A, B> ArgumentsFactory<A, B> for TreasuryAssetFactory
where
A: From<Location>,
B: FromEntropy,
B: sp_core::crypto::FromEntropy,
{
fn create_asset_kind(seed: u32) -> A {
Location { parents: 0, interior: X1(Arc::new([Junction::GeneralIndex(seed as u128)])) }
.into()
Location {
parents: 0,
interior: staging_xcm::latest::Junction::X1(alloc::sync::Arc::new([
staging_xcm::latest::Junction::GeneralIndex(seed as u128),
])),
}
.into()
}

fn create_beneficiary(seed: [u8; 32]) -> B {
Expand All @@ -604,8 +608,13 @@ where
A: From<Location>,
{
fn create_asset_kind(seed: u32) -> A {
Location { parents: 0, interior: X1(Arc::new([Junction::GeneralIndex(seed as u128)])) }
.into()
Location {
parents: 0,
interior: staging_xcm::latest::Junction::X1(alloc::sync::Arc::new([
staging_xcm::latest::Junction::GeneralIndex(seed as u128),
])),
}
.into()
}
}

Expand Down
4 changes: 4 additions & 0 deletions scripts/release-crates.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/bin/bash

cargo release \
-p serde-utils \
-p ismp \
-p mmr-primitives \
-p pallet-hyperbridge \
Expand All @@ -9,6 +10,9 @@ cargo release \
-p pallet-ismp-rpc \
-p substrate-state-machine \
-p ismp-parachain \
-p grandpa-verifier-primitives \
-p grandpa-verifier \
-p ismp-grandpa \
-p ismp-parachain-runtime-api \
-p ismp-parachain-inherent \
--execute

0 comments on commit cf3fd38

Please sign in to comment.