Carbon DeFi Dev
  • Carbon DeFi
    • Introducing Carbon DeFi
      • What Makes Carbon DeFi Unique?
      • Fees & Payments
      • Resources
    • Security & Audits
  • Contracts & Functions
    • Contracts
      • CarbonController
      • CarbonVortex
      • CarbonVortexBridge
      • Deployments
        • Mainnet Contracts
        • Testnet Contracts
    • CarbonController Functions
      • Write Functions
        • Transaction Prerequisites
          • approve() / allowance()
        • Trade
          • tradeBySourceAmount()
          • tradeByTargetAmount()
        • Strategy Management
          • createStrategy()
          • updateStrategy
          • deleteStrategy()
      • Read Functions
        • controllerType()
        • tradingFeePPM()
        • pairTradingFeePPM()
        • pair()
        • pairs()
        • strategy()
        • strategiesByPair()
        • strategiesByPairCount()
        • calculateTradeSourceAmount()
        • calculateTradeTargetAmount()
      • Data & Events
        • TradingFeePPMUpdated()
        • PairCreated()
        • StrategyCreated()
        • StrategyDeleted()
        • StrategyUpdated()
        • TokensTraded()
        • FeesWithdrawn()
    • CarbonVortex Functions
      • Write Functions
        • trade()
        • execute()
      • Read Functions
        • amountAvailableForTrading()
        • availableTokens()
        • expectedTradeInput()
        • expectedTradeReturn()
        • finalTargetToken()
        • minTargetTokenSaleAmount()
        • minTokenSaleAmount()
        • pairDisabled()
        • priceDecayHalfLife()
        • rewardsPPM()
        • targetToken()
        • targetTokenPriceDecayHalfLife()
        • targetTokenSaleAmount()
        • tokenPrice()
        • totalCollected()
        • tradingEnabled()
    • CarbonVortexBridge Functions
      • Write Functions
        • Bridge()
  • Rest API
    • Carbon DeFi Public REST API
  • Developer Guides
    • Carbon DeFi SDK
      • Getting started
      • Interacting with the SDK
        • Managing Strategies
        • Performing Trades
        • Getting User and Pair Data
        • Collecting Liquidity Data
      • SDK Functions
        • constructor
        • startDataSync
        • getCachedPairs
        • hasLiquidityByPair
        • getLiquidityByPair
        • getUserStrategies
        • getTradeData
        • composeTradeByTargetTransaction
        • composeTradeBySourceTransaction
        • createBuySellStrategy
        • updateStrategy
        • deleteStrategy
        • getMinRateByPair
        • getMaxRateByPair
        • getRateLiquidityDepthByPair
    • The Carbon DeFi versus Uniswap V3 Invariant Functions
    • Carbon DeFi Subgraph
      • Accessing the Subgraph
      • Creating Subgraph Queries
      • Subgraph Query in Python
      • Sample Subgraph Queries
    • Using CarbonVortex
      • CarbonVortex Dynamics
Powered by GitBook
On this page
  1. Developer Guides
  2. Carbon DeFi SDK

SDK Functions

PreviousCollecting Liquidity DataNextconstructor

Last updated 5 months ago

The Carbon DeFi SDK's main point of interaction is exposed through the functions in index.ts:

Name
Description

Initializes the SDK.

Fetches event data to create a representation of all Carbon DeFi strategies.

Gets a list of all active token pairs.

Checks if a pair currently has liquidity in one or more strategies.

Returns the total amount of liquidity in Carbon DeFi strategies for a given pair.

Gets the list of strategies owned by an address.

Generates and returns a trade route for a trade, including an unsigned transaction to execute the trade.

Creates an unsigned trade transaction for trading by target amount.

Creates an unsigned trade transaction for trading by source amount.

Creates a Carbon DeFi strategy, formatted for smart contract input, and generates an unsigned transaction.

Generates an unsigned transaction with updated order parameters.

Generates an unsigned transaction to delete a strategy.

This returns the amount of liquidity available for a token pair at a specific trade-rate.

Gets the current lowest trade price for a given token pair.

Gets the current highest trade price for a given token pair.

constructor
startDataSync
pairs
hasLiquidityByPair
getLiquidityByPair
getUserStrategies
getTradeData
composeTradeByTargetTransaction
composeTradeBySourceTransaction
createBuySellStrategy
updateStrategy
deleteStrategy
getRateLiquidityDepthByPair
getMinRateByPair
getMaxRateByPair