-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from kaiachain/dev
First release of sub libraries
- Loading branch information
Showing
1,402 changed files
with
20,064 additions
and
3,375 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,13 @@ | ||
|
||
![logo.png](<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. | ||
**kaia SDK** is a set of SDKs to interact with kaia (mono repo). It includes 4 SDKs (ethers-ext, web3js-ext, web3j-ext, web3py-ext) and allows developer to easily interact with kaia without very few changes. Furthermore **OAS 3.0** ([OpenAPI Specification 3.0](https://swagger.io/specification/)) is used to generate automatically the kaia 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 | ||
kaia has extended the RPC APIs over early Ethereum to allow developers to get various or kaia-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 kaia Node in the [rpc-specs](https://github.com/kaiachain/kaia-sdk/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) | ||
- ethers extension : **ethers-ext** (javascript) [NPM]() [Github](https://github.com/kaiachain/kaia-sdk/tree/main/ethers-ext) | ||
- web3js extension : **web3js-ext** (javascript) [NPM]() [Github](https://github.com/kaiachain/kaia-sdk/tree/main/web3js-ext) | ||
- web3j extension : **web3j-ext** (java) [MVN]() [Github](https://github.com/kaiachain/kaia-sdk/tree/main/web3j-ext) | ||
- web3py extension : **web3py-ext** (python) [pypi]() [Github](https://github.com/kaiachain/kaia-sdk/tree/main/web3py-ext) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,7 @@ then | |
elif [ "$1" == "split" ] | ||
then | ||
yarn build [email protected] -o "$RPC_SPEC_DIR"/web3rpc-klay.yaml | ||
yarn build [email protected] -o "$RPC_SPEC_DIR"/web3rpc-kaia.yaml | ||
yarn build [email protected] -o "$RPC_SPEC_DIR"/web3rpc-eth.yaml | ||
yarn build [email protected] -o "$RPC_SPEC_DIR"/web3rpc-debug.yaml | ||
yarn build [email protected] -o "$RPC_SPEC_DIR"/web3rpc-admin.yaml | ||
|
Oops, something went wrong.