Bags: track currencies per character instead of per profile

[dfrisone]

The bug

Reported by a user who wanted one currency tracked on their main and a different one on the alt that farms it: the bag's currency display was identical on every character. Unticking everything and re-picking, from either the EUI dropdown or Blizzard's own currency tab, always ended with every character showing the same set.

Root cause

The bag footer does not render Blizzard's tracked currencies. It renders the module's own currencyOrder table (the code comment says "decoupled from Blizzard"), and that table lives in the bag profile, so every character on the profile shares it.

The input feeding it is not shared. A TokenFrame.OnTokenWatchChanged callback syncs Blizzard's currency tab, which is per-character, into that one profile-level table. A per-character source writing a shared store can only ever bleed: ticking a currency on one character wrote it into everyone's bag.

That also explains the half of the report that sounded impossible, that Blizzard's own per-character tracking looked broken. EUI never writes that tab, and there is no SetCurrencyBackpack-family call anywhere in the module, only reads. What the user saw was the bag ignoring their per-character selection and showing the shared list instead.

The fix

Tracked currencies move to EllesmereUIDB.bagCurrencyByChar, keyed by name and realm.

Storage is at the DB root, not in the profile. The module already keeps its other per-character data there (characterGold, bagPinnedItems, bagItemAssignments), and it is cleared alongside them by the options page's per-character reset. Profile storage would have been wrong twice over:

• ApplyProfileData wipes db.profile wholesale before copying an imported snapshot, so importing any shared profile would have erased every character's currencies and substituted the exporter's.
• Profile exports would have shipped a roster of the author's character names, realms and per-alt currency lists to whoever imported it. That is exactly the leak PRIVATE_ADDON_KEYS exists to plug for the DataBars gold ledger and the QoL upgrade calculator.

Root storage also removes a failure mode the profile version had: a spec-driven profile switch (RepointAllDBs, no reload) could hand a character a freshly created empty table mid-session with nothing to seed it, blanking the footer for the rest of the session. Root data does not move with profiles, so first use happens once per character, ever.

Each character seeds once from the legacy shared table, so an upgrading user keeps exactly what they had and only diverges as they change things. The legacy table is deliberately left in place rather than deleted or migrated away: a per-character migration is not a one-shot, it runs once per character at that character's first login, so the seed source has to survive indefinitely. A character that has not logged in since the update still needs it, or it would open with an empty footer. Nothing writes to it any more, so the seed stays stable. Fresh installs are unchanged and still seed from Blizzard's tracked set.

One accessor owns the location and the seeding. The options dropdown goes through EllesmereUI._BagsCurrencyOrder rather than reaching for db.profile.currencyOrder, so there is a single definition of where this data lives. Because the TOC loads the options file before the module, that call is a runtime namespace lookup rather than a local captured at load time.

The character key is resolved once and cached. It is session-constant and was being rebuilt, two API calls plus a string allocation, on a render path driven by CURRENCY_DISPLAY_UPDATE. It refuses to cache before UnitName and GetRealmName both answer, so an early call returns nil rather than pinning a stub key for the session.

Scope

Two files, +70/−14. No new events, no timers, no API calls added. bagCurrencyByChar is deliberately absent from BAGS_DEFAULTS: StripDefaults and DeepMergeDefaults only walk keys present in the defaults table, so the per-character data is never stripped or masked.

Testing

Confirmed in game: currencies ticked on one character no longer follow to another, existing setups carry over untouched on upgrade, and Blizzard's currency tab now drives only the character it belongs to.