이 페이지는 영문에서 기계 번역되었으므로 오역이나 어색한 표현이 있을 수 있습니다. 따라서 정확한 정보는 영어 원문을 참조하시기 바랍니다. 또한 잦은 업데이트로 인해 일부 콘텐츠는 영문이 그대로 남아있을 수 있습니다. Crowdin에서 이 페이지의 번역을 개선하는 데 동참하여 도움을 주세요. (Crowdin translation page, Contributing guide)

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 supports both ethers v5 and v6. However, you need to use the right packages which are specified for each ethers version. So ethers v5 must be used with packages from @kaiachain/ethers-ext/v5 and ethers v6 is only compatible with @kaiachain/ethers-ext/v6.

NOTE: If the import path has no version sub-path (@kaiachain/ethers-ext), ethers v5 will be used by default.

• Don't: Mixing ethers v6 and ethers-ext for ethers v5

  
  

  const ethers = require("ethers"); // ethers v6

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

  const provider = new ethers.JsonRpcProvider(

  "https://public-en-kairos.node.kaia.io"

  );

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

  
  

• Do: Using with ethers v5

  
  

  const ethers = require("ethers"); // ethers v5

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

  const provider = new ethers.providers.JsonRpcProvider(

  "https://public-en-kairos.node.kaia.io"

  );

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

  
  

• Do: Using with ethers v6

  
  

  const ethers = require("ethers"); // ethers v6

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

  const provider = new ethers.JsonRpcProvider(

  "https://public-en-kairos.node.kaia.io"

  );

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

  
  

• Do: Using ethers-ext only

  
  

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

  // or

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

  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 # or ethers@6

  
  

• ESM or TypeScript

  
  

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

  // esm

  // v5

  import { v5 } from "@kaiachain/ethers-ext";

  const { Wallet, JsonRpcProvider } = v5;

  // v6

  import { v6 } from "@kaiachain/ethers-ext";

  const { Wallet, JsonRpcProvider } = v6;

  // esm subpath import. If using typescript, add "moduleResolution": "nodenext" to tsconfig.json

  // v5

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

  // v6

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

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

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

  
  

• CommonJS

  
  

  // v5

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

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

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

  // v6

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

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

  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. using ethers-ext.buldle.js for ethers v5 and ethers-ext.v6.bundle.js for ethers v6

<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.