|
| 1 | +--- |
| 2 | +description: One-page hackathon guide for building chains and contracts with Pop CLI. |
| 3 | +--- |
| 4 | + |
| 5 | +# Pop CLI Hackathon Guide |
| 6 | + |
| 7 | +## Introduction |
| 8 | + |
| 9 | +Pop CLI is an all-in-one tool for Polkadot development. It streamlines both parachain and smart contract workflows so you can go from idea → demo during a hackathon. |
| 10 | + |
| 11 | +Pop CLI simplifies development with: |
| 12 | + |
| 13 | +- Quick initialization of development environment. |
| 14 | +- Project scaffolding from predefined templates. |
| 15 | +- Easy launch and management of local development networks. |
| 16 | + |
| 17 | +> See also: [Quickstart Parachain Development with Pop CLI (official Polkadot docs)](https://docs.polkadot.com/develop/toolkit/parachains/quickstart/pop-cli/) |
| 18 | +
|
| 19 | +### Prerequisites |
| 20 | + |
| 21 | +Install Pop CLI: |
| 22 | +```bash |
| 23 | +cargo install --force --locked pop-cli |
| 24 | +``` |
| 25 | +Confirm the installation: |
| 26 | +```bash |
| 27 | +pop --help |
| 28 | +``` |
| 29 | +Set up your development environment: |
| 30 | +To build Polkadot SDK–based chains, make sure your local toolchain is ready. The [Install Polkadot SDK Dependencies](https://docs.polkadot.com/develop/parachains/install-polkadot-sdk/) guide covers this step by step. |
| 31 | + |
| 32 | +Or automate it with: |
| 33 | +```bash |
| 34 | +pop install |
| 35 | +``` |
| 36 | + |
| 37 | +### Chain Development (Parachains) <a href="#chain-development" id="chain-development"></a> |
| 38 | +Build and run a local parachain quickly; deploy when ready. |
| 39 | + |
| 40 | +#### TL;DR Flow |
| 41 | + |
| 42 | +```bash |
| 43 | +# 1) Scaffold (choose provider/template interactively) |
| 44 | +pop new chain |
| 45 | + |
| 46 | +# 2) Build your chain |
| 47 | +cd my-chain && pop build --release |
| 48 | + |
| 49 | +# 3) Run a local network (Zombienet config) |
| 50 | +pop up network -f ./network.toml |
| 51 | +``` |
| 52 | + |
| 53 | +Congrats! You’ve spun up a network with your parachain running! |
| 54 | +``` |
| 55 | +┌ Pop CLI : Deploy a parachain |
| 56 | +│ |
| 57 | +◇ 🚀 Network launched successfully - ctrl-c to terminate |
| 58 | +│ ⛓️ paseo-local |
| 59 | +│ alice: |
| 60 | +│ portal: https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:62551#/explorer |
| 61 | +│ logs: tail -f /var/folders/vl/txnq6gdj22s9rn296z0md27w0000gn/T/zombie-c0eb16fc-5d11-4792-aced-493ef972d056/alice/alice.log |
| 62 | +│ bob: |
| 63 | +│ portal: https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:62555#/explorer |
| 64 | +│ logs: tail -f /var/folders/vl/txnq6gdj22s9rn296z0md27w0000gn/T/zombie-c0eb16fc-5d11-4792-aced-493ef972d056/bob/bob.log |
| 65 | +│ ⛓️ local_testnet: 2000 |
| 66 | +│ collator-01: |
| 67 | +│ portal: https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:62559#/explorer |
| 68 | +│ logs: tail -f /var/folders/vl/txnq6gdj22s9rn296z0md27w0000gn/T/zombie-c0eb16fc-5d11-4792-aced-493ef972d056/collator-01/collator-01.log |
| 69 | +│ |
| 70 | +``` |
| 71 | + |
| 72 | +#### Other useful commands |
| 73 | +```bash |
| 74 | +# 4) Interact with your chain (You can secure signing via browser wallet). |
| 75 | +pop call chain # `pop call chain --use-wallet` |
| 76 | + |
| 77 | +# 5) Register the rollup on Paseo or deploy using Polkadot Deployment Portal |
| 78 | +pop up |
| 79 | +# And follow the interactive guide: |
| 80 | +┌ Pop CLI : Deploy a rollup |
| 81 | +│ |
| 82 | +◆ Select your deployment method: |
| 83 | +│ ● Polkadot Deployment Portal (https://staging.deploypolkadot.xyz) |
| 84 | +│ ○ Register |
| 85 | +``` |
| 86 | + |
| 87 | +##### Handy Links |
| 88 | +- [Launch a Chain in Development](../pop-cli-for-appchains/guides/launch-a-chain/running-your-parachain.md) |
| 89 | +- [Launch a Chain to Paseo](../pop-cli-for-appchains/guides/launch-a-chain/launch-a-chain-to-paseo.md) |
| 90 | +- [Deploy a chain with Polkadot Deployment Portal](../pop-cli-for-appchains/guides/launch-a-chain/deploy-a-chain-polkadot-deployment-portal.md) |
| 91 | +- [Securely Sign Transactions from CLI](../pop-cli-for-appchains/guides/securely-sign-transactions-from-cli.md) |
| 92 | + |
| 93 | + |
| 94 | +### Contract Development (ink!) <a href="#contract-development" id="contract-development"></a> |
| 95 | +Pop CLI introduces experimental support for [ink! v6 smart contracts](https://use.ink/docs/v6) running on [PolkaVM (RISC-V)](https://github.com/paritytech/polkavm) via `pallet-revive`. |
| 96 | + |
| 97 | +> ⚠️ This path is alpha. If you want to try it during the hackathon, install Pop CLI from the `v6` branch: |
| 98 | +```bash |
| 99 | +cargo install --git https://github.com/r0gue-io/pop-cli.git --branch v6.0.0-alpha.4 --locked |
| 100 | +``` |
| 101 | + |
| 102 | +#### TL;DR Flow |
| 103 | + |
| 104 | +```bash |
| 105 | +# 1) Scaffold (choose provider/template interactively) |
| 106 | +pop new contract |
| 107 | + |
| 108 | +# 2) Build your contract |
| 109 | +cd my-contract && pop build --release |
| 110 | + |
| 111 | +# 3) Deploy (Pop CLI will run a local network by default; add `--url` to target a remote RPC) |
| 112 | +pop up # `pop up --url wss://passet-hub-paseo.dotters.network` |
| 113 | + |
| 114 | +# 4) Interact with your contract (You can secure signing via browser wallet). |
| 115 | +pop call contract # `pop call contract --use-wallet` |
| 116 | +``` |
| 117 | + |
| 118 | +##### Handy Links |
| 119 | +- [ink! docs](https://use.ink/docs/v6) |
| 120 | +- [Launch a Chain to Paseo](../pop-cli-for-appchains/guides/launch-a-chain/launch-a-chain-to-paseo.md) |
| 121 | +- [Your first ink! smart contract](../pop-cli-for-smart-contracts/tutorials/your-first-ink-smart-contract.md) |
| 122 | +- [Securely Sign Transactions from CLI](../pop-cli-for-smart-contracts/guides/securely-sign-transactions-from-cli.md) |
| 123 | + |
| 124 | + |
| 125 | +### Support & Contribute |
| 126 | + |
| 127 | +- Questions / help? Join our [Telegram](https://web.telegram.org/k/#@pop_support) |
| 128 | + |
| 129 | +- Follow updates on [X](https://x.com/onpopio) |
| 130 | + |
| 131 | +- Found a *bug* or have a *feature request*? [Open an issue](https://github.com/r0gue-io/pop-cli/issues) |
| 132 | + |
| 133 | +- *Want to contribute?* Check out open issues tagged [`good first issue`](https://github.com/r0gue-io/pop-cli/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22) |
| 134 | + |
| 135 | +<figure> |
| 136 | + <img src="../.gitbook/assets/onpopio-hackathon.png" alt="Pop CLI" /> |
| 137 | +</figure> |
| 138 | + |
0 commit comments