Skip to content

user guides reset using versioning #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 111 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
111 commits
Select commit Hold shift + click to select a range
2636447
docs version to old
0xYankee-Raccoons Nov 21, 2024
841d413
update
0xYankee-Raccoons Nov 21, 2024
aff0b1c
fix docusaurus config
0xYankee-Raccoons Nov 21, 2024
11e2330
checkpoint: add get started docs
0xYankee-Raccoons Nov 22, 2024
dbcc4bb
checkpoint: add swap api folder and get quote doc
0xYankee-Raccoons Nov 22, 2024
0fc6f33
checkpoint: redo folder order and addd build/send swap transaction docs
0xYankee-Raccoons Nov 22, 2024
ac022df
fix: build swap tx tab item codeblock syntax
0xYankee-Raccoons Nov 24, 2024
a851f96
Merge branch 'main' into developer-version
0xYankee-Raccoons Nov 24, 2024
b310db3
Merge branch 'main' into developer-version
0xYankee-Raccoons Nov 24, 2024
b7868e8
checkpoint: add send swap transaction doc
0xYankee-Raccoons Nov 24, 2024
70e258a
checkpoint: apply custom docs sidebar (bug: applied on all sidebar li…
0xYankee-Raccoons Nov 25, 2024
fd6d117
checkpoint: add add fees to swap doc
0xYankee-Raccoons Nov 26, 2024
92375b7
checkpoint: add payments through swap doc
0xYankee-Raccoons Nov 26, 2024
31f740b
checkpoint: add solana unity sdk doc
0xYankee-Raccoons Nov 27, 2024
8b64a67
checkpoint: add limit order api
0xYankee-Raccoons Nov 27, 2024
10e0782
checkpoint: add price v2 api doc
0xYankee-Raccoons Nov 27, 2024
3c2db48
checkpoint: structure other tools section and add perp api teaser
0xYankee-Raccoons Nov 27, 2024
64f80fd
checkpoint: add terminal overview and walkthrough
0xYankee-Raccoons Nov 27, 2024
643d2bc
checkpoint: structure tool kits category and add wallet kit
0xYankee-Raccoons Nov 28, 2024
34a342c
checkpoint: custom navbar by url path
0xYankee-Raccoons Nov 28, 2024
fb036fb
fix tab titles
0xYankee-Raccoons Nov 28, 2024
5e2fe9a
checkpoint: rework docs mini landing page
0xYankee-Raccoons Nov 28, 2024
0817081
force light theme
0xYankee-Raccoons Nov 29, 2024
531bdef
checkpoint: navbar mobile sidebar
0xYankee-Raccoons Nov 30, 2024
d97ceb4
add links to terminal
0xYankee-Raccoons Nov 30, 2024
452428f
checkpoint: fix docslanding and add more items
0xYankee-Raccoons Nov 30, 2024
86b1232
rename other tools to more
0xYankee-Raccoons Dec 2, 2024
10c87d4
add more to price api and dev basics
0xYankee-Raccoons Dec 2, 2024
58f78e2
checkpoint: add api usage page
0xYankee-Raccoons Dec 2, 2024
e0df7fc
checkpoint: display api reference docs (not updated)
0xYankee-Raccoons Dec 4, 2024
8f23247
fix openapi/api.yaml
0xYankee-Raccoons Dec 4, 2024
c8ad81a
checkpoint: update api docs for quote, swap
0xYankee-Raccoons Dec 5, 2024
70bd669
checkpoint: add forceful redirects for /docs/old/** to /docs
0xYankee-Raccoons Dec 5, 2024
2e79301
remove duplicate redirect
0xYankee-Raccoons Dec 5, 2024
1da0074
checkpoint: fix broken redirects
0xYankee-Raccoons Dec 5, 2024
d43047b
add library versions
0xYankee-Raccoons Dec 5, 2024
2e09989
add api reference to quote and swap
0xYankee-Raccoons Dec 8, 2024
ba7daf8
add spot product to swap section and renamed more to utility
0xYankee-Raccoons Dec 8, 2024
1ddf5bb
checkpoint: add token api guide and api reference
0xYankee-Raccoons Dec 8, 2024
1734f5a
add date to api-usage doc
0xYankee-Raccoons Dec 8, 2024
14977fe
add limit and offset notes to token api doc
0xYankee-Raccoons Dec 8, 2024
997fb8c
correct token api info
0xYankee-Raccoons Dec 9, 2024
66b7b23
checkpoint: version guides to OLD
0xYankee-Raccoons Dec 9, 2024
c44986f
checkpoint: fix all broken links in old version and redirect
0xYankee-Raccoons Dec 9, 2024
68b2d65
checkpoint: navbar and sidebar structure
0xYankee-Raccoons Dec 9, 2024
5c0ef68
Merge branch 'main' into guides-version
0xYankee-Raccoons Dec 9, 2024
594200d
add skeleton content in spot/dca and nest spot products
0xYankee-Raccoons Dec 9, 2024
acd35bf
checkpoint: dynamically generate product section links during build time
0xYankee-Raccoons Dec 9, 2024
493a0d0
fix dynamic ordering
0xYankee-Raccoons Dec 9, 2024
58548fc
update redirects
0xYankee-Raccoons Dec 10, 2024
4b30157
fix
0xYankee-Raccoons Dec 10, 2024
76978c3
checkpoint: add /guides/old/ redirects
0xYankee-Raccoons Dec 10, 2024
126ffa8
checkpoint: add perps program account types doc
0xYankee-Raccoons Dec 11, 2024
d7acd37
attempt fix sidebar linebreak
0xYankee-Raccoons Dec 11, 2024
2349bd5
fix sidebar linebreak
0xYankee-Raccoons Dec 11, 2024
661139b
add position account
0xYankee-Raccoons Dec 11, 2024
4c2f870
add positionrequest doc
0xYankee-Raccoons Dec 11, 2024
42c8186
add pool account
0xYankee-Raccoons Dec 11, 2024
b5d6b25
synx fix for sidebar linebreak
0xYankee-Raccoons Dec 12, 2024
65ab6be
fix all api endpoints to new
0xYankee-Raccoons Dec 13, 2024
77733b0
tiny change
0xYankee-Raccoons Dec 13, 2024
19f9be8
checkpoint: add vish dca guides part 1
0xYankee-Raccoons Dec 16, 2024
1b2f872
checkpoint: add vish dca guides part 2
0xYankee-Raccoons Dec 16, 2024
e539f97
tiny change
0xYankee-Raccoons Dec 16, 2024
ef1bdc3
Merge branch 'main' into developer-version
0xYankee-Raccoons Dec 16, 2024
db4e52c
update image
0xYankee-Raccoons Dec 16, 2024
fcadebb
add price api params to openapi
0xYankee-Raccoons Dec 16, 2024
8383a78
Merge remote-tracking branch 'refs/remotes/origin/developer-version' …
0xYankee-Raccoons Dec 16, 2024
0c995b0
add dca faq
0xYankee-Raccoons Dec 17, 2024
33ee8b4
fix navbar font size
0xYankee-Raccoons Dec 17, 2024
c81e3f7
update dca price strategy
0xYankee-Raccoons Dec 17, 2024
de34dcb
minor changes to dca sidebar layout
0xYankee-Raccoons Dec 17, 2024
8460d79
fix navbar font size
0xYankee-Raccoons Dec 17, 2024
55dab20
fix broken link
0xYankee-Raccoons Dec 17, 2024
0c6de2b
adjust css
0xYankee-Raccoons Dec 18, 2024
062168b
add small fixes and swap skeleton files
0xYankee-Raccoons Dec 18, 2024
9d1fa90
fix link
0xYankee-Raccoons Dec 26, 2024
bba9c60
checkpoint: add swap quickstart
0xYankee-Raccoons Dec 26, 2024
308fb8b
checkpoint: add swap how to's
0xYankee-Raccoons Dec 30, 2024
9939614
checkpoint: add jupiverse content
0xYankee-Raccoons Dec 30, 2024
1c3455d
fix link
0xYankee-Raccoons Dec 30, 2024
29bff15
fix typo
0xYankee-Raccoons Dec 30, 2024
5d67f89
checkpoint: add limit order content
0xYankee-Raccoons Jan 2, 2025
ed6e3a6
add api setup doc
0xYankee-Raccoons Jan 2, 2025
af159c8
checkpoint: add djj lo video and move img to static
0xYankee-Raccoons Jan 2, 2025
c6f3eb4
fix home nav
0xYankee-Raccoons Jan 2, 2025
101a147
add stop loss caution to limit order
0xYankee-Raccoons Jan 3, 2025
f469563
some minor fix
0xYankee-Raccoons Jan 6, 2025
547b875
add how swap works and faq
0xYankee-Raccoons Jan 10, 2025
4bf4043
fix link
0xYankee-Raccoons Jan 10, 2025
f4e6670
checkpoint: spot navbar dropdown and fixes
0xYankee-Raccoons Jan 10, 2025
a59d472
move api setup images to static
0xYankee-Raccoons Jan 14, 2025
ff23d6f
checkpoint: search bar
0xYankee-Raccoons Jan 14, 2025
593e41a
small fix
0xYankee-Raccoons Jan 14, 2025
f4d6afd
save perp work
0xYankee-Raccoons Jan 15, 2025
ae92e51
save perps work 2
0xYankee-Raccoons Jan 15, 2025
85c8916
merge developer version latest to guides version
0xYankee-Raccoons Jan 15, 2025
0f07190
save perps work 3
0xYankee-Raccoons Jan 15, 2025
7adffe5
save perps work 4
0xYankee-Raccoons Jan 15, 2025
22b0e6f
save perps work 5
0xYankee-Raccoons Jan 16, 2025
c0c620e
save perps work 6
0xYankee-Raccoons Jan 16, 2025
7682415
fix links
0xYankee-Raccoons Jan 16, 2025
4362bc6
save perps work 7
0xYankee-Raccoons Jan 16, 2025
b741ec8
checkpoint: perps and home page
0xYankee-Raccoons Jan 17, 2025
c1413bb
small touch ups
0xYankee-Raccoons Jan 17, 2025
37bb6cd
checkpoint: ape pro g uides
0xYankee-Raccoons Jan 24, 2025
70813ce
merge main
0xYankee-Raccoons Jan 29, 2025
04bdde5
checkpoint: add onboarding and general
0xYankee-Raccoons Jan 29, 2025
bc691dd
checkpoint: rename spot files to new names
0xYankee-Raccoons Jan 29, 2025
aa8e768
merge main
0xYankee-Raccoons Feb 5, 2025
2d66c6d
final
0xYankee-Raccoons Feb 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 0 additions & 3 deletions Moved/2-how-swap-works/2-how-swap-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,8 @@ The Jupiter Swap is a decentralized exchange aggregator designed to provide the
Jupiter V3 introduced multiple improvements to the swap experience!

The Metropolis upgrade introduced Instant Routing, Dynamic Slippage, Smart Token Filtering, Ecosystem Token List and new Safety features.
[Dive into these new features in detail here! ->](/guides/2-jupiter-spot/2-jupiter-swap/2-how-swap-works/1-metropolis-features.md)

Metis, a routing protocol, was also introduced to improve route discovery, reducing slippage and scalability in V3.
[Dive into key features of the Metis routing protocol here! ->](/guides/2-jupiter-spot/2-jupiter-swap/2-how-swap-works/3-metis-routing.md)


### Token Ledger For Increased Swap Success Rates

Expand Down
8 changes: 4 additions & 4 deletions docs/100-swap-api/3-send-swap-transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ We are using [Triton’s `getRecentPrioritizationFees`](https://docs.triton.one/

```jsx
const swapResponse = await (
await fetch('https://api.jup.ag/swap/v1', {
await fetch('https://api.jup.ag/swap/v1/swap', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
Expand Down Expand Up @@ -164,7 +164,7 @@ When `true`, it allows the transaction to utilize a dynamic compute unit rather

```jsx
const swapTransaction = await (
await fetch('https://api.jup.ag/swap/v1', {
await fetch('https://api.jup.ag/swap/v1/swap', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
Expand Down Expand Up @@ -192,7 +192,7 @@ To understand Dynamic Slippage better, you can read here:

```jsx
const swapTransaction = await (
await fetch('https://api.jup.ag/swap/v1', {
await fetch('https://api.jup.ag/swap/v1/swap', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
Expand Down Expand Up @@ -259,7 +259,7 @@ Additionally, Jito enables bundling transactions to ensure they execute together

```jsx
const swapTransaction = await (
await fetch('https://api.jup.ag/swap/v1', {
await fetch('https://api.jup.ag/swap/v1/swap', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
Expand Down
14 changes: 14 additions & 0 deletions docs/200-perp-api/1-perp-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_label: "Perp API"
description: "Use the Jupiter Perp API to trade or analyze."
title: "Coming Soon!"
---

<head>
<title>Coming Soon!</title>
<meta name="twitter:card" content="summary" />
</head>

:::warning
The Perp API for trading and analyzing is still a **work in progress**, stay tuned!
:::
12 changes: 11 additions & 1 deletion docs/200-perp-api/204-custody-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Each `Custody` account contains the following data:
| `targetRatioBps` | **Type:** `u64`<br /><br />The target weightage (in basis points) for the custody in the JLP pool. |
| `assets` | **Type:** [`Assets`](#assets)<br /><br />Contains data used to calculate PNL, AUM, and core business logic for the program. |
| `fundingRateState` | **Type:** [`FundingRateState`](#fundingratestate)<br /><br />Contains data used to calculate borrow fees for open positions. |
| `jumpRateState` | **Type:** [`JumpRateState`](#jumpratestate)<br /><br />Contains data used to calculate borrow fees for open positions. |

### `PricingParams`

Expand Down Expand Up @@ -76,4 +77,13 @@ Each `Custody` account contains the following data:
| --- | --- |
| `cumulativeInterestRate` | **Type:** `u128`<br /><br />Traders are required to pay hourly borrow fees for opening leveraged positions. This fee is calculated based on two primary factors: the size of the trader's position and the current utilization of the pool for the custody.<br /><br />To calculate borrow fees more efficiently, each custody account contains a value called `cumulativeInterestRate`.<br /><br />Correspondingly, each position account stores a `cumulativeInterestSnapshot` which captures the value of `cumulativeInterestRate` at the time of the position's last update. Whenever there's a change in either the borrowed assets or the total assets within a custody, the `cumulativeInterestRate` for the custody is updated.<br /><br />The difference between the custody's `cumulativeInterestRate` and the position's `cumulativeInterestSnapshot` is then used to calculate the position's borrow fees. |
| `lastUpdate` | **Type:** `i64`<br /><br />The UNIX timestamp for when the custody's borrow fee data was last updated. |
| `hourlyFundingDbps` | **Type:** `u64`<br /><br />A constant used to calculate the hourly borrow fees for the custody. The Jupiter Perpetuals exchange works with Gauntlet and Chaos Labs to update and fine tune the `hourlyFundingDbps` to respond to traders' feedback and market conditions. |
| `hourlyFundingDbps` | **Type:** `u64`<br /><br />**NOTE: This will be deprecated in the near future.** A constant used to calculate the hourly borrow fees for the custody. The Jupiter Perpetuals exchange works with Gauntlet and Chaos Labs to update and fine tune the `hourlyFundingDbps` to respond to traders' feedback and market conditions. |

### `JumpRateState`

| Field | Description |
| --- | --- |
| `minRateBps` | **Type:** `u64`<br /><br />The lowest borrow rate, applied at 0% utilization. |
| `maxRateBps` | **Type:** `u64`<br /><br />The highest borrow rate, applied at 100% utilization. |
| `targetRateBps` | **Type:** `u64`<br /><br />The borrow rate when utilization reaches its target level. |
| `targetUtilizationRate` | **Type:** `u64`<br /><br />The optimal utilization level for the custody. |
28 changes: 28 additions & 0 deletions docs/200-perp-api/205-price-feed-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_label: "Price Feed Accounts"
description: "Understand and integrate the Jupiter Perp Program."
title: "Price Feed Accounts"
---

<head>
<title>Price Feed Accounts</title>
<meta name="twitter:card" content="summary" />
</head>

This page contains an overview of the **Solana account types** used in the Jupiter Perpetuals Program, and specifically the `PriceFeed` account.

The `PriceFeed` account is a struct which represents a set of parameters and states associated to price data managed by the Dove Oracle Program which consists of the following price feeds.

| Asset | Price Feed Account |
|-------|----------------|
| SOL | [39cWjvHrpHNz2SbXv6ME4NPhqBDBd4KsjUYv5JkHEAJU](https://solscan.io/account/39cWjvHrpHNz2SbXv6ME4NPhqBDBd4KsjUYv5JkHEAJU) |
| ETH | [5URYohbPy32nxK1t3jAHVNfdWY2xTubHiFvLrE3VhXEp](https://solscan.io/account/5URYohbPy32nxK1t3jAHVNfdWY2xTubHiFvLrE3VhXEp) |
| BTC | [4HBbPx9QJdjJ7GUe6bsiJjGybvfpDhQMMPXP1UEa7VT5](https://solscan.io/account/4HBbPx9QJdjJ7GUe6bsiJjGybvfpDhQMMPXP1UEa7VT5) |
| USDC | [A28T5pKtscnhDo6C1Sz786Tup88aTjt8uyKewjVvPrGk](https://solscan.io/account/A28T5pKtscnhDo6C1Sz786Tup88aTjt8uyKewjVvPrGk) |
| USDT | [AGW7q2a3WxCzh5TB2Q6yNde1Nf41g3HLaaXdybz7cbBU](https://solscan.io/account/AGW7q2a3WxCzh5TB2Q6yNde1Nf41g3HLaaXdybz7cbBU) |

:::tip Example Typescript Repository
[The code snippet in the examples repo shows how to fetch and stream onchain price updates from the accounts above](https://github.com/julianfssen/jupiter-perps-anchor-idl-parsing/blob/main/src/examples/poll-and-stream-oracle-price-updates.ts)

You can also find the [Custody Account fields in the repository](https://github.com/julianfssen/jupiter-perps-anchor-idl-parsing/blob/main/src/idl/doves-idl.ts) or on a [blockchain explorer](https://solscan.io/account/DoVEsk76QybCEHQGzkvYPWLQu9gzNoZZZt3TPiL597e#anchorProgramIdl).
:::
2 changes: 1 addition & 1 deletion docs/dex-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Our top priority is securing the best prices and the best token selection for ou
Given the amount of integration work involved:

- A DEX must have enough liquidity to be useful for trading and to attract volume, as of 1 January 2025, minimum DEX TVL is $500,000.
- Each market/pool must have a [minimum liquidity](../guides/general/get-your-token-on-jupiter) to show up on Jupiter, as of 1 January 2025, minimum market liquidity is $500.
- Each market/pool must have a [minimum liquidity](../guides/spot/instant/how-to-get-your-token-on-jupiter) to show up on Jupiter, as of 1 January 2025, minimum market liquidity is $500.

### Markets API
- This API should track all markets/pools that is listed or delisted, this will allow us to automatically track new markets as you add them to your DEX.
Expand Down
Loading