Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.jup.ag/docs/llms.txt

Use this file to discover all available pages before exploring further.

This guide covers how to integrate your decentralized exchange (DEX) into Jupiter’s Metis routing engine. You will need to provide a DEX SDK implementing the Jupiter AMM Interface, pass security and code health checks, and demonstrate traction. Jupiter is one of the most widely integrated protocols, so a lot of work is involved in minimizing issues on new integrations and making each integration valuable to our users and partners. Our top priority is ensuring security and providing the best prices and the best token selection for our users, so we will focus on DEXes that will bring the most benefits to them.

​
Integration Prerequisites

As Solana grows and more DEXes are built, we have to be more cautious in the DEXes we integrate, we look into a variety of factors.
  • Code health: It will help with integration and ensure maintainability in the future.
  • Security audit: This is important to ensure users’ funds are secure and the program is not malicious.
  • Traction: We look at the traction of the DEX to ensure it has market demand and is well-used.
  • Team and backers: This is a good indicator of the quality of the DEX if they are backed by or built by reputable or verifiable entities.

​
AMM Interface

To facilitate integration of your DEX into the Jupiter Core Engine:
  • Provide a DEX SDK that works with the Jupiter AMM Interface.
  • Enable us to fork your SDK, this ensures our users that we can guarantee maintenance, support for the SDK, and fix potential bugs related to integrated DEXs.
NOTEget_accounts_to_update provides the necessary accounts to fetch, they are batched and cached by the Jupiter Core Engine and delivered through update to the AMM instance, there might be multiple calls to quote using the same cache so we do not allow any network calls in the entire implementation.
RESOURCE AND SUPPORTYou can refer to the implementation guide https://github.com/jup-ag/rust-amm-implementation for easier integration with Jupiter.If you require assistance or have questions, reach out to us at Discord
pub trait Amm {
  // Maybe trait was made too restrictive?
  fn from_keyed_account(keyed_account: &KeyedAccount, amm_context: &AmmContext) -> Result<Self>
  where
      Self: Sized;
  /// A human readable label of the underlying DEX
  fn label(&self) -> String;
  fn program_id(&self) -> Pubkey;
  /// The pool state or market state address
  fn key(&self) -> Pubkey;
  /// The mints that can be traded
  fn get_reserve_mints(&self) -> Vec<Pubkey>;
  /// The accounts necessary to produce a quote
  fn get_accounts_to_update(&self) -> Vec<Pubkey>;
  /// Picks necessary accounts to update it's internal state
  /// Heavy deserialization and precomputation caching should be done in this function
  fn update(&mut self, account_map: &AccountMap) -> Result<()>;

  fn quote(&self, quote_params: &QuoteParams) -> Result<Quote>;

  /// Indicates which Swap has to be performed along with all the necessary account metas
  fn get_swap_and_account_metas(&self, swap_params: &SwapParams) -> Result<SwapAndAccountMetas>;

  /// Indicates if get_accounts_to_update might return a non constant vec
  fn has_dynamic_accounts(&self) -> bool {
      false
  }

  /// Indicates whether `update` needs to be called before `get_reserve_mints`
  fn requires_update_for_reserve_mints(&self) -> bool {
      false
  }

  // Indicates that whether ExactOut mode is supported
  fn supports_exact_out(&self) -> bool {
      false
  }

  fn get_user_setup(&self) -> Option<AmmUserSetup> {
      None
  }

  fn clone_amm(&self) -> Box<dyn Amm + Send + Sync>;

  /// It can only trade in one direction from its first mint to second mint, assuming it is a two mint AMM
  fn unidirectional(&self) -> bool {
      false
  }

  /// For testing purposes, provide a mapping of dependency programs to function
  fn program_dependencies(&self) -> Vec<(Pubkey, String)> {
      vec![]
  }

  fn get_accounts_len(&self) -> usize {
      32 // Default to a near whole legacy transaction to penalize no implementation
  }

  /// The identifier of the underlying liquidity
  ///
  /// Example:
  /// For RaydiumAmm uses Openbook market A this will return Some(A)
  /// For Openbook market A, it will also return Some(A)
  fn underlying_liquidities(&self) -> Option<HashSet<Pubkey>> {
      None
  }

  /// Provides a shortcut to establish if the AMM can be used for trading
  /// If the market is active at all
  fn is_active(&self) -> bool {
      true
  }
}