Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

Latest commit

 

History

History
23 lines (15 loc) · 2.81 KB

README.md

File metadata and controls

23 lines (15 loc) · 2.81 KB

No Maintenance Intended

NO LONGER MAINTAINED

Since the launch of Kaia Blockchain this repository has been parked in favour of the new open-source projects in Kaia's Github. Contributors have now moved there continuing with massive open-source contributions to our blockchain ecosystem. Please visit the new repository at kaiachain/kaia-sdk to continue contributing and to access the latest updates. A big thank you to everyone who has contributed to this repository. For more information about Klaytn's chain merge with Finschia blockchain please refer to the launching of Kaia blockchain - kaia.io.


logo.png

Overview

web3klaytn is a set of SDKs to interact with Klaytn. It includes 4 SDKs (ethers-ext, web3js-ext, web3j-ext, web3py-ext) and allows developer to easily interact with klaytn without very few changes. Furthermore OAS 3.0 (OpenAPI Specification 3.0) is used to generate automatically the klaytn NodeAPI specification and web API provider source code named web3rpc.

web3rpc wtih OpenAPI

Klaytn has extended the RPC APIs over early Ethereum to allow developers to get various or klaytn-specific data. Considering that would increasingly be mismatch between documentation and source code, OpenAPI specification is adopted to generate automatically the documentation and source code in the same time. You can see all the API specifications for Klaytn Node in the rpc-specs directory

extension strategies for existing web3 SDKs

The extension is focused on seamless development for web3 developers. Being able to develop web3 service from other chain without feeling differences will make the developers comfortable and more productivity. It also makes developers easy to build a service among several chains with a single SDK and same pattern. Except web3j-ext SDK for java language, what you need to do is just importing the extension with the existing SDK.

  • ethers extension : ethers-ext (javascript) NPM Github
  • web3js extension : web3js-ext (javascript) NPM Github
  • web3j extension : web3j-ext (java) MVN Github
  • web3py extension : web3py-ext (python) pypi Github