Struct TokenRegistry

Source

pub struct TokenRegistry { /* private fields */ }

Expand description

A registry mapping asset ticker symbols to their ERC-20 token metadata.

Stores both address and decimal precision so the executor can convert human-readable quantities to token atoms without assuming 18 decimals.

§Example

use alloy_primitives::Address;
use cow_chains::TokenRegistry;

let mut reg = TokenRegistry::new_with_decimals([
    ("USDC", Address::ZERO, 6u8),
    ("WETH", Address::ZERO, 18u8),
]);
assert_eq!(reg.get_decimals("USDC"), Some(6));
assert!(reg.contains("WETH"));
assert!(!reg.contains("DAI"));

reg.insert("DAI", Address::ZERO);
assert!(reg.contains("DAI"));
assert_eq!(reg.len(), 3);

Implementations§

Source §

impl TokenRegistry

Source

pub fn new( entries: impl IntoIterator<Item = (impl Into<String>, Address)>, ) -> Self

Create a new registry from (symbol, address) pairs.

All tokens registered this way are assumed to have 18 decimals. Use new_with_decimals when tokens have non-standard decimal counts (e.g. USDC = 6, WBTC = 8).

§Parameters

entries — an iterator of (symbol, address) pairs.

§Returns

A new TokenRegistry with all entries set to 18 decimals.

Source

pub fn new_with_decimals( entries: impl IntoIterator<Item = (impl Into<String>, Address, u8)>, ) -> Self

Create a new registry from (symbol, address, decimals) tuples.

Use this when tokens have non-standard decimal counts (e.g. USDC = 6, WBTC = 8).

§Parameters

entries — an iterator of (symbol, address, decimals) tuples.

§Returns

A new TokenRegistry with explicit decimal counts per token.

Source

pub fn get(&self, asset: &str) -> Option<Address>

Look up the Address for a given asset symbol, e.g. "WETH".

§Arguments

asset — the ticker symbol to look up.

§Returns

Some(address) if the symbol is registered, None otherwise.

Source

pub fn get_decimals(&self, asset: &str) -> Option<u8>

Look up the decimal count for a given asset symbol.

§Arguments

asset — the ticker symbol to look up.

§Returns

Some(decimals) when the symbol is registered, None otherwise.

Source

pub fn insert(&mut self, symbol: impl Into<String>, address: Address)

Register a token with 18 decimals (or update an existing entry).

§Arguments

symbol — the ticker symbol to register.
address — the ERC-20 contract Address.

Source

pub fn insert_with_decimals( &mut self, symbol: impl Into<String>, address: Address, decimals: u8, )

Register a token with explicit decimals (or update an existing entry).

§Arguments

symbol — the ticker symbol to register.
address — the ERC-20 contract Address.
decimals — the token’s decimal precision.

Source

pub fn contains(&self, asset: &str) -> bool

Returns true if asset is registered in this registry.

§Arguments

asset — the ticker symbol to check.

§Returns

true when the symbol exists in the registry.

Source

pub fn len(&self) -> usize

Returns the number of registered tokens.

§Returns

The count of tokens in this registry.

Source

pub fn is_empty(&self) -> bool

Returns true if no tokens are registered.

§Returns

true when the registry contains zero tokens.

Source

pub fn get_entry(&self, asset: &str) -> Option<(Address, u8)>

Look up both the address and decimal count for a given asset symbol.

Returns Some((address, decimals)) when registered, None otherwise.

use alloy_primitives::Address;
use cow_chains::TokenRegistry;

let reg = TokenRegistry::new_with_decimals([("USDC", Address::ZERO, 6u8)]);
assert_eq!(reg.get_entry("USDC"), Some((Address::ZERO, 6)));
assert_eq!(reg.get_entry("WETH"), None);