@typechain/ethers-v5

What is @typechain/ethers-v5?

@typechain/ethers-v5 is a TypeScript code generator that generates TypeScript typings for Ethereum smart contracts. It is specifically designed to work with the ethers.js library (version 5). This package helps developers interact with Ethereum smart contracts in a type-safe manner, reducing the likelihood of runtime errors and improving the developer experience.

What are @typechain/ethers-v5's main functionalities?

Generating TypeScript typings for smart contracts

This feature allows you to generate TypeScript typings for your Ethereum smart contracts. By running the TypeChain command with the ethers-v5 target, you can create type-safe contract interfaces that can be used in your TypeScript project.

const { execSync } = require('child_process');
execSync('npx typechain --target ethers-v5 --out-dir src/types "./artifacts/**/*.json"');

Interacting with smart contracts using type-safe methods

This feature demonstrates how to interact with a smart contract using the generated TypeScript typings. By importing the contract interface and using ethers.js, you can call contract methods in a type-safe manner, ensuring that the correct types are used and reducing the risk of runtime errors.

import { MyContract } from './types/MyContract';
import { ethers } from 'ethers';

async function main() {
  const provider = new ethers.providers.JsonRpcProvider('http://localhost:8545');
  const signer = provider.getSigner();
  const myContract = new ethers.Contract('0xYourContractAddress', MyContract.abi, signer) as MyContract;

  const result = await myContract.myMethod();
  console.log(result);
}

main();

Other packages similar to @typechain/ethers-v5

@typechain/truffle-v5

@typechain/truffle-v5 is a TypeScript code generator that generates TypeScript typings for Ethereum smart contracts specifically designed to work with the Truffle framework. It provides similar functionality to @typechain/ethers-v5 but is tailored for projects using Truffle instead of ethers.js.

ethers

ethers is a library for interacting with the Ethereum blockchain and its ecosystem. While it does not generate TypeScript typings for smart contracts, it provides a comprehensive set of tools for interacting with Ethereum, including contract interaction, wallet management, and more. @typechain/ethers-v5 builds on top of ethers.js to provide type-safe contract interactions.

README

Typechain target Ethers-v5

TypeChain target Ethers-v5

🔌 TypeScript bindings for Ethers 5.x.x smartcontracts

Medium post | DappCon Video

TypeChain readme