Cetus Plus Swap Aggregator

Integrating Cetus-Aggregator-SDK: A Comprehensive Guide, Please see details in document.
Explore the document »

Welcome to Cetus Plus Swap Aggregator

Cetus plus swap aggregator is a high-speed and easy-to-integrate solution designed to optimize your trading experience on the Sui blockchain. This aggregator integrates multiple mainstream decentralized exchanges (DEX) on the Sui chain, including various types of trading platforms, providing users with the best trading prices and the lowest slippage.

Core Advantages:

High-Speed Transactions: Thanks to advanced algorithms and efficient architecture, our aggregator can execute transactions at lightning speed, ensuring users get the best opportunities in a rapidly changing market.

Easy Integration: The aggregator is designed to be simple and easy to integrate. Whether you are an individual developer or a large project team, you can quickly connect and deploy.

Multi-Platform Support: Currently, we have integrated multiple mainstream DEXs on the Sui chain, including cetus, kriya, kriyav3, flowx, flowxv3, turbos, aftermath, haedal, volo, afsui, bluemove, deepbookv3, scallop, suilend, bluefin, haedalpmm, haedalhmmv2, alphafi, springsui, steamm, steamm_omm, steamm_omm_v2, metastable, obric, hawal, momentum, magma, fullsail, cetusdlmm, ferradlmm, ferraclmm, bolt, allowing users to enjoy a diversified trading experience on a single platform.

Sponsored Transactions: The SDK can build swap PTBs that do not use the user's gas coin, allowing a separate sponsor account to pay transaction gas.

By using our aggregator, you can trade more efficiently and securely on the Sui blockchain, fully leveraging the various opportunities brought by decentralized finance (DeFi).

Aggregator SDK

Install

The SDK is published to npm registry. To use the SDK in your project, you can

npm install @cetusprotocol/aggregator-sdk

Usage

1. Init client with rpc and package config

constclient=newAggregatorClient({})

2. Get best router swap result from aggregator service

constamount=newBN(1000000)constfrom="0x2::sui::SUI"consttarget="0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS"constrouters=awaitclient.findRouters({
from,
target,
amount,byAmountIn: true,// true means fix input amount, false means fix output amount})

3. Confirm and do fast swap

consttxb=newTransaction()if(routerRes!=null){awaitclient.fastRouterSwap({
routers,
txb,slippage: 0.01,})constresult=awaitclient.devInspectTransactionBlock(txb,keypair)if(result.effects.status.status==="success"){console.log("Sim exec transaction success")constresult=awaitclient.signAndExecuteTransaction(txb,keypair)}console.log("result",result)}

4. Sponsored transaction: sponsor pays gas

Set sponsored: true when building the swap. In this mode the swap does not use txb.gas as input or output, because the gas coin belongs to the sponsor.

import{Transaction}from"@mysten/sui/transactions"import{SUI_TYPE_ARG}from"@mysten/sui/utils"constsender=userSigner.toSuiAddress()constsponsor=sponsorSigner.toSuiAddress()consttxb=newTransaction()awaitclient.fastRouterSwap({router: routerRes,
txb,slippage: 0.01,sponsored: true,})// Build command-only bytes. Pass sender so CoinWithBalance can resolve// the user's input coins before the sponsor adds gas data.consttxKindBytes=awaitclient.buildTransactionKind(txb,sender)const{objects: gasCoins}=awaitclient.client.listCoins({owner: sponsor,coinType: SUI_TYPE_ARG,limit: 1,})constsponsorCoins=gasCoins.map((coin)=>({objectId: coin.objectId,version: coin.version,digest: coin.digest,}))constsponsoredTx=client.buildSponsoredTransaction({
txKindBytes,
sender,
sponsor,
sponsorCoins,gasBudget: "100000000",})constresult=awaitclient.signAndExecuteSponsoredTransaction(sponsoredTx,userSigner,sponsorSigner)

For a gas-station integration, the same flow is split across two parties: the user builds txKindBytes, the sponsor sets gasOwner and gasPayment, then both parties sign the same full transaction bytes.

Sponsor secret for the real transaction test

The real sponsored transaction test reuses the existing wallet secret as the user/sender and adds one sponsor secret:

SUI_WALLET_SECRET="user_base64_secret" \
SUI_SPONSOR_SECRET="sponsor_base64_secret" \
npx vitest run tests/unit/sponsored.test.ts

SUI_WALLET_SECRET owns the swap input coins and signs as the transaction sender. SUI_SPONSOR_SECRET owns the gas coin and signs as the gas sponsor. Use two different accounts; the sponsor account only needs enough SUI to cover SPONSORED_GAS_BUDGET (100000000 MIST by default).

Optional test variables:

SPONSORED_SWAP_AMOUNT=1000000
SPONSORED_GAS_BUDGET=100000000
SUI_RPC="https://fullnode.mainnet.sui.io:443"

If either secret is missing, tests/unit/sponsored.test.ts is skipped and no transaction is submitted.

Keep both secrets in your local shell or .env file, and do not commit them.

5. Build PTB and return target coin

consttxb=newTransaction()constbyAmountIn=trueif(routerRes!=null){consttargetCoin=awaitclient.routerSwap({router: routerRes,
txb,
inputCoin,slippage: 0.01,})// you can use this target coin object argument to build your ptb.client.transferOrDestoryCoin(txb,targetCoin,targetCoinType)constresult=awaitclient.devInspectTransactionBlock(txb,keypair)if(result.effects.status.status==="success"){console.log("Sim exec transaction success")constresult=awaitclient.signAndExecuteTransaction(txb,keypair)}console.log("result",result)}

Aggregator Contract Interface

Tags corresponding to different networks

Contract	Tag of Repo	Latest published at address
CetusAggregatorV2	mainnet	0x3a7fa58adcd7ff474ca0330c93068b139f5263c0cf9c64e702f5c4b17996ff10
CetusAggregatorV2ExtendV1	mainnet	0x2edc22bf96c85482b2208624fa9339255d5055113c92fd6c33add48ce971b774
CetusAggregatorV2ExtendV2	mainnet	0x2e227a3cbc6715518b18ed339d2f967153674b7b257da114ca62c72b2011258a

Example

CetusAggregatorV2 = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2/mainnet", rev = "mainnet-v1.63.0", override = true }
CetusAggregatorV2ExtendV1 = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2-extend-v1", rev = "mainnet-v1.63.0", override = true }
CetusAggregatorV2ExtendV2 = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2-extend-v2", rev = "mainnet-v1.63.0", override = true }

Simple Aggregator Contract Interface

• include: cetus, flowxv3, turbos, bluefin, haedalhmm, momentum, obric, deepbookv3

Tags corresponding to different networks

Contract	Tag of Repo	Latest published at address
CetusAggregatorSimple	mainnet	0xf44ab76524a6b22a175968ae193a13f4905aea9b805afb6db51655b6b59db69e

Example

CetusAggregatorSimple = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2/simple-mainnet", rev = "mainnet-v1.63.0", override = true }

Usage

Cetus clmm interface is not complete(just have function definition), so it will fails when sui client check the code version. However, this does not affect its actual functionality. Therefore, we need to add a --dependencies-are-root during the build.

sui move build --dependencies-are-root && sui client publish --dependencies-are-root

More About Cetus

Use the following links to learn more about Cetus:

Learn more about working with Cetus in the Cetus Documentation.

Join the Cetus community on Cetus Discord.