@metamask/assets-controller 10.0.1 → 10.2.0

package/dist/migrations/healAssetsInfoMetadata.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"healAssetsInfoMetadata.cjs","sourceRoot":"","sources":["../../src/migrations/healAssetsInfoMetadata.ts"],"names":[],"mappings":";;;AAGA,2CAKyB;AACzB,mCAAmC;AAEnC,0CAA8D;AAoF9D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,4BAA4B,CAAC,CAAC;AAc5E;;;;;;;;;GASG;AACH,SAAgB,0BAA0B,CAAC,EACzC,KAAK,EACL,iBAAiB,EACjB,gBAAgB,GACkB;IAClC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAQ,EAAE;QAC3C,GAAG,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;QACjD,gBAAgB,EAAE,CAChB,IAAI,KAAK,CACP,mEAAmE,IAAA,uBAAe,EAChF,KAAK,CACN,EAAE,CACJ,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,KAAK,GAAkC,IAAI,CAAC;IAChD,IAAI,CAAC;QACH,KAAK,GAAG,sBAAsB,CAAC,iBAAiB,EAAE,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,WAAW,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAA,kBAAS,EAAC,KAAK,CAAC,CAAC;QACnC,iBAAiB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAEpC,GAAG,CAAC,yDAAyD,EAAE;YAC7D,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM;YAC3D,0BAA0B,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM;SACnE,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,WAAW,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAzCD,gEAyCC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CACxB,KAAyB,EACzB,KAA6B;;IAE7B,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACnE,MAAA,KAAK,CAAC,UAAU,OAAC,OAAwB,eAAM,QAAQ,EAAC;IAC1D,CAAC;IAED,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;QACvE,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACrD,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG;YAC9B,GAAG,QAAQ;YACX,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAC7D,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AAErC,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,+BAA+B,GAAwB,IAAI,GAAG,CAAC;IACnE,UAAU,EAAE,mBAAmB;IAC/B,WAAW,EAAE,WAAW;IACxB,WAAW,EAAE,kBAAkB;IAC/B,YAAY,EAAE,UAAU;IACxB,YAAY,EAAE,QAAQ;IACtB,YAAY,EAAE,WAAW;IACzB,aAAa,EAAE,MAAM;IACrB,aAAa,EAAE,MAAM;IACrB,aAAa,EAAE,OAAO;IACtB,cAAc,EAAE,eAAe;IAC/B,cAAc,EAAE,YAAY;IAC5B,cAAc,EAAE,QAAQ;CACzB,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,sBAAsB,CACpC,WAAoB,EACpB,YAAgC;IAEhC,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC;IAC3E,IAAI,CAAC,IAAA,gBAAQ,EAAC,SAAS,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,WAAW,CAAC,CAAC;IACnE,MAAM,cAAc,GAAG,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,QAAQ,CAAC,WAAW,EAAE;QAC7C,kBAAkB;QAClB,kBAAkB;KACnB,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAiD,EAAE,CAAC;IAC7E,MAAM,oBAAoB,GAAuC,EAAE,CAAC;IAEpE,KAAK,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACpE,IAAI,CAAC,IAAA,gBAAQ,EAAC,aAAa,CAAC,EAAE,CAAC;YAC7B,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC5C,qEAAqE;QACrE,IAAI,CAAC,KAAK,IAAI,+BAA+B,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,SAAS;QACX,CAAC;QAED,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACjE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClD,SAAS;YACX,CAAC;YAED,MAAM,SAAS,GAAG,kBAAkB,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;YAC/D,MAAM,gBAAgB,GAAG,uBAAuB,CAC9C,gBAAgB,EAChB,UAAU,EACV,UAAU,CACX,CAAC;YAEF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,UAAU,GAAG,kBAAkB,CACnC,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,cAAc,CACf,CAAC;gBACF,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBACD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;gBAErC,sEAAsE;gBACtE,IACE,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,SAAS;oBAC9C,mBAAmB,CAAC,OAAO,CAAC,KAAK,SAAS,EAC1C,CAAC;oBACD,mBAAmB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;gBACtC,CAAC;gBAED,+CAA+C;gBAC/C,IAAI,SAAS,EAAE,CAAC;oBACd,sBAAsB,CACpB,YAAY,EACZ,oBAAoB,EACpB,SAAS,EACT,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IACE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,MAAM,KAAK,CAAC,EAC9C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,UAAU,EAAE,mBAAmB;QAC/B,YAAY,EAAE,oBAAoB;KACnC,CAAC;AACJ,CAAC;AAtFD,wDAsFC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,kBAAkB,CACzB,KAAc,EACd,KAAa,EACb,gBAA6B,EAC7B,cAA2B;IAE3B,IAAI,CAAC,IAAA,gBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,uDAAuD;IACvD,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IACE,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;QACjC,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EACtC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,uEAAuE;IACvE,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,OAAc,CAAC,CAAC;IAC/D,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+DAA+D;IAC/D,IAAI,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,iCAAiC;IACjC,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;AACrD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CACxB,KAA8B;IAE9B,MAAM,MAAM,GAAG,KAAK,CAAC,MAAgB,CAAC;IACtC,MAAM,IAAI,GACR,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QACrD,CAAC,CAAC,KAAK,CAAC,IAAI;QACZ,CAAC,CAAC,MAAM,CAAC;IACb,MAAM,QAAQ,GACZ,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QACnE,CAAC,CAAC,KAAK,CAAC,QAAQ;QAChB,CAAC,CAAC,CAAC,CAAC;IAER,MAAM,KAAK,GACT,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QACvD,CAAC,CAAC,KAAK,CAAC,KAAK;QACb,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;QAClD,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CACtB,CAAC,UAAU,EAAwB,EAAE,CAAC,OAAO,UAAU,KAAK,QAAQ,CACrE;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,IAAI,EAAE,OAAO;QACb,MAAM;QACN,IAAI;QACJ,QAAQ;QACR,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACxC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,0BAA0B,CACjC,WAAoB;IAEpB,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE;QACrC,oBAAoB;QACpB,kBAAkB;QAClB,UAAU;KACX,CAAC,CAAC;IACH,IAAI,CAAC,IAAA,gBAAQ,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,GAAG,GAA8B,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrD,IACE,IAAA,gBAAQ,EAAC,OAAO,CAAC;YACjB,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;YACnC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAC1B,CAAC;YACD,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,CAAC;QAC1C,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,qBAAqB,CAAC,YAAgC;IAC7D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAChD,YAAY,CAAC,gBAAgB,CAC9B,EAAE,CAAC;QACF,IAAI,IAAA,gBAAQ,EAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACvD,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,uBAAuB,CAC9B,gBAAyB,EACzB,UAAkB,EAClB,cAAsB;IAEtB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,IAAI,CAAC,IAAA,gBAAQ,EAAC,gBAAgB,CAAC,EAAE,CAAC;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAChD,IAAI,CAAC,IAAA,gBAAQ,EAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,YAAY,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;IAClD,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACzD,IAAI,OAAO,CAAC,WAAW,EAAE,KAAK,YAAY,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACnE,SAAS;QACX,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YAC3B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,UAAkB;IAC3C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,GAAG,mBAAmB,IAAI,OAAO,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CACxB,KAAa,EACb,YAAiB;IAEjB,IAAI,WAAmB,CAAC;IACxB,IAAI,CAAC;QACH,WAAW,GAAG,IAAA,0BAAkB,EAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,GAAG,KAAK,UAAU,WAAW,EAAmB,CAAC;AAC1D,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,QAAQ,CAAC,IAAa,EAAE,IAAc;IAC7C,OAAO,IAAI,CAAC,MAAM,CAAU,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC1C,IAAI,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC,EAAE,IAAI,CAAC,CAAC;AACX,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,sBAAsB,CAC7B,YAAgC,EAChC,SAA6C,EAC7C,SAAoB,EACpB,OAAsB;IAEtB,IAAI,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QACrD,OAAO;IACT,CAAC;IACD,IAAI,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5D,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IACD,SAAS,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;AAChC,CAAC","sourcesContent":["import type { AccountsControllerState } from '@metamask/accounts-controller';\nimport type { TokensControllerState } from '@metamask/assets-controllers';\nimport type { Hex } from '@metamask/utils';\nimport {\n  getChecksumAddress,\n  getErrorMessage,\n  hasProperty,\n  isObject,\n} from '@metamask/utils';\nimport { cloneDeep } from 'lodash';\n\nimport { createModuleLogger, projectLogger } from '../logger';\nimport type {\n  AccountId,\n  Caip19AssetId,\n  FungibleAssetMetadata,\n  AssetsControllerStateInternal,\n} from '../types';\n\n/**\n * TEMPORARY MODULE — remove in a future release.\n *\n * Port of extension migration #215 (Assets Controller Metadata Healing).\n * Issue: https://consensyssoftware.atlassian.net/browse/ASSETS-3346\n * Incident: #incident-metamask-1731\n *\n * Background: after a prior defect in AssetsController, metadata for custom\n * tokens was wiped. Most popular chains support auto-detection and can\n * self-heal, however not all.\n *\n * This module computes the state additions needed to restore metadata for\n * custom tokens on niche EVM chains (chains that cannot auto-detect and\n * self-heal), using the legacy `TokensController.allTokens` state as the\n * source of truth. It is a pure function so it can be tested in isolation;\n * the controller applies the returned patch in its constructor.\n *\n * The legacy state is treated as fully untrusted (`unknown`): every shape is\n * validated before use, and any unexpected input results in that entry being\n * skipped (or `null` being returned when nothing is restorable).\n */\n\n/**\n * The slices of current `AssetsController` state the healing computation\n * reads. Never mutated.\n */\nexport type CurrentAssetsState = Pick<\n  AssetsControllerStateInternal,\n  'assetsInfo' | 'assetsBalance' | 'customAssets' | 'assetPreferences'\n>;\n\n/**\n * TEMPORARY — will be removed in a future release.\n *\n * Shape of the legacy persisted state the ASSETS-3346 healing reads, derived\n * from the real `TokensControllerState` and `AccountsControllerState` types.\n * Use it to type the `tempMigrateAssetsInfoMetadataAssets3346` getter when\n * integrating in a client.\n *\n * Everything is optional and only the listed slices are read:\n *\n * - `TokensController.allTokens` — required for any healing to happen.\n * - `TokensController.allIgnoredTokens` — tokens the user hid/removed\n *   (skipped during healing).\n * - `AccountsController.internalAccounts.accounts` — maps addresses to\n *   account IDs so healed tokens are also tracked in `customAssets`\n *   (without it only `assetsInfo` is healed).\n *\n * At runtime the value still crosses the boundary as `unknown`: every shape\n * is re-validated by the migration, so a partial or malformed object is safe\n * and simply skipped.\n */\nexport type Assets3346MigrationState = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention -- must match the persisted controller state key\n  TokensController?: Partial<\n    Pick<TokensControllerState, 'allTokens' | 'allIgnoredTokens'>\n  >;\n  // eslint-disable-next-line @typescript-eslint/naming-convention -- must match the persisted controller state key\n  AccountsController?: {\n    internalAccounts?: {\n      accounts?: Record<\n        string,\n        Pick<\n          AccountsControllerState['internalAccounts']['accounts'][string],\n          'address'\n        >\n      >;\n    };\n  };\n};\n\nexport type AssetsInfoHealingPatch = {\n  assetsInfo: Record<Caip19AssetId, FungibleAssetMetadata>;\n  customAssets: Record<AccountId, Caip19AssetId[]>;\n};\n\nconst log = createModuleLogger(projectLogger, 'tempHealAssetsInfoMetadata');\n\nexport type TempHealAssetsInfoMetadataOptions = {\n  /** Current `AssetsController` state the healing patch is computed against. */\n  state: AssetsControllerStateInternal;\n  /**\n   * Host-provided getter for the untrusted legacy state root (see\n   * `AssetsControllerOptions.tempMigrateAssetsInfoMetadataAssets3346`).\n   */\n  getMigrationState: () => unknown;\n  /** Optional Sentry-compatible reporter for healing failures. */\n  captureException?: (error: Error) => void;\n};\n\n/**\n * TEMPORARY — will be removed in a future release.\n *\n * @param options - The options bag.\n * @param options.state - Current controller state to compute the patch against.\n * @param options.getMigrationState - Getter for the untrusted legacy state root.\n * @param options.captureException - Optional reporter for healing failures.\n * @returns Updated controller state with the healing patch applied, or the\n * original state when there is nothing to heal or healing fails.\n */\nexport function tempHealAssetsInfoMetadata({\n  state,\n  getMigrationState,\n  captureException,\n}: TempHealAssetsInfoMetadataOptions): AssetsControllerStateInternal {\n  const reportError = (error: unknown): void => {\n    log('Failed to heal assetsInfo metadata', error);\n    captureException?.(\n      new Error(\n        `AssetsController: temporary assetsInfo metadata healing failed: ${getErrorMessage(\n          error,\n        )}`,\n      ),\n    );\n  };\n\n  let patch: AssetsInfoHealingPatch | null = null;\n  try {\n    patch = healAssetsInfoMetadata(getMigrationState(), state);\n  } catch (error) {\n    reportError(error);\n  }\n\n  if (!patch) {\n    return state;\n  }\n\n  try {\n    const nextState = cloneDeep(state);\n    applyHealingPatch(nextState, patch);\n\n    log('Healed wiped assetsInfo metadata for niche-chain tokens', {\n      healedAssetsInfoCount: Object.keys(patch.assetsInfo).length,\n      healedCustomAssetsAccounts: Object.keys(patch.customAssets).length,\n    });\n\n    return nextState;\n  } catch (error) {\n    reportError(error);\n    return state;\n  }\n}\n\n/**\n * Apply a healing patch to (draft) controller state. Defensive against\n * concurrent writes: fills `assetsInfo` gaps only and dedupes `customAssets`\n * against the current draft rather than trusting the patch blindly.\n *\n * @param state - Mutable controller state copy.\n * @param patch - The additions computed by {@link healAssetsInfoMetadata}.\n */\nfunction applyHealingPatch(\n  state: CurrentAssetsState,\n  patch: AssetsInfoHealingPatch,\n): void {\n  for (const [assetId, metadata] of Object.entries(patch.assetsInfo)) {\n    state.assetsInfo[assetId as Caip19AssetId] ??= metadata;\n  }\n\n  for (const [accountId, assetIds] of Object.entries(patch.customAssets)) {\n    const existing = state.customAssets[accountId] ?? [];\n    state.customAssets[accountId] = [\n      ...existing,\n      ...assetIds.filter((assetId) => !existing.includes(assetId)),\n    ];\n  }\n}\n\nconst EVM_CHAIN_NAMESPACE = 'eip155';\n\nconst EVM_ADDRESS_REGEX = /^0x[0-9a-fA-F]{40}$/u;\n\n/**\n * Popular networks (covered by the Accounts API) can self-heal through\n * auto-detection, so their tokens must not be touched. Frozen snapshot from\n * extension migration #215.\n */\nconst ACCOUNT_API_SUPPORTED_CHAIN_IDS: ReadonlySet<string> = new Set([\n  'eip155:1', // Ethereum Mainnet\n  'eip155:10', // Optimism\n  'eip155:56', // BNB Smart Chain\n  'eip155:137', // Polygon\n  'eip155:143', // Monad\n  'eip155:999', // HyperEVM\n  'eip155:1329', // Sei\n  'eip155:5042', // Arc\n  'eip155:8453', // Base\n  'eip155:42161', // Arbitrum One\n  'eip155:43114', // Avalanche\n  'eip155:59144', // Linea\n]);\n\n/**\n * Compute the additions required to heal `assetsInfo` metadata (and custom\n * asset tracking) for tokens on niche EVM chains, based on the legacy\n * `TokensController` state.\n *\n * What it deliberately skips:\n *\n * - Accounts-API-supported chains — see `ACCOUNT_API_SUPPORTED_CHAIN_IDS`.\n * - Tokens the user hid/removed, detected via either the legacy\n *   `TokensController.allIgnoredTokens` or the current\n *   `assetPreferences` (`hidden: true`).\n * - Non-EVM assets, ERC-721s, and tokens with invalid addresses or metadata.\n *\n * @param legacyState - Untrusted legacy state root. Expected (but not\n * required) to contain `TokensController.allTokens`,\n * `TokensController.allIgnoredTokens`, and\n * `AccountsController.internalAccounts.accounts`.\n * @param currentState - Current `AssetsController` state slices (read-only).\n * @returns The additions to apply, or `null` when there is nothing to heal.\n */\nexport function healAssetsInfoMetadata(\n  legacyState: unknown,\n  currentState: CurrentAssetsState,\n): AssetsInfoHealingPatch | null {\n  const allTokens = readPath(legacyState, ['TokensController', 'allTokens']);\n  if (!isObject(allTokens)) {\n    return null;\n  }\n\n  const addressToAccountId = buildAddressToAccountIdMap(legacyState);\n  const hiddenAssetIds = collectHiddenAssetIds(currentState);\n  const allIgnoredTokens = readPath(legacyState, [\n    'TokensController',\n    'allIgnoredTokens',\n  ]);\n\n  const assetsInfoAdditions: Record<Caip19AssetId, FungibleAssetMetadata> = {};\n  const customAssetAdditions: Record<AccountId, Caip19AssetId[]> = {};\n\n  for (const [hexChainId, accountTokens] of Object.entries(allTokens)) {\n    if (!isObject(accountTokens)) {\n      continue;\n    }\n\n    const caip2 = hexChainIdToCaip2(hexChainId);\n    // Skip chains we can't parse or that self-heal via the accounts API.\n    if (!caip2 || ACCOUNT_API_SUPPORTED_CHAIN_IDS.has(caip2)) {\n      continue;\n    }\n\n    for (const [rawAddress, tokens] of Object.entries(accountTokens)) {\n      if (!Array.isArray(tokens) || tokens.length === 0) {\n        continue;\n      }\n\n      const accountId = addressToAccountId[rawAddress.toLowerCase()];\n      const ignoredAddresses = collectIgnoredAddresses(\n        allIgnoredTokens,\n        hexChainId,\n        rawAddress,\n      );\n\n      for (const token of tokens) {\n        const restorable = getRestorableAsset(\n          token,\n          caip2,\n          ignoredAddresses,\n          hiddenAssetIds,\n        );\n        if (!restorable) {\n          continue;\n        }\n        const { assetId, info } = restorable;\n\n        // `assetsInfo` is a global registry; fill gaps only, never overwrite.\n        if (\n          currentState.assetsInfo[assetId] === undefined &&\n          assetsInfoAdditions[assetId] === undefined\n        ) {\n          assetsInfoAdditions[assetId] = info;\n        }\n\n        // Ensure the asset is tracked for its account.\n        if (accountId) {\n          addCustomAssetAddition(\n            currentState,\n            customAssetAdditions,\n            accountId,\n            assetId,\n          );\n        }\n      }\n    }\n  }\n\n  if (\n    Object.keys(assetsInfoAdditions).length === 0 &&\n    Object.keys(customAssetAdditions).length === 0\n  ) {\n    return null;\n  }\n\n  return {\n    assetsInfo: assetsInfoAdditions,\n    customAssets: customAssetAdditions,\n  };\n}\n\n/**\n * Resolve a raw `TokensController` token entry to the CAIP-19 asset ID and\n * metadata that should be healed, or `null` when the token must be skipped\n * (not an object, missing/invalid address or symbol, an ERC-721, or hidden\n * in either the legacy or the current controller).\n *\n * @param token - Raw token entry from `allTokens`.\n * @param caip2 - The CAIP-2 chain ID of the token's chain (e.g. 'eip155:14').\n * @param ignoredAddresses - Lowercase addresses hidden via legacy `allIgnoredTokens`.\n * @param hiddenAssetIds - Lowercase asset IDs hidden via current `assetPreferences`.\n * @returns The restorable asset, or `null` to skip.\n */\nfunction getRestorableAsset(\n  token: unknown,\n  caip2: string,\n  ignoredAddresses: Set<string>,\n  hiddenAssetIds: Set<string>,\n): { assetId: Caip19AssetId; info: FungibleAssetMetadata } | null {\n  if (!isObject(token)) {\n    return null;\n  }\n  // Skip NFTs — AssetsController tracks them separately.\n  if (token.isERC721 === true) {\n    return null;\n  }\n  if (\n    typeof token.address !== 'string' ||\n    !EVM_ADDRESS_REGEX.test(token.address)\n  ) {\n    return null;\n  }\n  // Healed metadata with no symbol would be unusable in the UI; skip it.\n  if (typeof token.symbol !== 'string' || token.symbol.length === 0) {\n    return null;\n  }\n\n  const assetId = buildErc20AssetId(caip2, token.address as Hex);\n  if (!assetId) {\n    return null;\n  }\n\n  // Skip tokens the user hid/removed — in the legacy controller…\n  if (ignoredAddresses.has(token.address.toLowerCase())) {\n    return null;\n  }\n  // …or in the current controller.\n  if (hiddenAssetIds.has(assetId.toLowerCase())) {\n    return null;\n  }\n\n  return { assetId, info: buildEvmAssetInfo(token) };\n}\n\n/**\n * Build a `FungibleAssetMetadata` from a raw `TokensController` token entry.\n * The caller has already validated `symbol` as a non-empty string.\n *\n * @param token - Raw token object.\n * @returns The metadata to write into `assetsInfo`.\n */\nfunction buildEvmAssetInfo(\n  token: Record<string, unknown>,\n): FungibleAssetMetadata {\n  const symbol = token.symbol as string;\n  const name =\n    typeof token.name === 'string' && token.name.length > 0\n      ? token.name\n      : symbol;\n  const decimals =\n    typeof token.decimals === 'number' && Number.isFinite(token.decimals)\n      ? token.decimals\n      : 0;\n\n  const image =\n    typeof token.image === 'string' && token.image.length > 0\n      ? token.image\n      : undefined;\n  const aggregators = Array.isArray(token.aggregators)\n    ? token.aggregators.filter(\n        (aggregator): aggregator is string => typeof aggregator === 'string',\n      )\n    : undefined;\n\n  return {\n    type: 'erc20',\n    symbol,\n    name,\n    decimals,\n    ...(image ? { image } : {}),\n    ...(aggregators ? { aggregators } : {}),\n  };\n}\n\n/**\n * Build a map from lowercase account address to account UUID using the\n * legacy `AccountsController.internalAccounts.accounts`.\n *\n * @param legacyState - Untrusted legacy state root.\n * @returns Map of lowercase address to account ID (empty on invalid input).\n */\nfunction buildAddressToAccountIdMap(\n  legacyState: unknown,\n): Record<string, AccountId> {\n  const accounts = readPath(legacyState, [\n    'AccountsController',\n    'internalAccounts',\n    'accounts',\n  ]);\n  if (!isObject(accounts)) {\n    return {};\n  }\n\n  const map: Record<string, AccountId> = {};\n  for (const [id, account] of Object.entries(accounts)) {\n    if (\n      isObject(account) &&\n      typeof account.address === 'string' &&\n      account.address.length > 0\n    ) {\n      map[account.address.toLowerCase()] = id;\n    }\n  }\n  return map;\n}\n\n/**\n * Collect the set of CAIP-19 asset IDs (lowercased) marked `hidden: true` in\n * the current `assetPreferences`. Lowercasing lets callers compare against\n * checksummed asset IDs case-insensitively.\n *\n * @param currentState - Current `AssetsController` state slices.\n * @returns Set of lowercase hidden asset IDs.\n */\nfunction collectHiddenAssetIds(currentState: CurrentAssetsState): Set<string> {\n  const hidden = new Set<string>();\n  for (const [assetId, preference] of Object.entries(\n    currentState.assetPreferences,\n  )) {\n    if (isObject(preference) && preference.hidden === true) {\n      hidden.add(assetId.toLowerCase());\n    }\n  }\n  return hidden;\n}\n\n/**\n * Collect the lowercase token addresses ignored (hidden) in the legacy\n * `TokensController.allIgnoredTokens` for a given chain and account. The\n * account key is matched case-insensitively.\n *\n * @param allIgnoredTokens - The legacy `allIgnoredTokens` map (possibly missing).\n * @param hexChainId - The hex chain ID being processed.\n * @param accountAddress - The account address whose ignored list to read.\n * @returns Set of lowercase ignored token addresses.\n */\nfunction collectIgnoredAddresses(\n  allIgnoredTokens: unknown,\n  hexChainId: string,\n  accountAddress: string,\n): Set<string> {\n  const result = new Set<string>();\n  if (!isObject(allIgnoredTokens)) {\n    return result;\n  }\n\n  const chainEntry = allIgnoredTokens[hexChainId];\n  if (!isObject(chainEntry)) {\n    return result;\n  }\n\n  const lowerAccount = accountAddress.toLowerCase();\n  for (const [address, list] of Object.entries(chainEntry)) {\n    if (address.toLowerCase() !== lowerAccount || !Array.isArray(list)) {\n      continue;\n    }\n    for (const ignored of list) {\n      if (typeof ignored === 'string') {\n        result.add(ignored.toLowerCase());\n      }\n    }\n  }\n  return result;\n}\n\n/**\n * Convert a hex chain ID (e.g. '0x1') to a CAIP-2 chain ID (e.g. 'eip155:1').\n *\n * @param hexChainId - The hex-encoded EVM chain ID.\n * @returns The CAIP-2 chain ID, or `null` when the input cannot be parsed.\n */\nfunction hexChainIdToCaip2(hexChainId: string): string | null {\n  if (!/^0x[0-9a-fA-F]+$/u.test(hexChainId)) {\n    return null;\n  }\n  const decimal = Number.parseInt(hexChainId, 16);\n  if (!Number.isFinite(decimal)) {\n    return null;\n  }\n  return `${EVM_CHAIN_NAMESPACE}:${decimal}`;\n}\n\n/**\n * Build the checksummed CAIP-19 asset ID for an ERC-20 token.\n *\n * @param caip2 - The CAIP-2 chain ID (e.g. 'eip155:14').\n * @param tokenAddress - The ERC-20 contract address.\n * @returns The asset ID, or `null` when the address cannot be checksummed.\n */\nfunction buildErc20AssetId(\n  caip2: string,\n  tokenAddress: Hex,\n): Caip19AssetId | null {\n  let checksummed: string;\n  try {\n    checksummed = getChecksumAddress(tokenAddress);\n  } catch {\n    return null;\n  }\n  return `${caip2}/erc20:${checksummed}` as Caip19AssetId;\n}\n\n/**\n * Read a nested path on an unknown value, returning `undefined` if any\n * intermediate key is missing or not an object.\n *\n * @param root - The value to read from.\n * @param path - Sequence of keys to traverse.\n * @returns The value at the path, or `undefined`.\n */\nfunction readPath(root: unknown, path: string[]): unknown {\n  return path.reduce<unknown>((cursor, key) => {\n    if (!isObject(cursor) || !hasProperty(cursor, key)) {\n      return undefined;\n    }\n    return cursor[key];\n  }, root);\n}\n\n/**\n * Record `assetId` as a custom-asset addition for `accountId` unless it is\n * already tracked in the current `assetsBalance` (mutual exclusion), already\n * present in the current `customAssets`, or already queued as an addition.\n *\n * @param currentState - Current `AssetsController` state slices.\n * @param additions - The custom-asset additions accumulated so far (mutated).\n * @param accountId - The account UUID.\n * @param assetId - CAIP-19 asset identifier.\n */\nfunction addCustomAssetAddition(\n  currentState: CurrentAssetsState,\n  additions: Record<AccountId, Caip19AssetId[]>,\n  accountId: AccountId,\n  assetId: Caip19AssetId,\n): void {\n  if (currentState.assetsBalance[accountId]?.[assetId]) {\n    return;\n  }\n  if (currentState.customAssets[accountId]?.includes(assetId)) {\n    return;\n  }\n\n  const queued = additions[accountId] ?? [];\n  if (!queued.includes(assetId)) {\n    queued.push(assetId);\n  }\n  additions[accountId] = queued;\n}\n"]}

package/dist/migrations/healAssetsInfoMetadata.d.cts

@@ -0,0 +1,106 @@
+import type { AccountsControllerState } from "@metamask/accounts-controller";
+import type { TokensControllerState } from "@metamask/assets-controllers";
+import type { AccountId, Caip19AssetId, FungibleAssetMetadata, AssetsControllerStateInternal } from "../types.cjs";
+/**
+ * TEMPORARY MODULE — remove in a future release.
+ *
+ * Port of extension migration #215 (Assets Controller Metadata Healing).
+ * Issue: https://consensyssoftware.atlassian.net/browse/ASSETS-3346
+ * Incident: #incident-metamask-1731
+ *
+ * Background: after a prior defect in AssetsController, metadata for custom
+ * tokens was wiped. Most popular chains support auto-detection and can
+ * self-heal, however not all.
+ *
+ * This module computes the state additions needed to restore metadata for
+ * custom tokens on niche EVM chains (chains that cannot auto-detect and
+ * self-heal), using the legacy `TokensController.allTokens` state as the
+ * source of truth. It is a pure function so it can be tested in isolation;
+ * the controller applies the returned patch in its constructor.
+ *
+ * The legacy state is treated as fully untrusted (`unknown`): every shape is
+ * validated before use, and any unexpected input results in that entry being
+ * skipped (or `null` being returned when nothing is restorable).
+ */
+/**
+ * The slices of current `AssetsController` state the healing computation
+ * reads. Never mutated.
+ */
+export type CurrentAssetsState = Pick<AssetsControllerStateInternal, 'assetsInfo' | 'assetsBalance' | 'customAssets' | 'assetPreferences'>;
+/**
+ * TEMPORARY — will be removed in a future release.
+ *
+ * Shape of the legacy persisted state the ASSETS-3346 healing reads, derived
+ * from the real `TokensControllerState` and `AccountsControllerState` types.
+ * Use it to type the `tempMigrateAssetsInfoMetadataAssets3346` getter when
+ * integrating in a client.
+ *
+ * Everything is optional and only the listed slices are read:
+ *
+ * - `TokensController.allTokens` — required for any healing to happen.
+ * - `TokensController.allIgnoredTokens` — tokens the user hid/removed
+ *   (skipped during healing).
+ * - `AccountsController.internalAccounts.accounts` — maps addresses to
+ *   account IDs so healed tokens are also tracked in `customAssets`
+ *   (without it only `assetsInfo` is healed).
+ *
+ * At runtime the value still crosses the boundary as `unknown`: every shape
+ * is re-validated by the migration, so a partial or malformed object is safe
+ * and simply skipped.
+ */
+export type Assets3346MigrationState = {
+    TokensController?: Partial<Pick<TokensControllerState, 'allTokens' | 'allIgnoredTokens'>>;
+    AccountsController?: {
+        internalAccounts?: {
+            accounts?: Record<string, Pick<AccountsControllerState['internalAccounts']['accounts'][string], 'address'>>;
+        };
+    };
+};
+export type AssetsInfoHealingPatch = {
+    assetsInfo: Record<Caip19AssetId, FungibleAssetMetadata>;
+    customAssets: Record<AccountId, Caip19AssetId[]>;
+};
+export type TempHealAssetsInfoMetadataOptions = {
+    /** Current `AssetsController` state the healing patch is computed against. */
+    state: AssetsControllerStateInternal;
+    /**
+     * Host-provided getter for the untrusted legacy state root (see
+     * `AssetsControllerOptions.tempMigrateAssetsInfoMetadataAssets3346`).
+     */
+    getMigrationState: () => unknown;
+    /** Optional Sentry-compatible reporter for healing failures. */
+    captureException?: (error: Error) => void;
+};
+/**
+ * TEMPORARY — will be removed in a future release.
+ *
+ * @param options - The options bag.
+ * @param options.state - Current controller state to compute the patch against.
+ * @param options.getMigrationState - Getter for the untrusted legacy state root.
+ * @param options.captureException - Optional reporter for healing failures.
+ * @returns Updated controller state with the healing patch applied, or the
+ * original state when there is nothing to heal or healing fails.
+ */
+export declare function tempHealAssetsInfoMetadata({ state, getMigrationState, captureException, }: TempHealAssetsInfoMetadataOptions): AssetsControllerStateInternal;
+/**
+ * Compute the additions required to heal `assetsInfo` metadata (and custom
+ * asset tracking) for tokens on niche EVM chains, based on the legacy
+ * `TokensController` state.
+ *
+ * What it deliberately skips:
+ *
+ * - Accounts-API-supported chains — see `ACCOUNT_API_SUPPORTED_CHAIN_IDS`.
+ * - Tokens the user hid/removed, detected via either the legacy
+ *   `TokensController.allIgnoredTokens` or the current
+ *   `assetPreferences` (`hidden: true`).
+ * - Non-EVM assets, ERC-721s, and tokens with invalid addresses or metadata.
+ *
+ * @param legacyState - Untrusted legacy state root. Expected (but not
+ * required) to contain `TokensController.allTokens`,
+ * `TokensController.allIgnoredTokens`, and
+ * `AccountsController.internalAccounts.accounts`.
+ * @param currentState - Current `AssetsController` state slices (read-only).
+ * @returns The additions to apply, or `null` when there is nothing to heal.
+ */
+export declare function healAssetsInfoMetadata(legacyState: unknown, currentState: CurrentAssetsState): AssetsInfoHealingPatch | null;
+//# sourceMappingURL=healAssetsInfoMetadata.d.cts.map

package/dist/migrations/healAssetsInfoMetadata.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"healAssetsInfoMetadata.d.cts","sourceRoot":"","sources":["../../src/migrations/healAssetsInfoMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,sCAAsC;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,qCAAqC;AAW1E,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,6BAA6B,EAC9B,qBAAiB;AAElB;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,6BAA6B,EAC7B,YAAY,GAAG,eAAe,GAAG,cAAc,GAAG,kBAAkB,CACrE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IAErC,gBAAgB,CAAC,EAAE,OAAO,CACxB,IAAI,CAAC,qBAAqB,EAAE,WAAW,GAAG,kBAAkB,CAAC,CAC9D,CAAC;IAEF,kBAAkB,CAAC,EAAE;QACnB,gBAAgB,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,MAAM,CACf,MAAM,EACN,IAAI,CACF,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,EAC/D,SAAS,CACV,CACF,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC;IACzD,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;CAClD,CAAC;AAIF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,8EAA8E;IAC9E,KAAK,EAAE,6BAA6B,CAAC;IACrC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAC;IACjC,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,KAAK,EACL,iBAAiB,EACjB,gBAAgB,GACjB,EAAE,iCAAiC,GAAG,6BAA6B,CAqCnE;AAmDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,kBAAkB,GAC/B,sBAAsB,GAAG,IAAI,CAmF/B"}

package/dist/migrations/healAssetsInfoMetadata.d.mts

@@ -0,0 +1,106 @@
+import type { AccountsControllerState } from "@metamask/accounts-controller";
+import type { TokensControllerState } from "@metamask/assets-controllers";
+import type { AccountId, Caip19AssetId, FungibleAssetMetadata, AssetsControllerStateInternal } from "../types.mjs";
+/**
+ * TEMPORARY MODULE — remove in a future release.
+ *
+ * Port of extension migration #215 (Assets Controller Metadata Healing).
+ * Issue: https://consensyssoftware.atlassian.net/browse/ASSETS-3346
+ * Incident: #incident-metamask-1731
+ *
+ * Background: after a prior defect in AssetsController, metadata for custom
+ * tokens was wiped. Most popular chains support auto-detection and can
+ * self-heal, however not all.
+ *
+ * This module computes the state additions needed to restore metadata for
+ * custom tokens on niche EVM chains (chains that cannot auto-detect and
+ * self-heal), using the legacy `TokensController.allTokens` state as the
+ * source of truth. It is a pure function so it can be tested in isolation;
+ * the controller applies the returned patch in its constructor.
+ *
+ * The legacy state is treated as fully untrusted (`unknown`): every shape is
+ * validated before use, and any unexpected input results in that entry being
+ * skipped (or `null` being returned when nothing is restorable).
+ */
+/**
+ * The slices of current `AssetsController` state the healing computation
+ * reads. Never mutated.
+ */
+export type CurrentAssetsState = Pick<AssetsControllerStateInternal, 'assetsInfo' | 'assetsBalance' | 'customAssets' | 'assetPreferences'>;
+/**
+ * TEMPORARY — will be removed in a future release.
+ *
+ * Shape of the legacy persisted state the ASSETS-3346 healing reads, derived
+ * from the real `TokensControllerState` and `AccountsControllerState` types.
+ * Use it to type the `tempMigrateAssetsInfoMetadataAssets3346` getter when
+ * integrating in a client.
+ *
+ * Everything is optional and only the listed slices are read:
+ *
+ * - `TokensController.allTokens` — required for any healing to happen.
+ * - `TokensController.allIgnoredTokens` — tokens the user hid/removed
+ *   (skipped during healing).
+ * - `AccountsController.internalAccounts.accounts` — maps addresses to
+ *   account IDs so healed tokens are also tracked in `customAssets`
+ *   (without it only `assetsInfo` is healed).
+ *
+ * At runtime the value still crosses the boundary as `unknown`: every shape
+ * is re-validated by the migration, so a partial or malformed object is safe
+ * and simply skipped.
+ */
+export type Assets3346MigrationState = {
+    TokensController?: Partial<Pick<TokensControllerState, 'allTokens' | 'allIgnoredTokens'>>;
+    AccountsController?: {
+        internalAccounts?: {
+            accounts?: Record<string, Pick<AccountsControllerState['internalAccounts']['accounts'][string], 'address'>>;
+        };
+    };
+};
+export type AssetsInfoHealingPatch = {
+    assetsInfo: Record<Caip19AssetId, FungibleAssetMetadata>;
+    customAssets: Record<AccountId, Caip19AssetId[]>;
+};
+export type TempHealAssetsInfoMetadataOptions = {
+    /** Current `AssetsController` state the healing patch is computed against. */
+    state: AssetsControllerStateInternal;
+    /**
+     * Host-provided getter for the untrusted legacy state root (see
+     * `AssetsControllerOptions.tempMigrateAssetsInfoMetadataAssets3346`).
+     */
+    getMigrationState: () => unknown;
+    /** Optional Sentry-compatible reporter for healing failures. */
+    captureException?: (error: Error) => void;
+};
+/**
+ * TEMPORARY — will be removed in a future release.
+ *
+ * @param options - The options bag.
+ * @param options.state - Current controller state to compute the patch against.
+ * @param options.getMigrationState - Getter for the untrusted legacy state root.
+ * @param options.captureException - Optional reporter for healing failures.
+ * @returns Updated controller state with the healing patch applied, or the
+ * original state when there is nothing to heal or healing fails.
+ */
+export declare function tempHealAssetsInfoMetadata({ state, getMigrationState, captureException, }: TempHealAssetsInfoMetadataOptions): AssetsControllerStateInternal;
+/**
+ * Compute the additions required to heal `assetsInfo` metadata (and custom
+ * asset tracking) for tokens on niche EVM chains, based on the legacy
+ * `TokensController` state.
+ *
+ * What it deliberately skips:
+ *
+ * - Accounts-API-supported chains — see `ACCOUNT_API_SUPPORTED_CHAIN_IDS`.
+ * - Tokens the user hid/removed, detected via either the legacy
+ *   `TokensController.allIgnoredTokens` or the current
+ *   `assetPreferences` (`hidden: true`).
+ * - Non-EVM assets, ERC-721s, and tokens with invalid addresses or metadata.
+ *
+ * @param legacyState - Untrusted legacy state root. Expected (but not
+ * required) to contain `TokensController.allTokens`,
+ * `TokensController.allIgnoredTokens`, and
+ * `AccountsController.internalAccounts.accounts`.
+ * @param currentState - Current `AssetsController` state slices (read-only).
+ * @returns The additions to apply, or `null` when there is nothing to heal.
+ */
+export declare function healAssetsInfoMetadata(legacyState: unknown, currentState: CurrentAssetsState): AssetsInfoHealingPatch | null;
+//# sourceMappingURL=healAssetsInfoMetadata.d.mts.map

package/dist/migrations/healAssetsInfoMetadata.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"healAssetsInfoMetadata.d.mts","sourceRoot":"","sources":["../../src/migrations/healAssetsInfoMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,sCAAsC;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,qCAAqC;AAW1E,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,6BAA6B,EAC9B,qBAAiB;AAElB;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,6BAA6B,EAC7B,YAAY,GAAG,eAAe,GAAG,cAAc,GAAG,kBAAkB,CACrE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IAErC,gBAAgB,CAAC,EAAE,OAAO,CACxB,IAAI,CAAC,qBAAqB,EAAE,WAAW,GAAG,kBAAkB,CAAC,CAC9D,CAAC;IAEF,kBAAkB,CAAC,EAAE;QACnB,gBAAgB,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,MAAM,CACf,MAAM,EACN,IAAI,CACF,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,EAC/D,SAAS,CACV,CACF,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAC;IACzD,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;CAClD,CAAC;AAIF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,8EAA8E;IAC9E,KAAK,EAAE,6BAA6B,CAAC;IACrC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAC;IACjC,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,KAAK,EACL,iBAAiB,EACjB,gBAAgB,GACjB,EAAE,iCAAiC,GAAG,6BAA6B,CAqCnE;AAmDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,kBAAkB,GAC/B,sBAAsB,GAAG,IAAI,CAmF/B"}

package/dist/migrations/healAssetsInfoMetadata.mjs

@@ -0,0 +1,381 @@
+import { getChecksumAddress, getErrorMessage, hasProperty, isObject } from "@metamask/utils";
+import $lodash from "lodash";
+const { cloneDeep } = $lodash;
+import { createModuleLogger, projectLogger } from "../logger.mjs";
+const log = createModuleLogger(projectLogger, 'tempHealAssetsInfoMetadata');
+/**
+ * TEMPORARY — will be removed in a future release.
+ *
+ * @param options - The options bag.
+ * @param options.state - Current controller state to compute the patch against.
+ * @param options.getMigrationState - Getter for the untrusted legacy state root.
+ * @param options.captureException - Optional reporter for healing failures.
+ * @returns Updated controller state with the healing patch applied, or the
+ * original state when there is nothing to heal or healing fails.
+ */
+export function tempHealAssetsInfoMetadata({ state, getMigrationState, captureException, }) {
+    const reportError = (error) => {
+        log('Failed to heal assetsInfo metadata', error);
+        captureException?.(new Error(`AssetsController: temporary assetsInfo metadata healing failed: ${getErrorMessage(error)}`));
+    };
+    let patch = null;
+    try {
+        patch = healAssetsInfoMetadata(getMigrationState(), state);
+    }
+    catch (error) {
+        reportError(error);
+    }
+    if (!patch) {
+        return state;
+    }
+    try {
+        const nextState = cloneDeep(state);
+        applyHealingPatch(nextState, patch);
+        log('Healed wiped assetsInfo metadata for niche-chain tokens', {
+            healedAssetsInfoCount: Object.keys(patch.assetsInfo).length,
+            healedCustomAssetsAccounts: Object.keys(patch.customAssets).length,
+        });
+        return nextState;
+    }
+    catch (error) {
+        reportError(error);
+        return state;
+    }
+}
+/**
+ * Apply a healing patch to (draft) controller state. Defensive against
+ * concurrent writes: fills `assetsInfo` gaps only and dedupes `customAssets`
+ * against the current draft rather than trusting the patch blindly.
+ *
+ * @param state - Mutable controller state copy.
+ * @param patch - The additions computed by {@link healAssetsInfoMetadata}.
+ */
+function applyHealingPatch(state, patch) {
+    var _a, _b;
+    for (const [assetId, metadata] of Object.entries(patch.assetsInfo)) {
+        (_a = state.assetsInfo)[_b = assetId] ?? (_a[_b] = metadata);
+    }
+    for (const [accountId, assetIds] of Object.entries(patch.customAssets)) {
+        const existing = state.customAssets[accountId] ?? [];
+        state.customAssets[accountId] = [
+            ...existing,
+            ...assetIds.filter((assetId) => !existing.includes(assetId)),
+        ];
+    }
+}
+const EVM_CHAIN_NAMESPACE = 'eip155';
+const EVM_ADDRESS_REGEX = /^0x[0-9a-fA-F]{40}$/u;
+/**
+ * Popular networks (covered by the Accounts API) can self-heal through
+ * auto-detection, so their tokens must not be touched. Frozen snapshot from
+ * extension migration #215.
+ */
+const ACCOUNT_API_SUPPORTED_CHAIN_IDS = new Set([
+    'eip155:1', // Ethereum Mainnet
+    'eip155:10', // Optimism
+    'eip155:56', // BNB Smart Chain
+    'eip155:137', // Polygon
+    'eip155:143', // Monad
+    'eip155:999', // HyperEVM
+    'eip155:1329', // Sei
+    'eip155:5042', // Arc
+    'eip155:8453', // Base
+    'eip155:42161', // Arbitrum One
+    'eip155:43114', // Avalanche
+    'eip155:59144', // Linea
+]);
+/**
+ * Compute the additions required to heal `assetsInfo` metadata (and custom
+ * asset tracking) for tokens on niche EVM chains, based on the legacy
+ * `TokensController` state.
+ *
+ * What it deliberately skips:
+ *
+ * - Accounts-API-supported chains — see `ACCOUNT_API_SUPPORTED_CHAIN_IDS`.
+ * - Tokens the user hid/removed, detected via either the legacy
+ *   `TokensController.allIgnoredTokens` or the current
+ *   `assetPreferences` (`hidden: true`).
+ * - Non-EVM assets, ERC-721s, and tokens with invalid addresses or metadata.
+ *
+ * @param legacyState - Untrusted legacy state root. Expected (but not
+ * required) to contain `TokensController.allTokens`,
+ * `TokensController.allIgnoredTokens`, and
+ * `AccountsController.internalAccounts.accounts`.
+ * @param currentState - Current `AssetsController` state slices (read-only).
+ * @returns The additions to apply, or `null` when there is nothing to heal.
+ */
+export function healAssetsInfoMetadata(legacyState, currentState) {
+    const allTokens = readPath(legacyState, ['TokensController', 'allTokens']);
+    if (!isObject(allTokens)) {
+        return null;
+    }
+    const addressToAccountId = buildAddressToAccountIdMap(legacyState);
+    const hiddenAssetIds = collectHiddenAssetIds(currentState);
+    const allIgnoredTokens = readPath(legacyState, [
+        'TokensController',
+        'allIgnoredTokens',
+    ]);
+    const assetsInfoAdditions = {};
+    const customAssetAdditions = {};
+    for (const [hexChainId, accountTokens] of Object.entries(allTokens)) {
+        if (!isObject(accountTokens)) {
+            continue;
+        }
+        const caip2 = hexChainIdToCaip2(hexChainId);
+        // Skip chains we can't parse or that self-heal via the accounts API.
+        if (!caip2 || ACCOUNT_API_SUPPORTED_CHAIN_IDS.has(caip2)) {
+            continue;
+        }
+        for (const [rawAddress, tokens] of Object.entries(accountTokens)) {
+            if (!Array.isArray(tokens) || tokens.length === 0) {
+                continue;
+            }
+            const accountId = addressToAccountId[rawAddress.toLowerCase()];
+            const ignoredAddresses = collectIgnoredAddresses(allIgnoredTokens, hexChainId, rawAddress);
+            for (const token of tokens) {
+                const restorable = getRestorableAsset(token, caip2, ignoredAddresses, hiddenAssetIds);
+                if (!restorable) {
+                    continue;
+                }
+                const { assetId, info } = restorable;
+                // `assetsInfo` is a global registry; fill gaps only, never overwrite.
+                if (currentState.assetsInfo[assetId] === undefined &&
+                    assetsInfoAdditions[assetId] === undefined) {
+                    assetsInfoAdditions[assetId] = info;
+                }
+                // Ensure the asset is tracked for its account.
+                if (accountId) {
+                    addCustomAssetAddition(currentState, customAssetAdditions, accountId, assetId);
+                }
+            }
+        }
+    }
+    if (Object.keys(assetsInfoAdditions).length === 0 &&
+        Object.keys(customAssetAdditions).length === 0) {
+        return null;
+    }
+    return {
+        assetsInfo: assetsInfoAdditions,
+        customAssets: customAssetAdditions,
+    };
+}
+/**
+ * Resolve a raw `TokensController` token entry to the CAIP-19 asset ID and
+ * metadata that should be healed, or `null` when the token must be skipped
+ * (not an object, missing/invalid address or symbol, an ERC-721, or hidden
+ * in either the legacy or the current controller).
+ *
+ * @param token - Raw token entry from `allTokens`.
+ * @param caip2 - The CAIP-2 chain ID of the token's chain (e.g. 'eip155:14').
+ * @param ignoredAddresses - Lowercase addresses hidden via legacy `allIgnoredTokens`.
+ * @param hiddenAssetIds - Lowercase asset IDs hidden via current `assetPreferences`.
+ * @returns The restorable asset, or `null` to skip.
+ */
+function getRestorableAsset(token, caip2, ignoredAddresses, hiddenAssetIds) {
+    if (!isObject(token)) {
+        return null;
+    }
+    // Skip NFTs — AssetsController tracks them separately.
+    if (token.isERC721 === true) {
+        return null;
+    }
+    if (typeof token.address !== 'string' ||
+        !EVM_ADDRESS_REGEX.test(token.address)) {
+        return null;
+    }
+    // Healed metadata with no symbol would be unusable in the UI; skip it.
+    if (typeof token.symbol !== 'string' || token.symbol.length === 0) {
+        return null;
+    }
+    const assetId = buildErc20AssetId(caip2, token.address);
+    if (!assetId) {
+        return null;
+    }
+    // Skip tokens the user hid/removed — in the legacy controller…
+    if (ignoredAddresses.has(token.address.toLowerCase())) {
+        return null;
+    }
+    // …or in the current controller.
+    if (hiddenAssetIds.has(assetId.toLowerCase())) {
+        return null;
+    }
+    return { assetId, info: buildEvmAssetInfo(token) };
+}
+/**
+ * Build a `FungibleAssetMetadata` from a raw `TokensController` token entry.
+ * The caller has already validated `symbol` as a non-empty string.
+ *
+ * @param token - Raw token object.
+ * @returns The metadata to write into `assetsInfo`.
+ */
+function buildEvmAssetInfo(token) {
+    const symbol = token.symbol;
+    const name = typeof token.name === 'string' && token.name.length > 0
+        ? token.name
+        : symbol;
+    const decimals = typeof token.decimals === 'number' && Number.isFinite(token.decimals)
+        ? token.decimals
+        : 0;
+    const image = typeof token.image === 'string' && token.image.length > 0
+        ? token.image
+        : undefined;
+    const aggregators = Array.isArray(token.aggregators)
+        ? token.aggregators.filter((aggregator) => typeof aggregator === 'string')
+        : undefined;
+    return {
+        type: 'erc20',
+        symbol,
+        name,
+        decimals,
+        ...(image ? { image } : {}),
+        ...(aggregators ? { aggregators } : {}),
+    };
+}
+/**
+ * Build a map from lowercase account address to account UUID using the
+ * legacy `AccountsController.internalAccounts.accounts`.
+ *
+ * @param legacyState - Untrusted legacy state root.
+ * @returns Map of lowercase address to account ID (empty on invalid input).
+ */
+function buildAddressToAccountIdMap(legacyState) {
+    const accounts = readPath(legacyState, [
+        'AccountsController',
+        'internalAccounts',
+        'accounts',
+    ]);
+    if (!isObject(accounts)) {
+        return {};
+    }
+    const map = {};
+    for (const [id, account] of Object.entries(accounts)) {
+        if (isObject(account) &&
+            typeof account.address === 'string' &&
+            account.address.length > 0) {
+            map[account.address.toLowerCase()] = id;
+        }
+    }
+    return map;
+}
+/**
+ * Collect the set of CAIP-19 asset IDs (lowercased) marked `hidden: true` in
+ * the current `assetPreferences`. Lowercasing lets callers compare against
+ * checksummed asset IDs case-insensitively.
+ *
+ * @param currentState - Current `AssetsController` state slices.
+ * @returns Set of lowercase hidden asset IDs.
+ */
+function collectHiddenAssetIds(currentState) {
+    const hidden = new Set();
+    for (const [assetId, preference] of Object.entries(currentState.assetPreferences)) {
+        if (isObject(preference) && preference.hidden === true) {
+            hidden.add(assetId.toLowerCase());
+        }
+    }
+    return hidden;
+}
+/**
+ * Collect the lowercase token addresses ignored (hidden) in the legacy
+ * `TokensController.allIgnoredTokens` for a given chain and account. The
+ * account key is matched case-insensitively.
+ *
+ * @param allIgnoredTokens - The legacy `allIgnoredTokens` map (possibly missing).
+ * @param hexChainId - The hex chain ID being processed.
+ * @param accountAddress - The account address whose ignored list to read.
+ * @returns Set of lowercase ignored token addresses.
+ */
+function collectIgnoredAddresses(allIgnoredTokens, hexChainId, accountAddress) {
+    const result = new Set();
+    if (!isObject(allIgnoredTokens)) {
+        return result;
+    }
+    const chainEntry = allIgnoredTokens[hexChainId];
+    if (!isObject(chainEntry)) {
+        return result;
+    }
+    const lowerAccount = accountAddress.toLowerCase();
+    for (const [address, list] of Object.entries(chainEntry)) {
+        if (address.toLowerCase() !== lowerAccount || !Array.isArray(list)) {
+            continue;
+        }
+        for (const ignored of list) {
+            if (typeof ignored === 'string') {
+                result.add(ignored.toLowerCase());
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Convert a hex chain ID (e.g. '0x1') to a CAIP-2 chain ID (e.g. 'eip155:1').
+ *
+ * @param hexChainId - The hex-encoded EVM chain ID.
+ * @returns The CAIP-2 chain ID, or `null` when the input cannot be parsed.
+ */
+function hexChainIdToCaip2(hexChainId) {
+    if (!/^0x[0-9a-fA-F]+$/u.test(hexChainId)) {
+        return null;
+    }
+    const decimal = Number.parseInt(hexChainId, 16);
+    if (!Number.isFinite(decimal)) {
+        return null;
+    }
+    return `${EVM_CHAIN_NAMESPACE}:${decimal}`;
+}
+/**
+ * Build the checksummed CAIP-19 asset ID for an ERC-20 token.
+ *
+ * @param caip2 - The CAIP-2 chain ID (e.g. 'eip155:14').
+ * @param tokenAddress - The ERC-20 contract address.
+ * @returns The asset ID, or `null` when the address cannot be checksummed.
+ */
+function buildErc20AssetId(caip2, tokenAddress) {
+    let checksummed;
+    try {
+        checksummed = getChecksumAddress(tokenAddress);
+    }
+    catch {
+        return null;
+    }
+    return `${caip2}/erc20:${checksummed}`;
+}
+/**
+ * Read a nested path on an unknown value, returning `undefined` if any
+ * intermediate key is missing or not an object.
+ *
+ * @param root - The value to read from.
+ * @param path - Sequence of keys to traverse.
+ * @returns The value at the path, or `undefined`.
+ */
+function readPath(root, path) {
+    return path.reduce((cursor, key) => {
+        if (!isObject(cursor) || !hasProperty(cursor, key)) {
+            return undefined;
+        }
+        return cursor[key];
+    }, root);
+}
+/**
+ * Record `assetId` as a custom-asset addition for `accountId` unless it is
+ * already tracked in the current `assetsBalance` (mutual exclusion), already
+ * present in the current `customAssets`, or already queued as an addition.
+ *
+ * @param currentState - Current `AssetsController` state slices.
+ * @param additions - The custom-asset additions accumulated so far (mutated).
+ * @param accountId - The account UUID.
+ * @param assetId - CAIP-19 asset identifier.
+ */
+function addCustomAssetAddition(currentState, additions, accountId, assetId) {
+    if (currentState.assetsBalance[accountId]?.[assetId]) {
+        return;
+    }
+    if (currentState.customAssets[accountId]?.includes(assetId)) {
+        return;
+    }
+    const queued = additions[accountId] ?? [];
+    if (!queued.includes(assetId)) {
+        queued.push(assetId);
+    }
+    additions[accountId] = queued;
+}
+//# sourceMappingURL=healAssetsInfoMetadata.mjs.map