Class ChainLinkService

ChainLinkService

Remark

https://docs.chain.link/data-feeds/price-feeds/addresses

Hierarchy (view full)

AbstractRpcService
- ChainLinkService

Implements

IRpcService

Index

Constructors

Accessors

config supportedChainMap supportedChains supportedNetworks

Methods

cloneConfig fetchPairPrice getAddressByPair

Basic Methods

getEndpointByChainId getNetworkByChainId isSupportedChain setApiKey setChainMap setEndpoint setVersion

Constructors

constructor

new ChainLinkService(chainId?): ChainLinkService
Parameters
- Optional chainId: number
Returns ChainLinkService
Overrides AbstractRpcService.constructor
- Defined in ../../src/services/rpcs/chainLink/ChainLinkService.ts:47

Accessors

config

get config(): NetworkModels
return verified configurations

Returns NetworkModels
Implementation of IRpcService.config
Overrides AbstractRpcService.config
- Defined in ../../src/services/rpcs/chainLink/ChainLinkService.ts:66

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` cloneConfig

cloneConfig(config): NetworkModels
overwrite
Parameters
- config: NetworkModels
Returns NetworkModels
Overrides AbstractRpcService.cloneConfig
- Defined in ../../src/services/rpcs/chainLink/ChainLinkService.ts:75

fetchPairPrice

fetchPairPrice(pair): Promise<null | ChainLinkPriceResult>
Get the current price of the specified pair
Parameters
- pair: string
  {string} - e.g.: BTC/USD, see: EthereumPriceFeedAddresses.ts
Returns Promise<null | ChainLinkPriceResult>
- Defined in ../../src/services/rpcs/chainLink/ChainLinkService.ts:150

getAddressByPair

getAddressByPair(pair, chainId?): null | ChainLinkPriceFeedAddressItem
Parameters
- pair: string
  {string} e.g.: BTC/USD, see the keys in file EthereumPriceFeedAddresses.ts
- Optional chainId: number
  {number}
Returns null | ChainLinkPriceFeedAddressItem
- Defined in ../../src/services/rpcs/chainLink/ChainLinkService.ts:106

Basic Methods

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/chainLink/ChainLinkService.ts:87

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