etherscan-typescript

A TypeScript library for interacting with the Etherscan API and other Etherscan-like explorers from different EVM chains, enabling developers to easily fetch blockchain data directly through these interfaces.

Installation

To install the library, you can use either npm or bun:

npm install etherscan-typescript

or

bun add etherscan-typescript

Usage

Start by importing the EtherScan class from the library and initializing it with your Etherscan API key:

import { EtherScan } from 'etherscan-typescript';

const apiKey = 'YOUR_ETHERSCAN_API_KEY';
const etherscan = new EtherScan(apiKey);

Example: Fetching an Account Balance from Etherscan

You can retrieve the balance of an Ethereum address as follows:

async function getBalance() {
  const address = '0x...'; // Specify the Ethereum address
  const balance = await etherscan.account.getBalance(address);
  console.log(balance);
}

getBalance();

Using Other Explorers like Arbiscan

The library also supports other Etherscan-like explorers. For example, interacting with Arbiscan is as straightforward as using the EtherScan class. Import the ArbiScan class and use it in the same way:

import { ArbiScan } from 'etherscan-typescript';

const apiKey = 'YOUR_ARBISCAN_API_KEY';
const arbiscan = new ArbiScan(apiKey);

async function getBalanceOnArbitrum() {
  const address = '0x...'; // Specify the Arbitrum address
  const balance = await arbiscan.account.getBalance(address);
  console.log(balance);
}

getBalanceOnArbitrum();

Features

The etherscan-typescript library provides access to various Etherscan API functionalities, including but not limited to:

• Account API: Fetch balances, transaction history, and ERC-20 token transfers.
• Contract API: Retrieve contract ABI, source code, and other contract-related data.
• Transaction API: Check transaction status and gas used.
• Blocks API: Information on blocks and uncle blocks by number or date.

Additionally, this library supports similar functionalities across multiple EVM-compatible block explorers like Arbiscan, BscScan, and more.

Contributing

Contributions to the etherscan-typescript library are welcome. Please ensure that your code adheres to the existing style, and include tests for new features.

License

This project is licensed under the MIT License - see the LICENSE file for details.