NO LONGER MAINTAINED

Important

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. A big thank you to everyone who has contributed to this repository.

For future development and contributions, please refer to the new kaia-service-sdk repository

More information about Klaytn's chain merge with Finschia blockchain, please refer to the launching of Kaia blockchain kaia.io.

---

• Klaytn Service SDK
  • Oracles Module
    • Witnet
  • Bridges Module
    • Celer Bridge
    • Wormhole Bridge
  • DEX Module
    • Open source DEX
• Getting started
  • Quick Usage
  • Setup Locally
    • Requirement
    • Steps to setup locally
• Usage
  • Want to Contribute to Klaytn Service SDK?

Klaytn Service SDK

Klaytn Service SDK is a monorepo of all the services in the Klaytn ecosystem. Check out Quick Usage to integrate the services in the dapp

Oracles Module

Witnet

Implementation of the following features using the Hardhat development environment:

• Witnet Data Feeds on Klaytn
• Witnet Randomness on Klaytn

Bridges Module

Celer Bridge

Implementations:

• PoolBased Transfer
• PoolBased Transfer Refund
• MintCanoncialToken
• MintCanoncialToken Refund
• BurnCanoncialToken
• BurnCanoncialToken Refund

Wormhole Bridge

Implementations:

• Token Attestation
• Transfer Tokens

DEX Module

Open source DEX

Integration of the following 5 DEX contracts:

• Swap
• Liquidity
• Farming
• Staking

Getting started

Quick Usage

To use klaytn-service-sdk, you can import the below npm packages in an existing nodejs project. Instructions for importing the package and utilizing its features can be found in the readme provided in the links below.

• @klaytn/kss-bridges-wormhole - Contains Wormhole integration
• @klaytn/kss-bridges-celer - Contains Celer integration
• @klaytn/kss-dexs - Contains Dexs integration
• @klaytn/kss-oracles - Contains Oracles integration
• @klaytn/kss-cli - Contains CLI features

Setup Locally

If you would like to explore current repository, please follow below instructions.

Requirement

• git
  • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
• Nodejs
  • You'll know you've installed nodejs right if you can run:
    • node --versionand get an output like: vx.x.x
• Yarn instead of npm
  • You'll know you've installed yarn right if you can run:
    • yarn --version And get an output like: x.x.x
    • You might need to install it with npm

If you're familiar with npx and npm instead of yarn, you can use npx for execution and npm for installing dependencies.

Steps to setup locally

After installing all the requirements, run the following to setup locally:

git clone https://github.com/klaytn/klaytn-service-sdk
cd klaytn-service-sdk

then

yarn

or

npm i

Usage

You can run the scripts from respective packages by cd into the packages.

Want to Contribute to Klaytn Service SDK?

In line with our commitment to decentralization, all Klaytn codebase and its documentations are completely open source. Klaytn always welcomes your contribution. Anyone can view, edit, fix its contents and make suggestions. You can either create a pull request on GitHub or create a enhancement request. Make sure to check our Contributor License Agreement (CLA) first and there are also a few guidelines our contributors would check out before contributing:

• Contribution Guide
• License
• Code of Conducts