README.md

Klaytn cBridge starter kit

• Klaytn cBridge starter kit
  • About
  • Folder Structure
  • Setup
  • Overview
  • Reference Docs:

About

cBridge provides a simple liquidity provider experience and high liquidity efficiency for users when they manage their funds in different chains with lower costs. Learn more about flow and terminology from this doc: cBridge requirements

Folder Structure

• use-cases: Ready-to-run code examples to call the cBridge gateway via the REST API.
• core: cBridge client implementation.
  • APIs: cBridge client core logic.
  • contracts: Generated cBridge contract ABIs and bindings.
  • proto: gRPC-Web Protobuf definitions.
  • ts-proto: Generated .d.ts gRPC-Web bindings.

Setup

To setup locally and install dependencies, follow below command

npm install

Overview

For details information & documentation of each module of this package please refer to the docs linked below.

• Overview

• ParamsExplanation

• Prerequisites.md

Reference Docs:

• https://cbridge-docs.celer.network/developer/cbridge-sdk
• https://github.com/celer-network/cBridge-typescript-client
• https://test-cbridge-v2.celer.network/ (Testnet Website URL)
• https://cbridge.celer.network (Mainnet Website URL)