@metamask/assets-controllers 42.0.0 → 43.1.0

package/dist/AssetsContractController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AssetsContractController.mjs","sourceRoot":"","sources":["../src/AssetsContractController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAKxD,OAAO,EAAE,wBAAwB,EAAE,mCAAmC;AAWtE,OAAO,EAAE,qBAAqB,EAAY,wBAAwB;AAElE,OAAO,8BAA6B,wCAAwC;;AAE5E,OAAO,EAAE,+BAA+B,EAAE,yBAAqB;AAC/D,OAAO,EAAE,aAAa,EAAE,sCAAkC;AAC1D,OAAO,EAAE,eAAe,EAAE,6DAAyD;AACnF,OAAO,EAAE,cAAc,EAAE,2DAAuD;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG;IACrD,CAAC,+BAA+B,CAAC,OAAO,CAAC,EACvC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,GAAG,CAAC,EACnC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,OAAO,CAAC,EACvC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,YAAY,CAAC,EAC5C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,aAAa,CAAC,EAC7C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,aAAa,CAAC,EAC7C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,SAAS,CAAC,EACzC,4CAA4C;CACR,CAAC;AAEzC,MAAM,CAAC,MAAM,sBAAsB,GACjC,uHAAuH,CAAC;AAY1H;;GAEG;AACH,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAgHxC;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAWnC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,OAAO,EAAE,cAAc,GAIxB;;QAvBQ,SAAI,GAAgB,IAAI,CAAC;QAIlC,qDAAgC;QAEhC,wDAAqB;QAErB,oDAAc;QAgBZ,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,uBAAA,IAAI,sCAAa,SAAS,MAAA,CAAC;QAC3B,uBAAA,IAAI,yCAAgB,wBAAwB,MAAA,CAAC;QAC7C,uBAAA,IAAI,qCAAY,cAAc,MAAA,CAAC;QAE/B,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC;QAC/B,uBAAA,IAAI,iGAA4B,MAAhC,IAAI,CAA8B,CAAC;IACrC,CAAC;IAqDD;;;;OAIG;IACH,WAAW,CAAC,QAA8B;QACxC,uBAAA,IAAI,sCAAa,QAAQ,MAAA,CAAC;IAC5B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,uBAAA,IAAI,6CAAa,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,yCAAS,CAAC;IACvB,CAAC;IAkDD;;;;;OAKG;IACH,gBAAgB,CAAC,eAAiC;QAChD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,eAAiC;QACjD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,eAAiC;QAClD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,eAAuB,EACvB,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAe,EACf,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAe,EACf,eAAuB,EACvB,KAAa,EACb,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,0BAA0B,CAC9B,YAAoB,EACpB,WAAoB,EACpB,OAAgB,EAChB,eAAiC;QASjC,gCAAgC;QAChC,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAE1C,SAAS;QACT,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YAC/D,OAAO;gBACL,GAAG,CAAC,MAAM,cAAc,CAAC,UAAU,CACjC,YAAY,EACZ,uBAAA,IAAI,6CAAa,EACjB,OAAO,CACR,CAAC;aACH,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,UAAU;QACV,IAAI;YACF,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;YACjE,OAAO;gBACL,GAAG,CAAC,MAAM,eAAe,CAAC,UAAU,CAClC,YAAY,EACZ,uBAAA,IAAI,6CAAa,EACjB,OAAO,CACR,CAAC;aACH,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,QAAQ;QACR,IAAI;YACF,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YAC7D,OAAO;gBACL,GAAG,CAAC,MAAM,aAAa,CAAC,UAAU,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;aAC/D,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,WAAmB,EACnB,UAAkB,EAClB,KAAa,EACb,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,qBAAqB,CACzB,UAAkB,EAClB,aAAqB,EACrB,gBAAwB,EACxB,KAAa,EACb,GAAW,EACX,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,cAAc,CACnC,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,KAAK,EACL,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,eAAuB,EACvB,cAAwB,EACxB,eAAiC;QAEjC,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,IACE,CAAC,CAAC,CAAC,EAAE,EAA8D,EAAE,CACnE,EAAE,IAAI,uCAAuC,CAAC,CAAC,OAAO,CAAC,EACzD;YACA,gDAAgD;YAChD,OAAO,EAAE,CAAC;SACX;QACD,MAAM,eAAe,GAAG,uCAAuC,CAAC,OAAO,CAAC,CAAC;QAEzE,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,eAAe,EACf,6BAA6B,EAC7B,QAAQ,CACT,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC,CAAC;QAC1E,MAAM,eAAe,GAAe,EAAE,CAAC;QACvC,0BAA0B;QAC1B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,cAAc,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;gBAC7C,MAAM,OAAO,GAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClC,0BAA0B;gBAC1B,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;oBAC3B,eAAe,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;iBACzC;YACH,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;;IApcG,MAAM,4BAA4B,GAAG;QACnC,aAAa;QACb,iBAAiB;QACjB,aAAa;QACb,UAAU;QACV,aAAa;QACb,SAAS;KACV,CAAC;IAEF,qBAAqB,CAAa,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CACpE,CAAC,MAAM,EAAE,EAAE;QACT,IACE,CAAC,CAAC,GAAe,EAA6C,EAAE,CAC9D,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC;YACpD,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,CAAC,MAAM,CAAC,EAC1C;YACA,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,IAAI,MAAM,EAAE;YACnB,uHAAuH;YACvH,0JAA0J;YAC1J,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACxB,CAAC;SACH;IACH,CAAC,CACF,CAAC;AACJ,CAAC;IAGC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;QAClB,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;IAClC,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oCAAoC,EACpC,CAAC,EAAE,uBAAuB,EAAE,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,uBAAuB,CAAC,CAAC;QAEjE,IAAI,uBAAA,IAAI,yCAAS,KAAK,OAAO,EAAE;YAC7B,uBAAA,IAAI,qCAAY,OAAO,MAAA,CAAC;YACxB,6FAA6F;YAC7F,uBAAA,IAAI,sCAAa,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,CAAsB,MAAA,CAAC;SAC7C;IACH,CAAC,CACF,CAAC;AACJ,CAAC,uGAyBmB,eAAiC;IACnD,MAAM,QAAQ,GAAG,eAAe;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,wCAAwC,EACxC,eAAe,CAChB,CAAC,QAAQ;QACZ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,4CAA4C,CAAC;YACrE,EAAE,QAAQ,IAAI,uBAAA,IAAI,0CAAU,CAAC;IAEnC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC,qGAQkB,eAAiC;IAClD,IAAI,eAAe,EAAE;QACnB,MAAM,0BAA0B,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC1D,4DAA4D,EAC5D,eAAe,CAChB,CAAC;QACF,IAAI,0BAA0B,EAAE;YAC9B,OAAO,0BAA0B,CAAC,OAAO,CAAC;SAC3C;KACF;IACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3D,4BAA4B,CAC7B,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IACF,OAAO,aAAa,CAAC,aAAa,EAAE,OAAO,IAAI,uBAAA,IAAI,yCAAS,CAAC;AAC/D,CAAC;AAsVH,eAAe,wBAAwB,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type {\n  ActionConstraint,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { IPFS_DEFAULT_GATEWAY_URL } from '@metamask/controller-utils';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientId,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerNetworkDidChangeEvent,\n  Provider,\n} from '@metamask/network-controller';\nimport type { PreferencesControllerStateChangeEvent } from '@metamask/preferences-controller';\nimport { getKnownPropertyNames, type Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport abiSingleCallBalancesContract from 'single-call-balance-checker-abi';\n\nimport { SupportedTokenDetectionNetworks } from './assetsUtil';\nimport { ERC20Standard } from './Standards/ERC20Standard';\nimport { ERC1155Standard } from './Standards/NftStandards/ERC1155/ERC1155Standard';\nimport { ERC721Standard } from './Standards/NftStandards/ERC721/ERC721Standard';\n\n/**\n * Check if token detection is enabled for certain networks\n *\n * @param chainId - ChainID of network\n * @returns Whether the current network supports token detection\n */\nexport const SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID = {\n  [SupportedTokenDetectionNetworks.mainnet]:\n    '0xb1f8e55c7f64d203c1400b9d8555d050f94adf39',\n  [SupportedTokenDetectionNetworks.bsc]:\n    '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',\n  [SupportedTokenDetectionNetworks.polygon]:\n    '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',\n  [SupportedTokenDetectionNetworks.avax]:\n    '0xD023D153a0DFa485130ECFdE2FAA7e612EF94818',\n  [SupportedTokenDetectionNetworks.aurora]:\n    '0x1286415D333855237f89Df27D388127181448538',\n  [SupportedTokenDetectionNetworks.linea_goerli]:\n    '0x10dAd7Ca3921471f616db788D9300DC97Db01783',\n  [SupportedTokenDetectionNetworks.linea_mainnet]:\n    '0xF62e6a41561b3650a69Bb03199C735e3E3328c0D',\n  [SupportedTokenDetectionNetworks.arbitrum]:\n    '0x151E24A486D7258dd7C33Fb67E4bB01919B7B32c',\n  [SupportedTokenDetectionNetworks.optimism]:\n    '0xB1c568e9C3E6bdaf755A60c7418C269eb11524FC',\n  [SupportedTokenDetectionNetworks.base]:\n    '0x6AA75276052D96696134252587894ef5FFA520af',\n  [SupportedTokenDetectionNetworks.zksync]:\n    '0x458fEd3144680a5b8bcfaa0F9594aa19B4Ea2D34',\n  [SupportedTokenDetectionNetworks.cronos]:\n    '0x768ca200f0fc702ac9ea502498c18f5eff176378',\n  [SupportedTokenDetectionNetworks.celo]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.gnosis]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.fantom]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.polygon_zkevm]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.moonbeam]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.moonriver]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n} as const satisfies Record<Hex, string>;\n\nexport const MISSING_PROVIDER_ERROR =\n  'AssetsContractController failed to set the provider correctly. A provider must be set for this method to be available';\n\n/**\n * @type BalanceMap\n *\n * Key value object containing the balance for each tokenAddress\n * @property [tokenAddress] - Address of the token\n */\nexport type BalanceMap = {\n  [tokenAddress: string]: BN;\n};\n\n/**\n * The name of the {@link AssetsContractController}\n */\nconst name = 'AssetsContractController';\n\n/**\n * A utility type that derives the public method names of a given messenger consumer class,\n * and uses it to generate the class's internal messenger action types.\n * @template Controller - A messenger consumer class.\n */\n// TODO: Figure out generic constraint and move to base-controller\ntype ControllerActionsMap<Controller> = {\n  [ClassMethod in keyof Controller as Controller[ClassMethod] extends ActionConstraint['handler']\n    ? ClassMethod\n    : never]: {\n    type: `${typeof name}:${ClassMethod & string}`;\n    handler: Controller[ClassMethod];\n  };\n};\n\ntype AssetsContractControllerActionsMap =\n  ControllerActionsMap<AssetsContractController>;\n\n/**\n * The union of all public class method names of {@link AssetsContractController}.\n */\ntype AssetsContractControllerMethodName =\n  keyof AssetsContractControllerActionsMap;\n\n/**\n * The union of all internal messenger actions available to the {@link AssetsContractControllerMessenger}.\n */\nexport type AssetsContractControllerActions =\n  AssetsContractControllerActionsMap[AssetsContractControllerMethodName];\n\nexport type AssetsContractControllerGetERC20StandardAction =\n  AssetsContractControllerActionsMap['getERC20Standard'];\n\nexport type AssetsContractControllerGetERC721StandardAction =\n  AssetsContractControllerActionsMap['getERC721Standard'];\n\nexport type AssetsContractControllerGetERC1155StandardAction =\n  AssetsContractControllerActionsMap['getERC1155Standard'];\n\nexport type AssetsContractControllerGetERC20BalanceOfAction =\n  AssetsContractControllerActionsMap['getERC20BalanceOf'];\n\nexport type AssetsContractControllerGetERC20TokenDecimalsAction =\n  AssetsContractControllerActionsMap['getERC20TokenDecimals'];\n\nexport type AssetsContractControllerGetERC20TokenNameAction =\n  AssetsContractControllerActionsMap['getERC20TokenName'];\n\nexport type AssetsContractControllerGetERC721NftTokenIdAction =\n  AssetsContractControllerActionsMap['getERC721NftTokenId'];\n\nexport type AssetsContractControllerGetERC721TokenURIAction =\n  AssetsContractControllerActionsMap['getERC721TokenURI'];\n\nexport type AssetsContractControllerGetERC721AssetNameAction =\n  AssetsContractControllerActionsMap['getERC721AssetName'];\n\nexport type AssetsContractControllerGetERC721AssetSymbolAction =\n  AssetsContractControllerActionsMap['getERC721AssetSymbol'];\n\nexport type AssetsContractControllerGetERC721OwnerOfAction =\n  AssetsContractControllerActionsMap['getERC721OwnerOf'];\n\nexport type AssetsContractControllerGetERC1155TokenURIAction =\n  AssetsContractControllerActionsMap['getERC1155TokenURI'];\n\nexport type AssetsContractControllerGetERC1155BalanceOfAction =\n  AssetsContractControllerActionsMap['getERC1155BalanceOf'];\n\nexport type AssetsContractControllerTransferSingleERC1155Action =\n  AssetsContractControllerActionsMap['transferSingleERC1155'];\n\nexport type AssetsContractControllerGetTokenStandardAndDetailsAction =\n  AssetsContractControllerActionsMap['getTokenStandardAndDetails'];\n\nexport type AssetsContractControllerGetBalancesInSingleCallAction =\n  AssetsContractControllerActionsMap['getBalancesInSingleCall'];\n\n/**\n * The union of all internal messenger events available to the {@link AssetsContractControllerMessenger}.\n */\nexport type AssetsContractControllerEvents = never;\n\n/**\n * The union of all external messenger actions that must be allowed by the {@link AssetsContractControllerMessenger}.\n */\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetNetworkConfigurationByNetworkClientId\n  | NetworkControllerGetSelectedNetworkClientAction\n  | NetworkControllerGetStateAction;\n\n/**\n * The union of all external messenger event that must be allowed by the {@link AssetsContractControllerMessenger}.\n */\nexport type AllowedEvents =\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerNetworkDidChangeEvent;\n\n/**\n * The messenger of the {@link AssetsContractController}.\n */\nexport type AssetsContractControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  AssetsContractControllerActions | AllowedActions,\n  AssetsContractControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that interacts with contracts on mainnet through web3\n */\nexport class AssetsContractController {\n  readonly name: typeof name = name;\n\n  protected messagingSystem: AssetsContractControllerMessenger;\n\n  #provider: Provider | undefined;\n\n  #ipfsGateway: string;\n\n  #chainId: Hex;\n\n  /**\n   * Creates a AssetsContractController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The controller messenger.\n   * @param options.chainId - The chain ID of the current network.\n   */\n  constructor({\n    messenger,\n    chainId: initialChainId,\n  }: {\n    messenger: AssetsContractControllerMessenger;\n    chainId: Hex;\n  }) {\n    this.messagingSystem = messenger;\n    this.#provider = undefined;\n    this.#ipfsGateway = IPFS_DEFAULT_GATEWAY_URL;\n    this.#chainId = initialChainId;\n\n    this.#registerActionHandlers();\n    this.#registerEventSubscriptions();\n  }\n\n  // TODO: Expand into base-controller utility function that batch registers action handlers.\n  #registerActionHandlers() {\n    const methodsExcludedFromMessenger = [\n      'constructor',\n      'messagingSystem',\n      'setProvider',\n      'provider',\n      'ipfsGateway',\n      'chainId',\n    ];\n\n    getKnownPropertyNames<keyof this>(Object.getPrototypeOf(this)).forEach(\n      (method) => {\n        if (\n          ((key: keyof this): key is AssetsContractControllerMethodName =>\n            !methodsExcludedFromMessenger.find((e) => e === key) &&\n            typeof this[key] === 'function')(method)\n        ) {\n          this.messagingSystem.registerActionHandler(\n            `${name}:${method}`,\n            // TODO: Write a generic for-loop implementation that iterates over an input union type in tandem with the input array.\n            // @ts-expect-error Both assigned argument and assignee parameter are using the entire union type for `method` instead of the type for the current element\n            this[method].bind(this),\n          );\n        }\n      },\n    );\n  }\n\n  #registerEventSubscriptions() {\n    this.messagingSystem.subscribe(\n      `PreferencesController:stateChange`,\n      ({ ipfsGateway }) => {\n        this.#ipfsGateway = ipfsGateway;\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      `NetworkController:networkDidChange`,\n      ({ selectedNetworkClientId }) => {\n        const chainId = this.#getCorrectChainId(selectedNetworkClientId);\n\n        if (this.#chainId !== chainId) {\n          this.#chainId = chainId;\n          // @ts-expect-error TODO: remove this annotation once the `Eip1193Provider` class is released\n          this.#provider = this.#getCorrectProvider();\n        }\n      },\n    );\n  }\n\n  /**\n   * Sets a new provider.\n   *\n   * @param provider - Provider used to create a new underlying Web3 instance\n   */\n  setProvider(provider: Provider | undefined) {\n    this.#provider = provider;\n  }\n\n  get ipfsGateway() {\n    return this.#ipfsGateway;\n  }\n\n  get chainId() {\n    return this.#chainId;\n  }\n\n  /**\n   * Get the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID.\n   * @returns Web3Provider instance.\n   */\n  #getCorrectProvider(networkClientId?: NetworkClientId): Web3Provider {\n    const provider = networkClientId\n      ? this.messagingSystem.call(\n          `NetworkController:getNetworkClientById`,\n          networkClientId,\n        ).provider\n      : this.messagingSystem.call('NetworkController:getSelectedNetworkClient')\n          ?.provider ?? this.#provider;\n\n    if (provider === undefined) {\n      throw new Error(MISSING_PROVIDER_ERROR);\n    }\n\n    return new Web3Provider(provider);\n  }\n\n  /**\n   * Get the relevant chain ID.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns Hex chain ID.\n   */\n  #getCorrectChainId(networkClientId?: NetworkClientId): Hex {\n    if (networkClientId) {\n      const networkClientConfiguration = this.messagingSystem.call(\n        'NetworkController:getNetworkConfigurationByNetworkClientId',\n        networkClientId,\n      );\n      if (networkClientConfiguration) {\n        return networkClientConfiguration.chainId;\n      }\n    }\n    const { selectedNetworkClientId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n    const networkClient = this.messagingSystem.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n    return networkClient.configuration?.chainId ?? this.#chainId;\n  }\n\n  /**\n   * Get a ERC20Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC20Standard instance.\n   */\n  getERC20Standard(networkClientId?: NetworkClientId): ERC20Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC20Standard(provider);\n  }\n\n  /**\n   * Get a ERC721Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC721Standard instance.\n   */\n  getERC721Standard(networkClientId?: NetworkClientId): ERC721Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC721Standard(provider);\n  }\n\n  /**\n   * Get a ERC1155Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC1155Standard instance.\n   */\n  getERC1155Standard(networkClientId?: NetworkClientId): ERC1155Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC1155Standard(provider);\n  }\n\n  /**\n   * Get balance or count for current account on specific asset contract.\n   *\n   * @param address - Asset ERC20 contract address.\n   * @param selectedAddress - Current account public address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to BN object containing balance for current account on specific asset contract.\n   */\n  async getERC20BalanceOf(\n    address: string,\n    selectedAddress: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<BN> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getBalanceOf(address, selectedAddress);\n  }\n\n  /**\n   * Query for the decimals for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getERC20TokenDecimals(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getTokenDecimals(address);\n  }\n\n  /**\n   * Query for the name for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getERC20TokenName(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getTokenName(address);\n  }\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param selectedAddress - Current account public address.\n   * @param index - An NFT counter less than `balanceOf(selectedAddress)`.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.\n   */\n  async getERC721NftTokenId(\n    address: string,\n    selectedAddress: string,\n    index: number,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getNftTokenId(address, selectedAddress, index);\n  }\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param tokenAddress - ERC721 asset contract address.\n   * @param userAddress - Current account public address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to an object containing the token standard and a set of details which depend on which standard the token supports.\n   */\n  async getTokenStandardAndDetails(\n    tokenAddress: string,\n    userAddress?: string,\n    tokenId?: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<{\n    standard: string;\n    tokenURI?: string | undefined;\n    symbol?: string | undefined;\n    name?: string | undefined;\n    decimals?: string | undefined;\n    balance?: BN | undefined;\n  }> {\n    // Asserts provider is available\n    this.#getCorrectProvider(networkClientId);\n\n    // ERC721\n    try {\n      const erc721Standard = this.getERC721Standard(networkClientId);\n      return {\n        ...(await erc721Standard.getDetails(\n          tokenAddress,\n          this.#ipfsGateway,\n          tokenId,\n        )),\n      };\n    } catch {\n      // Ignore\n    }\n\n    // ERC1155\n    try {\n      const erc1155Standard = this.getERC1155Standard(networkClientId);\n      return {\n        ...(await erc1155Standard.getDetails(\n          tokenAddress,\n          this.#ipfsGateway,\n          tokenId,\n        )),\n      };\n    } catch {\n      // Ignore\n    }\n\n    // ERC20\n    try {\n      const erc20Standard = this.getERC20Standard(networkClientId);\n      return {\n        ...(await erc20Standard.getDetails(tokenAddress, userAddress)),\n      };\n    } catch {\n      // Ignore\n    }\n\n    throw new Error('Unable to determine contract standard');\n  }\n\n  /**\n   * Query for tokenURI for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  async getERC721TokenURI(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getTokenURI(address, tokenId);\n  }\n\n  /**\n   * Query for name for a given asset.\n   *\n   * @param address - ERC721 or ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'name'.\n   */\n  async getERC721AssetName(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getAssetName(address);\n  }\n\n  /**\n   * Query for symbol for a given asset.\n   *\n   * @param address - ERC721 or ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'symbol'.\n   */\n  async getERC721AssetSymbol(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getAssetSymbol(address);\n  }\n\n  /**\n   * Query for owner for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the owner address.\n   */\n  async getERC721OwnerOf(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getOwnerOf(address, tokenId);\n  }\n\n  /**\n   * Query for tokenURI for a given asset.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @param tokenId - ERC1155 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  async getERC1155TokenURI(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.getTokenURI(address, tokenId);\n  }\n\n  /**\n   * Query for balance of a given ERC 1155 token.\n   *\n   * @param userAddress - Wallet public address.\n   * @param nftAddress - ERC1155 asset contract address.\n   * @param nftId - ERC1155 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'balanceOf'.\n   */\n  async getERC1155BalanceOf(\n    userAddress: string,\n    nftAddress: string,\n    nftId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<BN> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.getBalanceOf(nftAddress, userAddress, nftId);\n  }\n\n  /**\n   * Transfer single ERC1155 token.\n   *\n   * @param nftAddress - ERC1155 token address.\n   * @param senderAddress - ERC1155 token sender.\n   * @param recipientAddress - ERC1155 token recipient.\n   * @param nftId - ERC1155 token id.\n   * @param qty - Quantity of tokens to be sent.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'transferSingle' ERC1155 token.\n   */\n  async transferSingleERC1155(\n    nftAddress: string,\n    senderAddress: string,\n    recipientAddress: string,\n    nftId: string,\n    qty: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<void> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.transferSingle(\n      nftAddress,\n      senderAddress,\n      recipientAddress,\n      nftId,\n      qty,\n    );\n  }\n\n  /**\n   * Get the token balance for a list of token addresses in a single call. Only non-zero balances\n   * are returned.\n   *\n   * @param selectedAddress - The address to check token balances for.\n   * @param tokensToDetect - The token addresses to detect balances for.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns The list of non-zero token balances.\n   */\n  async getBalancesInSingleCall(\n    selectedAddress: string,\n    tokensToDetect: string[],\n    networkClientId?: NetworkClientId,\n  ) {\n    const chainId = this.#getCorrectChainId(networkClientId);\n    const provider = this.#getCorrectProvider(networkClientId);\n    if (\n      !((id): id is keyof typeof SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID =>\n        id in SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID)(chainId)\n    ) {\n      // Only fetch balance if contract address exists\n      return {};\n    }\n    const contractAddress = SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID[chainId];\n\n    const contract = new Contract(\n      contractAddress,\n      abiSingleCallBalancesContract,\n      provider,\n    );\n    const result = await contract.balances([selectedAddress], tokensToDetect);\n    const nonZeroBalances: BalanceMap = {};\n    /* istanbul ignore else */\n    if (result.length > 0) {\n      tokensToDetect.forEach((tokenAddress, index) => {\n        const balance: BN = result[index];\n        /* istanbul ignore else */\n        if (String(balance) !== '0') {\n          nonZeroBalances[tokenAddress] = balance;\n        }\n      });\n    }\n    return nonZeroBalances;\n  }\n}\n\nexport default AssetsContractController;\n"]}
+{"version":3,"file":"AssetsContractController.mjs","sourceRoot":"","sources":["../src/AssetsContractController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,wDAAwD;AACxD,OAAO,EAAE,SAAS,EAAE,iCAAiC;AACrD,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAKxD,OAAO,EAAE,wBAAwB,EAAE,mCAAmC;AAWtE,OAAO,EAAE,qBAAqB,EAAY,wBAAwB;AAElE,OAAO,8BAA6B,wCAAwC;;AAE5E,OAAO,EACL,8BAA8B,EAC9B,+BAA+B,EAChC,yBAAqB;AACtB,OAAO,EAAE,aAAa,EAAE,sCAAkC;AAC1D,OAAO,EAAE,eAAe,EAAE,6DAAyD;AACnF,OAAO,EAAE,cAAc,EAAE,2DAAuD;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG;IACrD,CAAC,+BAA+B,CAAC,OAAO,CAAC,EACvC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,GAAG,CAAC,EACnC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,OAAO,CAAC,EACvC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,YAAY,CAAC,EAC5C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,aAAa,CAAC,EAC7C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,aAAa,CAAC,EAC7C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,SAAS,CAAC,EACzC,4CAA4C;CACR,CAAC;AAEzC,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,CAAC,8BAA8B,CAAC,OAAO,CAAC,EACtC,4CAA4C;IAC9C,CAAC,8BAA8B,CAAC,OAAO,CAAC,EACtC,4CAA4C;CACR,CAAC;AAEzC,MAAM,CAAC,MAAM,sBAAsB,GACjC,uHAAuH,CAAC;AAY1H;;GAEG;AACH,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAkHxC;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAWnC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,OAAO,EAAE,cAAc,GAIxB;;QAvBQ,SAAI,GAAgB,IAAI,CAAC;QAIlC,qDAAgC;QAEhC,wDAAqB;QAErB,oDAAc;QAgBZ,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,uBAAA,IAAI,sCAAa,SAAS,MAAA,CAAC;QAC3B,uBAAA,IAAI,yCAAgB,wBAAwB,MAAA,CAAC;QAC7C,uBAAA,IAAI,qCAAY,cAAc,MAAA,CAAC;QAE/B,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC;QAC/B,uBAAA,IAAI,iGAA4B,MAAhC,IAAI,CAA8B,CAAC;IACrC,CAAC;IAqDD;;;;OAIG;IACH,WAAW,CAAC,QAA8B;QACxC,uBAAA,IAAI,sCAAa,QAAQ,MAAA,CAAC;IAC5B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,uBAAA,IAAI,6CAAa,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,yCAAS,CAAC;IACvB,CAAC;IAkDD;;;;;OAKG;IACH,gBAAgB,CAAC,eAAiC;QAChD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,eAAiC;QACjD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,eAAiC;QAClD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,eAAuB,EACvB,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAe,EACf,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAe,EACf,eAAuB,EACvB,KAAa,EACb,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,0BAA0B,CAC9B,YAAoB,EACpB,WAAoB,EACpB,OAAgB,EAChB,eAAiC;QASjC,gCAAgC;QAChC,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAE1C,SAAS;QACT,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YAC/D,OAAO;gBACL,GAAG,CAAC,MAAM,cAAc,CAAC,UAAU,CACjC,YAAY,EACZ,uBAAA,IAAI,6CAAa,EACjB,OAAO,CACR,CAAC;aACH,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,UAAU;QACV,IAAI;YACF,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;YACjE,OAAO;gBACL,GAAG,CAAC,MAAM,eAAe,CAAC,UAAU,CAClC,YAAY,EACZ,uBAAA,IAAI,6CAAa,EACjB,OAAO,CACR,CAAC;aACH,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,QAAQ;QACR,IAAI;YACF,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YAC7D,OAAO;gBACL,GAAG,CAAC,MAAM,aAAa,CAAC,UAAU,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;aAC/D,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,WAAmB,EACnB,UAAkB,EAClB,KAAa,EACb,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,qBAAqB,CACzB,UAAkB,EAClB,aAAqB,EACrB,gBAAwB,EACxB,KAAa,EACb,GAAW,EACX,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,cAAc,CACnC,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,KAAK,EACL,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,eAAuB,EACvB,cAAwB,EACxB,eAAiC;QAEjC,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,IACE,CAAC,CAAC,CAAC,EAAE,EAA8D,EAAE,CACnE,EAAE,IAAI,uCAAuC,CAAC,CAAC,OAAO,CAAC,EACzD;YACA,gDAAgD;YAChD,OAAO,EAAE,CAAC;SACX;QACD,MAAM,eAAe,GAAG,uCAAuC,CAAC,OAAO,CAAC,CAAC;QAEzE,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,eAAe,EACf,6BAA6B,EAC7B,QAAQ,CACT,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC,CAAC;QAC1E,MAAM,eAAe,GAAe,EAAE,CAAC;QACvC,0BAA0B;QAC1B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,cAAc,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;gBAC7C,MAAM,OAAO,GAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClC,0BAA0B;gBAC1B,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;oBAC3B,eAAe,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;iBACzC;YACH,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAe,EACf,eAAiC;QAEjC,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAE3D,2BAA2B;QAC3B,IAAI,OAAO,GAAc,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE3C,kDAAkD;QAClD,IACE,CAAC;YACC,8BAA8B,CAAC,OAAO;YACtC,8BAA8B,CAAC,OAAO;SACvC,CAAC,QAAQ,CAAC,OAAyC,CAAC,EACrD;YACA,OAAO,SAA0B,CAAC;SACnC;QACD,uDAAuD;QACvD,IACE,CAAC,CAAC,CAAC,EAAE,EAA0D,EAAE,CAC/D,EAAE,IAAI,mCAAmC,CAAC,CAAC,OAAO,CAAC,EACrD;YACA,OAAO,SAA0B,CAAC;SACnC;QAED,MAAM,eAAe,GAAG,mCAAmC,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,GAAG,GAAG;YACV;gBACE,MAAM,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACvE,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACjE,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,UAAU;aACjB;YACD;gBACE,MAAM,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACtE,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;gBACvE,eAAe,EAAE,MAAM;gBACvB,IAAI,EAAE,UAAU;aACjB;SACF,CAAC;QAEF,IAAI;YACF,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC9D,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAErD,kFAAkF;YAClF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACtB,OAAO,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;aACjE;SACF;QAAC,OAAO,KAAK,EAAE;YACd,uDAAuD;YACvD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACtB;QAED,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC;CACF;;IAxgBG,MAAM,4BAA4B,GAAG;QACnC,aAAa;QACb,iBAAiB;QACjB,aAAa;QACb,UAAU;QACV,aAAa;QACb,SAAS;KACV,CAAC;IAEF,qBAAqB,CAAa,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CACpE,CAAC,MAAM,EAAE,EAAE;QACT,IACE,CAAC,CAAC,GAAe,EAA6C,EAAE,CAC9D,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC;YACpD,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,CAAC,MAAM,CAAC,EAC1C;YACA,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,IAAI,MAAM,EAAE;YACnB,uHAAuH;YACvH,0JAA0J;YAC1J,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACxB,CAAC;SACH;IACH,CAAC,CACF,CAAC;AACJ,CAAC;IAGC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;QAClB,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;IAClC,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oCAAoC,EACpC,CAAC,EAAE,uBAAuB,EAAE,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,uBAAuB,CAAC,CAAC;QAEjE,IAAI,uBAAA,IAAI,yCAAS,KAAK,OAAO,EAAE;YAC7B,uBAAA,IAAI,qCAAY,OAAO,MAAA,CAAC;YACxB,6FAA6F;YAC7F,uBAAA,IAAI,sCAAa,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,CAAsB,MAAA,CAAC;SAC7C;IACH,CAAC,CACF,CAAC;AACJ,CAAC,uGAyBmB,eAAiC;IACnD,MAAM,QAAQ,GAAG,eAAe;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,wCAAwC,EACxC,eAAe,CAChB,CAAC,QAAQ;QACZ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,4CAA4C,CAAC;YACrE,EAAE,QAAQ,IAAI,uBAAA,IAAI,0CAAU,CAAC;IAEnC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC,qGAQkB,eAAiC;IAClD,IAAI,eAAe,EAAE;QACnB,MAAM,0BAA0B,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC1D,4DAA4D,EAC5D,eAAe,CAChB,CAAC;QACF,IAAI,0BAA0B,EAAE;YAC9B,OAAO,0BAA0B,CAAC,OAAO,CAAC;SAC3C;KACF;IACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3D,4BAA4B,CAC7B,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IACF,OAAO,aAAa,CAAC,aAAa,EAAE,OAAO,IAAI,uBAAA,IAAI,yCAAS,CAAC;AAC/D,CAAC;AA0ZH,eAAe,wBAAwB,CAAC","sourcesContent":["// import { BigNumber } from '@ethersproject/bignumber';\nimport { BigNumber } from '@ethersproject/bignumber';\nimport { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type {\n  ActionConstraint,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { IPFS_DEFAULT_GATEWAY_URL } from '@metamask/controller-utils';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientId,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerNetworkDidChangeEvent,\n  Provider,\n} from '@metamask/network-controller';\nimport type { PreferencesControllerStateChangeEvent } from '@metamask/preferences-controller';\nimport { getKnownPropertyNames, type Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport abiSingleCallBalancesContract from 'single-call-balance-checker-abi';\n\nimport {\n  SupportedStakedBalanceNetworks,\n  SupportedTokenDetectionNetworks,\n} from './assetsUtil';\nimport { ERC20Standard } from './Standards/ERC20Standard';\nimport { ERC1155Standard } from './Standards/NftStandards/ERC1155/ERC1155Standard';\nimport { ERC721Standard } from './Standards/NftStandards/ERC721/ERC721Standard';\n\n/**\n * Check if token detection is enabled for certain networks\n *\n * @param chainId - ChainID of network\n * @returns Whether the current network supports token detection\n */\nexport const SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID = {\n  [SupportedTokenDetectionNetworks.mainnet]:\n    '0xb1f8e55c7f64d203c1400b9d8555d050f94adf39',\n  [SupportedTokenDetectionNetworks.bsc]:\n    '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',\n  [SupportedTokenDetectionNetworks.polygon]:\n    '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',\n  [SupportedTokenDetectionNetworks.avax]:\n    '0xD023D153a0DFa485130ECFdE2FAA7e612EF94818',\n  [SupportedTokenDetectionNetworks.aurora]:\n    '0x1286415D333855237f89Df27D388127181448538',\n  [SupportedTokenDetectionNetworks.linea_goerli]:\n    '0x10dAd7Ca3921471f616db788D9300DC97Db01783',\n  [SupportedTokenDetectionNetworks.linea_mainnet]:\n    '0xF62e6a41561b3650a69Bb03199C735e3E3328c0D',\n  [SupportedTokenDetectionNetworks.arbitrum]:\n    '0x151E24A486D7258dd7C33Fb67E4bB01919B7B32c',\n  [SupportedTokenDetectionNetworks.optimism]:\n    '0xB1c568e9C3E6bdaf755A60c7418C269eb11524FC',\n  [SupportedTokenDetectionNetworks.base]:\n    '0x6AA75276052D96696134252587894ef5FFA520af',\n  [SupportedTokenDetectionNetworks.zksync]:\n    '0x458fEd3144680a5b8bcfaa0F9594aa19B4Ea2D34',\n  [SupportedTokenDetectionNetworks.cronos]:\n    '0x768ca200f0fc702ac9ea502498c18f5eff176378',\n  [SupportedTokenDetectionNetworks.celo]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.gnosis]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.fantom]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.polygon_zkevm]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.moonbeam]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.moonriver]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n} as const satisfies Record<Hex, string>;\n\nexport const STAKING_CONTRACT_ADDRESS_BY_CHAINID = {\n  [SupportedStakedBalanceNetworks.mainnet]:\n    '0x4fef9d741011476750a243ac70b9789a63dd47df',\n  [SupportedStakedBalanceNetworks.holesky]:\n    '0x37bf0883c27365cffcd0c4202918df930989891f',\n} as const satisfies Record<Hex, string>;\n\nexport const MISSING_PROVIDER_ERROR =\n  'AssetsContractController failed to set the provider correctly. A provider must be set for this method to be available';\n\n/**\n * @type BalanceMap\n *\n * Key value object containing the balance for each tokenAddress\n * @property [tokenAddress] - Address of the token\n */\nexport type BalanceMap = {\n  [tokenAddress: string]: BN;\n};\n\n/**\n * The name of the {@link AssetsContractController}\n */\nconst name = 'AssetsContractController';\n\n/**\n * A utility type that derives the public method names of a given messenger consumer class,\n * and uses it to generate the class's internal messenger action types.\n * @template Controller - A messenger consumer class.\n */\n// TODO: Figure out generic constraint and move to base-controller\ntype ControllerActionsMap<Controller> = {\n  [ClassMethod in keyof Controller as Controller[ClassMethod] extends ActionConstraint['handler']\n    ? ClassMethod\n    : never]: {\n    type: `${typeof name}:${ClassMethod & string}`;\n    handler: Controller[ClassMethod];\n  };\n};\n\ntype AssetsContractControllerActionsMap =\n  ControllerActionsMap<AssetsContractController>;\n\n/**\n * The union of all public class method names of {@link AssetsContractController}.\n */\ntype AssetsContractControllerMethodName =\n  keyof AssetsContractControllerActionsMap;\n\n/**\n * The union of all internal messenger actions available to the {@link AssetsContractControllerMessenger}.\n */\nexport type AssetsContractControllerActions =\n  AssetsContractControllerActionsMap[AssetsContractControllerMethodName];\n\nexport type AssetsContractControllerGetERC20StandardAction =\n  AssetsContractControllerActionsMap['getERC20Standard'];\n\nexport type AssetsContractControllerGetERC721StandardAction =\n  AssetsContractControllerActionsMap['getERC721Standard'];\n\nexport type AssetsContractControllerGetERC1155StandardAction =\n  AssetsContractControllerActionsMap['getERC1155Standard'];\n\nexport type AssetsContractControllerGetERC20BalanceOfAction =\n  AssetsContractControllerActionsMap['getERC20BalanceOf'];\n\nexport type AssetsContractControllerGetERC20TokenDecimalsAction =\n  AssetsContractControllerActionsMap['getERC20TokenDecimals'];\n\nexport type AssetsContractControllerGetERC20TokenNameAction =\n  AssetsContractControllerActionsMap['getERC20TokenName'];\n\nexport type AssetsContractControllerGetERC721NftTokenIdAction =\n  AssetsContractControllerActionsMap['getERC721NftTokenId'];\n\nexport type AssetsContractControllerGetERC721TokenURIAction =\n  AssetsContractControllerActionsMap['getERC721TokenURI'];\n\nexport type AssetsContractControllerGetERC721AssetNameAction =\n  AssetsContractControllerActionsMap['getERC721AssetName'];\n\nexport type AssetsContractControllerGetERC721AssetSymbolAction =\n  AssetsContractControllerActionsMap['getERC721AssetSymbol'];\n\nexport type AssetsContractControllerGetERC721OwnerOfAction =\n  AssetsContractControllerActionsMap['getERC721OwnerOf'];\n\nexport type AssetsContractControllerGetERC1155TokenURIAction =\n  AssetsContractControllerActionsMap['getERC1155TokenURI'];\n\nexport type AssetsContractControllerGetERC1155BalanceOfAction =\n  AssetsContractControllerActionsMap['getERC1155BalanceOf'];\n\nexport type AssetsContractControllerTransferSingleERC1155Action =\n  AssetsContractControllerActionsMap['transferSingleERC1155'];\n\nexport type AssetsContractControllerGetTokenStandardAndDetailsAction =\n  AssetsContractControllerActionsMap['getTokenStandardAndDetails'];\n\nexport type AssetsContractControllerGetBalancesInSingleCallAction =\n  AssetsContractControllerActionsMap['getBalancesInSingleCall'];\n\n/**\n * The union of all internal messenger events available to the {@link AssetsContractControllerMessenger}.\n */\nexport type AssetsContractControllerEvents = never;\n\n/**\n * The union of all external messenger actions that must be allowed by the {@link AssetsContractControllerMessenger}.\n */\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetNetworkConfigurationByNetworkClientId\n  | NetworkControllerGetSelectedNetworkClientAction\n  | NetworkControllerGetStateAction;\n\n/**\n * The union of all external messenger event that must be allowed by the {@link AssetsContractControllerMessenger}.\n */\nexport type AllowedEvents =\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerNetworkDidChangeEvent;\n\n/**\n * The messenger of the {@link AssetsContractController}.\n */\nexport type AssetsContractControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  AssetsContractControllerActions | AllowedActions,\n  AssetsContractControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\nexport type StakedBalance = string | undefined;\n\n/**\n * Controller that interacts with contracts on mainnet through web3\n */\nexport class AssetsContractController {\n  readonly name: typeof name = name;\n\n  protected messagingSystem: AssetsContractControllerMessenger;\n\n  #provider: Provider | undefined;\n\n  #ipfsGateway: string;\n\n  #chainId: Hex;\n\n  /**\n   * Creates a AssetsContractController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The controller messenger.\n   * @param options.chainId - The chain ID of the current network.\n   */\n  constructor({\n    messenger,\n    chainId: initialChainId,\n  }: {\n    messenger: AssetsContractControllerMessenger;\n    chainId: Hex;\n  }) {\n    this.messagingSystem = messenger;\n    this.#provider = undefined;\n    this.#ipfsGateway = IPFS_DEFAULT_GATEWAY_URL;\n    this.#chainId = initialChainId;\n\n    this.#registerActionHandlers();\n    this.#registerEventSubscriptions();\n  }\n\n  // TODO: Expand into base-controller utility function that batch registers action handlers.\n  #registerActionHandlers() {\n    const methodsExcludedFromMessenger = [\n      'constructor',\n      'messagingSystem',\n      'setProvider',\n      'provider',\n      'ipfsGateway',\n      'chainId',\n    ];\n\n    getKnownPropertyNames<keyof this>(Object.getPrototypeOf(this)).forEach(\n      (method) => {\n        if (\n          ((key: keyof this): key is AssetsContractControllerMethodName =>\n            !methodsExcludedFromMessenger.find((e) => e === key) &&\n            typeof this[key] === 'function')(method)\n        ) {\n          this.messagingSystem.registerActionHandler(\n            `${name}:${method}`,\n            // TODO: Write a generic for-loop implementation that iterates over an input union type in tandem with the input array.\n            // @ts-expect-error Both assigned argument and assignee parameter are using the entire union type for `method` instead of the type for the current element\n            this[method].bind(this),\n          );\n        }\n      },\n    );\n  }\n\n  #registerEventSubscriptions() {\n    this.messagingSystem.subscribe(\n      `PreferencesController:stateChange`,\n      ({ ipfsGateway }) => {\n        this.#ipfsGateway = ipfsGateway;\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      `NetworkController:networkDidChange`,\n      ({ selectedNetworkClientId }) => {\n        const chainId = this.#getCorrectChainId(selectedNetworkClientId);\n\n        if (this.#chainId !== chainId) {\n          this.#chainId = chainId;\n          // @ts-expect-error TODO: remove this annotation once the `Eip1193Provider` class is released\n          this.#provider = this.#getCorrectProvider();\n        }\n      },\n    );\n  }\n\n  /**\n   * Sets a new provider.\n   *\n   * @param provider - Provider used to create a new underlying Web3 instance\n   */\n  setProvider(provider: Provider | undefined) {\n    this.#provider = provider;\n  }\n\n  get ipfsGateway() {\n    return this.#ipfsGateway;\n  }\n\n  get chainId() {\n    return this.#chainId;\n  }\n\n  /**\n   * Get the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID.\n   * @returns Web3Provider instance.\n   */\n  #getCorrectProvider(networkClientId?: NetworkClientId): Web3Provider {\n    const provider = networkClientId\n      ? this.messagingSystem.call(\n          `NetworkController:getNetworkClientById`,\n          networkClientId,\n        ).provider\n      : this.messagingSystem.call('NetworkController:getSelectedNetworkClient')\n          ?.provider ?? this.#provider;\n\n    if (provider === undefined) {\n      throw new Error(MISSING_PROVIDER_ERROR);\n    }\n\n    return new Web3Provider(provider);\n  }\n\n  /**\n   * Get the relevant chain ID.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns Hex chain ID.\n   */\n  #getCorrectChainId(networkClientId?: NetworkClientId): Hex {\n    if (networkClientId) {\n      const networkClientConfiguration = this.messagingSystem.call(\n        'NetworkController:getNetworkConfigurationByNetworkClientId',\n        networkClientId,\n      );\n      if (networkClientConfiguration) {\n        return networkClientConfiguration.chainId;\n      }\n    }\n    const { selectedNetworkClientId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n    const networkClient = this.messagingSystem.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n    return networkClient.configuration?.chainId ?? this.#chainId;\n  }\n\n  /**\n   * Get a ERC20Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC20Standard instance.\n   */\n  getERC20Standard(networkClientId?: NetworkClientId): ERC20Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC20Standard(provider);\n  }\n\n  /**\n   * Get a ERC721Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC721Standard instance.\n   */\n  getERC721Standard(networkClientId?: NetworkClientId): ERC721Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC721Standard(provider);\n  }\n\n  /**\n   * Get a ERC1155Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC1155Standard instance.\n   */\n  getERC1155Standard(networkClientId?: NetworkClientId): ERC1155Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC1155Standard(provider);\n  }\n\n  /**\n   * Get balance or count for current account on specific asset contract.\n   *\n   * @param address - Asset ERC20 contract address.\n   * @param selectedAddress - Current account public address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to BN object containing balance for current account on specific asset contract.\n   */\n  async getERC20BalanceOf(\n    address: string,\n    selectedAddress: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<BN> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getBalanceOf(address, selectedAddress);\n  }\n\n  /**\n   * Query for the decimals for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getERC20TokenDecimals(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getTokenDecimals(address);\n  }\n\n  /**\n   * Query for the name for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getERC20TokenName(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getTokenName(address);\n  }\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param selectedAddress - Current account public address.\n   * @param index - An NFT counter less than `balanceOf(selectedAddress)`.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.\n   */\n  async getERC721NftTokenId(\n    address: string,\n    selectedAddress: string,\n    index: number,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getNftTokenId(address, selectedAddress, index);\n  }\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param tokenAddress - ERC721 asset contract address.\n   * @param userAddress - Current account public address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to an object containing the token standard and a set of details which depend on which standard the token supports.\n   */\n  async getTokenStandardAndDetails(\n    tokenAddress: string,\n    userAddress?: string,\n    tokenId?: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<{\n    standard: string;\n    tokenURI?: string | undefined;\n    symbol?: string | undefined;\n    name?: string | undefined;\n    decimals?: string | undefined;\n    balance?: BN | undefined;\n  }> {\n    // Asserts provider is available\n    this.#getCorrectProvider(networkClientId);\n\n    // ERC721\n    try {\n      const erc721Standard = this.getERC721Standard(networkClientId);\n      return {\n        ...(await erc721Standard.getDetails(\n          tokenAddress,\n          this.#ipfsGateway,\n          tokenId,\n        )),\n      };\n    } catch {\n      // Ignore\n    }\n\n    // ERC1155\n    try {\n      const erc1155Standard = this.getERC1155Standard(networkClientId);\n      return {\n        ...(await erc1155Standard.getDetails(\n          tokenAddress,\n          this.#ipfsGateway,\n          tokenId,\n        )),\n      };\n    } catch {\n      // Ignore\n    }\n\n    // ERC20\n    try {\n      const erc20Standard = this.getERC20Standard(networkClientId);\n      return {\n        ...(await erc20Standard.getDetails(tokenAddress, userAddress)),\n      };\n    } catch {\n      // Ignore\n    }\n\n    throw new Error('Unable to determine contract standard');\n  }\n\n  /**\n   * Query for tokenURI for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  async getERC721TokenURI(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getTokenURI(address, tokenId);\n  }\n\n  /**\n   * Query for name for a given asset.\n   *\n   * @param address - ERC721 or ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'name'.\n   */\n  async getERC721AssetName(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getAssetName(address);\n  }\n\n  /**\n   * Query for symbol for a given asset.\n   *\n   * @param address - ERC721 or ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'symbol'.\n   */\n  async getERC721AssetSymbol(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getAssetSymbol(address);\n  }\n\n  /**\n   * Query for owner for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the owner address.\n   */\n  async getERC721OwnerOf(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getOwnerOf(address, tokenId);\n  }\n\n  /**\n   * Query for tokenURI for a given asset.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @param tokenId - ERC1155 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  async getERC1155TokenURI(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.getTokenURI(address, tokenId);\n  }\n\n  /**\n   * Query for balance of a given ERC 1155 token.\n   *\n   * @param userAddress - Wallet public address.\n   * @param nftAddress - ERC1155 asset contract address.\n   * @param nftId - ERC1155 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'balanceOf'.\n   */\n  async getERC1155BalanceOf(\n    userAddress: string,\n    nftAddress: string,\n    nftId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<BN> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.getBalanceOf(nftAddress, userAddress, nftId);\n  }\n\n  /**\n   * Transfer single ERC1155 token.\n   *\n   * @param nftAddress - ERC1155 token address.\n   * @param senderAddress - ERC1155 token sender.\n   * @param recipientAddress - ERC1155 token recipient.\n   * @param nftId - ERC1155 token id.\n   * @param qty - Quantity of tokens to be sent.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'transferSingle' ERC1155 token.\n   */\n  async transferSingleERC1155(\n    nftAddress: string,\n    senderAddress: string,\n    recipientAddress: string,\n    nftId: string,\n    qty: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<void> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.transferSingle(\n      nftAddress,\n      senderAddress,\n      recipientAddress,\n      nftId,\n      qty,\n    );\n  }\n\n  /**\n   * Get the token balance for a list of token addresses in a single call. Only non-zero balances\n   * are returned.\n   *\n   * @param selectedAddress - The address to check token balances for.\n   * @param tokensToDetect - The token addresses to detect balances for.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns The list of non-zero token balances.\n   */\n  async getBalancesInSingleCall(\n    selectedAddress: string,\n    tokensToDetect: string[],\n    networkClientId?: NetworkClientId,\n  ) {\n    const chainId = this.#getCorrectChainId(networkClientId);\n    const provider = this.#getCorrectProvider(networkClientId);\n    if (\n      !((id): id is keyof typeof SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID =>\n        id in SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID)(chainId)\n    ) {\n      // Only fetch balance if contract address exists\n      return {};\n    }\n    const contractAddress = SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID[chainId];\n\n    const contract = new Contract(\n      contractAddress,\n      abiSingleCallBalancesContract,\n      provider,\n    );\n    const result = await contract.balances([selectedAddress], tokensToDetect);\n    const nonZeroBalances: BalanceMap = {};\n    /* istanbul ignore else */\n    if (result.length > 0) {\n      tokensToDetect.forEach((tokenAddress, index) => {\n        const balance: BN = result[index];\n        /* istanbul ignore else */\n        if (String(balance) !== '0') {\n          nonZeroBalances[tokenAddress] = balance;\n        }\n      });\n    }\n    return nonZeroBalances;\n  }\n\n  /**\n   * Get the staked ethereum balance for an address in a single call.\n   *\n   * @param address - The address to check staked ethereum balance for.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns The hex staked ethereum balance for address.\n   */\n  async getStakedBalanceForChain(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<StakedBalance> {\n    const chainId = this.#getCorrectChainId(networkClientId);\n    const provider = this.#getCorrectProvider(networkClientId);\n\n    // balance defaults to zero\n    let balance: BigNumber = BigNumber.from(0);\n\n    // Only fetch staked balance on supported networks\n    if (\n      ![\n        SupportedStakedBalanceNetworks.mainnet,\n        SupportedStakedBalanceNetworks.holesky,\n      ].includes(chainId as SupportedStakedBalanceNetworks)\n    ) {\n      return undefined as StakedBalance;\n    }\n    // Only fetch staked balance if contract address exists\n    if (\n      !((id): id is keyof typeof STAKING_CONTRACT_ADDRESS_BY_CHAINID =>\n        id in STAKING_CONTRACT_ADDRESS_BY_CHAINID)(chainId)\n    ) {\n      return undefined as StakedBalance;\n    }\n\n    const contractAddress = STAKING_CONTRACT_ADDRESS_BY_CHAINID[chainId];\n    const abi = [\n      {\n        inputs: [{ internalType: 'address', name: 'account', type: 'address' }],\n        name: 'getShares',\n        outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],\n        stateMutability: 'view',\n        type: 'function',\n      },\n      {\n        inputs: [{ internalType: 'uint256', name: 'shares', type: 'uint256' }],\n        name: 'convertToAssets',\n        outputs: [{ internalType: 'uint256', name: 'assets', type: 'uint256' }],\n        stateMutability: 'view',\n        type: 'function',\n      },\n    ];\n\n    try {\n      const contract = new Contract(contractAddress, abi, provider);\n      const userShares = await contract.getShares(address);\n\n      // convert shares to assets only if address shares > 0 else return default balance\n      if (!userShares.lte(0)) {\n        balance = await contract.convertToAssets(userShares.toString());\n      }\n    } catch (error) {\n      // if we get an error, log and return the default value\n      console.error(error);\n    }\n\n    return balance.toHexString();\n  }\n}\n\nexport default AssetsContractController;\n"]}

package/dist/CurrencyRateController.d.cts

@@ -29,14 +29,14 @@ type CurrencyRatePollingInput = {
     nativeCurrencies: string[];
 };
 declare const CurrencyRateController_base: (abstract new (...args: any[]) => {
-    readonly "__#787890@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#787890@#intervalLength": number | undefined;
+    readonly "__#787887@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#787887@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: CurrencyRatePollingInput): void;
     _stopPollingByPollingTokenSetId(key: string): void;
-    readonly "__#787882@#pollingTokenSets": Map<string, Set<string>>;
-    "__#787882@#callbacks": Map<string, Set<(input: CurrencyRatePollingInput) => void>>;
+    readonly "__#787879@#pollingTokenSets": Map<string, Set<string>>;
+    "__#787879@#callbacks": Map<string, Set<(input: CurrencyRatePollingInput) => void>>;
     _executePoll(input: CurrencyRatePollingInput): Promise<void>;
     startPolling(input: CurrencyRatePollingInput): string;
     stopAllPolling(): void;

package/dist/CurrencyRateController.d.mts

@@ -29,14 +29,14 @@ type CurrencyRatePollingInput = {
     nativeCurrencies: string[];
 };
 declare const CurrencyRateController_base: (abstract new (...args: any[]) => {
-    readonly "__#787890@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#787890@#intervalLength": number | undefined;
+    readonly "__#787887@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#787887@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: CurrencyRatePollingInput): void;
     _stopPollingByPollingTokenSetId(key: string): void;
-    readonly "__#787882@#pollingTokenSets": Map<string, Set<string>>;
-    "__#787882@#callbacks": Map<string, Set<(input: CurrencyRatePollingInput) => void>>;
+    readonly "__#787879@#pollingTokenSets": Map<string, Set<string>>;
+    "__#787879@#callbacks": Map<string, Set<(input: CurrencyRatePollingInput) => void>>;
     _executePoll(input: CurrencyRatePollingInput): Promise<void>;
     startPolling(input: CurrencyRatePollingInput): string;
     stopAllPolling(): void;

package/dist/RatesController/RatesController.cjs

@@ -17,9 +17,16 @@ const base_controller_1 = require("@metamask/base-controller");
 const async_mutex_1 = require("async-mutex");
 const crypto_compare_service_1 = require("../crypto-compare-service/index.cjs");
 exports.name = 'RatesController';
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 var Cryptocurrency;
 (function (Cryptocurrency) {
     Cryptocurrency["Btc"] = "btc";
+    Cryptocurrency["Solana"] = "sol";
 })(Cryptocurrency || (exports.Cryptocurrency = Cryptocurrency = {}));
 const DEFAULT_INTERVAL = 180000;
 const metadata = {
@@ -34,8 +41,12 @@ const defaultState = {
             conversionDate: 0,
             conversionRate: 0,
         },
+        [Cryptocurrency.Solana]: {
+            conversionDate: 0,
+            conversionRate: 0,
+        },
     },
-    cryptocurrencies: [Cryptocurrency.Btc],
+    cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],
 };
 class RatesController extends base_controller_1.BaseController {
     /**

package/dist/RatesController/RatesController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.cjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAC3D,6CAAoC;AAGpC,gFAA+F;AAQlF,QAAA,IAAI,GAAG,iBAAiB,CAAC;AAEtC,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6BAAW,CAAA;AACb,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC;CACvC,CAAC;AAEF,MAAa,eAAgB,SAAQ,gCAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,+CAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI,EAAJ,YAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;AA5LD,0CA4LC;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\nexport enum Cryptocurrency {\n  Btc = 'btc',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}
+{"version":3,"file":"RatesController.cjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAC3D,6CAAoC;AAGpC,gFAA+F;AAQlF,QAAA,IAAI,GAAG,iBAAiB,CAAC;AAEtC;;;;;GAKG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,gCAAc,CAAA;AAChB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;QACD,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACvB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC;CAC9D,CAAC;AAEF,MAAa,eAAgB,SAAQ,gCAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,+CAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI,EAAJ,YAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;AA5LD,0CA4LC;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\n/**\n * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible\n * with CryptoCompare's API which is the default source for the rates.\n *\n * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint\n */\nexport enum Cryptocurrency {\n  Btc = 'btc',\n  Solana = 'sol',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n    [Cryptocurrency.Solana]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}

package/dist/RatesController/RatesController.d.cts

@@ -1,8 +1,15 @@
 import { BaseController } from "@metamask/base-controller";
 import type { RatesControllerState, RatesControllerOptions, RatesControllerMessenger } from "./types.cjs";
 export declare const name = "RatesController";
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 export declare enum Cryptocurrency {
-    Btc = "btc"
+    Btc = "btc",
+    Solana = "sol"
 }
 export declare class RatesController extends BaseController<typeof name, RatesControllerState, RatesControllerMessenger> {
     #private;

package/dist/RatesController/RatesController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.d.cts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC,oBAAY,cAAc;IACxB,GAAG,QAAQ;CACZ;AAqBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}
+{"version":3,"file":"RatesController.d.cts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,MAAM,QAAQ;CACf;AAyBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}

package/dist/RatesController/RatesController.d.mts

@@ -1,8 +1,15 @@
 import { BaseController } from "@metamask/base-controller";
 import type { RatesControllerState, RatesControllerOptions, RatesControllerMessenger } from "./types.mjs";
 export declare const name = "RatesController";
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 export declare enum Cryptocurrency {
-    Btc = "btc"
+    Btc = "btc",
+    Solana = "sol"
 }
 export declare class RatesController extends BaseController<typeof name, RatesControllerState, RatesControllerMessenger> {
     #private;

package/dist/RatesController/RatesController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.d.mts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC,oBAAY,cAAc;IACxB,GAAG,QAAQ;CACZ;AAqBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}
+{"version":3,"file":"RatesController.d.mts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,MAAM,QAAQ;CACf;AAyBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}

package/dist/RatesController/RatesController.mjs

@@ -14,9 +14,16 @@ import { BaseController } from "@metamask/base-controller";
 import { Mutex } from "async-mutex";
 import { fetchMultiExchangeRate as defaultFetchExchangeRate } from "../crypto-compare-service/index.mjs";
 export const name = 'RatesController';
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 export var Cryptocurrency;
 (function (Cryptocurrency) {
     Cryptocurrency["Btc"] = "btc";
+    Cryptocurrency["Solana"] = "sol";
 })(Cryptocurrency || (Cryptocurrency = {}));
 const DEFAULT_INTERVAL = 180000;
 const metadata = {
@@ -31,8 +38,12 @@ const defaultState = {
             conversionDate: 0,
             conversionRate: 0,
         },
+        [Cryptocurrency.Solana]: {
+            conversionDate: 0,
+            conversionRate: 0,
+        },
     },
-    cryptocurrencies: [Cryptocurrency.Btc],
+    cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],
 };
 export class RatesController extends BaseController {
     /**

package/dist/RatesController/RatesController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.mjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAGpC,OAAO,EAAE,sBAAsB,IAAI,wBAAwB,EAAE,4CAAkC;AAQ/F,MAAM,CAAC,MAAM,IAAI,GAAG,iBAAiB,CAAC;AAEtC,MAAM,CAAN,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6BAAW,CAAA;AACb,CAAC,EAFW,cAAc,KAAd,cAAc,QAEzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC;CACvC,CAAC;AAEF,MAAM,OAAO,eAAgB,SAAQ,cAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,wBAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,KAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\nexport enum Cryptocurrency {\n  Btc = 'btc',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}
+{"version":3,"file":"RatesController.mjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAGpC,OAAO,EAAE,sBAAsB,IAAI,wBAAwB,EAAE,4CAAkC;AAQ/F,MAAM,CAAC,MAAM,IAAI,GAAG,iBAAiB,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,gCAAc,CAAA;AAChB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;QACD,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACvB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC;CAC9D,CAAC;AAEF,MAAM,OAAO,eAAgB,SAAQ,cAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,wBAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,KAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\n/**\n * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible\n * with CryptoCompare's API which is the default source for the rates.\n *\n * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint\n */\nexport enum Cryptocurrency {\n  Btc = 'btc',\n  Solana = 'sol',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n    [Cryptocurrency.Solana]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}