README.md

Jupiter Terminal

Jupiter Terminal is an open-sourced, lite version of Jupiter that provides end-to-end swap flow by linking it in your HTML.

Demo: https://terminal.jup.ag

---

Core features

• main.js bundle ~66kb gzipped
  • app bundle (~900Kb) are loaded on-demand when init() is called
  • alternatively, preload app bundle with data-preload attributes
• Built-in wallets, or passthrough wallets from your dApp
• Modal, Integrated, or Widget mode.
• Mode (default, outputOnly) to allow user to swap between any token pair, or only swap to destination pair.
• Fee supports

---

Getting started

Integrating the widget

In your document, link and embed main.js.

<script src="https://terminal.jup.ag/main.js" data-preload />

Preloading Terminal

Assign the attribute data-preload to the script tag, the full application will be preloaded on your browser's (document.readyState === "complete") event.

<script src="https://terminal.jup.ag/main.js" data-preload />

Then,

window.Jupiter.init({ mode: 'default', endpoint: "https://api.mainnet-beta.solana.com",});

---

Built-in wallets, or passthrough wallets from your dApp

Mode 1: Wallet passthrough

If your user have connected their wallet via your dApp, you may passthrough the wallet instance via the init({ passThroughWallet: wallet }).

const App = () => {
  const { wallet } = useWallet();

  const initJupiter = () => {
    if (wallet) {
      window.Jupiter.init({
        mode: 'default',
        endpoint,
        passThroughWallet: wallet,
      });
    }
  };
};

Mode 2: Built-in wallet

If your user is not connected, Jupiter Terminal have several built-in wallets that user can connect and perform swap directly.

---

Modal, Integrated, or Widget mode.

Modal

By default, Jupiter renders as a modal and take up the whole screen.

window.Jupiter.init({ displayMode: 'modal' });

Integrated

Integrated mode renders Jupiter Terminal as a part of your dApp.

window.Jupiter.init({ displayMode: 'integrated' });

Widget

Widget mode renders Jupiter Terminal as a widget that can be placed at different position.

```tsx
window.Jupiter.init({ 
  displayMode: 'widget',
  widgetPosition: 'bottom-right', // 'bottom-left', 'top-right', 'top-left'
});

---

Mode

• default: Default mode, user can swap between any token pair.
• outputOnly: Output only mode, user can only swap to destination pair.

  window.Jupiter.init({
    mode: 'outputOnly',
    mint: 'So11111111111111111111111111111111111111112',
    endpoint: "https://api.mainnet-beta.solana.com",
    passThroughWallet: wallet,
  });

---

Resuming / Closing activity

• Everytime init() is called, it will create a new activity.

• If you want to resume the previous activity, you can use resume().

• close() function only hide the widget.

if (window.Jupiter._instance) {
  window.Jupiter.resume();
}

window.Jupiter.close();

---

Fee supports

Similar to Jupiter, Jupiter Terminal supports fee for integrators.

There are no protocol fees on Jupiter, but integrators can introduce a platform fee on swaps. The platform fee is provided in basis points, e.g. 20 bps for 0.2% of the token output.

Refer to Adding your own fees docs for more details.

Note: You will need to create the Token fee accounts to collect the platform fee.

import { getPlatformFeeAccounts } from '@jup-ag/core';

// Jupiter Core provides a helper function that returns all your feeAccounts
const platformFeeAndAccounts = {
  feeBps: 50,
  feeAccounts: await getPlatformFeeAccounts(
    connection,
    new PublicKey('BUX7s2ef2htTGb2KKoPHWkmzxPj4nTWMWRgs5CSbQxf9') // The platform fee account owner
  ) // map of mint to token account pubkey
}

window.Jupiter.init({
  // ...
  platformFeeAndAccounts,
});

---

onSuccess/onSwapError callback

onSuccess() reference can be provided, and will be called when swap is successful.

While onSwapError() will be called when an error has occurred.

window.Jupiter.init({
  onSuccess: ({ txid }) => {
    console.log('onSuccess', txid);
  }
  onSwapError: ({ error }) => {
    console.log('onSwapError', error);
  },
});

Customising styles: CSSProperties

Any CSS-in-JS can be injected to the outer-most container via containerStyles api.

Examples:

• Custom zIndex

window.Jupiter.init({
  // ...
  containerStyles: { zIndex: 100 },
});

• Custom height

window.Jupiter.init({
  // ...
  containerStyles: { maxHeight: '90vh', },
});

Customising className: Tailwind className

Tailwind classes can be injected to the outer-most container via containerClassName api.

Example:

• Custom breakpoints

window.Jupiter.init({
  // ...
  containerClassName: 'max-h-[90vh] lg:max-h-[600px]'
});

---

Known issue

- Wallet passthrough supports does not work for Solflare - Jupiter Terminal currently prompts the user to connect their Solflare wallet again, to perform swap. (Issue fixed in 0.1.10)