\n\n## Information\n\nThis package serves as a `core` component for both `@paraspell/sdk` and `@paraspell/sdk-pjs` and is `automatically` installed as a `dependency`. The package on its own offers functionality that can be imported separately and be used in front-end applications. It allows retrieving asset data from compatible Parachains. Users can retrieve details like `asset decimals`, `registered assets on particular Parachain`, `check if the asset is registered on Parachain`, and more.\n\n## Implementation\n\n### Install package\n\n```bash\nnpm install | pnpm add | yarn add @paraspell/assets\n```\n\n### Import functionality\n\nTo use this functionality, you first have to import it in the following way.\n\n```ts\nimport { getSupportedDestinations, getSupportedAssets, getFeeAssets, getAssetsObject, getRelayChainSymbol, getNativeAssets, getNativeAssets, getOtherAssets, getAllAssetsSymbols, getParaId, getTChain, getAssetLocation, findAssetInfo, findAssetInfoOrThrow } from '@paraspell/assets'\n```\n\n\n### Query assets object\nThis function returns `assets object` from `assets.json` for `particular Parachain`, including information about `native` and `foreign` assets. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetAssetsObject(TChain)\n```\n\n### Query Relay chain asset symbol\nThis function returns the `symbol` of the Relay chain for a particular Parachain. Either `DOT` or `KSM` or `WND` or `PAS`. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetRelayChainSymbol(TChain)\n```\n\n### Query native assets\nThis function returns a string array of `native` assets symbols for a particular Parachain. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetNativeAssets(TChain)\n```\n\n### Query foreign assets\nThis function returns an object array of foreign assets for a particular Parachain. Each object has a symbol and assetId property. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetOtherAssets(TChain)\n```\n\n### Query all asset symbols\nFunction returns string array of all asset symbols for a specific Parachain. (native and foreign assets are merged into a single array). Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetAllAssetsSymbols(TChain)\n```\n\n### Query Parachain ID\nThe function returns specific Parachain id. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetParaId(TChain)\n```\n\n### Query asset data and support for specific chain I\nFind out whether asset is registered on chain and return its entire parameters. If not found, returns null. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\nfindAssetInfo(TChain, ASSET_SYMBOL/*, DESTINATION?*/)\n```\n\n### Query asset data and support for specific chain II\nFind out whether asset is registered on chain and return its entire parameters. If not found, returns error. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\nfindAssetInfoOrThrow(TChain, ASSET_SYMBOL/*, DESTINATION?*/)\n```\n\n### Query Parachain name\nFunction to get specific TChain from Parachain id.\n\n```ts\ngetTChain(chainID: number, ecosystem: 'Polkadot' | 'Kusama' | 'Ethereum' | 'Paseo' | 'Westend') //When Ethereum ecosystem is selected please fill chainID as 1 to select Ethereum.\n```\n\n### Convert id or symbol to location\nGet location for asset id or symbol. Function uses [TChain](https://paraspell.github.io/docs/xcm-sdk/asset-package.html#import-chains-as-types) types.\n\n```ts\ngetAssetLocation(TChain, { symbol: symbol } | { id: assetId })\n```\n\n## 💻 Tests\n\n- Run compilation using `pnpm compile`\n\n- Run linter using `pnpm lint`\n\n- Run unit tests using `pnpm test`\n\n- Update Parachain registered assets in the map using script - `pnpm updateAssets`\n\n- Update existential deposits in the map using script - `pnpm updateEds`\n\n> [!NOTE]\n> Asset queries can be tested in [XCM Playground](https://github.com/paraspell/xcm-tools/tree/main/apps/playground).\n\n## Contribute to XCM Tools and earn rewards 💰\n\nWe run an open Bug Bounty Program that rewards contributors for reporting and fixing bugs in the project. More information on bug bounty can be found in the [official documentation](https://paraspell.github.io/docs/contribution-guidelines.html).\n\n## Get Support 🚑\n\n- Contact form on our [landing page](https://paraspell.xyz/#contact-us).\n- Message us on our [X](https://x.com/paraspell).\n- Support channel on [telegram](https://t.me/paraspell).\n\n## License\n\nMade with 💛 by [ParaSpell✨](https://paraspell.xyz/)\n\nPublished under [MIT License](https://github.com/paraspell/xcm-tools/blob/main/packages/assets/LICENSE).\n\n## Supported by\n\n
![\"Shows](\"https://github.com/paraspell/presskit/blob/main/logos_supporters/polkadot_kusama_w3f_standard.png\")
\n ![\"version\"](\"https://img.shields.io/npm/v/@paraspell/assets?style=flat-square\")
\n ![\"downloads\"](\"https://img.shields.io/npm/dm/@paraspell/assets?style=flat-square\")
\n ![\"build\"](\"https://github.com/paraspell/xcm-sdk/actions/workflows/release.yml/badge.svg\"){kind=icon}
\n