@xchainjs/xchain-ethereum

Modules

• client - Custom client for communicating with Ethereum by using ethers

Installation

yarn add @xchainjs/xchain-ethereum
Copy

Following peer dependencies have to be installed into your project. These are not included in @xchainjs/xchain-ethereum.

yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios ethers
Copy

Documentation

xchain ethereum

How xchain-ethereum works
How to use xchain-ethereum

Service Providers

This package uses the following service providers:

Function	Service	Notes
ETH balances	Etherscan	https://etherscan.io/apis#accounts (module=account, action=balance)
Token balances	Etherscan	https://etherscan.io/apis#tokens (module=account, action=tokenbalance)
ETH transaction history	Etherscan	https://etherscan.io/apis#accounts (module=account, action=txlistinternal)
Token transaction history	Etherscan	https://etherscan.io/apis#accounts (module=account, action=tokentx)
Transaction fees	Etherscan	https://etherscan.io/apis#gastracker (module=gastracker, action=gasoracle)
Transaction broadcast	Etherscan	https://sebs.github.io/etherscan-api/#eth_sendrawtransaction
Explorer	Etherscan	https://etherscan.io/

Etherscan API rate limits: https://info.etherscan.com/api-return-errors/

• This package uses etherjs library, by default it uses several providers. (https://docs.ethers.io/v5/api-keys/)

Enviroment variables

ETHERSCAN_API_KEY={YOUR_ETHERSCAN_API_KEY}
Copy

Default config can access.

process.env.ETHERSCAN_API_KEY
Copy