> ## Documentation Index
> Fetch the complete documentation index at: https://docs.powfi.alephium.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Token

> Token metadata from the Alephium token list, with caching.

export const VersionBanner = ({network = 'mainnet', products = [], lang = 'en'}) => {
  const SDK_VERSION = '1.0.2';
  const ADDRESSES = {
    mainnet: {
      cpmm: {
        Router: 'ze15rnAwTyVCPnDhN7J8An3SvNeWBsZHAVMeBx1ehXeP',
        TokenPairFactory: '24CXRLvj1QiDH6riwr1EPERG7BcduHKZtktygbq97MfYb'
      },
      clmm: {
        PoolFactory: '24gqd4DMQXVzjm5QDAGxUtYupx3WM2PSu3vZUseuBCV9h',
        PositionManager: 'vFyKSqnJHS9MicrojBcLgztyRFqhS4hB349Ci3LJCELw'
      },
      staking: {
        XAlphToken: '225WevmFp5ZgzPsyVJTvyp2v2uyKrvp329HfrVmzffnWj',
        RewardFeeCollector: '22CE7vG6u64zjjsLZLxeJqQuPDydjPvbP9iG1d861j2G7'
      }
    },
    testnet: {
      cpmm: {
        Router: 'xaueT8kPMvpnaFJEfHv6CJLgqsSPpoNmHjF1QgTxoF9R',
        TokenPairFactory: '29hdd9b9Gp7oXuamwHKfUqBaRXP487HoeTcutS3RhZJEj'
      },
      clmm: {
        PoolFactory: 'z2QFT7qBQrfm8UwAYG3VHWoHs7B56ZDFNdSCcDu5j53m',
        PositionManager: '21p6egW8d6FEyVVuH17WqvHCARsCsD61GcBmeCr75XdGT'
      },
      staking: {
        XAlphToken: '23psDicimC5VdpM56wrgqgCzQzcyXWGCkQGSYWbtZAPRq',
        RewardFeeCollector: '29qQ1LPJ5uqawRviXLVDMeo19JUygRrNNTQy5RUBh817D'
      }
    }
  };
  const EXPLORERS = {
    mainnet: 'https://explorer.alephium.org/addresses/',
    testnet: 'https://testnet.alephium.org/addresses/'
  };
  const LABELS = {
    en: {
      sdk: 'SDK',
      network: 'Network',
      contracts: 'Contracts',
      all: 'All addresses',
      allNetworks: 'mainnet · testnet · devnet',
      devnet: 'Local deployment (addresses vary per devnet)'
    },
    zh: {
      sdk: 'SDK 版本',
      network: '网络',
      contracts: '合约',
      all: '全部地址',
      allNetworks: 'mainnet · testnet · devnet',
      devnet: '本地部署（每个 devnet 的地址不同）'
    },
    fr: {
      sdk: 'SDK',
      network: 'Réseau',
      contracts: 'Contrats',
      all: 'Toutes les adresses',
      allNetworks: 'mainnet · testnet · devnet',
      devnet: 'Déploiement local (adresses propres à chaque devnet)'
    }
  };
  const t = LABELS[lang] ?? LABELS.en;
  const contractsPage = lang === 'en' ? '/reference/contracts' : `/${lang}/reference/contracts`;
  const short = a => `${a.slice(0, 6)}…${a.slice(-4)}`;
  const entries = [];
  const addrs = ADDRESSES[network];
  if (addrs) {
    for (const p of products) {
      for (const [name, address] of Object.entries(addrs[p] ?? ({}))) entries.push({
        name,
        address
      });
    }
  }
  let contractsCell;
  if (network === 'devnet' && products.length > 0) {
    contractsCell = <span>{t.devnet}</span>;
  } else if (entries.length > 0) {
    contractsCell = entries.map(({name, address}, i) => <span key={name}>
        {i > 0 && <span className="mx-1 opacity-50">·</span>}
        {name}{' '}
        <a href={EXPLORERS[network] + address} target="_blank" rel="noreferrer" title={address}>
          <code>{short(address)}</code>
        </a>
      </span>);
  }
  const row = (label, value) => <div className="flex flex-wrap gap-x-2">
      <span className="font-semibold min-w-[5.5rem]">{label}</span>
      <span className="flex-1 min-w-0 break-words">{value}</span>
    </div>;
  return <div className="not-prose mb-6 rounded-xl border border-zinc-950/10 dark:border-white/10 bg-zinc-50 dark:bg-white/5 px-4 py-3 text-sm leading-6 text-zinc-700 dark:text-zinc-300">
      {row(t.sdk, <code>@alephium/powfi-sdk@{SDK_VERSION}</code>)}
      {row(t.network, network === 'all' ? t.allNetworks : network)}
      {contractsCell && row(t.contracts, <span>
            {contractsCell}
            <span className="mx-1 opacity-50">·</span>
            <a href={contractsPage}>{t.all} →</a>
          </span>)}
    </div>;
};

<VersionBanner network="mainnet" products={[]} lang="en" />

```ts theme={null}
powfi.token // TokenModule
```

The token module fetches the JSON token list at `network.tokenListUrl` and caches it in memory for **one day**. Pool-state methods in the CPMM and CLMM modules use it to attach `TokenInfo` (symbol, decimals, logo) to both pool tokens.

<Warning>
  `cpmm.getPoolState` and `clmm.getPoolState` **throw** if either pool token is missing from the token list. To work with unlisted tokens, point `networkOverrides.tokenListUrl` at a list that includes them, or read pool contracts directly through the [contract artifacts](/reference/contracts).
</Warning>

## `TokenInfo`

From `@alephium/token-list`:

```ts theme={null}
interface TokenInfo {
  id: string          // 64-hex token ID (ALPH = ALPH_TOKEN_ID, "00…00")
  name: string
  symbol: string
  decimals: number
  description: string
  logoURI: string
  originChain?: string
  unchainedLogoURI?: string
}
```

## Methods

### `getTokens()`

```ts theme={null}
getTokens(): Promise<TokenInfo[]>
```

Returns the cached list if it is fresh. Otherwise it fetches the list. If the fetch fails and a stale cache exists, the stale copy is returned (logged at info level). With no cache, the error is thrown.

### `getTokenById(id)` / `getTokenBySymbol(symbol)`

```ts theme={null}
getTokenById(id: string): Promise<TokenInfo>
getTokenBySymbol(symbol: string): Promise<TokenInfo>
```

Throw `Unknown token, … not found in token list` when no match exists. Symbols are matched case-sensitively, and the first match wins.

### `getTokenInfoBy(predicate)`

```ts theme={null}
getTokenInfoBy(fn: (token: TokenInfo) => boolean): Promise<TokenInfo | undefined>
```

### `fetchTokens()`

Forces a refresh and replaces the cache. The payload is validated: it must be `{ tokens: TokenInfo[] }` with string `id`, `name`, `symbol`, `description`, `logoURI` and an integer `decimals` in `[0, 255]`. Anything else is rejected.

## Example

```ts theme={null}
const tokens = await powfi.token.getTokens()
const ayin = await powfi.token.getTokenBySymbol('AYIN')
const stable = await powfi.token.getTokenInfoBy((t) => t.symbol.startsWith('USD'))
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.