fix: price fetching for native tokens with non zero addresses

[bergeron]

Explanation

When querying the price API, the native token is usually represented by the zero address. But this is not the case on some chains like polygon, whose native token has a contract 0x0000000000000000000000000000000000001010.

Note: Extension/mobile would also need to use the exported getNativeTokenAddress, so they know where to lookup the native prices in state.

Draft extension PR: https://github.com/MetaMask/metamask-extension/pull/28584

References

Changelog

@metamask/assets-controllers

• ADDED: chainIdToNativeTokenAddress to record chains with unique (non-zero) addresses
• ADDED: getNativeTokenAddress() exported function to return the correct native token address for native assets (either zero addresses, or the unique addresses recorded in chainIdToNativeTokenAddress)
• CHANGED: Updated price API calls to use the native token by chain instead of relying on the zero address.
• CHANGED: Updated TokenRatesController market data mapping to use getNativeTokenAddress instead of the zero address for native tokens.

Checklist

• [x] I've updated the test suite for new or updated code as appropriate
• [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate
• [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

[bergeron]

@metamaskbot publish-preview

[github-actions[bot]]

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

``` { "@metamask-previews/accounts-controller": "19.0.0-preview-3487bcdd", "@metamask-previews/address-book-controller": "6.0.1-preview-3487bcdd", "@metamask-previews/announcement-controller": "7.0.1-preview-3487bcdd", "@metamask-previews/approval-controller": "7.1.1-preview-3487bcdd", "@metamask-previews/assets-controllers": "44.1.0-preview-3487bcdd", "@metamask-previews/base-controller": "7.0.2-preview-3487bcdd", "@metamask-previews/build-utils": "3.0.1-preview-3487bcdd", "@metamask-previews/chain-controller": "0.1.3-preview-3487bcdd", "@metamask-previews/composable-controller": "9.0.1-preview-3487bcdd", "@metamask-previews/controller-utils": "11.4.3-preview-3487bcdd", "@metamask-previews/ens-controller": "15.0.0-preview-3487bcdd", "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-3487bcdd", "@metamask-previews/gas-fee-controller": "22.0.1-preview-3487bcdd", "@metamask-previews/json-rpc-engine": "10.0.1-preview-3487bcdd", "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-3487bcdd", "@metamask-previews/keyring-controller": "18.0.0-preview-3487bcdd", "@metamask-previews/logging-controller": "6.0.2-preview-3487bcdd", "@metamask-previews/message-manager": "11.0.1-preview-3487bcdd", "@metamask-previews/multichain": "0.0.0-preview-3487bcdd", "@metamask-previews/name-controller": "8.0.1-preview-3487bcdd", "@metamask-previews/network-controller": "22.0.2-preview-3487bcdd", "@metamask-previews/notification-controller": "7.0.0-preview-3487bcdd", "@metamask-previews/notification-services-controller": "0.13.0-preview-3487bcdd", "@metamask-previews/permission-controller": "11.0.3-preview-3487bcdd", "@metamask-previews/permission-log-controller": "3.0.1-preview-3487bcdd", "@metamask-previews/phishing-controller": "12.3.0-preview-3487bcdd", "@metamask-previews/polling-controller": "12.0.1-preview-3487bcdd", "@metamask-previews/preferences-controller": "14.0.0-preview-3487bcdd", "@metamask-previews/profile-sync-controller": "1.0.2-preview-3487bcdd", "@metamask-previews/queued-request-controller": "7.0.1-preview-3487bcdd", "@metamask-previews/rate-limit-controller": "6.0.1-preview-3487bcdd", "@metamask-previews/selected-network-controller": "19.0.0-preview-3487bcdd", "@metamask-previews/signature-controller": "22.0.0-preview-3487bcdd", "@metamask-previews/transaction-controller": "39.0.0-preview-3487bcdd", "@metamask-previews/user-operation-controller": "18.0.0-preview-3487bcdd" } ```

[Prithpal-Sooriya]

@metamaskbot publish-preview

[github-actions[bot]]

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

``` { "@metamask-previews/accounts-controller": "19.0.0-preview-6f3061d2", "@metamask-previews/address-book-controller": "6.0.1-preview-6f3061d2", "@metamask-previews/announcement-controller": "7.0.1-preview-6f3061d2", "@metamask-previews/approval-controller": "7.1.1-preview-6f3061d2", "@metamask-previews/assets-controllers": "44.1.0-preview-6f3061d2", "@metamask-previews/base-controller": "7.0.2-preview-6f3061d2", "@metamask-previews/build-utils": "3.0.1-preview-6f3061d2", "@metamask-previews/chain-controller": "0.1.3-preview-6f3061d2", "@metamask-previews/composable-controller": "9.0.1-preview-6f3061d2", "@metamask-previews/controller-utils": "11.4.3-preview-6f3061d2", "@metamask-previews/ens-controller": "15.0.0-preview-6f3061d2", "@metamask-previews/eth-json-rpc-provider": "4.1.6-preview-6f3061d2", "@metamask-previews/gas-fee-controller": "22.0.1-preview-6f3061d2", "@metamask-previews/json-rpc-engine": "10.0.1-preview-6f3061d2", "@metamask-previews/json-rpc-middleware-stream": "8.0.5-preview-6f3061d2", "@metamask-previews/keyring-controller": "18.0.0-preview-6f3061d2", "@metamask-previews/logging-controller": "6.0.2-preview-6f3061d2", "@metamask-previews/message-manager": "11.0.1-preview-6f3061d2", "@metamask-previews/multichain": "0.0.0-preview-6f3061d2", "@metamask-previews/name-controller": "8.0.1-preview-6f3061d2", "@metamask-previews/network-controller": "22.0.2-preview-6f3061d2", "@metamask-previews/notification-controller": "7.0.0-preview-6f3061d2", "@metamask-previews/notification-services-controller": "0.13.0-preview-6f3061d2", "@metamask-previews/permission-controller": "11.0.3-preview-6f3061d2", "@metamask-previews/permission-log-controller": "3.0.1-preview-6f3061d2", "@metamask-previews/phishing-controller": "12.3.0-preview-6f3061d2", "@metamask-previews/polling-controller": "12.0.1-preview-6f3061d2", "@metamask-previews/preferences-controller": "14.0.0-preview-6f3061d2", "@metamask-previews/profile-sync-controller": "1.0.2-preview-6f3061d2", "@metamask-previews/queued-request-controller": "7.0.1-preview-6f3061d2", "@metamask-previews/rate-limit-controller": "6.0.1-preview-6f3061d2", "@metamask-previews/selected-network-controller": "19.0.0-preview-6f3061d2", "@metamask-previews/signature-controller": "22.0.0-preview-6f3061d2", "@metamask-previews/transaction-controller": "39.0.0-preview-6f3061d2", "@metamask-previews/user-operation-controller": "18.0.0-preview-6f3061d2" } ```