@defisaver/tokens 1.3.73 → 1.4.1

package/README.md

@@ -26,6 +26,7 @@
 - [getAssetInfoByAddress](README.md#getassetinfobyaddress)
 - [getIlkInfo](README.md#getilkinfo)
 - [ilkToAsset](README.md#ilktoasset)
+- [set](README.md#set)
 - [tokenFromJoin](README.md#tokenfromjoin)
 - [tokenFromMakerJoin](README.md#tokenfrommakerjoin)
 - [tokenFromReflexerJoin](README.md#tokenfromreflexerjoin)
@@ -34,288 +35,368 @@
 
 ### AssetData
 
-Ƭ **AssetData**: { `aaveCollateral`: *boolean* ; `address`: *string* ; `compoundCollateral`: *boolean* ; `decimals`: *number* ; `exchange`: *boolean* ; `icon`: Function ; `isStable`: *boolean* ; `name`: *string* ; `symbol`: *string* ; `underlyingAsset`: *string* ; `yearnCollateral`: *boolean*  }
+Ƭ **AssetData**: `Object`
 
 Asset info type
 
-#### Type declaration:
+#### Type declaration
 
-Name | Type |
------- | ------ |
-`aaveCollateral` | *boolean* |
-`address` | *string* |
-`compoundCollateral` | *boolean* |
-`decimals` | *number* |
-`exchange` | *boolean* |
-`icon` | Function |
-`isStable` | *boolean* |
-`name` | *string* |
-`symbol` | *string* |
-`underlyingAsset` | *string* |
-`yearnCollateral` | *boolean* |
+| Name | Type |
+| :------ | :------ |
+| `aaveCollateral` | `boolean` |
+| `address` | `string` |
+| `addresses` | `AddressMapping` |
+| `compoundCollateral` | `boolean` |
+| `decimals` | `number` |
+| `exchange` | `boolean` |
+| `icon` | `Function` |
+| `isStable` | `boolean` |
+| `name` | `string` |
+| `symbol` | `string` |
+| `underlyingAsset` | `string` |
+| `yearnCollateral` | `boolean` |
 
-Defined in: [types.ts:4](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/types.ts#L4)
+#### Defined in
+
+[types.ts:13](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/types.ts#L13)
 
 ___
 
 ### ExtendedIlkData
 
-Ƭ **ExtendedIlkData**: [*IlkData*](README.md#ilkdata) \| { `assetData`: [*AssetData*](README.md#assetdata)  }
+Ƭ **ExtendedIlkData**: [`IlkData`](README.md#ilkdata) \| { `assetData`: [`AssetData`](README.md#assetdata)  }
+
+#### Defined in
 
-Defined in: [types.ts:41](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/types.ts#L41)
+[types.ts:51](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/types.ts#L51)
 
 ___
 
 ### IlkData
 
-Ƭ **IlkData**: { `asset`: *string* ; `assetAddress?`: *string* ; `clip?`: *string* ; `clipCalc?`: *string* ; `flip?`: *string* ; `ilkBytes`: *string* ; `ilkLabel`: *string* ; `isLP`: *boolean* ; `join`: *string* ; `pip`: *string*  }
+Ƭ **IlkData**: `Object`
 
 Maker ilk info type
 
-#### Type declaration:
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `asset` | `string` |
+| `assetAddress?` | `string` |
+| `clip?` | `string` |
+| `clipCalc?` | `string` |
+| `flip?` | `string` |
+| `ilkBytes` | `string` |
+| `ilkLabel` | `string` |
+| `isLP` | `boolean` |
+| `join` | `string` |
+| `pip` | `string` |
 
-Name | Type |
------- | ------ |
-`asset` | *string* |
-`assetAddress?` | *string* |
-`clip?` | *string* |
-`clipCalc?` | *string* |
-`flip?` | *string* |
-`ilkBytes` | *string* |
-`ilkLabel` | *string* |
-`isLP` | *boolean* |
-`join` | *string* |
-`pip` | *string* |
+#### Defined in
 
-Defined in: [types.ts:21](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/types.ts#L21)
+[types.ts:31](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/types.ts#L31)
 
 ## Variables
 
 ### MAXUINT
 
-• `Const` **MAXUINT**: *string*= '115792089237316195423570985008687907853269984665640564039457584007913129639935'
+• **MAXUINT**: `string` = `'115792089237316195423570985008687907853269984665640564039457584007913129639935'`
 
-Defined in: [index.ts:19](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L19)
+#### Defined in
+
+[index.ts:27](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L27)
 
 ___
 
 ### aaveV2Markets
 
-• `Const` **aaveV2Markets**: AaveMarketData[]
+• **aaveV2Markets**: `AaveMarketData`[]
+
+#### Defined in
 
-Defined in: [aaveV2Markets.ts:3](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/aaveV2Markets.ts#L3)
+[aaveV2Markets.ts:3](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/aaveV2Markets.ts#L3)
 
 ___
 
 ### assets
 
-• `Const` **assets**: [*AssetData*](README.md#assetdata)[]
+• **assets**: [`AssetData`](README.md#assetdata)[]
 
-Defined in: [assets.ts:381](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/assets.ts#L381)
+#### Defined in
+
+[assets.ts:230](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/assets.ts#L230)
 
 ___
 
 ### ilks
 
-• `Const` **ilks**: [*IlkData*](README.md#ilkdata)[]
+• **ilks**: [`IlkData`](README.md#ilkdata)[]
+
+#### Defined in
 
-Defined in: [ilks.ts:5](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/ilks.ts#L5)
+[ilks.ts:5](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/ilks.ts#L5)
 
 ___
 
 ### reflexerCollTypes
 
-• `Const` **reflexerCollTypes**: [*IlkData*](README.md#ilkdata)[]
+• **reflexerCollTypes**: [`IlkData`](README.md#ilkdata)[]
+
+#### Defined in
 
-Defined in: [reflexerCollTypes.ts:3](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/reflexerCollTypes.ts#L3)
+[reflexerCollTypes.ts:3](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/reflexerCollTypes.ts#L3)
 
 ___
 
 ### utils
 
-• `Const` **utils**: *object*
+• **utils**: `Object`
 
-#### Type declaration:
+#### Type declaration
 
-Name | Type | Value |
------- | ------ | ------ |
-`bytesToString` | *function* | (`hex`: *string*) => *string* |
-`compare` | *function* | (`a`: *string*, `b`: *string*) => *boolean* |
-`stringToBytes` | *function* | (`str`: *string*) => *string* |
+| Name | Type |
+| :------ | :------ |
+| `bytesToString` | (`hex`: `string`) => `string` |
+| `compare` | (`a`: `string`, `b`: `string`) => `boolean` |
+| `stringToBytes` | (`str`: `string`) => `string` |
 
-Defined in: [index.ts:17](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L17)
+#### Defined in
+
+[index.ts:25](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L25)
 
 ## Functions
 
 ### assetAmountInEth
 
-▸ `Const`**assetAmountInEth**(`amount`: *string* \| *number* \| *object*, `asset?`: *string*): *string*
+▸ `Const` **assetAmountInEth**(`amount`, `asset?`): `string`
+
+#### Parameters
 
-#### 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) |
 
-Name | Type | Default value | Description |
------- | ------ | ------ | ------ |
-`amount` | *string* \| *number* \| *object* | - | Amount in wei   |
-`asset` | *string* | 'ETH' | Asset symbol (or `MCD-${symbol}` for maker asset - always 18dec)   |
+#### Returns
 
-**Returns:** *string*
+`string`
 
-Defined in: [index.ts:128](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L128)
+#### Defined in
+
+[index.ts:142](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L142)
 
 ___
 
 ### assetAmountInWei
 
-▸ `Const`**assetAmountInWei**(`amount`: *string* \| *number* \| *object*, `asset`: *string*): *string*
+▸ `Const` **assetAmountInWei**(`amount`, `asset`): `string`
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `amount` | `string` \| `number` \| `object` | Amount in eth |
+| `asset` | `string` | Asset symbol |
 
-#### Parameters:
+#### Returns
 
-Name | Type | Description |
------- | ------ | ------ |
-`amount` | *string* \| *number* \| *object* | Amount in eth   |
-`asset` | *string* | Asset symbol   |
+`string`
 
-**Returns:** *string*
+#### Defined in
 
-Defined in: [index.ts:149](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L149)
+[index.ts:163](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L163)
 
 ___
 
 ### getAaveV2MarketInfo
 
-▸ `Const`**getAaveV2MarketInfo**(`name?`: *string*): *void* \| AaveMarketData
+▸ `Const` **getAaveV2MarketInfo**(`name?`): `void` \| `AaveMarketData`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `name` | `string` | `''` |
 
-#### Parameters:
+#### Returns
 
-Name | Type | Default value |
------- | ------ | ------ |
-`name` | *string* | '' |
+`void` \| `AaveMarketData`
 
-**Returns:** *void* \| AaveMarketData
+#### Defined in
 
-Defined in: [index.ts:121](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L121)
+[index.ts:135](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L135)
 
 ___
 
 ### getAssetInfo
 
-▸ `Const`**getAssetInfo**(`symbol?`: *string*): [*AssetData*](README.md#assetdata)
+▸ `Const` **getAssetInfo**(`symbol?`): [`AssetData`](README.md#assetdata)
 
 Returns asset info.
 Warning: will not throw if asset not found. Instead, will return a placeholder object.
 
-#### Parameters:
+#### Parameters
 
-Name | Type | Default value |
------- | ------ | ------ |
-`symbol` | *string* | '' |
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `symbol` | `string` | `''` |
 
-**Returns:** [*AssetData*](README.md#assetdata)
+#### Returns
 
-Defined in: [index.ts:41](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L41)
+[`AssetData`](README.md#assetdata)
+
+#### Defined in
+
+[index.ts:49](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L49)
 
 ___
 
 ### getAssetInfoByAddress
 
-▸ `Const`**getAssetInfoByAddress**(`address?`: *string*): [*AssetData*](README.md#assetdata)
+▸ `Const` **getAssetInfoByAddress**(`address?`): [`AssetData`](README.md#assetdata)
+
+#### Parameters
 
-#### Parameters:
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `address` | `string` | `''` |
 
-Name | Type | Default value |
------- | ------ | ------ |
-`address` | *string* | '' |
+#### Returns
 
-**Returns:** [*AssetData*](README.md#assetdata)
+[`AssetData`](README.md#assetdata)
 
-Defined in: [index.ts:71](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L71)
+#### Defined in
+
+[index.ts:85](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L85)
 
 ___
 
 ### getIlkInfo
 
-▸ `Const`**getIlkInfo**(`ilk?`: *string*): [*ExtendedIlkData*](README.md#extendedilkdata)
+▸ `Const` **getIlkInfo**(`ilk?`): [`ExtendedIlkData`](README.md#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:
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `ilk` | `string` | `''` | Ilk encoded as string or as hex |
 
-Name | Type | Default value | Description |
------- | ------ | ------ | ------ |
-`ilk` | *string* | '' | Ilk encoded as string or as hex   |
+#### Returns
 
-**Returns:** [*ExtendedIlkData*](README.md#extendedilkdata)
+[`ExtendedIlkData`](README.md#extendedilkdata)
 
-Defined in: [index.ts:50](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L50)
+#### Defined in
+
+[index.ts:64](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L64)
 
 ___
 
 ### ilkToAsset
 
-▸ `Const`**ilkToAsset**(`ilk?`: *string*): *string*
+▸ `Const` **ilkToAsset**(`ilk?`): `string`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `ilk` | `string` | `''` |
 
-#### Parameters:
+#### Returns
 
-Name | Type | Default value |
------- | ------ | ------ |
-`ilk` | *string* | '' |
+`string`
 
-**Returns:** *string*
+#### Defined in
 
-Defined in: [index.ts:73](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L73)
+[index.ts:87](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L87)
+
+___
+
+### set
+
+▸ `Const` **set**(`key`, `value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+| `value` | `any` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[index.ts:21](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L21)
 
 ___
 
 ### tokenFromJoin
 
-▸ `Const`**tokenFromJoin**(`join`: *string*, `fromIlks?`: [*IlkData*](README.md#ilkdata)[]): *string*
+▸ `Const` **tokenFromJoin**(`join`, `fromIlks?`): `string`
 
-#### Parameters:
+#### Parameters
 
-Name | Type | Default value | Description |
------- | ------ | ------ | ------ |
-`join` | *string* | - | Maker or Reflexer ilk join   |
-`fromIlks` | [*IlkData*](README.md#ilkdata)[] | ... |  |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `join` | `string` | `undefined` | Maker or Reflexer ilk join |
+| `fromIlks` | [`IlkData`](README.md#ilkdata)[] | `ilks` |  |
 
-**Returns:** *string*
+#### Returns
+
+`string`
 
 Token symbol
 
-Defined in: [index.ts:101](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L101)
+#### Defined in
+
+[index.ts:115](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L115)
 
 ___
 
 ### tokenFromMakerJoin
 
-▸ `Const`**tokenFromMakerJoin**(`join`: *string*): *string*
+▸ `Const` **tokenFromMakerJoin**(`join`): `string`
 
-#### Parameters:
+#### Parameters
 
-Name | Type | Description |
------- | ------ | ------ |
-`join` | *string* | Maker ilk join   |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `join` | `string` | Maker ilk join |
 
-**Returns:** *string*
+#### Returns
+
+`string`
 
 Token symbol
 
-Defined in: [index.ts:113](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L113)
+#### Defined in
+
+[index.ts:127](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L127)
 
 ___
 
 ### tokenFromReflexerJoin
 
-▸ `Const`**tokenFromReflexerJoin**(`join`: *string*): *string*
+▸ `Const` **tokenFromReflexerJoin**(`join`): `string`
 
-#### Parameters:
+#### Parameters
 
-Name | Type | Description |
------- | ------ | ------ |
-`join` | *string* | Reflexer ilk join   |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `join` | `string` | Reflexer ilk join |
 
-**Returns:** *string*
+#### Returns
+
+`string`
 
 Token symbol
 
-Defined in: [index.ts:119](https://github.com/DecenterApps/defisaver-tokens/blob/e29f27f/src/index.ts#L119)
+#### Defined in
+
+[index.ts:133](https://github.com/DecenterApps/defisaver-tokens/blob/5d144eb/src/index.ts#L133)