Class OneInchTokenService

OneInchTokenService

Remark

https://portal.1inch.dev/documentation/authentication

Hierarchy (view full)

AbstractRpcService
- OneInchTokenService

Implements

IRpcService

Index

Constructors

constructor

new OneInchTokenService(chainId?): OneInchTokenService
Parameters
- Optional chainId: number
  {number} the chainId number. defaults to getCurrentChain()
Returns OneInchTokenService
Overrides AbstractRpcService.constructor
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:33

Accessors

config

get config(): NetworkModels
return verified configurations

Returns NetworkModels
Implementation of IRpcService.config
Overrides AbstractRpcService.config
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:63

supportedChainMap

get supportedChainMap(): RpcSupportedChainMap
get supported chain map

Returns RpcSupportedChainMap
Implementation of IRpcService.supportedChainMap
Inherited from AbstractRpcService.supportedChainMap
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:76

supportedChains

get supportedChains(): number[]
get supported chain id list

Returns number[]
Implementation of IRpcService.supportedChains
Inherited from AbstractRpcService.supportedChains
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:86

supportedNetworks

get supportedNetworks(): string[]
get supported chain/network short name list

Returns string[]
Implementation of IRpcService.supportedNetworks
Inherited from AbstractRpcService.supportedNetworks
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:96

Methods

`Protected` extractTokenContractAddressFromUrl

extractTokenContractAddressFromUrl(url): null | string

Protected

Parameters

url: string
{string}

Returns null | string

Example

const url = "https://tokens.1inch.io/0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c.png";
    const token = extractTokenFromURL(url);
    console.log(token); // "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c"

fetchTokenItemInfo

fetchTokenItemInfo(contractAddress): Promise<OneInchTokenItem>
fetch token custom info
Parameters
- contractAddress: string
  {string} contract address
Returns Promise<OneInchTokenItem>
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:221

fetchTokenMap

fetchTokenMap(): Promise<OneInchTokenMap>
fetch token map/list

Returns Promise<OneInchTokenMap>
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:295

getTokenItemInfo

getTokenItemInfo(contractAddress): Promise<null | OneInchTokenItem>

get token item info

Parameters

contractAddress: string
{string} contract address

Returns Promise<null | OneInchTokenItem>

Example

//
//    switch chain/network to BNB Smart Chain Mainnet
//
const currentChainId = 56;

const contractAddress : string = new OneInchTokenService( currentChainId ).nativeTokenAddress;
const item = await new OneInchTokenService( currentChainId ).getTokenItemInfo( contractAddress );
//    should return:
{
   chainId: 56,
   symbol: 'BNB',
   name: 'BNB',
   address: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
   decimals: 18,
   logoURI: 'https://tokens.1inch.io/0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c.png',
   providers: [ '1inch', 'Curve Token List' ],
   eip2612: false,
   tags: [ 'native' ]
}

`Static` isValid1InchTokenItem

isValid1InchTokenItem(item): boolean
check if the input object is a valid OneInchTokenItem
Parameters
- item: null | {
  [key: string]: any;
  }
  { [ key : string ] : any | null } the object to be checked
Returns boolean
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:367

`Static` isValid1InchTokenLogoItem

isValid1InchTokenLogoItem(logoItem): boolean
check if the input value is a valid OneInchTokenLogoItem
Parameters
- logoItem: null | {
  [key: string]: any;
  }
  { { [ key : string ] : any } | null }
Returns boolean
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:439

Basic Methods

`Protected` cloneConfig

cloneConfig(config): NetworkModels
Protected
deep clone configuration from the input
Parameters
- config: NetworkModels
  {NetworkModels}
Returns NetworkModels
Inherited from AbstractRpcService.cloneConfig
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:221

getEndpointByChainId

getEndpointByChainId(chainId?): string
set end point by chainId
Parameters
- Optional chainId: number
  {number} the chainId number
Returns string
Implementation of IRpcService.getEndpointByChainId
Overrides AbstractRpcService.getEndpointByChainId
- Defined in ../../src/services/rpcs/oneInchToken/OneInchTokenService.ts:75

getNetworkByChainId

getNetworkByChainId(chainId?): null | string
get network short name by chainId
Parameters
- Optional chainId: number
  {number} the chainId number
Returns null | string
Implementation of IRpcService.getNetworkByChainId
Inherited from AbstractRpcService.getNetworkByChainId
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:135

isSupportedChain

isSupportedChain(chainId): boolean
check if the given chainId is supported
Parameters
- chainId: number
  {number} the chainId number
Returns boolean
Inherited from AbstractRpcService.isSupportedChain
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:121

`Protected` setApiKey

setApiKey(apiKey): void
set api key
Parameters
- apiKey: string
  {string}
Returns void
Inherited from AbstractRpcService.setApiKey
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:204

`Protected` setChainMap

setChainMap(chainMap): void
set supported chain map
Parameters
- chainMap: RpcSupportedChainMap
  {RpcSupportedChainMap}
Returns void
Inherited from AbstractRpcService.setChainMap
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:168

`Protected` setEndpoint

setEndpoint(endpoint): void
set end point
Parameters
- endpoint: string
  {string} the end point url
Returns void
Inherited from AbstractRpcService.setEndpoint
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:180

`Protected` setVersion

setVersion(version): void
set version
Parameters
- version: string
  {string}
Returns void
Inherited from AbstractRpcService.setVersion
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:192

Class OneInchTokenService

Remark

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Basic Methods

Constructors

constructor

Parameters

Returns OneInchTokenService

Accessors

config

Returns NetworkModels

supportedChainMap

Returns RpcSupportedChainMap

supportedChains

Returns number[]

supportedNetworks

Returns string[]

Methods

Protected extractTokenContractAddressFromUrl

Parameters

Returns null | string

Example

fetchTokenItemInfo

Parameters

Returns Promise<OneInchTokenItem>

fetchTokenMap

Returns Promise<OneInchTokenMap>

getTokenItemInfo

Parameters

Returns Promise<null | OneInchTokenItem>

Example

Static isValid1InchTokenItem

Parameters

Returns boolean

Static isValid1InchTokenLogoItem

Parameters

Returns boolean

Basic Methods

Protected cloneConfig

Parameters

Returns NetworkModels

getEndpointByChainId

Parameters

Returns string

getNetworkByChainId

Parameters

Returns null | string

isSupportedChain

Parameters

Returns boolean

Protected setApiKey

Parameters

Returns void

Protected setChainMap

Parameters

Returns void

Protected setEndpoint

Parameters

Returns void

Protected setVersion

Parameters

Returns void

`Protected` extractTokenContractAddressFromUrl

`Static` isValid1InchTokenItem

`Static` isValid1InchTokenLogoItem

`Protected` cloneConfig

`Protected` setApiKey

`Protected` setChainMap

`Protected` setEndpoint

`Protected` setVersion