๐งญ Start Here
Different readers come to pallet-xp for different reasons.
- Some want to learn the model ๐ง
- Some want to integrate it into their runtime โ๏ธ
- Some want to extend it ๐
- Some want to modify the pallet itself ๐ ๏ธ
This page helps you choose the right path quickly.
๐ง 1. I Want to Learn How XP Worksโ
Start here if you want to understand:
- what XP is
- why it exists
- how Pulse works
- how lifecycle + ownership work
- why XP is not a token
๐ Direct Linksโ
- ๐ Intro
- ๐งฉ Concepts
- ๐๏ธ Architecture Overview
Understand the model before writing code.
Most mistakes happen when XP is treated like balances. It is not.
โ๏ธ 2. I Want to Use XP in My Projectโ
Start here if you want to:
- add XP to your runtime
- build governance reputation
- create contributor scoring
- use staking / commitment flows
- integrate XP into another pallet
๐ Direct Linksโ
- ๐ฆ Installation
- โ๏ธ Configuration
- ๐ฑ First XP
- ๐ Extrinsics
- ๐งช Inspectors
- ๐ RPC + UI
- ๐งฌ Traits
- ๐ Call Surface
- ๐งฉ Instances
- ๐ Staking
This is the real integration path.
Use this for production runtime development.
๐ ๏ธ 3. I Want to Modify pallet-xp Itselfโ
Start here if you want to:
- add features
- change lifecycle rules
- improve architecture
- contribute to the pallet
๐ Direct Linksโ
- ๐งฉ Concepts
- ๐๏ธ Architecture Overview
- ๐๏ธ Storage
- ๐งฌ Traits
- ๐ Core / Extrinsics
- ๐ก Core / Events
- ๐งช Core / Inspectors
- ๐ Advanced / Listeners
- ๐ Advanced / Upcoming
Understand architecture first.
Never modify lifecycle logic before understanding invariants.
๐ 4. I Am Building RPC / API Providersโ
Start here if you want to:
- build RPC endpoints
- power frontend apps
- support indexers
- create dashboards
- build explorer integrations
๐ Direct Linksโ
- ๐ RPC + UI
- ๐ก Events
- ๐งช Inspectors
- ๐งฉ Concepts
- ๐๏ธ Architecture Overview
Important Ruleโ
Production -> public pallet APIs (RPC + UI)
Development -> inspector extrinsics
Use pallet public functions directly and do not build production APIs around inspector events.
๐ 5. I Want to Critic / Audit the Designโ
๐ Read everything firstโ
If you want to audit or challenge the design:
read everything first.
We always welcome criticism, we genuinely value it.
Good criticism helps make the system stronger by bringing new perspectives, uncovering blind spots, and challenging assumptions.
Most incorrect criticism comes from:
treating XP like balances or ignoring lifecycle assumptions
XP is a lifecycle-bound execution + reputation model.
Not a token system.
๐ก Final Advice
Start with:
Why does XP exist?
Everything else depends on that answer.
XP is identity-bound programmable reputation
Understanding that first makes everything easier.
๐ Next Stepsโ
To understand how XP works in detail:
๐ Concepts -> XP Model