https://github.com/kybernetwork/ks-sdk-elastic-demo

Sample implementation of Elastic swap and liquidity management operations in a TypeScript environment
https://github.com/kybernetwork/ks-sdk-elastic-demo

Last synced: about 2 months ago
JSON representation

Sample implementation of Elastic swap and liquidity management operations in a TypeScript environment

• Host: GitHub
• URL: https://github.com/kybernetwork/ks-sdk-elastic-demo
• Owner: KyberNetwork
• Created: 2023-10-03T10:36:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-12T09:36:23.000Z (about 1 year ago)
• Last Synced: 2023-10-12T22:39:58.062Z (about 1 year ago)
• Language: TypeScript
• Size: 59.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# KyberSwap Elastic SDK Demo

This repository serves as a guide for developers looking to interact with KyberSwap Elastic smart contracts via a typescript SDK. For simplicity, the examples are implemented purely in Node.js so that users can focus on the backend logic required to achieve the following Elastic Operations:

* Getting a quote (`getQoute()`)

* Executing a trade (`executeTrade()`)

* Create a new position (`createPosition()`)

* Add liquidity to exisintg position (`increaseLiquidity()`)

* Remove liquidity (`removeLiquidity()`)

## Getting Started

To run the examples:

* Clone this repository

* Install dependencies: `npm install`

* Run dev environment with Nodemon (auto-refresh on save): `npm run start:dev`

* Run dev environment: `npm run start`

## Detailed Guides And Technical Reference

For each of the operations listed above, a guide has been created on the [KyberSwap Docs](https://docs.kyberswap.com/liquidity-solutions/elastic-sdk) which goes through in detail each of the steps required to complete the specific operation. You can also find the full list of [Elastic SDK Classes](https://docs.kyberswap.com/liquidity-solutions/elastic-sdk/classes) on the Docs.

## Additional Notes

Note that the code samples in this repository are not production-ready and are meant as references to get you started on integrating Elastic functionality into your dApp.