https://github.com/interest-protocol/sui-amm-sdk
TS SDK to interact with Interest Protocol Sui Contracts
https://github.com/interest-protocol/sui-amm-sdk
Last synced: about 1 year ago
JSON representation
TS SDK to interact with Interest Protocol Sui Contracts
- Host: GitHub
- URL: https://github.com/interest-protocol/sui-amm-sdk
- Owner: interest-protocol
- Created: 2023-04-10T17:05:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T15:27:50.000Z (over 2 years ago)
- Last Synced: 2025-04-03T05:05:28.976Z (about 1 year ago)
- Language: TypeScript
- Size: 279 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Interest Protocol Sui SDK](https://www.interestprotocol.com/)
## Functionality
- [findPoolId](https://docs.interestprotocol.com/developers/sdk#findpoolid)
- [createVolatilePool](https://docs.interestprotocol.com/developers/sdk#createvolatilepool)
- [createStablePool](https://docs.interestprotocol.com/developers/sdk#createstablepool)
- [swap](https://docs.interestprotocol.com/developers/sdk#swap)
- [quoteSwap](https://docs.interestprotocol.com/developers/sdk#quoteswap)
- [addLiquidity](https://docs.interestprotocol.com/developers/sdk#addliquidity)
- [quoteAddLiquidity](https://docs.interestprotocol.com/developers/sdk#quoteaddliquidity)
- [removeLiquidity](https://docs.interestprotocol.com/developers/sdk#removeliquidity)
- [quoteRemoveLiquidity](https://docs.interestprotocol.com/developers/sdk#quoteremoveliquidity)
- [getLatestDEXMarkets](https://docs.interestprotocol.com/developers/sdk#getlatestdexmarkets)
## Install
Install the project dependencies with yarn or npm
```bash
yarn add @interest-protocol/sui-sdk@latest
```
## Requirements
Node.js version >= 18
### [Install node.js LTS](https://nodejs.org/en)
Verify your Node.js version with
```bash
node -v
```
## Documentation
https://docs.interestprotocol.com/developers/sui/sdk
## Code Style
You must install it in your Editor text
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Technologies
- [Typescript](https://typescriptlang.org)
- [Ramda](https://ramdajs.com/)
- [@mysten/sui.js](https://www.npmjs.com/package/@mysten/sui.js)
## Contributing
We always want to be better.
Feel invited to contribute, if you are comfortable, follow the instructions in [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
## Contact Us
- Twitter: [@interest_dinero](https://twitter.com/interest_dinero)
- Discord: https://discord.gg/interestprotocol
- Telegram: https://t.me/interestprotocol
- Email: [info@interestprotocol.com](mailto:info@interestprotocol.com)
- Medium: [@interestprotocol](https://medium.com/@interestprotocol)