https://github.com/klaytn/web3klaytn

web3klaytn
https://github.com/klaytn/web3klaytn

Last synced: 30 days ago
JSON representation

web3klaytn

• Host: GitHub
• URL: https://github.com/klaytn/web3klaytn
• Owner: klaytn
• License: mit
• Archived: true
• Created: 2023-03-24T06:33:02.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2024-07-16T04:12:37.000Z (5 months ago)
• Last Synced: 2024-10-30T06:27:47.988Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 56.1 MB
• Stars: 12
• Watchers: 6
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-klaytn - web3klaytn - a set of SDKs to interact with Klaytn by extending existing web3 SDKs. (SDKs)

README

        
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

# 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](https://github.com/kaiachain). Contributors have now moved there continuing with massive open-source contributions to our blockchain ecosystem. Please visit the new repository at [kaiachain/kaia-sdk](https://github.com/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](https://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](https://swagger.io/specification/)) 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](https://github.com/klaytn/web3klaytn/tree/dev/web3rpc/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](https://www.npmjs.com/package/@klaytn/ethers-ext) [Github](https://github.com/klaytn/web3klaytn/tree/main/ethers-ext)

- web3js extension : **web3js-ext** (javascript) [NPM](https://www.npmjs.com/package/@klaytn/web3js-ext) [Github](https://github.com/klaytn/web3klaytn/tree/main/web3js-ext)

- web3j extension : **web3j-ext** (java) [MVN](https://mvnrepository.com/artifact/foundation.klaytn/web3j-ext) [Github](https://github.com/klaytn/web3klaytn/tree/main/web3j-ext)

- web3py extension : **web3py-ext** (python) [pypi](https://pypi.org/project/web3py-ext/) [Github](https://github.com/klaytn/web3klaytn/tree/main/web3py-ext)