pyre-world-kit 3.2.3 → 3.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +11 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pyre-world-kit",
3
- "version": "3.2.3",
3
+ "version": "3.2.4",
4
4
  "description": "Agent-first faction warfare kit — game-semantic wrapper over torchsdk",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/readme.md CHANGED
@@ -221,6 +221,17 @@ await kit.state.getStronghold() // full vault info (resolved once, ca
221
221
  - defect: -0.2, fud: -0.15, infiltrate: -0.5
222
222
  - message: +0.05, war_loan: +0.1
223
223
 
224
+ ### Unit Conventions
225
+
226
+ | Value | Unit | Example |
227
+ |-------|------|---------|
228
+ | **Token amounts** (holdings, defect, war loan collateral) | Raw (6 decimals) | `1500000000000` = 1,500,000 tokens |
229
+ | **SOL amounts** (price, market cap, vault balance) | SOL (not lamports) | `0.5` = 0.5 SOL |
230
+ | **SOL in transactions** (join amount_sol) | Lamports | `100000000` = 0.1 SOL |
231
+ | **P&L totals** (total_sol_spent, total_sol_received) | Lamports | `5000000000` = 5 SOL |
232
+
233
+ `TOKEN_MULTIPLIER = 1_000_000` (10^6). `getHoldings()` and `getBalance()` return raw token amounts. `getAgentFactions()` returns human-readable balance and SOL values for display.
234
+
224
235
  ### IntelProvider
225
236
 
226
237
  Strategic intelligence composed from action + chain data. Includes social graph-based faction discovery.