# comet-sdk > The Typescript SDK for Comet, a DEX aggregator on NEAR. Latest version **1.0.1** (published 2022-05-29) · ISC license · 0 weekly downloads ## Install ```sh npm install comet-sdk pnpm add comet-sdk yarn add comet-sdk bun add comet-sdk ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2022-05-29 | | First published | 2022-05-29 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 1.9 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Shardul Aeer | | Maintainers | secretshardul | ## Links - npm: https://www.npmjs.com/package/comet-sdk - npm.io page: https://npm.io/package/comet-sdk ## Recent versions - 1.0.1 (latest) — 2022-05-29 - 1.0.0 — 2022-05-29 ## README # Game plan 1. Single DEX swaps for REF and Jumbo - Study REF's router - Study the provider object returned by the wallet adapter. - Study Jupiter's SDK. Follow its naming conventions. - Write SDK: wrapper on a graphQL API 1. `/quote`: Get a ranked list of possible routes 2. `/swap`: Get serialized TX to swap 2. Split routes (v2): Use `NearWalletSelector.signAndSendTransactions`. The wallet can sign multiple TXs directed to different contracts using https://github.com/ref-finance/ref-ui/blob/19d5bee1c40e0b98686965e19a590a7f3ea27ac0/src/utils/sender-wallet.ts#L163. Eg. for adding liquidity in REF, you first call `ft_transfer_call()` for each token, then call the `add_liquidity` function on REF. 3. Multi leg swaps and Orderbook based swaps- todo 4. Aurora based swaps- Copy code from REF's UI. This is an add-on for the aggregator. - https://wallet.near.org/sign?transactions=DQAAAG1vbmtleWlzLm5lYXIAo66hZ5Dg8T%2BGyeY8sttBfvZM8K0%2BezAfHsJRsv1SCmzSdszH8DkAADwAAABhMGI4Njk5MWM2MjE4YjM2YzFkMTlkNGEyZTllYjBjZTM2MDZlYjQ4LmZhY3RvcnkuYnJpZGdlLm5lYXJJUaTRXjHERt4bKVYvKl%2BFUCuCxKA20xI6biy9KTTeTAEAAAACDwAAAHN0b3JhZ2VfZGVwb3NpdDcAAAB7InJlZ2lzdHJhdGlvbl9vbmx5Ijp0cnVlLCJhY2NvdW50X2lkIjoibW9ua2V5aXMubmVhciJ9AOBX60gbAAAAAID2SuHHAi0VAAAAAAAA%2CDQAAAG1vbmtleWlzLm5lYXIAo66hZ5Dg8T%2BGyeY8sttBfvZM8K0%2BezAfHsJRsv1SCmzTdszH8DkAAAkAAAB3cmFwLm5lYXJJUaTRXjHERt4bKVYvKl%2BFUCuCxKA20xI6biy9KTTeTAEAAAACEAAAAGZ0X3RyYW5zZmVyX2NhbGx3AAAAeyJyZWNlaXZlcl9pZCI6ImF1cm9yYSIsImFtb3VudCI6IjUwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsIm1lbW8iOiIiLCJtc2ciOiIxNjFlNkEyZmZGMGI4N0ZEQjFlNGIxZUM2Y0RjOWU3OTQ4OGQzMzM0In0AYCIlqj8AAAEAAAAAAAAAAAAAAAAAAAA%3D%2CDQAAAG1vbmtleWlzLm5lYXIAo66hZ5Dg8T%2BGyeY8sttBfvZM8K0%2BezAfHsJRsv1SCmzUdszH8DkAAAYAAABhdXJvcmFJUaTRXjHERt4bKVYvKl%2BFUCuCxKA20xI6biy9KTTeTAEAAAACBAAAAGNhbGx9AAAAAMQsMKxswV%2Bsm9k4YYvKoaH66FAdAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEAAAAOVCTUQAAAAAAAAAAAAAAACy0XttFF9WUev3jvqv5WlglBoWLAAAAAAAAAAAAAAAAAAAAAAAAAAAAANPCG87M7aEAAAAAYLeYbIgAAAAAAAAAAAAAAAAAAAAAAAA%3D%2CDQAAAG1vbmtleWlzLm5lYXIAo66hZ5Dg8T%2BGyeY8sttBfvZM8K0%2BezAfHsJRsv1SCmzVdszH8DkAAAYAAABhdXJvcmFJUaTRXjHERt4bKVYvKl%2BFUCuCxKA20xI6biy9KTTeTAEAAAACBAAAAGNhbGw9AQAAACy0XttFF9WUev3jvqv5WlglBoWLAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAQAAOO0XOQAAAAAAAAAAAAAAAAAAAAAAAAAAAABp4Q3nZnbQgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABJE0wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAoAAAAAAAAAAAAAAAABYeai%2F%2FC4f9seSx7GzcnnlIjTM0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGJ57P8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAAAAAAAAAMQsMKxswV%2Bsm9k4YYvKoaH66FAdAAAAAAAAAAAAAAAAsSv8paVYBqr2TplSGRikvw%2FECAIAYLeYbIgAAAAAAAAAAAAAAAAAAAAAAAA%3D%2CDQAAAG1vbmtleWlzLm5lYXIAo66hZ5Dg8T%2BGyeY8sttBfvZM8K0%2BezAfHsJRsv1SCmzWdszH8DkAAAYAAABhdXJvcmFJUaTRXjHERt4bKVYvKl%2BFUCuCxKA20xI6biy9KTTeTAEAAAACBAAAAGNhbGy9AAAAALEr%2FKWlWAaq9k6ZUhkYpL8PxAgCAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACEAAAAazUYSAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABJE0wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADW1vbmtleWlzLm5lYXIAAAAAAAAAAAAAAAAAAAAAAAAAAGC3mGyIAAAAAAAAAAAAAAAAAAAAAAAA&callbackUrl=https%3A%2F%2Fapp.ref.finance%2F - TXs 1. Token storage deposit: https://explorer.mainnet.near.org/transactions/AVdCHhFM46mYdAUes4EqbXEMfDo8sYfMqC6oCKF5qspT 2. Transfer token to Aurora: https://explorer.mainnet.near.org/transactions/84kGefNaj3ZKZeFGJi5pW7NBjHAfPMtLvHXVdDP47xNN 3. Opaque messages sent to Aurora: https://explorer.mainnet.near.org/transactions/5oFCN1aLrCCGJXLi2PEAWB7xwJ1ZnUiGrQGMTSvap2E9, https://explorer.mainnet.near.org/transactions/8TC2XcdUsKNqSnsWQfkkx5WUkmkmXLx6KM9MoGkvzwdA, https://explorer.mainnet.near.org/transactions/5KnMNnaswMULq2b4MiKrveUJDecaNKgZ4LtoeFgA37Jw # DEX aggregator test setup 1. Single DEX swap - Best route tests are not immediate priority. We can setup local pools and compare results. - No tests for returned TX structure. 2. Multi leg swaps 1. Deploy an instance of test-token for every token needed by pools. 2. Deploy pools for every token pair 3. Test cases: 1. Ref- single and double swap 3. Combination of Ref and Jumbo Stableswap has the same swap interface as regular pools, so we do not need separate tests. Mainnet stableswap pool ID is 1910. 4. Have separate unit tests to find best route # Execution plan 1. Call `ft_transfer_call` on the input token with `v1.comet.near` as the destination. 2. The args are ```jsonc { "receiver_id": "v1.comet.near", "amount" : "100000", "msg": { "referral_id": "vault.comet.near", "dexes": [ { "dex": "v2.ref-finance.near", "token_in": "wrap.near", // Do not decode "actions": [{ "pool_id": 0, "token_in": "wrap.near", "token_out": "dai.near", "amount_in": "100000", "min_amount_out": "5000", }], }, { "dex": "spot.spin-fi.testnet", "token_in": "dai.near", // do not decode "actions": [{ "market_id": 1, "drop": ["23"], "place": [ { "price": "2000000000000000000000000", "quantity": "1000000000000000000000000", "ttl": 604800, "market_order": true, "order_type": "Bid", "client_order_id": 1 } ] }] } ] } } ``` 3. `v1.comet.near` will get this message through `ft_on_transfer`. 4. For each dex 1. Read the `dex` and `token_in`. 2. Call `token_in::ft_transfer_call`, with `dex` as the `reciever_id`. The message format should be ```jsonc { "force": 0, "actions": {}, // decoded actions array "referral_id": "" // the passed reciever ID } ``` 5. Keep a whitelist of allowed DEXes to prevent fund loss. 6. Spin needs 3 calls 1. Deposit input token with `ft_transfer_call` 2. Place market orders with `place_bid` or `place_ask`. Market orders are executed immediately. Multi-market swaps can be atomically performed using `batch_ops`. 3. Withdraw tokens with `withdraw` function ## Gas research - 1 TGas = 10^12 gas - 3 pool swap on REF: 47 TGas - Tx to reciept conversion: 2 Tgas - Transfer wNEAR to Ref: 10 TGas - Ref swap: 22 TGas - Transfer output token to user: 5 TGas - Withdraw callback: 3 Tgas - Token transfer callback: 2 Tgas - Max gas per call: 300 TGas. This should be sufficient for 3 REF-like swaps. - swap() based method: takes 139 TGas. - Instant swap method: 121 TGas - 100 TGas if ft_balance_of and callback is removed - Instant swap without outbound transfer: 84 # wNEAR -> USDT issue 1. REF UI returns wrap.near -> DAI (6b175474e89094c44da98b954eedeac495271d0f.factory.bridge.near) -> USDT 2. SDK returns wrap.near -> USDC (a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48.factory.bridge.near) -> USDT It's using uni v2 algorithm on the stable pool 1910. --- _Source: https://npm.io/package/comet-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._