Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OmniBTC/OmniSwap-Sui-SDK
The typescript SDK for Sui-AMM-swap
https://github.com/OmniBTC/OmniSwap-Sui-SDK
amm sdk sui swap
Last synced: 12 days ago
JSON representation
The typescript SDK for Sui-AMM-swap
- Host: GitHub
- URL: https://github.com/OmniBTC/OmniSwap-Sui-SDK
- Owner: OmniBTC
- License: apache-2.0
- Created: 2022-11-08T03:18:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T07:00:57.000Z (over 1 year ago)
- Last Synced: 2024-08-01T02:26:23.622Z (3 months ago)
- Topics: amm, sdk, sui, swap
- Language: TypeScript
- Homepage: https://docs-omniswap-sui.omnibtc.finance
- Size: 15.8 MB
- Stars: 6
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sui - OmniSwap-Sui-SDK
- awesome-move - OmniSwap-Sui-SDK
README
## OmniSwap-Sui-SDK
The typescript SDK for [Sui-AMM-swap](https://github.com/OmniBTC/Sui-AMM-swap)
## Docs
[OmniSwap Sui SDK docs](https://docs-omniswap-sui.omnibtc.finance)
## Testnet
* swap_package=0xe4dfb7dca0d54f5cc51ed39d847251417666b7c1
* swap_global=0x5faf9ee713fa866766ac448f2b634074c23851e3
* test_coins_package=0x0a3af85362a35154ce5f513bada2d38887d8a66f
* test_coins_faucet=0x41ed95838a6e03d172b4d55f3cdebe66cd1a3de2
* $test_coins_package::coins::USDT
* $test_coins_package::coins::XBTC
* $test_coins_package::coins::BTC
* $test_coins_package::coins::ETH
* $test_coins_package::coins::BNB
* $test_coins_package::coins::WBTC
* $test_coins_package::coins::USDC
* $test_coins_package::coins::DAI
## Usage
### Install
```bash
yarn add @omnibtc/omniswap-sui-sdk
```
### Test
```bash
yarn test
```
### Init SDK
```ts
import { SDK,TESTNET_CONFIG } from '@omnibtc/omniswap-sui-sdk';
(async function main() {
const sdk = new SDK(TESTNET_CONFIG);
})();
```
### Query LiquidPool
```ts
import { SDK,TESTNET_CONFIG } from '@omnibtc/omniswap-sui-sdk';
const SUI_COIN_TYPE = "0x2::sui::SUI";
const USDT_COIN_TYPE = "0xbf2972612002f472b5bd21394b4417d75c9fe887::usdt::USDT";
(async function main() {
const sdk = new SDK(TESTNET_CONFIG);
// get all pool list
const poolDetail = await sdk.Pool.getPoolList();
// get pool info from coinx and coiny
const poolDetail = await sdk.Pool.getPoolInfo(SUI_COIN_TYPE,USDT_COIN_TYPE);
console.log(poolDetail);
})();
```
### CoinList
```ts
...
//get coin list:
const tokenList = sdk.CoinList.getCoinInfoList();
console.log(tokenList);
```
```ts
//get coin info:
const tokenInfo = sdk.CoinList.getCoinInfoBySymbol('SUI');
console.log(tokenInfo);
```
### Coin
```ts
const SUI_COIN_TYPE = "0x2::sui::SUI";
const USDT_COIN_TYPE = "0xbf2972612002f472b5bd21394b4417d75c9fe887::usdt::USDT";
const address = '0x036e2406b8cf1fc4541ed6d0e252c77b094d0fd9';
...
const token = await sdk.Coin.getTokenBalance(address,SUI_COIN_TYPE);
```
## CLI
yarn cli
```
____ _ _ __ __ __ __ ____ _ ___
/ ___| _ _ (_) / \ | \/ | | \/ | / ___| | | |_ _|
\___ \ | | | | | | _____ / _ \ | |\/| | | |\/| | _____ | | | | | |
___) | | |_| | | | |_____| / ___ \ | | | | | | | | |_____| | |___ | |___ | |
|____/ \__,_| |_| /_/ \_\ |_| |_| |_| |_| \____| |_____| |___|
Usage: index [options] [command]
Options:
-c, --config path to your sui config.yml (generated with "sui client active-address")
-h, --help display help for command
Commands:
omniswap:faucet faucet token
omniswap:wallet print wallet
omniswap:addLiquid add liquid
omniswap:removeLiquid add liquid
omniswap:list_pools list all pools
help [command] display help for command
```
### Add Liquid
* BTC-ETH Pool
```
yarn cli -c ~/.sui/sui_config omniswap:addLiquid 0xed67ff7ca06c2af6353fcecc69e312a0588dbab1::btc::BTC 0xed67ff7ca06c2af6353fcecc69e312a0588dbab1::eth::ETH 0x96bf551cd27081c5d519f120592f180d8103d79f 100000000000 0xd7167f5fba00e2e8814651a9f41dc08fd92db43c 100000000000 0.2 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```
* XBTC-USDT Pool
```
yarn cli -c ~/.sui/sui_config omniswap:addLiquid 0x985c26f5edba256380648d4ad84b202094a4ade3::usdt::USDT 0x985c26f5edba256380648d4ad84b202094a4ade3::xbtc::XBTC 0xc9e9cd5042b0df537426abc1e2f4b20babd07186 999999998000 0x74d246f80c53ab48d0b7b23387d8e1dc64536265 9999998000 0.2 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```
* BTC-XBTC
```
yarn cli -c ~/.sui/sui_config omniswap:addLiquid 0xed67ff7ca06c2af6353fcecc69e312a0588dbab1::btc::BTC 0x985c26f5edba256380648d4ad84b202094a4ade3::xbtc::XBTC 0x96bf551cd27081c5d519f120592f180d8103d79f 100000000000 0xd7167f5fba00e2e8814651a9f41dc08fd92db43c 100000000000 0.2 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```
* BTC-USDT Pool
```
yarn cli -c ~/.sui/sui_config omniswap:addLiquid 0xed67ff7ca06c2af6353fcecc69e312a0588dbab1::btc::BTC 0x985c26f5edba256380648d4ad84b202094a4ade3::usdt::USDT 0x73ea04683c9fb1a7621d4bd48fd9542d6b9d45dc 10000000000000 0x21170033ca498d40ae12caa331e045e40a20c99f 10000000000000 0.2 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```
* ETH-USDT Pool
```
yarn cli -c ~/.sui/sui_config omniswap:addLiquid 0xed67ff7ca06c2af6353fcecc69e312a0588dbab1::eth::ETH 0x985c26f5edba256380648d4ad84b202094a4ade3::usdt::USDT 0x69cce60989e7c9e413031481d10bdbc165f854d0 10000000000000 0x262439fc8cd278eaf74c8fe464f54ea6b73d1c58 10000000000000 0.2 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```
* BNB-USDT Pool
```
yarn cli -c ~/.sui/sui_config omniswap:addLiquid 0xed67ff7ca06c2af6353fcecc69e312a0588dbab1::bnb::BNB 0x985c26f5edba256380648d4ad84b202094a4ade3::usdt::USDT 0x572ddd6021e94c1cb938a58a549667853ff3d222 10000000000000 0x572ddd6021e94c1cb938a58a549667853ff3d222 10000000000000 0.2 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```
### Remove Liquid
```
yarn cli -c ~/.sui/sui_config omniswap:removeLiquid 0x985c26f5edba256380648d4ad84b202094a4ade3::usdt::USDT 0x985c26f5edba256380648d4ad84b202094a4ade3::xbtc::XBTC 0x2909381a88fbac804a6361d96941ed52234a40ab 0xf3a028216f202bba58f2520a3ed6aca6c5d4275e
```