@paraspell/assets NPM

Information

This 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 to retrieve 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.

Implementation

Install package

pnpm | npm install || yarn add @paraspell/assets

Import functionality

To use this functionality you first have to import it in the following way.

import { getAssetsObject, getAssetId, getRelayChainSymbol, getNativeAssets, getNativeAssets, getOtherAssets, getAllAssetsSymbols, hasSupportForAsset, getAssetDecimals, getParaId, getTNode, getAssetMultiLocation, NODE_NAMES } from  '@paraspell/assets'

Query assets object

This function returns assets object from assets.json for particular Parachain including information about native and foreign assets.

getAssetsObject('Acala')

Query asset ID

This function returns assetId for particular Parachain and asset symbol

getAssetId('Acala', 'DOT')

Query Relay chain asset symbol

This function returns the symbol of the Relay chain for a particular Parachain. Either "DOT" or "KSM"

getRelayChainSymbol('Basilisk')

Query native assets

This function returns a string array of native assets symbols for a particular Parachain

getNativeAssets('Acala')

Query foreign assets

This function returns an object array of foreign assets for a particular Parachain. Each object has a symbol and assetId property

getOtherAssets('Acala')

Query all asset symbols

Function returns string array of all asset symbols for a specific Parachain. (native and foreign assets are merged into a single array)

getAllAssetsSymbols('Acala')

Query asset support

The function checks if Parachain supports a particular asset. (Both native and foreign assets are searched). Returns boolean

hasSupportForAsset(node: TNode, symbol: string)

Query asset decimals

The function returns decimals for a specific asset

getAssetDecimals('Basilisk', 'KSM')

Query Parachain ID

The function returns specific Parachain id

getParaId('Basilisk')

Query Parachain name

Function to get specific TNode from Parachain id

getTNode(nodeID: number, ecosystem: 'polkadot' || 'kusama' || 'ethereum') //When Ethereum ecosystem is selected please fill nodeID as 1 to select Ethereum.

Import Parachains as constant

Import all compatible Parachains as constant

console.log(NODE_NAMES)

Convert id or symbol to multilocation

Get multilocation for asset id or symbol.

getAssetMultiLocation(chainFrom, { symbol: symbol } | { id: assetId })

💻 Tests

Run compilation using pnpm compile
Run linter using pnpm lint
Run unit tests using pnpm test
Update Parachain registered assets in the map using script - pnpm updateAssets
Update existential deposits in the map using script - pnpm updateEds

Assets can be tested in Playground.