Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
_book/
.idea/
.DS_Store
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ Install the Pop CLI and start building:

* [Chains](https://learn.onpop.io/v/appchains)
* [Smart Contracts](https://learn.onpop.io/v/contracts)

<figure>
<img src=".gitbook/assets/onpopio-hackathon.png" alt="Pop CLI" />
</figure>
1 change: 0 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@
* [Build a Chain](https://learn.onpop.io/v/appchains)
* [Build a Smart Contract](https://learn.onpop.io/v/contracts)
* [Hackathon Guide](welcome/hackathon-guide.md)
* [Get tokens on Pop Network](welcome/get-tokens-on-pop-network.md)
2 changes: 1 addition & 1 deletion pop-cli-for-appchains/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Build custom blockchain that can operate as solo chains or connect to Polkadot f

Start building with the [Polkadot documentation](https://docs.polkadot.com/).

**Ready to build your first chain?** [Start here!](guides/create-a-new-parachain/)
**Ready to build your first chain?** [Start here!](guides/create-a-new-chain.md)
15 changes: 6 additions & 9 deletions pop-cli-for-appchains/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,22 @@

## GUIDES

* [Create a new parachain](guides/create-a-new-parachain/README.md)
* [Create an Assets parachain](guides/create-a-new-parachain/create-an-assets-parachain.md)
* [Create a Contracts parachain](guides/create-a-new-parachain/create-a-smart-contract-parachain.md)
* [Create an EVM parachain](guides/create-a-new-parachain/create-an-evm-parachain.md)
* [Benchmarking](guides/benchmarking/benchmarking-pallets-and-extrinsics.md)
* [Build](guides/build-your-parachain.md)
* [Create a new chain](guides/create-a-new-chain.md)
* [Build](guides/build-your-chain.md)
* [Build your chain specification](guides/build-spec.md)
* [Build your runtime deterministically](guides/build-deterministic-runtime.md)
* [Call](guides/call-a-chain.md)
* [Test runtime upgrades](guides/test-runtime-upgrades.md)
* [Benchmarking](guides/benchmarking/benchmarking-pallets-and-extrinsics.md)
* [Deploy](guides/launch-a-chain/README.md)
* [Launch a Chain in Development](guides/launch-a-chain/running-your-parachain.md)
* [Launch a Chain in Development](guides/launch-a-chain/running-your-chain.md)
* [Launch a Known Chain](guides/launch-a-chain/launch-a-known-chain.md)
* [Launch a Chain to Paseo](guides/launch-a-chain/launch-a-chain-to-paseo.md)
* [Launch Paseo](guides/launch-a-chain/launch-paseo.md)
* [Set up keys](guides/launch-a-chain/keys.md)
* [Acquire Coretime](guides/launch-a-chain/coretime.md)
* [Deploy a chain with Polkadot Deployment Portal](guides/launch-a-chain/deploy-a-chain-polkadot-deployment-portal.md)
* [Running a post-startup command](guides/running-a-post-startup-command.md)
* [Call](guides/call-a-chain.md)
* [Securely Sign Transactions from CLI](guides/securely-sign-transactions-from-cli.md)
* [Test runtime upgrades](guides/test-runtime-upgrades.md)
* [Hash](guides/hashing.md)
* [Conversions](guides/address-conversion.md)
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

[Benchmarking in the Polkadot SDK/Substrate](https://docs.polkadot.com/develop/parachains/testing/benchmarking/) measures execution time and resource usage for pallets and extrinsics, ensuring accurate weight calculations and optimal performance.

<figure><img src="../../.gitbook/assets/popbench.gif" alt="pop bench pallet"><figcaption></figcaption></figure>

With Pop CLI, you can benchmark pallets and extrinsics interactively by managing parameters efficiently. Run the following command to start benchmarking:

Expand Down
5 changes: 2 additions & 3 deletions pop-cli-for-appchains/guides/build-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,16 @@ Run the command without arguments to be guided through all choices:
pop build spec
```

This will prompt you for key values like output file name, parachain id, relay chain, chain type, protocol id,
This will prompt you for key values like output file name, chain id, relay chain, chain type, protocol id,
properties, whether to generate genesis files, and whether to build and inject a deterministic runtime.

<figure><img src="../.gitbook/assets/build_spec.gif" alt="pop build spec"><figcaption></figcaption></figure>

> Tip: You can press Tab to accept defaults and type to filter list selections.

### What you’ll typically provide

- Output file name/path for the plain spec (default: ./chain-spec.json)
- Parachain ID (default: 2000)
- Chain (Parachain) ID (default: 2000)
- Chain type (Development / Local / Live)
- Relay chain (paseo, westend, kusama, polkadot and their local variants)
- Protocol ID and optional properties (token symbol/decimals/SS58)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Build your parachain
# Build your chain

To build your parachain using Pop CLI
To build your chain using Pop CLI

```shell
cd my-appchain
cd my-chain
pop build
```

```
┌ Pop CLI : Building a parachain
┌ Pop CLI : Building a chain
Compiling parachain-template-runtime v0.1.0 (/Users/pop/src/my-appchain/runtime)
Compiling parachain-template-node v0.1.0 (/Users/pop/src/my-appchain/node)
Compiling parachain-template-runtime v0.1.0 (/Users/pop/src/my-chain/runtime)
Compiling parachain-template-node v0.1.0 (/Users/pop/src/my-chain/node)
Finished release [optimized] target(s) in 1m 20s

└ Build Completed Successfully!
Expand All @@ -20,25 +20,26 @@ pop build
If you are outside the project's directory, you can specify the path

```shell
pop build -p ./my-appchain
pop build -p ./my-chain
```

If you are building the parachain with the intent to onboard the parachain to a Polkadot Relay chain then you can run the following build command:
If you are building the chain with the intent to onboard to a Polkadot Relay chain then you can run the following build command:

```
pop build -p ../my-appchain --para_id 2000
pop build -p ../my-chain --para_id 2000
```

This command will build your parachain and generate the chain spec, WebAssembly runtime for the parachain, and generate the parachain genesis state needed for registering and onboarding a parachain onto the Relay chain.
This command will build your chain and generate the chain spec, the WebAssembly runtime, and generate the chain genesis state needed for registering and onboarding onto the Relay chain.

#### Learning Resources

* 🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
* ⭕ Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains).
* ⭕ Learn more about Polkadot chains [here](https://wiki.polkadot.network/docs/learn-parachains).
* 🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are the Polkadot SDK documentation resources.

**Technical Support**

* [Polkadot Stack Exchange](https://polkadot.stackexchange.com/)
* Create a question and tag it with "[`pop`](https://substrate.stackexchange.com/tags/pop/info)"
* Share the StackExchange question in our [Pop Support Telegram channel](https://t.me/pop\_support)
* Share the StackExchange question in our [Pop Support Telegram channel](https://t.me/pop_support)

3 changes: 0 additions & 3 deletions pop-cli-for-appchains/guides/call-a-chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ You can execute an extrinsic by specifying the pallet and function (dispatchable
pop call chain --pallet System --function remark --args "0x11" --url ws://localhost:9944 --suri //Alice --sudo
```

<img src="../.gitbook/assets/callchain_extrinsic.gif" alt="pop call chain">

#### Querying Storage

You can query storage items by specifying the pallet and function (storage item name).
Expand All @@ -71,7 +69,6 @@ pop call chain --pallet Sudo --function Key --url wss://pas-rpc.stakeworld.io -y
pop call chain --pallet System --function Account --args 0xb815821c5b300d1667d5fc081c06cc4b6addffb90464d68d871ee363b01a127c --url wss://pas-rpc.stakeworld.io -y
```

<img src="../.gitbook/assets/callchain_state.gif" alt="pop call chain">

#### Reading Constants

Expand Down
26 changes: 26 additions & 0 deletions pop-cli-for-appchains/guides/create-a-new-chain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Create a new chain

Use the interactive prompt to scaffold a chain:

```bash
pop new chain
```

Available templates:

- Pop
- Standard
- Assets
- Contracts
- OpenZeppelin
- Generic Runtime Template
- EVM Template
- Parity
- Polkadot SDK's Parachain Template

> Note: Some upstream template names and binaries still say "parachain", this is a Polkadot Chain.

**Need help?**

Ask on [Polkadot Stack Exchange](https://polkadot.stackexchange.com/) (tag it [`pop`](https://substrate.stackexchange.com/tags/pop/info)) or drop by [our Telegram](https://t.me/onpopio). We're here to help!

66 changes: 0 additions & 66 deletions pop-cli-for-appchains/guides/create-a-new-parachain/README.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 1 addition & 1 deletion pop-cli-for-appchains/guides/launch-a-chain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: The following guides show how to launch a chain on Polkadot.

A typical development workflow for launching a chain on Polkadot:&#x20;

1. [Launch a Development Network](running-your-parachain.md) with predefined chains.
1. [Launch a Development Network](running-your-chain.md) with predefined chains.
2. [Launch a Known Chain](launch-a-known-chain.md)
3. [Launch a Chain on Paseo](launch-a-chain-to-paseo.md).
4. [Deploy a Chain With Polkadot Deployment Portal](deploy-a-chain-polkadot-deployment-portal.md).
Expand Down
2 changes: 1 addition & 1 deletion pop-cli-for-appchains/guides/launch-a-chain/coretime.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If the event `OnDemandOrderPlaced` is returned it means that your block will be

* [https://paritytech.github.io/devops-guide/guides/parachain\_deployment.html](https://paritytech.github.io/devops-guide/guides/parachain_deployment.html)
* 🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
* ⭕ Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains).
* ⭕ Learn more about Polkadot chains [here](https://wiki.polkadot.network/docs/learn-parachains).
* 🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are the Polkadot SDK documentation resources.

**Need help?**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The `ParaRegistration` proxy is designed to limit permissions strictly to paraID

_Why Use a Pure Proxy?_

A pure proxy enhances security by keeping private keys hidden and delegating control to an any proxy. It simplifies multisig setups by allowing signatory changes without creating a new account. Highly recommended for parachain registration!
A pure proxy enhances security by keeping private keys hidden and delegating control to an any proxy. It simplifies multisig setups by allowing signatory changes without creating a new account. Highly recommended for chain registration!

To create a pure proxy run:

Expand Down
Loading