This page uses machine translation from English, which may contain errors or unclear language. For the most accurate information, please see the original English version. Some content may be in the original English due to frequent updates. Help us improve this page's translation by joining our effort on Crowdin. (Crowdin translation page, Contributing guide)

NOTE: This version is going to be temporary. Please upgrade the version more than v1.0.1. You can use the ethers-ext with ethers v5 or v6, look at view.

Ethers.js Extension for kaia

Ethers.js Extension for kaia offers:

• Drop-in replacement to ethers.Wallet that handles both Ethereum and kaia transaction types involving AccountKey and TxTypes.
• Drop-in replacement to ethers.providers.JsonRpcProvider that provides accesses to both Ethereum RPCs and kaia-specific RPCs.
• Drop-in replacement to ethers.Web3Provider to work with both MetaMask (window.ethereum) and Kaia Wallet (window.klaytn)

Note for ethers v6

@kaiachain/ethers-ext was developed based on ethers v5. As a result, ethers v6 classes are incompatible with ethers-ext classes. If you are using ethers v6 in your codebase, do not mix ethers v6 classes and ethers-ext classes. e.g. ethers v6 JsonRpcProvider cannot be supplied to ethers-ext Wallet.

• Don't: mix ethers v6 and ethers-ext
  
  

  const ethers = require("ethers");

  const { Wallet } = require("@kaiachain/ethers-ext");

  const provider = new ethers.JsonRpcProvider("https://public-en-kairos.node.kaia.io");

  const wallet = new Wallet("<private key>", provider);

  
  
• Do: mix ethers v5 and ethers-ext
  
  

  const ethers = require("ethers");

  const { Wallet } = require("@kaiachain/ethers-ext");

  const provider = new ethers.providers.JsonRpcProvider("https://public-en-kairos.node.kaia.io");

  const wallet = new Wallet("<private key>", provider);

  
  
• Do: ethers-ext only
  
  

  const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext");

  const provider = new JsonRpcProvider("https://public-en-kairos.node.kaia.io");

  const wallet = new Wallet("<private key>", provider);

  
  

Install

Node.js

• Install
  
  

  npm install --save @kaiachain/ethers-ext ethers@5

  
  
• ESM or TypeScript
  
  

  import { Wallet, JsonRpcProvider } from "@kaiachain/ethers-ext";

  const provider = new JsonRpcProvider("https://public-en-kairos.node.kaia.io");

  const wallet = new Wallet("<private key>", provider);

  
  
• CommonJS
  
  

  const { Wallet, JsonRpcProvider } = require("@kaiachain/ethers-ext");

  const provider = new JsonRpcProvider("https://public-en-kairos.node.kaia.io");

  const wallet = new Wallet("<private key>", provider);

  
  

Browser

It is not recommended to use CDNs in production, But you can use below for quick prototyping.

<script src="https://cdn.jsdelivr.net/npm/@kaiachain/ethers-ext@latest/dist/ethers-ext.bundle.js"></script>

<script>

const provider = new ethers_ext.providers.Web3Provider(window.klaytn);

</script>

Usage

See example and test.