@zennomi/tokens

@zennomi/tokens

Table of contents

Type aliases

• AaveMarketData
• AddressMapping
• AssetData
• AssetDataBase
• ExtendedIlkData
• IlkData

Variables

• MAXUINT
• aaveV2Markets
• assets
• ilks
• reflexerCollTypes
• utils

Functions

• assetAmountInEth
• assetAmountInWei
• getAaveV2MarketInfo
• getAssetInfo
• getAssetInfoByAddress
• getIlkInfo
• ilkToAsset
• set
• tokenFromJoin
• tokenFromMakerJoin
• tokenFromReflexerJoin

Type aliases

AaveMarketData

Ƭ AaveMarketData: Object

Type declaration

Name	Type
dataProvider	string
lendingPool	string
lendingPoolAddressProvider	string
name	string

Defined in

types.ts:70

AddressMapping

Ƭ AddressMapping: Object

Index signature

▪ [key: number]: string

Defined in

types.ts:6

AssetData

Ƭ AssetData: Object

Chain-specific asset info type

Type declaration

Name	Type
aaveCollateral	boolean
address	string
addresses	AddressMapping
compoundCollateral	boolean
decimals	number
exchange	boolean
feedAvailability	BoolMapping
icon	Function
isStable	boolean
name	string
nativeChainId	number
symbol	string
underlyingAsset	string
yearnCollateral	boolean

Defined in

types.ts:36

AssetDataBase

Ƭ AssetDataBase: Object

Chain-agnostic asset info type

Type declaration

Name	Type
aaveCollateral	boolean
addresses	AddressMapping
compoundCollateral	boolean
decimals	number
exchange	boolean
feedAvailability	BoolMapping
icon	Function
isStable	boolean
name	string
nativeChainId	number
symbol	string
underlyingAsset	string
yearnCollateral	boolean

Defined in

types.ts:17

ExtendedIlkData

Ƭ ExtendedIlkData: IlkData | { assetData: AssetData }

Defined in

types.ts:77

IlkData

Ƭ IlkData: Object

Maker ilk info type

Type declaration

Name	Type
asset	string
assetAddress?	string
clip?	string
clipCalc?	string
flip?	string
ilkBytes	string
ilkLabel	string
isCrop	boolean
isLP	boolean
join	string
pip	string

Defined in

types.ts:56

Variables

MAXUINT

• MAXUINT: string = '115792089237316195423570985008687907853269984665640564039457584007913129639935'

Defined in

index.ts:27

aaveV2Markets

• aaveV2Markets: AaveMarketData[]

Defined in

aaveV2Markets.ts:3

assets

• assets: AssetDataBase[]

Defined in

assets.ts:240

ilks

• ilks: IlkData[]

Defined in

ilks.ts:5

reflexerCollTypes

• reflexerCollTypes: IlkData[]

Defined in

reflexerCollTypes.ts:3

utils

• utils: Object

Type declaration

Name	Type
bytesToString	(hex: string) => string
compare	(a: string, b: string) => boolean
stringToBytes	(str: string) => string

Defined in

index.ts:25

Functions

assetAmountInEth

▸ Const assetAmountInEth(amount, asset?): string

Parameters

Name	Type	Default value	Description
amount	string | number | object	undefined	Amount in wei
asset	string	'ETH'	Asset symbol (or MCD-${symbol} for maker asset - always 18dec)

Returns

string

Defined in

index.ts:149

assetAmountInWei

▸ Const assetAmountInWei(amount, asset): string

Parameters

Name	Type	Description
amount	string | number | object	Amount in eth
asset	string	Asset symbol

Returns

string

Defined in

index.ts:170

getAaveV2MarketInfo

▸ Const getAaveV2MarketInfo(name?): void | AaveMarketData

Parameters

Name	Type	Default value
name	string	''

Returns

void | AaveMarketData

Defined in

index.ts:142

getAssetInfo

▸ Const getAssetInfo(symbol?, chainId?): AssetData

Returns asset info. Warning: will not throw if asset not found. Instead, will return a placeholder object.

Parameters

Name	Type	Default value
symbol	string	''
chainId?	number	undefined

Returns

AssetData

Defined in

index.ts:60

getAssetInfoByAddress

▸ Const getAssetInfoByAddress(address?, chainId?): AssetData

Parameters

Name	Type	Default value
address	string	''
chainId?	number	undefined

Returns

AssetData

Defined in

index.ts:95

getIlkInfo

▸ Const getIlkInfo(ilk?): ExtendedIlkData

Returns Maker or Reflexer ilk info, and asset info as assetData attribute. Warning: will not throw if ilk not found. Instead, will return a placeholder object.

Parameters

Name	Type	Default value	Description
ilk	string	''	Ilk encoded as string or as hex

Returns

ExtendedIlkData

Defined in

index.ts:73

ilkToAsset

▸ Const ilkToAsset(ilk?): string

Parameters

Name	Type	Default value
ilk	string	''

Returns

string

Defined in

index.ts:100

set

▸ Const set(key, value): void

Parameters

Name	Type
key	string
value	any

Returns

void

Defined in

index.ts:21

tokenFromJoin

▸ Const tokenFromJoin(join, fromIlks?): string

Parameters

Name	Type	Default value	Description
join	string	undefined	Maker or Reflexer ilk join
fromIlks	IlkData[]	ilks

Returns

string

Token symbol

Defined in

index.ts:122

tokenFromMakerJoin

▸ Const tokenFromMakerJoin(join): string

Parameters

Name	Type	Description
join	string	Maker ilk join

Returns

string

Token symbol

Defined in

index.ts:134

tokenFromReflexerJoin

▸ Const tokenFromReflexerJoin(join): string

Parameters

Name	Type	Description
join	string	Reflexer ilk join

Returns

string

Token symbol

Defined in

index.ts:140