Skip to main content

๐Ÿงญ 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

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

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

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

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