Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the process to launch your first (omni) node #3946

Closed
wants to merge 29 commits into from
Closed
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
caa30ea
Create docs
kianenigma Oct 22, 2023
3acf463
Rename docs to docs.yml
kianenigma Oct 22, 2023
dcf4cb1
Update docs.yml
kianenigma Oct 22, 2023
4c0725b
Merge branch 'paritytech:master' into master
kianenigma Feb 20, 2024
6cdf818
Merge branch 'master' of github.com:paritytech/polkadot-sdk
kianenigma Mar 1, 2024
37d38f9
Merge branch 'master' of github.com:paritytech/polkadot-sdk
kianenigma Mar 12, 2024
71bfa2d
Merge branch 'master' of github.com:paritytech/polkadot-sdk
kianenigma Mar 26, 2024
cd27a21
add guide step 2, build your own runtime
kianenigma Mar 28, 2024
a1e76f5
Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…
kianenigma Mar 28, 2024
ad27452
clean up the runtime section
kianenigma Mar 28, 2024
79ada5e
jot down ideas for node section
kianenigma Mar 28, 2024
99c43e3
add a run-your-node-section
kianenigma Apr 2, 2024
360b542
some fixes, merging master
kianenigma Apr 2, 2024
92ad95b
Master.into()
kianenigma Apr 2, 2024
43be5fa
Fixes runtime macro issue
gupnik Apr 2, 2024
7061b5b
prepare for PR
kianenigma Apr 2, 2024
a8c06c5
merged
kianenigma Apr 2, 2024
6518a76
Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…
kianenigma Apr 2, 2024
68acc52
fix?
kianenigma Apr 2, 2024
181ba3f
update
kianenigma Apr 2, 2024
7d5f122
remove native stuff that's not needed
kianenigma Apr 2, 2024
fe7703f
Master.into()
kianenigma Apr 5, 2024
9aacc47
Master.into()
kianenigma Apr 5, 2024
6eb6fbb
Master.into()
kianenigma Apr 26, 2024
623f870
Update docs/sdk/packages/guides/first-pallet/src/lib.rs
kianenigma Jul 23, 2024
64acf7d
Update docs/sdk/packages/guides/first-pallet/src/lib.rs
kianenigma Jul 23, 2024
62b2772
Update docs/sdk/packages/guides/first-pallet/src/lib.rs
kianenigma Jul 23, 2024
be19f0b
Update docs/sdk/packages/guides/first-pallet/src/lib.rs
kianenigma Jul 23, 2024
4ba77fc
Update docs/sdk/packages/guides/first-pallet/src/lib.rs
kianenigma Jul 23, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 79 additions & 18 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ members = [
"cumulus/test/service",
"cumulus/xcm/xcm-emulator",
"docs/sdk",
"docs/sdk/packages/guides/first-pallet",
"docs/sdk/packages/guides/first-runtime",
"polkadot",
"polkadot/cli",
"polkadot/core-primitives",
Expand Down
41 changes: 27 additions & 14 deletions docs/sdk/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,25 @@ frame = { package = "polkadot-sdk-frame", path = "../../substrate/frame", featur
"experimental",
"runtime",
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
] }
pallet-examples = { path = "../../substrate/frame/examples" }
pallet-default-config-example = { path = "../../substrate/frame/examples/default-config" }
pallet-example-offchain-worker = { path = "../../substrate/frame/examples/offchain-worker" }

# How we build docs in rust-docs
simple-mermaid = "0.1.1"
docify = "0.2.8"
assert_cmd = "2.0.14"

# Polkadot SDK deps, typically all should only be in scope such that we can link to their doc item.
node-cli = { package = "staging-node-cli", path = "../../substrate/bin/node/cli" }
kitchensink-runtime = { path = "../../substrate/bin/node/runtime" }
chain-spec-builder = { package = "staging-chain-spec-builder", path = "../../substrate/bin/utils/chain-spec-builder" }
subkey = { path = "../../substrate/bin/utils/subkey" }
frame-system = { path = "../../substrate/frame/system", default-features = false }
frame-support = { path = "../../substrate/frame/support", default-features = false }
frame-executive = { path = "../../substrate/frame/executive", default-features = false }
pallet-example-single-block-migrations = { path = "../../substrate/frame/examples/single-block-migrations" }

# Substrate Client
sc-network = { path = "../../substrate/client/network" }
sc-rpc-api = { path = "../../substrate/client/rpc-api" }
sc-rpc = { path = "../../substrate/client/rpc" }
sc-client-db = { path = "../../substrate/client/db" }
sc-cli = { path = "../../substrate/client/cli" }
sc-chain-spec = { path = "../../substrate/client/chain-spec" }
sc-consensus-aura = { path = "../../substrate/client/consensus/aura" }
sc-consensus-babe = { path = "../../substrate/client/consensus/babe" }
sc-consensus-grandpa = { path = "../../substrate/client/consensus/grandpa" }
Expand All @@ -60,9 +55,12 @@ cumulus-pallet-parachain-system = { path = "../../cumulus/pallets/parachain-syst
"parameterized-consensus-hook",
] }
parachain-info = { package = "staging-parachain-info", path = "../../cumulus/parachains/pallets/parachain-info" }
pallet-aura = { path = "../../substrate/frame/aura", default-features = false }
pallet-aura = { path = "../../substrate/frame/aura" }

# Pallets and FRAME internals
frame-system = { path = "../../substrate/frame/system" }
frame-support = { path = "../../substrate/frame/support" }
frame-executive = { path = "../../substrate/frame/executive" }
pallet-timestamp = { path = "../../substrate/frame/timestamp" }
pallet-balances = { path = "../../substrate/frame/balances" }
pallet-assets = { path = "../../substrate/frame/assets" }
Expand All @@ -77,6 +75,14 @@ pallet-democracy = { path = "../../substrate/frame/democracy" }
pallet-uniques = { path = "../../substrate/frame/uniques" }
pallet-nfts = { path = "../../substrate/frame/nfts" }
pallet-scheduler = { path = "../../substrate/frame/scheduler" }
pallet-examples = { path = "../../substrate/frame/examples" }
pallet-default-config-example = { path = "../../substrate/frame/examples/default-config" }
pallet-example-offchain-worker = { path = "../../substrate/frame/examples/offchain-worker" }
pallet-example-single-block-migrations = { path = "../../substrate/frame/examples/single-block-migrations" }
pallet-referenda = { path = "../../substrate/frame/referenda" }
pallet-broker = { path = "../../substrate/frame/broker" }
pallet-babe = { path = "../../substrate/frame/babe" }
pallet-grandpa = { path = "../../substrate/frame/grandpa" }

# Primitives
sp-io = { path = "../../substrate/primitives/io" }
Expand All @@ -85,14 +91,21 @@ sp-core = { path = "../../substrate/primitives/core" }
sp-keyring = { path = "../../substrate/primitives/keyring" }
sp-runtime = { path = "../../substrate/primitives/runtime" }
sp-arithmetic = { path = "../../substrate/primitives/arithmetic" }

# Misc pallet dependencies
pallet-referenda = { path = "../../substrate/frame/referenda" }
pallet-broker = { path = "../../substrate/frame/broker" }
pallet-babe = { path = "../../substrate/frame/babe" }

sp-offchain = { path = "../../substrate/primitives/offchain" }
sp-version = { path = "../../substrate/primitives/version" }

# XCM
xcm = { package = "staging-xcm", path = "../../polkadot/xcm" }

# Templates
minimal-template-runtime = { path = "../../templates/minimal/runtime" }
solochain-template-runtime = { path = "../../templates/solochain/runtime" }
parachain-template-runtime = { path = "../../templates/parachain/runtime" }


# Packages defined right here
polkadot-sdk-docs-packages-guides-first-pallet = { path = "./packages/guides/first-pallet" }
polkadot-sdk-docs-packages-guides-first-runtime = { path = "./packages/guides/first-runtime" }

[dev-dependencies]
nix = { version = "0.28.0", features = ["signal"] }
34 changes: 34 additions & 0 deletions docs/sdk/packages/guides/first-pallet/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[package]
name = "polkadot-sdk-docs-packages-guides-first-pallet"
description = "A simple pallet created for the polkadot-sdk-docs guides"
version = "0.0.0"
license = "MIT-0"
authors.workspace = true
homepage.workspace = true
repository.workspace = true
edition.workspace = true
publish = false

[lints]
workspace = true

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]

[dependencies]
codec = { package = "parity-scale-codec", version = "3.0.0", features = [
"derive",
], default-features = false }
scale-info = { version = "2.10.0", default-features = false, features = [
"derive",
] }
frame = { package = "polkadot-sdk-frame", path = "../../../../../substrate/frame", default-features = false, features = [
"experimental",
"runtime",
] }
docify = "0.2.7"


[features]
default = ["std"]
std = ["codec/std", "frame/std", "scale-info/std"]
Loading
Loading