Skip to content

Commit

Permalink
Merge pull request #9 from kaiachain/dev
Browse files Browse the repository at this point in the history
First release of sub libraries
  • Loading branch information
jack authored Jul 5, 2024
2 parents 6e2f6fa + 257e13a commit 0f043f5
Show file tree
Hide file tree
Showing 1,402 changed files with 20,064 additions and 3,375 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd ethers-ext && npx pnpm --filter "@klaytn/*" -r publish --publish-branch main --no-git-check --access=public && cd -
cd ethers-ext && npx pnpm --filter "@kaiachain/*" -r publish --publish-branch main --no-git-check --access=public && cd -
- name: generate web3rpc-javascript sdk
Expand All @@ -127,7 +127,7 @@ jobs:
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd web3rpc/sdk/client/javascript/openapi && npx pnpm --filter "@klaytn/*" -r publish --publish-branch main --no-git-check --access=public && cd -
cd web3rpc/sdk/client/javascript/openapi && npx pnpm --filter "@kaiachain/*" -r publish --publish-branch main --no-git-check --access=public && cd -
- name: generate web3rpc-java sdk
Expand Down Expand Up @@ -165,7 +165,7 @@ jobs:
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd js-ext-core && npx pnpm --filter "@klaytn/*" -r publish --publish-branch main --no-git-check --access=public && cd -
cd js-ext-core && npx pnpm --filter "@kaiachain/*" -r publish --publish-branch main --no-git-check --access=public && cd -
- name: generate web3js-ext
if: steps.verify-changed-files.outputs.web3js-ext_any_changed == 'true'
Expand All @@ -178,4 +178,4 @@ jobs:
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
cd web3js-ext && npx pnpm --filter "@klaytn/*" -r publish --publish-branch main --no-git-check --access=public && cd -
cd web3js-ext && npx pnpm --filter "@kaiachain/*" -r publish --publish-branch main --no-git-check --access=public && cd -
15 changes: 6 additions & 9 deletions README.md
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)
1 change: 1 addition & 0 deletions documentation/generate-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 0f043f5

Please sign in to comment.