diff --git a/Moved/2-how-swap-works/2-how-swap-works.md b/Moved/2-how-swap-works/2-how-swap-works.md index eb9a6c9a..3a2a3ea2 100644 --- a/Moved/2-how-swap-works/2-how-swap-works.md +++ b/Moved/2-how-swap-works/2-how-swap-works.md @@ -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 diff --git a/docs/100-swap-api/3-send-swap-transaction.md b/docs/100-swap-api/3-send-swap-transaction.md index 48d5200b..5f97109f 100644 --- a/docs/100-swap-api/3-send-swap-transaction.md +++ b/docs/100-swap-api/3-send-swap-transaction.md @@ -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' @@ -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' @@ -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' @@ -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' diff --git a/docs/200-perp-api/1-perp-api.md b/docs/200-perp-api/1-perp-api.md new file mode 100644 index 00000000..62475b94 --- /dev/null +++ b/docs/200-perp-api/1-perp-api.md @@ -0,0 +1,14 @@ +--- +sidebar_label: "Perp API" +description: "Use the Jupiter Perp API to trade or analyze." +title: "Coming Soon!" +--- + + + Coming Soon! + + + +:::warning +The Perp API for trading and analyzing is still a **work in progress**, stay tuned! +::: \ No newline at end of file diff --git a/docs/200-perp-api/204-custody-account.md b/docs/200-perp-api/204-custody-account.md index fc2f1360..ba81d3a5 100644 --- a/docs/200-perp-api/204-custody-account.md +++ b/docs/200-perp-api/204-custody-account.md @@ -49,6 +49,7 @@ Each `Custody` account contains the following data: | `targetRatioBps` | **Type:** `u64`

The target weightage (in basis points) for the custody in the JLP pool. | | `assets` | **Type:** [`Assets`](#assets)

Contains data used to calculate PNL, AUM, and core business logic for the program. | | `fundingRateState` | **Type:** [`FundingRateState`](#fundingratestate)

Contains data used to calculate borrow fees for open positions. | +| `jumpRateState` | **Type:** [`JumpRateState`](#jumpratestate)

Contains data used to calculate borrow fees for open positions. | ### `PricingParams` @@ -76,4 +77,13 @@ Each `Custody` account contains the following data: | --- | --- | | `cumulativeInterestRate` | **Type:** `u128`

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.

To calculate borrow fees more efficiently, each custody account contains a value called `cumulativeInterestRate`.

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.

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`

The UNIX timestamp for when the custody's borrow fee data was last updated. | -| `hourlyFundingDbps` | **Type:** `u64`

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`

**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`

The lowest borrow rate, applied at 0% utilization. | +| `maxRateBps` | **Type:** `u64`

The highest borrow rate, applied at 100% utilization. | +| `targetRateBps` | **Type:** `u64`

The borrow rate when utilization reaches its target level. | +| `targetUtilizationRate` | **Type:** `u64`

The optimal utilization level for the custody. | diff --git a/docs/200-perp-api/205-price-feed-account.md b/docs/200-perp-api/205-price-feed-account.md new file mode 100644 index 00000000..c2320203 --- /dev/null +++ b/docs/200-perp-api/205-price-feed-account.md @@ -0,0 +1,28 @@ +--- +sidebar_label: "Price Feed Accounts" +description: "Understand and integrate the Jupiter Perp Program." +title: "Price Feed Accounts" +--- + + + Price Feed Accounts + + + +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). +::: diff --git a/docs/dex-integration.md b/docs/dex-integration.md index f8a3a36c..58d311fa 100644 --- a/docs/dex-integration.md +++ b/docs/dex-integration.md @@ -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. diff --git a/docs_versioned_docs/version-old/10-legal/1-sdk-api-license-agreement.md b/docs_versioned_docs/version-old/10-legal/1-sdk-api-license-agreement.md index 697223de..339e080e 100644 --- a/docs_versioned_docs/version-old/10-legal/1-sdk-api-license-agreement.md +++ b/docs_versioned_docs/version-old/10-legal/1-sdk-api-license-agreement.md @@ -1,199 +1,127 @@ +# SDK & API License Agreement + -# **Jupiter API & SDK License Agreement** +**IMPORTANT**: This Jupiter SDK & API License Agreement ("Agreement") is a legally binding contract between you, as Licensee ("You" or "Licensee") and Jupiter exchanges and applies to your use of the Jupiter SDK or API, as defined herein, available through https://docs.jup.ag (collectively the "Service"). The Service includes an Application Programming Interface ("API" or "Program") and a Software Development Kit (“SDK”), which is further discussed and defined below. If you do not agree to be bound by the terms and conditions of this Agreement, please do not proceed with the use of Service, the API, or the SDK. -**IMPORTANT:** This Jupiter API & SDK License Agreement ("Agreement") is a legally binding contract between you, as Licensee ("You", "Your" or "Licensee") and Block Raccoon S.A., an entity incorporated in Panama ("Jupiter," "we" or "our") and applies to your use of the Jupiter API or SDK, as defined herein, available through https://portal.jup.ag (collectively the "Service"). The Service includes an Application Programming Interface ("API") and a Software Development Kit (“SDK”), which is further discussed and defined below. If you do not agree to be bound by the terms and conditions of this Agreement, please do not proceed with the use of Service, the API, or the SDK. +In this Agreement, the terms "you" or "your" mean any person or entity using the Service ("Users"). Unless otherwise stated, the terms "Jupiter," "we" or "our" will collectively refer to Block Raccoon S.A. and its representatives. -This Agreement becomes effective as of the date you first access, download, copy or otherwise use the API or SDK ("Effective Date"). This Agreement shall continue until terminated either by us or by you. Even after termination of this Agreement, certain provisions will survive, as discussed herein. This Agreement also incorporates Jupiter`s Terms of Service link and Privacy Policy link which terms shall also govern your use of the Service. In the event of any conflict between this Agreement and the Terms of Service or Privacy Policy, the provisions of this Agreement shall prevail. +This Agreement becomes effective as of the date you first access, download or use the API or SDK ("Effective Date"). This Agreement shall continue until terminated either by us or by you. Even after termination of this Agreement, certain provisions will survive, as discussed herein. This Agreement also incorporates Jupiter`s Terms of Service link and Privacy Policy link which terms shall also govern your use of the Service. YOU ARE ENTERING A LEGALLY BINDING CONTRACT: BY COPYING, DOWNLOADING, OR OTHERWISE USING THE JUPITER API OR SDK YOU ARE EXPRESSLY AGREEING TO BE BOUND BY ALL TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, YOU ARE NOT AUTHORIZED TO COPY, DOWNLOAD, INSTALL OR OTHERWISE USE THE JUPITER API or SDK. The API and SDK are protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The API and SDK is licensed to you, and its use is subject to the terms of this Agreement. -**1. Definitions​** +### 1. Definitions​ -1.1 **"Application Programming Interfaces"** or **"API"** or **“Jupiter API”** means the back-end smart routing algorithm which facilitates the user’s efficient swapping of digital assets at a variety of third party trading venues, which may include object code, software libraries, software tools, sample source code, published specifications and Documentation. Jupiter API shall include any future, updated or otherwise modified version(s) thereof furnished by Jupiter (in its sole discretion) to Licensee. +1.1. "Application Programming Interfaces" or "API" or “Program” or “Jupiter API” means Jupiter Exchange use technology, a smart router algorithm which is an informational service that provides routing information that is used by Jupiter Aggregation Protocol, (Swap API and its related services), which may include object code, software libraries, software tools, sample source code, published specifications and Documentation. Jupiter API shall include any future, updated or otherwise modified version(s) thereof furnished by Jupiter (in its sole discretion) to Licensee. -1.2 **"Software Development Kit"** or **“SDK”** or **“Jupiter SDK”** means the ancillary tools and resources that allow the user to utilise or integrate the API. Jupiter SDK shall include any future, updated or otherwise modified version(s) thereof furnished by Jupiter (in its sole discretion) to Licensee. +1.2. "Software Development Kit" or “SDK” or “Jupiter SDK” means Jupiter Exchange use technology, a smart router algorithm which is a software library that provides routing information that is used by Jupiter Aggregation Protocol and its related services, which may include object code, software libraries, software tools, sample source code, published specifications, and Documentation. Jupiter SDK shall include any future, updated or otherwise modified version(s) thereof furnished by Jupiter (in its sole discretion) to Licensee. -1.3 **"Documentation"** includes, but is not limited to programmer guides, manuals, materials, and information appropriate or necessary for use in connection with the API. +1.3. "Documentation" includes, but is not limited to programmer guides, manuals, materials, and information appropriate or necessary for use in connection with the API. -**2. Grant of License​** +### 2. Grant of License​ -2.1 Subject to the terms of this Agreement, Jupiter hereby grants Licensee a limited, non-exclusive, fee-bearing, non-transferable, non-sublicensable licence to use the API or SDK during the term of this Agreement solely for the purpose of Licensee's internal development efforts to develop products or services integrating the API and/or SDK in any manner (the **Licensee’s Product**). +2.1. Subject to the terms of this Agreement, Jupiter hereby grants Licensee a limited, non- exclusive, non-transferable, royalty-free license (without the right to sublicense) to use the API or SDK solely for the purpose of Licensee's internal development efforts to develop applications to work in conjunction with the Jupiter products referenced in the API or SDK and for which the API or SDK was provided. -2.2 Licensee shall have no right to distribute, license (whether or not through multiple tiers) or otherwise transfer the API or SDK to any third party. +2.2. Licensee shall have no right to distribute, license (whether or not through multiple tiers) or otherwise transfer the API or SDK to any third party or use it for commercial reasons. -2.3 In case of potential other API or SDK use that is not prescribed by this Agreement, please write to info@jup.ag to seek written consent. +2.3. In case of potential other API or SDK use that is not prescribed by this Agreement please write at `info@jup.ag`. 2.4 Representations. Both Parties to this Agreement are duly organized and validly existing in good standing with all requisite power and authority to enter into this Agreement and conduct its business as is now being conducted. Neither Party is identified on, or engages in any transactions with anyone else listed on, any sanctions list maintained by the U.S. Department of the Treasury’s Office of Foreign Asset Control (“OFAC”) and have shared with each other a copy of their Articles of Incorporation and Significant Shareholder list. -2.5 By providing access to the API and the SDK, Jupiter is solely providing a back-end technical service to the Licensee which allows the Licensee to provide swap-related services to end users of the Licensee’s products or services. Jupiter is not a party to any agreement for swap-related services between the Licensee, its end users, any counterparty or trading venue where swaps are performed, nor any trustee, custodian, bailee, manager, administrator or service provider in respect of any digital asset or otherwise. - -2.6 Independent Contractor Relationship. The relationship between the Parties is that of independent contractors. Nothing in this Agreement shall be construed to create anything like the relationship of an employer and employee, joint venture, partnership, or joint association. - -**3. Other Rights and Limitations​** - -3.1 Copies. Licensee may copy the API or SDK only as necessary for the purpose of the licence hereunder. - -3.2 Except as expressly authorised under this Agreement or by Jupiter in writing, the Licensee agrees it shall not (and shall not permit or authorise any other person to): - -a. use the API or SDK in any manner that is not expressly authorised by this Agreement; - -b. use the API or SDK or develop or use the Licensee's Product (i) for any illegal, unauthorised or otherwise improper purposes or (ii) in any manner which would violate this Agreement or the Documentation, breach any laws, regulations, rules or orders (including those relating to virtual assets, intellectual property, data privacy, data transfer, international communications or the export of technical or personal data) or violate the rights of third parties (including rights of privacy or publicity); - -c. remove any legal, copyright, trademark or other proprietary rights notices contained in or on materials it receives or is given access to pursuant to this Agreement, including the API, the SDK and the Documentation; - -d. sell, lease, share, transfer or sublicense the API, SDK or any content obtained through the API, directly or indirectly, to any third party; - -e. use the API or SDK in a manner that, as determined by Jupiter in its sole discretion, exceeds reasonable request volume, constitutes excessive or abusive usage, or otherwise fails to comply or is inconsistent with any part of the Documentation; - -f. access the API or SDK for competitive analysis or disseminate performance information (including uptime, response time and/or benchmarks) relating to the API; - -g. use the API in conjunction with, or combine content from the API with, content obtained through scraping or any other means outside the API; - -h. (i) interfere with, disrupt, degrade, impair, overburden or compromise the integrity of the API, Jupiter's systems or any networks connected to the API or Jupiter's systems (including by probing, scanning or testing their vulnerability), (ii) disobey any requirements, procedures, policies or regulations of networks connected to the API or Jupiter's systems, (iii) attempt to gain unauthorised access to the API, Jupiter's systems or any information not permitted by this Agreement or circumvent any access or usage limits imposed by Jupiter or (iv) transmit through the Licensee's Product or the use of the API or SDK any (A) content that is illegal, tortious, defamatory, vulgar, obscene, racist, ethnically insensitive, or invasive of another person's privacy, (B) content that promotes illegal or harmful activity, or gambling or adult content, (C) viruses, worms, defects, Trojan horses, or any other malicious programs or code or items of a destructive nature or (D) materials that could harm minors in any way; - -i. copy, adapt, reformat, reverse-engineer, disassemble, decompile, download, translate or otherwise modify or create derivative works of the API, the SDK or the Documentation, Jupiter's website, or any of Jupiter's other content, products or services, through automated or other means; - -j. interfere with Jupiter's business practices or the way in which it licenses or distributes the API or SDK; - -k. make any representations, warranties or commitments (i) regarding the API or SDK or (ii) on behalf of Jupiter; or - -l. take any action that would subject the API or SDK to any third-party terms, including without limitation any open source software licence terms. - -3.3 Without prejudice of the generality of the foregoing, where the Licensee’s Product is competitive with the API or the Service, Jupiter shall have the right to access the Licensee’s Product, request the Licensee for information regarding the Licensee’s Product, and Jupiter shall be granted a non-exclusive, royalty-free, non-transferable, non-sublicensable licence to use the Licensee’s Product for any purpose. - -3.4 Third Party Software. Licensee acknowledges that effective utilization of the API and SDK may require the use of a development tool, compiler and other software and technology of third parties (“Third Party Software”). Licensee is solely responsible for procuring such Third-Party Software and technology and the necessary licenses for the use thereof. Jupiter makes no representation or warranty concerning Third Party Software and shall have no obligation or liability with respect to Third Party Software. - -3.5 No right is granted to Licensee to sublicense its rights hereunder. All rights not expressly granted are reserved by Jupiter and, except as expressly set forth herein, no license is granted by Jupiter under this Agreement directly, by implication, estoppel or otherwise, under any patent, copyright, trade secret or trademark or other intellectual property rights of Jupiter. Nothing herein shall be deemed to authorize Licensee to use Jupiter`s trademarks or trade names in Licensee's advertising, marketing, promotional, sales or related materials. Jupiter reserves all rights not otherwise expressly granted in this Agreement. - -3.6 No assertion by Licensee. Licensee agrees not to assert any patent rights related to the API/SDK or applications developed using the API/SDK against Jupiter, Jupiter's participants, or other licensees of the API/SDK for making, using, selling, offering for sale, or importing any products or technology developed using the API/SDK. - -3.7 Jupiter may from time to time provide updates or upgrades to the API or SDK. Any such updates and upgrades will be performed according to Jupiter's then-current operational policies, which may include automatic updating or upgrading of API or SDK currently in use at that time. Where the Licensee fails to accept such updates or upgrades, Jupiter shall be entitled to withhold access to the API, SDK and/or Service, and the same shall not constitute any breach of the terms of this Agreement. - -**4. Intellectual Property and proprietary rights** - -4.1 As between Jupiter and Licensee, Jupiter and/or its licensors shall own and retain all proprietary rights, including all patent, copyright, trade secret, trademark and other intellectual property rights, in and to the API and SDK and any corrections, bug fixes, enhancements, updates, improvements, or modifications thereto and (to the extent such rights accrue to the Licensee), the Licensee hereby irrevocably transfers, conveys and assigns to Jupiter all of its right, title, and interest therein. - -4.2 Jupiter shall have the exclusive right to apply for or register any patents, mask work rights, copyrights, and such other proprietary protections with respect thereto. - -4.3 The Licensee acknowledges that the license granted under this Agreement does not provide Licensee with title or ownership to the API or SDK, but only a right of limited use under the terms and conditions of this Agreement. - -4.4 The Parties acknowledge that Jupiter does not store, send, or receive digital assets. Digital assets exist only by virtue of the ownership record maintained on the relevant blockchain network. Any creation or transfer of title that might occur in respect of any digital asset occurs on the relevant blockchain network (on the relevant contractual terms applicable to such creation and/or transfer) and is performed by the Licensee’s Product, and Jupiter does not have any role or responsibility in such transactions. Jupiter cannot guarantee that the Licensee’s Product, or any party can effect the transfer of such title or right to any digital asset. Accordingly, Jupiter cannot provide any guarantee, warranty or assurance regarding the authenticity, uniqueness, originality, quality, marketability, legality or value of any digital assets utilised in connection with the API and the Services. - -**5. No Obligation to Support​** - -5.1 Subject to payment of fees as described herein, Jupiter would issue to the Licensee certain unique API keys, tokens, passwords and/or other credentials (collectively, **"Keys"**), for accessing the API and/or SDK and managing the Licensee's access to the API. The Licensee may only access the API with the Keys issued to the Licensee by Jupiter. The Licensee acknowledges that access to the API may not always be available. The Licensee may not sell, transfer, sublicense or otherwise disclose its Keys to any other party or use them for any other purpose other than that expressly permitted by Jupiter. The Licensee is responsible for maintaining the secrecy and security of the Keys. The Licensee is fully responsible for all activities that occur using the Keys, regardless of whether such activities are undertaken by the Licensee or a third party. The Licensee is responsible for maintaining up-to-date and accurate information (including a current email address and other required contact information) for the Licensee's access to the API and SFK. Jupiter may discontinue the Licensee's access to the API and SDK if such contact information is not up-to-date and/or the Licensee does not respond to communications directed to such coordinates. - -5.2 Jupiter makes no guarantees with respect to the performance, availability or uptime of the API or the SDK. Jupiter may conduct maintenance on or stop providing any of the API or the SDK at any time with or without written notice to the Licensee. In addition, Jupiter may change the method of access to the API, SDK and Documentation at any time. - -5.3 Jupiter does not guarantee any support for the API or SDK under this Agreement. Nothing herein shall be construed to require Jupiter to provide consultations, support services or updates, upgrades, bug fixes or modifications to the API or SDK. In the event of degradation or instability of Jupiter's system or an emergency, Jupiter may, in its sole discretion, suspend access to the API and/or SDK. - -5.4 Jupiter reserves the right to change the method of access to the API or SDK at any time to ensure the safety and security of its environment. In the event of degradation or instability of Jupiter`s systems or in an emergency, you acknowledge and agree that Jupiter may, in its sole and absolute discretion, temporarily suspend your access to the API or SDK in order to minimize threats to and protect the operational stability and security of the Jupiter system. - -**6. Fees & Payment​** - -6.1 Jupiter shall charge a subscription fee for usage of the Jupiter API and/or SDK. This may be a fixed fee, infrastructure fee and/or a variable fee based on revenue earned by the Licensee in respect of the Licensee’s Product. - -6.2 The details of the level of fees charged shall be notified to you via the API portal at https://portal.jup.ag. By accessing, downloading, copying or otherwise using the API or SDK, you shall be deemed to have consented to said fees. - -6.3 The Fees may be reviewed by Jupiter at any time commencing from three (3) months after the Effective Date. Any updated fees shall be notified to you via the API portal and your continued usage of the API or SDK shall be deemed consent to such updated fees. - -**7. Licensee’s Obligations** - -7.1 The Licensee agrees to report to Jupiter any errors or difficulties discovered related to the API or SDK, and the characteristic conditions and symptoms of such errors and difficulties. +2.5 Independent Contractor Relationship. The relationship between the Parties is that of independent contractors. Nothing in this Agreement shall be construed to create anything like the relationship of an employer and employee, joint venture, partnership, or joint association. -7.2 The Licensee shall perform such sanity testing, cybersecurity testing or other technical checks in respect of the API or SDK as may be reasonably requested by Licensor from time to time. +### 3. Other Rights and Limitations​ -7.3 The Licensee shall ensure that the offering/provision of the Licensee's Product complies with all applicable laws and regulations, including without limitation all consumer protection, Know Your Customer (KYC) or Anti-money Laundering (AML) due diligence laws, sanctions, anti-money laundering or terrorist financing laws, securities laws, payment provider laws, or virtual assets regulations. Without prejudice to the generality of the foregoing, the Licensee shall obtain and maintain in force (or as applicable procure the obtaining and maintenance in force of) all necessary licenses, permissions, authorisations, consents and permits which may be necessary or desirable for the offering/provision of the Licensee's Product. +3.1. Copies. Licensee may copy the API or SDK only as necessary to exercise its rights hereunder. -7.4 The Licensee acknowledges and agrees that all reporting, information gathering and other obligations under applicable Know Your Customer (KYC) or Anti-money Laundering (AML) due diligence laws, sanctions, anti-money laundering or terrorist financing laws, securities laws, payment provider laws, or virtual assets regulations with respect to the Licensee's end-users are the responsibility of the Licensee; and Jupiter shall not be responsible or have any liability for any of the foregoing. The Licensee agrees to provide such information to Jupiter if reasonably requested by Jupiter. +3.2. No Reverse Engineering. Licensee shall have no rights to any source code for any of the software in the API, except for the explicit rights to use the source code as provided to Licensee hereunder. Licensee may not reverse engineer, decompile, modify, disassemble or otherwise alter the API or any part thereof or otherwise reduce the API to human-perceivable form in whole or in part, except and only to the extent that such activity is expressly permitted by this Agreement or applicable laws. -7.5 Without prejudice to the foregoing, upon written request from Jupiter, the Licensee shall use all efforts to block any specific digital wallet or address from accessing the Licensee's Product and/or the API integration. +3.3. Third Party Software. Licensee acknowledges that effective utilization of the API may require the use of a development tool, compiler and other software and technology of third parties (“Third Party Software”). Licensee is solely responsible for procuring such Third-Party Software and technology and the necessary licenses for the use thereof. Jupiter makes no representation or warranty concerning Third Party Software and shall have no obligation or liability with respect to Third Party Software. -7.6 The Licensee agrees to immediately notify Jupiter if (i) the Licensee becomes aware of any security event, including any cybersecurity breach, attack or economic exploit relating to the Licensee's Product or (ii) the Licensee's Product, API, SDK or the Service becomes subject to any legal or regulatory investigation or action. +3.4. No right is granted to Licensee to sublicense its rights hereunder. All rights not expressly granted are reserved by Jupiter and, except as expressly set forth herein, no license is granted by Jupiter under this Agreement directly, by implication, estoppel or otherwise, under any patent, copyright, trade secret or trademark or other intellectual property rights of Jupiter. Nothing herein shall be deemed to authorize Licensee to use Jupiter`s trademarks or trade names in Licensee's advertising, marketing, promotional, sales or related materials. Jupiter reserves all rights not otherwise expressly granted in this Agreement. -7.7 The Licensee shall be responsible for all customer service for all its products and services (including the Licensee's Product). +3.5. No assertion by Licensee. Licensee agrees not to assert any patent rights related to the API/SDK or applications developed using the API/SDK against Jupiter, Jupiter's participants, or other licensees of the API/SDK for making, using, selling, offering for sale, or importing any products or technology developed using the API/SDK. -**8. Confidentiality​ and Publicity** +### 4. Ownership -8.1 The API and SDK contains valuable proprietary information and trade secrets of Jupiter and its suppliers that remain the property of Jupiter. You shall protect the confidentiality of, and avoid disclosure and unauthorized use of, the API or SDK. +4.1. As between Jupiter and Licensee, Jupiter and/or its licensors shall own and retain all proprietary rights, including all patent, copyright, trade secret, trademark and other intellectual property rights, in and to the API and SDK and any corrections, bug fixes, enhancements, updates, improvements, or modifications thereto and Licensee hereby irrevocably transfers, conveys and assigns to Jupiter all of its right, title, and interest therein. Jupiter shall have the exclusive right to apply for or register any patents, mask work rights, copyrights, and such other proprietary protections with respect thereto. Licensee acknowledges that the license granted under this Agreement does not provide Licensee with title or ownership to the API or SDK, but only a right of limited use under the terms and conditions of this Agreement. -8.2 Without prejudice to the generality of the foregoing, you agree not to disparage Jupiter, any of its affiliates, or any of their directors, shareholders, employees, servants, contractors, or agents in any manner, or otherwise make any false, misleading or negative statements to any party about Jupiter or any of its affiliates, the Service (or any output of the Service), or any other product(s) or service(s) of Jupiter or any of its affiliates. +### 5. Support​ -8.3 Jupiter may disclose and publicise the existence of the business relationship between Jupiter and you on its website and in promotional and marketing materials without requiring any further consent from you. +5.1. Jupiter will not provide any support for the API or SDK under this Agreement. Nothing herein shall be construed to require Jupiter to provide consultations, support services or updates, upgrades, bug fixes or modifications to the API or SDK. Jupiter will promptly respond to inquiries from you with respect to the API Services and will implement systems and procedures to ensure that any User of the API will be treated with the same fairness and good faith as any other user of our API. -8.4 You shall ensure that the Licensee’s Product shall prominently display to end users of such product or service the message “Powered by Jupiter”. +5.2. Jupiter reserves the right to change the method of access to the API or SDK at any time to ensure the safety and security of its environment. In the event of degradation or instability of Jupiter`s systems or in an emergency, you acknowledge and agree that Jupiter may, in its sole and absolute discretion, temporarily suspend your access to the API or SDK in order to minimize threats to and protect the operational stability and security of the Jupiter system. -**9. No Warranty​** +### 6. Fees & Payment​ -9.1 The API, SDK, and Documentation are provided "AS-IS" without any warranty whatsoever. To the full extent allowed by law, the foregoing warranties and remedies are exclusive and are in lieu of all other warranties, terms, or conditions, express or implied, either in fact or by operation of law, statutory or otherwise, including warranties, terms, or conditions of merchantability, fitness for a particular purpose, satisfactory quality, correspondence with description, and non-infringement, all of which are expressly disclaimed. +6.1. Jupiter reserves the right to charge fees for future use of or access to Jupiter API or SDK. If Jupiter decides to charge for access to the API or SDK, you do not have any obligation to continue to use such API or SDK. -9.2 No advice or information, whether oral or written, obtained by you from Jupiter or through or from the API/SDK shall create any warranty not expressly stated in this agreement. Jupiter does not warrant that the API, SDK and Documentation are suitable for Licensee's use, that the API, SDK or Documentation are without defect or error, that operation will be uninterrupted, or that defects will be corrected. Further, Jupiter makes no warranty regarding the results of the use of the API, SDK, and Documentation. +### 7. Confidentiality​ -**10. Limitation of Liability​** +7.1. The API and SDK contains valuable proprietary information and trade secrets of Jupiter and its suppliers that remain the property of Jupiter. You shall protect the confidentiality of, and avoid disclosure and unauthorized use of, the API or SDK. -JUPITER WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING OUT OF OR RELATING TO THE USE OR THE INABILITY TO USE THE API, SDK AND ITS USE OR THE INABILITY TO USE WITH ANY THIRD PARTY SOFTWARE, ITS CONTENT OR FUNCTIONALITY, INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOSS OF BUSINESS PROFITS OR REVENUE; BUSINESS INTERRUPTION OR WORK STOPPAGE; COMPUTER FAILURE OR MALFUNCTION; LOSS OF BUSINESS INFORMATION, DATA OR DATA USE; LOSS OF GOODWILL; DAMAGES CAUSED BY OR RELATED TO ERRORS, OMISSIONS, INTERRUPTIONS, DEFECTS, DELAY IN OPERATION OR TRANSMISSION, COMPUTER VIRUS, FAILURE TO CONNECT, NETWORK CHARGES, AND ALL OTHER DIRECT, INDIRECT, SPECIAL, INCIDENTAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES EVEN IF JUPITER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE ABOVE EXCLUSIONS OR LIMITATIONS MAY NOT APPLY TO YOU. NOTWITHSTANDING THE FOREGOING, JUPITER TOTAL LIABILITY TO LICENSEE FOR ALL LOSSES, DAMAGES, CAUSES OF ACTION, INCLUDING BUT NOT LIMITED TO THOSE BASED ON CONTRACT, TORT, OR OTHERWISE, ARISING OUT OF YOUR USE OF THE API/SDK AND/OR INTELLECTUAL PROPERTY ON THIS TECHNOLOGY PLATFORM OR API/SDK, OR ANY OTHER PROVISION OF THIS AGREEMENT, SHALL NOT EXCEED THE AMOUNT OF 100 USD. THE FOREGOING LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, EVEN IF ANY REMEDY FAILS ITS ESSENTIAL PURPOSE. +### 8. No Warranty​ -**11. Indemnity​** +8.1. The API, SDK, and Documentation are provided "AS-IS" without any warranty whatsoever. To the full extent allowed by law, the foregoing warranties and remedies are exclusive and are in lieu of all other warranties, terms, or conditions, express or implied, either in fact or by operation of law, statutory or otherwise, including warranties, terms, or conditions of merchantability, fitness for a particular purpose, satisfactory quality, correspondence with description, and non-infringement, all of which are expressly disclaimed. -You agree to indemnify and hold harmless Jupiter and its contributors, subsidiaries, affiliates, officers, agents, Intellectual Property service providers, co-branders, customers, suppliers or other partners, and employees, from any loss, claim or demand, including reasonable attorneys' fees, made by any third party due to or arising out of your negligence, error, omissions, or failure to perform relating to your use of the API/SDK, your connection to the API, or your violation of the Agreement. +8.2. No advice or information, whether oral or written, obtained by you from Jupiter or through or from the API/SDK shall create any warranty not expressly stated in this agreement. Jupiter does not warrant that the API, SDK and Documentation are suitable for licensee's use, that the API, SDK or Documentation are without defect or error, that operation will be uninterrupted, or that defects will be corrected. Further, Jupiter makes no warranty regarding the results of the use of the API, SDK, and Documentation. -**12. Disclaimers** +### 9. Limitation of Liability​ -12.1 UNLESS SEPARATELY STATED IN A WRITTEN EXPRESS LIMITED WARRANTY, THE API AND SDK PROVIDED BY JUPITER IS PROVIDED “AS IS” AND ON AN “AS AVAILABLE” BASIS, WITHOUT WARRANTIES OF ANY KIND FROM JUPITER, EITHER EXPRESS OR IMPLIED. TO THE FULLEST EXTENT POSSIBLE PURSUANT TO APPLICABLE LAW, JUPITER DISCLAIMS ALL WARRANTIES EXPRESS, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY OR WORKMANSHIP LIKE EFFORT, FITNESS FOR A PARTICULAR PURPOSE, RELIABILITY OR AVAILABILITY, ACCURACY, LACK OF VIRUSES, QUIET ENJOYMENT, NON- INFRINGEMENT OF THIRD-PARTY RIGHTS OR OTHER VIOLATIONS OF RIGHTS. SOME JURISDICTIONS DO NOT ALLOW EXCLUSIONS OR LIMITATIONS OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSIONS OR LIMITATIONS MAY NOT APPLY TO YOU. NO ADVICE OR INFORMATION, WHETHER ORAL OR WRITTEN, OBTAINED BY YOU FROM JUPITER OR ITS AFFILIATES SHALL BE DEEMED TO ALTER THIS DISCLAIMER BY JUPITER OF WARRANTY REGARDING THE API OR SDK OR THE AGREEMENT, OR TO CREATE ANY WARRANTY OF ANY SORT FROM JUPITER. +9.1. JUPITER WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING OUT OF OR RELATING TO THE USE OR THE INABILITY TO USE THE API, SDK AND ITS USE OR THE INABILITY TO USE WITH ANY THIRD PARTY SOFTWARE, ITS CONTENT OR FUNCTIONALITY, INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOSS OF BUSINESS PROFITS OR REVENUE; BUSINESS INTERRUPTION OR WORK STOPPAGE; COMPUTER FAILURE OR MALFUNCTION; LOSS OF BUSINESS INFORMATION, DATA OR DATA USE; LOSS OF GOODWILL; DAMAGES CAUSED BY OR RELATED TO ERRORS, OMISSIONS, INTERRUPTIONS, DEFECTS, DELAY IN OPERATION OR TRANSMISSION, COMPUTER VIRUS, FAILURE TO CONNECT, NETWORK CHARGES, AND ALL OTHER DIRECT, INDIRECT, SPECIAL, INCIDENTAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES EVEN IF JUPITER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE ABOVE EXCLUSIONS OR LIMITATIONS MAY NOT APPLY TO YOU. NOTWITHSTANDING THE FOREGOING, JUPITER TOTAL LIABILITY TO LICENSEE FOR ALL LOSSES, DAMAGES, CAUSES OF ACTION, INCLUDING BUT NOT LIMITED TO THOSE BASED ON CONTRACT, TORT, OR OTHERWISE, ARISING OUT OF YOUR USE OF THE API/SDK AND/OR INTELLECTUAL PROPERTY ON THIS TECHNOLOGY PLATFORM OR API/SDK, OR ANY OTHER PROVISION OF THIS AGREEMENT, SHALL NOT EXCEED THE AMOUNT OF 100 USD. THE FOREGOING LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, EVEN IF ANY REMEDY FAILS ITS ESSENTIAL PURPOSE. -12.2 NEITHER JUPITER NOR THE API PROVIDES ANY DIGITAL ASSET EXCHANGE OR PORTFOLIO/FUND MANAGEMENT SERVICE. WHERE THE LICENSEE OR ANY END USER OF THE LICENSEE'S PRODUCT MAKES THE DECISION TO TRANSACT UTILISING THE API OR THE SERVICE, THEN SUCH DECISIONS AND TRANSACTIONS AND ANY CONSEQUENCES FLOWING THEREFROM ARE SUCH TRANSACTING PARTY'S SOLE RESPONSIBILITY. +### 10. Indemnity​ -12.3 THE API FUNCTIONS SOLELY AS A BACK-END SUPPORTING TECHNICAL SERVICE FOR A SMART ROUTING ALGORITHM FOR DIGITAL ASSET SWAPS ONLY; IN NO CIRCUMSTANCES SHALL JUPITER, THE API OR THE SDK BE CONSTRUED AS A DIGITAL ASSET EXCHANGE, BROKER, DEALER, FUND MANAGER, FINANCIAL INSTITUTION, EXCHANGE, CUSTODIAN, ROBO-ADVISOR, INTERMEDIARY, OR CREDITOR. +10.1. You agree to indemnify and hold harmless Jupiter and its contributors, subsidiaries, affiliates, officers, agents, Intellectual Property service providers, co-branders, customers, suppliers or other partners, and employees, from any loss, claim or demand, including reasonable attorneys' fees, made by any third party due to or arising out of your negligence, error, omissions, or failure to perform relating to your use of the API/SDK, your connection to the API, or your violation of the Agreement. -12.4 THE API DOES NOT FACILITATE OR ARRANGE DIGITAL ASSET TRANSACTIONS BETWEEN COUNTERPARTIES, INCLUDING WITH RESPECT TO ANY TRANSACTIONS THAT OCCUR IN CONNECTION WITH ANY DECENTRALISED EXCHANGE, LIQUIDITY POOL OR OTHER CENTRALISED OR DECENTALISED FINANCE PRODUCT / FACILITY, WHICH TRANSACTIONS OCCUR ON SUCH PLATFORM, PROTOCOL AND/OR THE RELEVANT BLOCKCHAIN NETWORK. JUPITER IS NOT A COUNTERPARTY TO ANY DIGITAL ASSET TRANSACTION FACILITATED BY THE API OR THE LICENSEE'S PRODUCT. +### 11. Disclaimer of Warranty​ -12.5 There may be various vulnerabilities, failures or abnormal behaviour of software relating to digital assets (e.g., token contract, wallet, smart contract), or relating to the relevant blockchain network, and Jupiter cannot be responsible for any losses in connection with the same, including without limitation any losses in connection with (i) user error, such as forgotten passwords or incorrectly construed smart contracts or other transactions, (ii) server failure or data loss, (iii) corrupted wallet files, or (iv) unauthorised access or activities by third parties, including but not limited to the use of viruses, phishing, brute-forcing or other means of attack against the API or SDK, the relevant blockchain network, or the Licensee's or any end user's digital wallet. +11.1. UNLESS SEPARATELY STATED IN A WRITTEN EXPRESS LIMITED WARRANTY, ALL API AND SDK PROVIDED BY JUPITER IS PROVIDED “AS IS” AND ON AN “AS AVAILABLE” BASIS, WITHOUT WARRANTIES OF ANY KIND FROM JUPITER, EITHER EXPRESS OR IMPLIED. TO THE FULLEST EXTENT POSSIBLE PURSUANT TO APPLICABLE LAW, JUPITER DISCLAIMS ALL WARRANTIES EXPRESS, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY OR WORKMANSHIP LIKE EFFORT, FITNESS FOR A PARTICULAR PURPOSE, RELIABILITY OR AVAILABILITY, ACCURACY, LACK OF VIRUSES, QUIET ENJOYMENT, NON- INFRINGEMENT OF THIRD-PARTY RIGHTS OR OTHER VIOLATIONS OF RIGHTS. SOME JURISDICTIONS DO NOT ALLOW EXCLUSIONS OR LIMITATIONS OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSIONS OR LIMITATIONS MAY NOT APPLY TO YOU. NO ADVICE OR INFORMATION, WHETHER ORAL OR WRITTEN, OBTAINED BY YOU FROM JUPITER OR ITS AFFILIATES SHALL BE DEEMED TO ALTER THIS DISCLAIMER BY JUPITER OF WARRANTY REGARDING THE API OR SDK OR THE AGREEMENT, OR TO CREATE ANY WARRANTY OF ANY SORT FROM JUPITER. -12.6 Jupiter disclaims any responsibility for any disclosure of information or any other practices of any third-party API provider. Jupiter expressly disclaims any warranty regarding whether your personal information is captured by any third-party API provider or the use to which such personal information may be put by such third-party API provider. +11.2. JUPITER DISCLAIMS ANY RESPONSIBILITY FOR ANY DISCLOSURE OF INFORMATION OR ANY OTHER PRACTICES OF ANY THIRD-PARTY API PROVIDER. JUPITER EXPRESSLY DISCLAIMS ANY WARRANTY REGARDING WHETHER YOUR PERSONAL INFORMATION IS CAPTURED BY ANY THIRD- PARTY API PROVIDER OR THE USE TO WHICH SUCH PERSONAL INFORMATION MAY BE PUT BY SUCH THIRD-PARTY API PROVIDER. -**13. Term and Termination​** +### 12. Term and Termination​ -13.1 The effective date of this Agreement is the start of use of the API or SDK by the Licensee. There shall be a minimum term of 30 days for usage of the API to be paid for in advance (or such other minimum term as notified to you via the API portal at https://portal.jup.ag). +12.1. The effective date of this Agreement is the start of use of the API or SDK by the Licensee. -13.2 This Agreement will terminate automatically if you fail to comply with any of the terms and conditions of this Agreement and you will be liable to Jupiter and its suppliers for damages or losses caused by your non-compliance. The waiver by Jupiter of a specific breach or default shall not constitute the waiver of any subsequent breach or default. +12.2. This Agreement will terminate automatically if you fail to comply with any of the terms and conditions of this Agreement and you will be liable to Jupiter and its suppliers for damages or losses caused by your non-compliance. The waiver by Jupiter of a specific breach or default shall not constitute the waiver of any subsequent breach or default. -13.3 Either party shall have the right to terminate the Agreement, immediately or upon thirty (30) days written notice to legal@jup.ag. +12.3. Either party shall have the right to terminate the Agreement, immediately or upon thirty (30) days written notice to `legal@jup.ag`. -13.4 Upon termination of this Agreement, Licensee will immediately cease using the API and the SDK, and Licensee agrees to destroy all adaptations or copies of the API, SDK, and Documentation or return them to Jupiter upon the termination of this License. +12.4. Upon termination of this Agreement, Licensee will immediately cease using the API and the SDK, and Licensee agrees to destroy all adaptations or copies of the API, SDK, and Documentation or return them to Jupiter upon the termination of this License. -13.5 Jupiter shall have the right to review/audit your use of the API or SDK in conjunction with this Agreement, and you will provide reasonable assistance for this purpose. +12.5. Jupiter shall have the right to audit your use of the API or SDK in conjunction with this Agreement, and you will provide reasonable assistance for this purpose. -13.6 The rights of Jupiter and your obligations contained in this Agreement survive any expiration or termination of this Agreement. +12.6. The rights of Jupiter and your obligations contained in this Agreement survive any expiration or termination of this Agreement. -**14. Applicable Law; Arbitration​** +### 13. Applicable Law; Arbitration​ -14.1 Licensee and Jupiter agree to arbitrate any dispute arising from this Agreement, except for disputes in which either party seeks equitable and other relief for the alleged unlawful use of copyrights, trademarks, trade names, logos, trade secrets or patents. ARBITRATION PREVENTS LICENSEE FROM SUING IN COURT OR FROM HAVING A JURY TRIAL. +13.1. Licensee and Jupiter agree to arbitrate any dispute arising from this Agreement, except for disputes in which either party seeks equitable and other relief for the alleged unlawful use of copyrights, trademarks, trade names, logos, trade secrets or patents. ARBITRATION PREVENTS LICENSEE FROM SUING IN COURT OR FROM HAVING A JURY TRIAL. -14.2 Licensee and Jupiter agree to notify each other in writing of any dispute within thirty (30) days of when it arises. Notice to Jupiter shall be sent to legal@jup.ag. +13.2. Licensee and Jupiter agree to notify each other in writing of any dispute within thirty (30) days of when it arises. Notice to Jupiter shall be sent to `legal@jup.ag`. -14.3 The Licensee and Jupiter shall cooperate in good faith to resolve any dispute, controversy or claim arising out of, relating to, or in connection with this Agreement, including with respect to the formation, applicability, breach, termination, validity or enforceability thereof (a “Dispute”) shall be settled in accordance with the laws of Panama. The parties undertake to carry out any award without delay and waive their right to any form of recourse insofar as such waiver can validly be made. Judgment upon the award may be entered by any court having jurisdiction thereof or having jurisdiction over the relevant party or its assets. Jupiter and the Licensee will each pay their respective attorneys’ fees and expenses. Any dispute arising out of or related to this Agreement is personal to the Licensee and Jupiter and will not be brought as a class arbitration, class action, or any other type of representative proceeding. There will be no class arbitration or arbitration in which a person attempts to resolve a dispute as a representative of another person or group of persons. Further, a dispute cannot be brought as a class or other type of representative action, whether within or outside of arbitration, or on behalf of any other person or group of persons. +13.3. The Licensee and Jupiter shall cooperate in good faith to resolve any dispute, controversy or claim arising out of, relating to, or in connection with this Agreement, including with respect to the formation, applicability, breach, termination, validity or enforceability thereof (a “Dispute”) shall be settled in accordance with the laws of Panama. The parties undertake to carry out any award without delay and waive their right to any form of recourse insofar as such waiver can validly be made. Judgment upon the award may be entered by any court having jurisdiction thereof or having jurisdiction over the relevant party or its assets. Jupiter and the Licensee will each pay their respective attorneys’ fees and expenses. Any dispute arising out of or related to this Agreement is personal to the Licensee and Jupiter and will not be brought as a class arbitration, class action, or any other type of representative proceeding. There will be no class arbitration or arbitration in which a person attempts to resolve a dispute as a representative of another person or group of persons. Further, a dispute cannot be brought as a class or other type of representative action, whether within or outside of arbitration, or on behalf of any other person or group of persons. -14.4 Any dispute between the parties will be governed by this Agreement and the laws of Panama, without giving effect to any conflict of laws principles that may provide for the application of the law of another jurisdiction. Whether the dispute is heard in arbitration or in court, Licensee and Jupiter will not commence against the other a class action, class arbitration or representative action or proceeding. +13.4. Any dispute between the parties will be governed by this Agreement and the laws of Panama, without giving effect to any conflict of laws principles that may provide for the application of the law of another jurisdiction. Whether the dispute is heard in arbitration or in court, Licensee and Jupiter will not commence against the other a class action, class arbitration or representative action or proceeding. -**15. Changes to this Agreement​** +### 14. Changes to this Agreement​ -We may amend any portion of this Agreement at any time by posting the revised version of this Agreement on https://portal.jup.ag with an updated revision date. The changes will become effective and shall be deemed accepted by you, the first time you use or access the SDK or API after the initial posting of the revised Agreement and shall apply on a going-forward basis with respect to your use of the SDK and/or API. In the event that you do not agree with any such modification, your sole and exclusive remedy is to terminate your use of the SDK and/or API. +14.1 We may amend any portion of this Agreement at any time by posting the revised version of this Agreement with an updated revision date. The changes will become effective and shall be deemed accepted by you, the first time you use or access the SDK or API after the initial posting of the revised Agreement and shall apply on a going-forward basis with respect to your use of the SDK or API. In the event that you do not agree with any such modification, your sole and exclusive remedy are to terminate your use of the SDK or API. -**16. Miscellaneous​** + -16.1 Assignment. Licensee may not assign this Agreement or any interest or rights granted hereunder to any third party without the prior written consent of Jupiter. A change of control or reorganization of Licensee pursuant to a merger, sale of assets or stock shall be deemed to be an assignment under this Agreement. This Agreement shall terminate immediately upon the occurrence of any prohibited assignment. +### 15. Miscellaneous​ -16.2 Waiver. No failure by either party to exercise or enforce any of its rights under this Agreement will act as a waiver of such rights and no waiver of a breach in a particular situation shall be held to be a waiver of any other or subsequent breach. +15.1. Assignment. Licensee may not assign this Agreement or any interest or rights granted hereunder to any third party without the prior written consent of Jupiter. A change of control or reorganization of Licensee pursuant to a merger, sale of assets or stock shall be deemed to be an assignment under this Agreement. This Agreement shall terminate immediately upon the occurrence of any prohibited assignment. -16.3 Severability. If any provision of this Agreement is found invalid or unenforceable, that provision will be enforced to the maximum extent possible and the other provisions of this Agreement will remain in force. +15.2. Waiver. No failure by either party to exercise or enforce any of its rights under this Agreement will act as a waiver of such rights and no waiver of a breach in a particular situation shall be held to be a waiver of any other or subsequent breach. -16.4 Entire agreement. This Agreement represents the complete agreement concerning the API, SDK and oral amendments are void. If any provision of this Agreement is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. +15.3. Severability. If any provision of this Agreement is found invalid or unenforceable, that provision will be enforced to the maximum extent possible and the other provisions of this Agreement will remain in force. -16.5 Neither Party hereto shall be responsible for any failure to perform its obligations under this Agreement if such failure is caused by acts of God, war, strikes, revolutions, lack or failure of transportation facilities, laws or governmental regulations or other causes that are beyond the reasonable control of such Party. Obligations hereunder, however, shall in no event be excused but shall be suspended only until the cessation of any cause of such failure. +15.4. Entire agreement. This Agreement represents the complete agreement concerning the API, SDK and oral amendments are void. If any provision of this Agreement is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. -16.6 By installing, copying, or otherwise using this API or SDK, you acknowledge that you have read, understand and agree to be bound by the terms and conditions indicated above. +15.5. By installing, copying, or otherwise using this API or SDK, you acknowledge that you have read, understand and agree to be bound by the terms and conditions indicated above. diff --git a/docs_versioned_docs/version-old/10-legal/2-terms-of-use.md b/docs_versioned_docs/version-old/10-legal/2-terms-of-use.md index 1f2e0902..cf1da1d6 100644 --- a/docs_versioned_docs/version-old/10-legal/2-terms-of-use.md +++ b/docs_versioned_docs/version-old/10-legal/2-terms-of-use.md @@ -1,28 +1,29 @@ # Terms of Use - + -Jupiter, https://jup.ag, a website-hosted user interface (the **"Interface"**) made available by Block Raccoon S.A. +**Jupiter**, https://jup.ag, a website-hosted user interface (the "Interface") made available by Block Raccoon S.A. -The Interface is a visual representation of Jupiter protocol (the **"Protocol"**) which comprises open source software deployed in a permissionless manner by Block Raccoon S.A. The Interface provides an interface which allows users to view and administer their interactions with the Protocol. +The Interface is a visual representation of Jupiter protocol (the "Protocol") which comprises open source software deployed in a permissionless manner by Block Raccoon S.A. The Interface provides an interface which allows users to view and administer their interactions with the Protocol. -These Terms of Use and any terms and conditions incorporated herein by reference (collectively, the **"Terms"**) govern your access to and use of the Interface. You must read the Terms carefully +These Terms of Use and any terms and conditions incorporated herein by reference (collectively, the "Terms") govern your access to and use of the Interface. You must read the Terms carefully. To make these Terms easier to read: -Block Raccoon S.A. is referred to as "Jupiter", "we", "us", "our" or "the Company". -"You", "your" and "user(s)" refers to anybody who accesses or uses, in any way, the Interface. If you are accessing or using the Interface on behalf of a company (such as your employer) or other legal entity, you represent and warrant that you have the authority to bind that entity to these Terms and, in that case, "you", "your" or "user(s)" will refer to that entity. +- Block Raccoon S.A.is referred to as "Jupiter", "we", "us", "our" or "the Company". +- "You", "your" and "user(s)" refers to anybody who accesses or uses, in any way, the Interface. If you are accessing or using the Interface on behalf of a company (such as your employer) or other legal entity, you represent and warrant that you have the authority to bind that entity to these Terms and, in that case, "you", "your" or "user(s)" will refer to that entity. + By accessing, browsing, or otherwise using the Interface, or by acknowledging agreement to the Terms on the Interface, you agree that you have read, understood, and accepted all of the Terms and our Privacy Policy (the "Privacy Policy"), which is incorporated by reference into the Terms. IMPORTANT NOTE REGARDING ARBITRATION: WHEN YOU AGREE TO THESE TERMS BY USING OR ACCESSING THE INTERFACE, YOU ARE AGREEING TO RESOLVE ANY DISPUTE BETWEEN YOU AND JUPITER THROUGH BINDING, INDIVIDUAL ARBITRATION RATHER THAN IN COURT. AND YOU AGREE TO A CLASS ACTION WAIVER, BOTH OF WHICH IMPACT YOUR RIGHTS AS TO HOW DISPUTES ARE RESOLVED. -If you come up with any further questions, please, dont be shy and feel free to contact us at legal@jup.ag. +If you come up with any further questions, please, dont be shy and feel free to contact us at `legal@jup.ag`. -**1. Eligibility​** +### 1. Eligibility​ -General. You may not use the Interface if you are otherwise barred from using the Interface under applicable law. +_General_. You may not use the Interface if you are otherwise barred from using the Interface under applicable law. -Legality. You are solely responsible for adhering to all laws and regulations applicable to you and your use or access to the Interface. Your use of the Interface is prohibited by and otherwise violate or facilitate the violation of any applicable laws or regulations, or contribute to or facilitate any illegal activity. +_Legality_. You are solely responsible for adhering to all laws and regulations applicable to you and your use or access to the Interface. Your use of the Interface is prohibited by and otherwise violate or facilitate the violation of any applicable laws or regulations, or contribute to or facilitate any illegal activity. The Interface and each of the Company's services does not constitute, and may not be used for the purposes of, an offer or solicitation to anyone in any jurisdiction in which such offer or solicitation is not authorised, or to any person to whom it is unlawful to make such an offer or solicitation. @@ -30,59 +31,45 @@ By using or accessing the Interface, you represent to us that you are not subjec We make no representations or warranties that the information, products, or services provided through our Interface, are appropriate for access or use in other jurisdictions. You are not permitted to access or use our Interface in any jurisdiction or country if it would be contrary to the law or regulation of that jurisdiction or if it would subject us to the laws of, or any registration requirement with, such jurisdiction. We reserve the right to limit the availability of our Interface to any person, geographic area, or jurisdiction, at any time and at our sole and absolute discretion. -Prohibited Localities. Jupiter does not interact with digital wallets located in, established in, or a resident of the United States, the Republic of China, Singapore, Myanmar (Burma), Cote D'Ivoire (Ivory Coast), Cuba, Crimea and Sevastopol, Democratic Republic of Congo, Iran, Iraq, Libya, Mali, Nicaragua, Democratic People’s Republic of Korea (North Korea), Somalia, Sudan, Syria, Yemen, Zimbabwe or any other state, country or region that is subject to sanctions enforced by the United States, the United Kingdom or the European Union. You must not use any software or networking techniques, including use of a Virtual Private Network (VPN) to modify your internet protocol address or otherwise circumvent or attempt to circumvent this prohibition. +_Prohibited Localities_. Jupiter does not interact with digital wallets located in, established in, or a resident of the United States, the Republic of China, Singapore, Myanmar (Burma), Cote D'Ivoire (Ivory Coast), Cuba, Crimea and Sevastopol, Democratic Republic of Congo, Iran, Iraq, Libya, Mali, Nicaragua, Democratic People’s Republic of Korea (North Korea), Somalia, Sudan, Syria, Yemen, Zimbabwe or any other state, country or region that is subject to sanctions enforced by the United States, the United Kingdom or the European Union. You must not use any software or networking techniques, including use of a Virtual Private Network (VPN) to modify your internet protocol address or otherwise circumvent or attempt to circumvent this prohibition. -Non-Circumvention. You agree not to access the Interface using any technology for the purposes of circumventing these Terms. +_Non-Circumvention_. You agree not to access the Interface using any technology for the purposes of circumventing these Terms. -**2. Compliance Obligations​** +### 2. Compliance Obligations​ The Interface may not be available or appropriate for use in all jurisdictions. By accessing or using the Interface, you agree that you are solely and entirely responsible for compliance with all laws and regulations that may apply to you. You further agree that we have no obligation to inform you of any potential liabilities or violations of law or regulation that may arise in connection with your access and use of the Interface and that we are not liable in any respect for any failure by you to comply with any applicable laws or regulations. -**3. Access to the Interface​** +### 3. Access to the Interface​ We reserve the right to disable access to the Interface at any time in the event of any breach of the Terms, including without limitation, if we, in our sole discretion, believe that you, at any time, fail to satisfy the eligibility requirements set forth in the Terms. Further, we reserve the right to limit or restrict access to the Interface by any person or entity, or within any geographic area or legal jurisdiction, at any time and at our sole discretion. We will not be liable to you for any losses or damages you may suffer as a result of or in connection with the Interface being inaccessible to you at any time or for any reason. The Interface and the Protocol may rely on or utilise a variety of external third party services or software, including without limitation oracles, decentralised cloud storage services, analytics tools, hence the Interface or the Protocol may be adversely affected by any number of risks related to these third party services/software. These may include technical interruptions, network congestion/failure, security vulnerabilities, cyberattacks, or malicious activity. Access to the Interface or the Protocol may become degraded or unavailable during times of significant volatility or volume. This could result in the inability to interact with third-party services for periods of time and may also lead to support response time delays. The Company cannot guarantee that the Interface or the Protocol will be available without interruption and neither does it guarantee that requests to interact with third-party services will be successful. You agree that you shall not hold the Company responsible for any losses which occur due to any of the foregoing. -**4. Your Use of Interface​** +### 4. Your Use of Interface​ By using or accessing the Interface, you represent and warrant that you understand that there are inherent risks associated with virtual currency, and the underlying technologies including, without limitation, cryptography and blockchain, and you agree that Jupiter is not responsible for any losses or damages associated with these risks. You specifically acknowledge and agree that the Interface facilitates your interaction with decentralized networks and technology and, as such, we have no control over any blockchain or virtual currencies and cannot and do not ensure that any of your interactions will be confirmed on the relevant blockchain and do not have the ability to effectuate any cancellation or modification requests regarding any of your interactions. Without limiting the foregoing, you specifically understand and hereby represent your acknowledgment of the following: -The pricing information data provided through the Interface does not represent an offer, a solicitation of an offer, or any advice regarding, or recommendation to enter into, a transaction with the Interface. - -The Interface does not act as an agent for any of the users. - -The Interface does not own or control any of the underlying software through which blockchain networks are formed, and therefore is not responsible for them and their operation. - -You are solely responsible for reporting and paying any taxes applicable to your use of the Interface. - -Although it is intended to provide accurate and timely information on the Interface, the Interface or relevant tools may not always be entirely accurate, complete, or current and may also include technical inaccuracies or typographical errors. Accordingly, you should verify all information before relying on it, and all decisions based on information contained on the Interface or relevant tools are your sole responsibility. +- The pricing information data provided through the Interface does not represent an offer, a solicitation of an offer, or any advice regarding, or recommendation to enter into, a transaction with the Interface. +- The Interface does not act as an agent for any of the users. +- The Interface does not own or control any of the underlying software through which blockchain networks are formed, and therefore is not responsible for them and their operation. +- You are solely responsible for reporting and paying any taxes applicable to your use of the Interface. +- Although it is intended to provide accurate and timely information on the Interface, the Interface or relevant tools may not always be entirely accurate, complete, or current and may also include technical inaccuracies or typographical errors. Accordingly, you should verify all information before relying on it, and all decisions based on information contained on the Interface or relevant tools are your sole responsibility. In order to allow other users to have a full and positive experience of using the Interface you agree that you will not use the Interface in a manner that: -Breaches the Terms; - -Infringes on or violates any copyright, trademark, service mark, patent, right of publicity, right of privacy, or other proprietary or intellectual property rights under the law; - -Seeks to interfere with or compromise the integrity, security, or proper functioning of any computer, server, network, personal device, or other information technology system, including, but not limited to, the deployment of viruses and denial of service attacks; - -Attempts, in any manner, to obtain the private key, password, account, or other security information from any other user, including such information about the digital wallet; - -Decompiles, reverse engineer, or otherwise attempt to obtain the source code or underlying ideas or information of or relating to the Interface; - -Seeks to defraud us or any other person or entity, including, but not limited to, providing any false, inaccurate, or misleading information in order to unlawfully obtain the property of another; - -Violates any applicable law, rule, or regulation concerning the integrity of trading markets, including, but not limited to, the manipulative tactics commonly known as spoofing and wash trading; - -Violates any applicable law, rule, or regulation of the United States or another relevant jurisdiction, including, but not limited to, the restrictions and regulatory requirements imposed by U.S. law; - -Disguises or interferes in any way with the IP address of the computer you are using to access or use the Interface or that otherwise prevents us from correctly identifying the IP address of the computer you are using to access the Interface; - -Transmits, exchanges, or is otherwise supported by the direct or indirect proceeds of criminal or fraudulent activity; - -Contributes to or facilitates any of the foregoing activities. +- Breaches the Terms; +- Infringes on or violates any copyright, trademark, service mark, patent, right of publicity, right of privacy, or other proprietary or intellectual property rights under the law; +- Seeks to interfere with or compromise the integrity, security, or proper functioning of any computer, server, network, personal device, or other information technology system, including, but not limited to, the deployment of viruses and denial of service attacks; +- Attempts, in any manner, to obtain the private key, password, account, or other security information from any other user, including such information about the digital wallet; +- Decompiles, reverse engineer, or otherwise attempt to obtain the source code or underlying ideas or information of or relating to the Interface; +- Seeks to defraud us or any other person or entity, including, but not limited to, providing any false, inaccurate, or misleading information in order to unlawfully obtain the property of another; +- Violates any applicable law, rule, or regulation concerning the integrity of trading markets, including, but not limited to, the manipulative tactics commonly known as spoofing and wash trading; +- Violates any applicable law, rule, or regulation of the United States or another relevant jurisdiction, including, but not limited to, the restrictions and regulatory requirements imposed by U.S. law; +- Disguises or interferes in any way with the IP address of the computer you are using to access or use the Interface or that otherwise prevents us from correctly identifying the IP address of the computer you are using to access the Interface; +- Transmits, exchanges, or is otherwise supported by the direct or indirect proceeds of criminal or fraudulent activity; +- Contributes to or facilitates any of the foregoing activities. As it has been already stated, we only provide you with the relevant interface and software and neither has control over your interactions with the blockchain nor encourages you to perform any. Any interaction performed by you via the Interface remains your sole responsibility. @@ -92,7 +79,7 @@ The Terms are not intended to, and do not, create or impose any fiduciary duties You understand that smart contract protocols such as the Protocol simply comprise a set of autonomous blockchain-based smart contracts deployed on the relevant blockchain network, operated directly by users calling functions on it (which allows them to interact with other users in a multi-party peer-to-peer manner). There is no further control by or interaction with the original entity which had deployed the smart contract, which entity solely functions as a provider of technical tools for users, and is not offering any sort of securities product or regulated service nor does it hold any user assets on custody. Any rewards earned by user interactions arise solely out of their involvement in the protocol by taking on the risk of interacting with other users and the ecosystem. -**5. Non-custodial nature of Interface and Protocol** +### 5. Non-custodial nature of Interface and Protocol The Interface and Protocol are non-custodial in nature, therefore neither holds or controls your digital assets. Any digital assets which you may acquire through the usage of the Interface or the Protocol will be held and administered solely by you through your selected electronic wallet, and we shall have no access to or responsibility in regard to such electronic wallet or digital asset held therein. It is solely your responsibility to select the wallet service provider to use, and your use of such electronic wallet will be subject to the governing terms of use or privacy policy of the provider of such wallet. We neither own nor control your selected electronic wallet service, the relevant blockchain network, or any other third party site, product, or service that you might access, visit, or use for the purpose of enabling you to utilise the Interface or the Protocol. We will not be liable for the acts or omissions of any such third parties, nor will we be liable for any damage that you may suffer as a result of your transactions or any other interaction with any such third parties. @@ -100,9 +87,10 @@ We will not create any hosted wallet for you or otherwise custody digital assets Neither the Company, the Interface nor the Protocol provides any digital asset exchange or portfolio/fund management services. If you choose to engage in transactions with other users via the Interface or the Protocol, then such decisions and transactions and any consequences flowing therefrom are your sole responsibility. In no event shall the Company, its affiliates or their respective directors or employees be responsible or liable to you or anyone else, directly or indirectly, for any damage or loss arising from or relating to any interaction or continued interaction with the Interface or the Protocol or in reliance on any information provided on the Interface (including, without limitation, directly or indirectly resulting from errors in, omissions of or alterations to any such information). -"Know Your Customer" and "Anti-Money Laundering" checks: We reserve the right to conduct "Know Your Customer" and "Anti-Money Laundering" checks on you if deemed necessary by us (at our sole discretion) or such checks become required under applicable laws in any jurisdiction. Upon our request, you shall immediately provide us with information and documents that we, in our sole discretion, deem necessary or appropriate to conduct "Know Your Customer" and "Anti-Money Laundering" checks. Such documents may include, but are not limited to, passports, driver's licenses, utility bills, photographs of associated individuals, government identification cards or sworn statements before notaries or other equivalent professionals. Notwithstanding anything herein, we may, in its sole discretion, refuse to provide access to the Interface to you until such requested information is provided, or in the event that, based on information available to us, you are suspected of using the Interface or the Protocol in connection with any money laundering, terrorism financing, or any other illegal activity. In addition, we shall be entitled to use any possible efforts for preventing money laundering, terrorism financing or any other illegal activity, including without limitation monitoring of transactions which you perform, screening of your digital wallet addresses, performing analytics on the foregoing as well as any related transactions or digital wallet address, blocking of your access to the Interface or the Protocol, or providing your information to any regulatory authority. +"Know Your Customer" and "Anti-Money Laundering" checks +We reserve the right to conduct "Know Your Customer" and "Anti-Money Laundering" checks on you if deemed necessary by us (at our sole discretion) or such checks become required under applicable laws in any jurisdiction. Upon our request, you shall immediately provide us with information and documents that we, in our sole discretion, deem necessary or appropriate to conduct "Know Your Customer" and "Anti-Money Laundering" checks. Such documents may include, but are not limited to, passports, driver's licenses, utility bills, photographs of associated individuals, government identification cards or sworn statements before notaries or other equivalent professionals. Notwithstanding anything herein, we may, in its sole discretion, refuse to provide access to the Interface to you until such requested information is provided, or in the event that, based on information available to us, you are suspected of using the Interface or the Protocol in connection with any money laundering, terrorism financing, or any other illegal activity. In addition, we shall be entitled to use any possible efforts for preventing money laundering, terrorism financing or any other illegal activity, including without limitation blocking of your access to the Interface or the Protocol, or providing your information to any regulatory authority. -**6. Disclaimers​** +### 6. Disclaimers​ You understand and agree that the Interface enables access to an online, decentralized, and autonomous protocol and environment, and associated decentralized networks, that are not controlled by Jupiter. We do not have access to your private key and cannot initiate an interaction with your virtual currency or otherwise access your virtual currency. We are not responsible for any activities that you engage in when using your wallet, or the Interface. @@ -116,7 +104,7 @@ By accessing and using the Interface, you represent that you understand (a) the The Interface may contain references or links to third-party resources, including, but not limited to, information, materials, products, or services, that we do not own or control. In addition, third parties may offer promotions related to your access and use of the Interface. We do not endorse or assume any responsibility for any such resources or promotions. If you access any such resources or participate in any such promotions, you do so at your own risk, and you understand that the Terms do not apply to your dealings or relationships with any third parties. You expressly relieve us of any and all liability arising from your use of any such resources or participation in any such promotions. -**7. Intellectual Proprietary Rights​** +### 7. Intellectual Proprietary Rights​ We own all intellectual property and other rights in the Interface and its contents, including, but not limited to, software, text, images, trademarks, service marks, copyrights, patents, and designs. Unless expressly authorized by us, you may not copy, modify, adapt, rent, license, sell, publish, distribute, or otherwise permit any third party to access or use the Interface or any of its contents. Accessing or using the Interface does not constitute a grant to you of any proprietary intellectual property or other rights in the Interface or its contents. @@ -128,38 +116,38 @@ If (i) you satisfy all of the eligibility requirements set forth in the Terms, a In the event that you utilise any intellectual property in any manner which infringes on the rights of any party (including by unauthorised incorporation of the same in any project, protocol, code or any digital token), the Company reserves the sole discretion to effectuate the takedown of any such project, protocol, code or any digital token (or underlying intellectual property) at any time, without notice, compensation or payment to you. In addition, and without prejudice to the Company's other remedies under this Agreement, you shall indemnify the Company and its officers, directors, employees, contractors, agents, affiliates, and subsidiaries from and against all claims, damages, obligations, losses, liabilities, costs, and expenses arising from your aforesaid infringement of intellectual rights. -**8. Indemnification​** +### 8. Indemnification​ You agree to hold harmless, release, defend, and indemnify us and our officers, directors, employees, contractors, agents, affiliates, and subsidiaries from and against all claims, damages, obligations, losses, liabilities, costs, and expenses arising from (a) your access to and use of the Interface; (b) your violation of these Terms, the right of any third party, or any other applicable law, rule, or regulation; and (c) any other party’s access and use of the Interface with your assistance or using any device or account that you own or control. -**9. Limitation of Liability​** +### 9. Limitation of Liability​ Under no circumstances shall we or any of our officers, directors, employees, contractors, agents, affiliates, or subsidiaries be liable to you for any indirect, punitive, incidental, special, consequential, or exemplary damages, including (but not limited to) damages for loss of profits, goodwill, use, data, or other intangible property, arising out of or relating to any access to or use of the Interface, nor will we be responsible for any damage, loss, or injury resulting from hacking, tampering, or other unauthorized access to or use of the Interface, or from any access to or use of any information obtained by any unauthorized access to or use of the Interface. We assume no liability or responsibility for any: (a) errors, mistakes, or inaccuracies of content; (b) personal injury or property damage, of any nature whatsoever, resulting from any access to or use of the Interface; (c) unauthorized access to or use of any secure server or database in our control or the use of any information or data stored therein; (d) interruption or cessation of function related to the Interface; (e) bugs, viruses, trojan horses, or the like that may be transmitted to or through the Interface; (f) errors or omissions in, or loss or damage incurred as a result of, the use of any content made available through the Interface; and (g) the defamatory, offensive, or illegal conduct of any third party. Under no circumstances shall we or any of our officers, directors, employees, contractors, agents, affiliates, or subsidiaries be liable to you for any claims, proceedings, liabilities, obligations, damages, losses, or costs in an amount exceeding the greater of (i) the amount you paid to us in exchange for access to and use of the Interface, or (ii) $100.00. This limitation of liability applies regardless of whether the alleged liability is based on contract, tort, negligence, strict liability, or any other basis, and even if we have been advised of the possibility of such liability. Some jurisdictions do not allow the exclusion of certain warranties or the limitation or exclusion of certain liabilities and damages. Accordingly, some of the disclaimers and limitations set forth in the Terms may not apply to you. This limitation of liability shall apply to the fullest extent permitted by law. -**10. Arbitration and Class Action Waiver​** +### 10. Arbitration and Class Action Waiver​ -Binding Arbitration. Except for disputes in which either party seeks to bring an individual action in small claims court or seeks injunctive or other equitable relief for the alleged unlawful use of copyrights, trademarks, trade names, logos, trade secrets or patents, you and the Jupiter: (a) waive the right to have any and all disputes or claims arising from these Terms, your use or access to the Interface or any other disputes with the Jupiter (collectively, "Disputes") resolved in a court; and (b) waive any right to a jury trial. Instead, you and the Jupiter agree to arbitrate Disputes that are not resolved informally (as described below) through binding arbitration (i.e. the referral of a Dispute to one or more persons charged with reviewing the Dispute and making a final and binding determination to resolve it) instead of having the Dispute decided by a judge or jury in court. +_Binding Arbitration_. Except for disputes in which either party seeks to bring an individual action in small claims court or seeks injunctive or other equitable relief for the alleged unlawful use of copyrights, trademarks, trade names, logos, trade secrets or patents, you and the Jupiter: (a) waive the right to have any and all disputes or claims arising from these Terms, your use or access to the Interface or any other disputes with the Jupiter _(collectively, "Disputes")_ resolved in a court; and (b) waive any right to a jury trial. Instead, you and the Jupiter agree to arbitrate Disputes that are not resolved informally (as described below) through binding arbitration (i.e. the referral of a Dispute to one or more persons charged with reviewing the Dispute and making a final and binding determination to resolve it) instead of having the Dispute decided by a judge or jury in court). -No Class Arbitrations, Class Actions or Representative Actions. You and Jupiter agree that any dispute is personal to you and Jupiter and that any such dispute will be resolved solely through individual arbitration and will not be brought as a class arbitration, class action, or any other type of representative proceeding. Neither party agrees to class arbitration or to an arbitration in which an individual attempts to resolve a dispute as a representative of another individual or group of individuals. Further, you and the Jupiter agree that a dispute cannot be brought as a class, or other types of representative action, whether within or outside of arbitration, or on behalf of any other individual or group of individuals. +_No Class Arbitrations, Class Actions or Representative Actions_. You and Jupiter agree that any dispute is personal to you and Jupiter and that any such dispute will be resolved solely through individual arbitration and will not be brought as a class arbitration, class action, or any other type of representative proceeding. Neither party agrees to class arbitration or to an arbitration in which an individual attempts to resolve a dispute as a representative of another individual or group of individuals. Further, you and the Jupiter agree that a dispute cannot be brought as a class, or other types of representative action, whether within or outside of arbitration, or on behalf of any other individual or group of individuals. -Process. You and the Jupiter agree that each will notify the other, in writing, of any Dispute within thirty (30) days of when it arises so that the parties can attempt, in good faith, to resolve the Dispute informally. Notice to Jupiter shall be provided by sending an email to legal@jup.ag. Your notice must include (1) your name, postal address, and email address; (2) a description of the nature or basis of the Dispute; and (3) the specific action that you are seeking. If you and the Jupiter cannot resolve the Dispute within thirty (30) days of the Jupiter receiving the notice, either you or Jupiter may, as appropriate pursuant to this Section 10, commence an arbitration proceeding. You and Jupiter agree that any arbitration or claim must be commenced or filed within one (1) year after the Dispute arose; otherwise, you and the Jupiter agree that the claim is permanently barred (which means that you will no longer have the right to assert a claim regarding the Dispute). +_Process_. You and the Jupiter agree that each will notify the other, in writing, of any Dispute within thirty (30) days of when it arises so that the parties can attempt, in good faith, to resolve the Dispute informally. Notice to Jupiter shall be provided by sending an email to legal@jup.ag. Your notice must include (1) your name, postal address, and email address; (2) a description of the nature or basis of the Dispute; and (3) the specific action that you are seeking. If you and the Jupiter cannot resolve the Dispute within thirty (30) days of the Jupiter receiving the notice, either you or Jupiter may, as appropriate pursuant to this Section 12, commence an arbitration proceeding. You and Jupiter agree that any arbitration or claim must be commenced or filed within one (1) year after the Dispute arose; otherwise, you and the Jupiter agree that the claim is permanently barred (which means that you will no longer have the right to assert a claim regarding the Dispute). -Choice of Law. These Terms are governed by and will be construed under the laws of Panama, without regard to principles of conflict of laws, govern the Terms and any Dispute between you and us. Any Dispute under these Terms shall be finally settled by Binding Arbitration (as defined below). Any unresolved Dispute arising out of or in connection with these Terms shall be referred to and finally resolved by arbitration under the rules of the London Court of International Arbitration (LCIA), which rules are deemed to be incorporated by reference into this Section 10 to the extent they are consistent with it. Any dispute arising from or relating to the subject matter of these Terms shall be finally settled in London, United Kingdom, in English, in accordance with the LCIA Arbitration Rules. Unless we agree otherwise, the arbitrator may not consolidate your claims with those of any other party. Any judgment on the award rendered by the arbitrator may be entered in any court of competent jurisdiction, to the extent a court therein would be deemed to be a court of competent jurisdiction other than any court located in the United States of America. You further agree that the Interface shall be deemed to be based solely in Panama and that, although the Interface may be available in other jurisdictions, its availability does not give rise to general or specific personal jurisdiction in any forum outside Panama. +_Choice of Law_. These Terms are governed by and will be construed under the laws of Panama, without regard to principles of conflict of laws, govern the Terms and any Dispute between you and us. Any Dispute under these Terms shall be finally settled by Binding Arbitration (as defined below). Any unresolved Dispute arising out of or in connection with these Terms shall be referred to and finally resolved by arbitration under the rules of the London Court of International Arbitration (LCIA), which rules are deemed to be incorporated by reference into this Section 12 to the extent they are consistent with it. Any dispute arising from or relating to the subject matter of these Terms shall be finally settled in London, United Kingdom, in English, in accordance with the LCIA Arbitration Rules. Unless we agree otherwise, the arbitrator may not consolidate your claims with those of any other party. Any judgment on the award rendered by the arbitrator may be entered in any court of competent jurisdiction, to the extent a court therein would be deemed to be a court of competent jurisdiction other than any court located in the United States of America. You further agree that the Interface shall be deemed to be based solely in Panama and that, although the Interface may be available in other jurisdictions, its availability does not give rise to general or specific personal jurisdiction in any forum outside Panama. -Authority of Arbitrator. As limited by these Terms and applicable arbitration rules, the arbitrator will have: (a) the exclusive authority and jurisdiction to make all procedural and substantive decisions regarding a Dispute; and (b) the authority to grant any remedy that would otherwise be available in court. The arbitrator may only conduct an individual arbitration and may not consolidate more than one individual s claims, preside over any type of class or representative proceeding or preside over any proceeding involving more than one individual. +_Authority of Arbitrator_. As limited by these Terms and applicable arbitration rules, the arbitrator will have: (a) the exclusive authority and jurisdiction to make all procedural and substantive decisions regarding a Dispute; and (b) the authority to grant any remedy that would otherwise be available in court. The arbitrator may only conduct an individual arbitration and may not consolidate more than one individual s claims, preside over any type of class or representative proceeding or preside over any proceeding involving more than one individual. -**11. Miscellaneous​** +### 11. Miscellaneous​ -Changes. We may amend any portion of these Terms at any time by posting the revised version of these Terms with an updated revision date. The changes will become effective and shall be deemed accepted by you, the first time you use or access the Interface after the initial posting of the revised Terms and shall apply on a going-forward basis with respect to your use of the Interface including any transactions initiated after the posting date. In the event that you do not agree with any such modification, your sole and exclusive remedy are to terminate your use of the Interface. +_Changes_. We may amend any portion of these Terms at any time by posting the revised version of these Terms with an updated revision date. The changes will become effective and shall be deemed accepted by you, the first time you use or access the Interface after the initial posting of the revised Terms and shall apply on a going-forward basis with respect to your use of the Interface including any transactions initiated after the posting date. In the event that you do not agree with any such modification, your sole and exclusive remedy are to terminate your use of the Interface. -Entire Agreement. These Terms (and any additional terms, rules, and conditions of participation that may be posted on the website of Jupiter) including the Privacy Policy constitute the entire agreement with respect to the Interface and supersedes any prior agreements, oral or written. +_Entire Agreement_. These Terms (and any additional terms, rules, and conditions of participation that may be posted on the website of Jupiter) including the Privacy Policy constitute the entire agreement with respect to the Interface and supersedes any prior agreements, oral or written. -Privacy Policy. The Privacy Policy describes the ways we collect, use, store and disclose your personal information. You agree to the collection, use, storage, and disclosure of your data in accordance with the Privacy Policy. +_Privacy Policy_. The Privacy Policy describes the ways we collect, use, store and disclose your personal information. You agree to the collection, use, storage, and disclosure of your data in accordance with the Privacy Policy. -Severability. If any provision of these Terms shall be determined to be invalid or unenforceable under any rule, law, or regulation of any local, state, or federal government agency, such provision will be changed and interpreted to accomplish the objectives of the provision to the greatest extent possible under any applicable law and the validity or enforceability of any other provision of these Terms shall not be affected. If such construction is not possible, the invalid or unenforceable portion will be severed from these Terms but the rest of these Terms will remain in full force and effect. +_Severability_. If any provision of these Terms shall be determined to be invalid or unenforceable under any rule, law, or regulation of any local, state, or federal government agency, such provision will be changed and interpreted to accomplish the objectives of the provision to the greatest extent possible under any applicable law and the validity or enforceability of any other provision of these Terms shall not be affected. If such construction is not possible, the invalid or unenforceable portion will be severed from these Terms but the rest of these Terms will remain in full force and effect. -Survival. Upon termination of these Terms for any reason, all rights and obligations of the parties that by their nature are continuing will survive such termination. +_Survival_. Upon termination of these Terms for any reason, all rights and obligations of the parties that by their nature are continuing will survive such termination. -English language. Notwithstanding any other provision of these Terms, any translation of these Terms is provided for your convenience. The meanings of terms, conditions, and representations herein are subject to their definitions and interpretations in the English language. In the event of conflict or ambiguity between the English language version and translated versions of these terms, the English language version shall prevail. You acknowledge that you have read and understood the English language version of these Terms. +_English language_. Notwithstanding any other provision of these Terms, any translation of these Terms is provided for your convenience. The meanings of terms, conditions, and representations herein are subject to their definitions and interpretations in the English language. In the event of conflict or ambiguity between the English language version and translated versions of these terms, the English language version shall prevail. You acknowledge that you have read and understood the English language version of these Terms. -If you have any questions, claims, complaints, or suggestions, please, contact us at legal@jup.ag. +If you have any questions, claims, complaints, or suggestions, please, contact us at `legal@jup.ag`. diff --git a/docs_versioned_docs/version-old/2-apis/7-cpi.md b/docs_versioned_docs/version-old/2-apis/7-cpi.md index c1633cde..c9f4965c 100644 --- a/docs_versioned_docs/version-old/2-apis/7-cpi.md +++ b/docs_versioned_docs/version-old/2-apis/7-cpi.md @@ -13,12 +13,6 @@ title: Jupiter Swap via CPI To integrate your program with Jupiter Swap you can take two approaches. One is [Flash Filling](/docs/old/APIs/flash-fill) or you can utilize Cross Program Invocation (CPI). -:::note CPI is recommended -As of January 2025, Jupiter Swap via CPI is recommended for most users. - -The `Loosen CPI restriction` feature has been deployed on Solana, you can find more information [here](https://github.com/solana-labs/solana/issues/26641). -::: - :::danger CPI Limitations As of August 2023, taking the CPI approach has some tradeoffs. Due to Solana's transaction limit of 1232 bytes, swaps via CPI will likely fail at runtime since Jupiter routes may involve multiple DEXes in order to reduce price impact. You could set a limit to the number of accounts used for swaps via Jupiter's swap API to fit it within your needs. However, limiting the accounts will likely incur greater price impact. @@ -26,7 +20,7 @@ _Note: when using Jupiter's API, you can set [maxAccounts](/docs/old/APIs/swap-a ::: :::info Use Flash-Fill -An alternative method is to use the [flash-fill](/docs/old/APIs/flash-fill) approach. The flash-fill approach takes advantage of [Versioned Transaction](https://docs.solana.com/developing/versioned-transactions) in combination with [Address Lookup Tables](https://docs.solana.com/developing/lookup-tables) to allow for more accounts per transaction while keeping within the 1232 bytes limit. +Instead, we recommend taking the [flash-fill](/docs/old/APIs/flash-fill) approach. The flash-fill approach takes advantage of [Versioned Transaction](https://docs.solana.com/developing/versioned-transactions) in combination with [Address Lookup Tables](https://docs.solana.com/developing/lookup-tables) to allow for more accounts per transaction while keeping within the 1232 bytes limit. ::: ## Example @@ -65,7 +59,7 @@ use jupiter_cpi; let signer_seeds: &[&[&[u8]]] = &[...]; // pass accounts to context one-by-one and construct accounts here. -// Or in practice, it may be easier to use `remaining_accounts` https://book.anchor-lang.com/anchor_in_depth/the_program_module.html +// Or in practise, it may be easier to use `remaining_accounts` https://book.anchor-lang.com/anchor_in_depth/the_program_module.html let accounts = jupiter_cpi::cpi::accounts::SharedAccountsRoute { token_program: , program_authority: , diff --git a/docusaurus.config.js b/docusaurus.config.js index f98fd263..a60fa73a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -4,7 +4,6 @@ const lightCodeTheme = require("prism-react-renderer/themes/github"); const darkCodeTheme = require("prism-react-renderer/themes/dracula"); const redirects = require('./redirects.json'); -const { UnfoldHorizontal } = require("lucide-react"); require("dotenv").config(); /** @type {import('@docusaurus/types').Config} */ @@ -115,6 +114,8 @@ const config = { require.resolve("./src/css/custom.css"), require.resolve("./src/css/navbar.css"), require.resolve("./src/css/sidebar.css"), + require.resolve("./src/css/searchbar.css"), + require.resolve("./src/css/apepro.css"), ], }, proxy: { @@ -132,10 +133,23 @@ const config = { /** @type {import('@docusaurus/plugin-content-docs').Options} */ ({ id: "guides", + lastVersion: 'current', + versions: { + current: { + label: 'Latest', + path: '', + badge: false, + }, + old: { + label: 'Old', + path: 'old', + banner: 'unmaintained', + } + }, path: "guides", routeBasePath: "guides", sidebarPath: require.resolve("./sidebars-guides.js"), - sidebarCollapsed: true, + sidebarCollapsed: false, editUrl: "https://github.com/jup-ag/space-station/tree/main/", }), ], @@ -188,7 +202,9 @@ const config = { }, items: [ { to: 'guides', label: 'Guides', position: 'left' }, - { to: 'docs/index', label: 'Docs', position: 'left' }, + { to: 'docs', label: 'Docs', position: 'left' }, + { to: 'https://jup.com', label: 'Jupiverse', position: 'left' }, + { type: 'search', position: 'right' }, ], }, algolia: { diff --git a/guides/0-onboard/adding-funds.md b/guides/0-onboard/adding-funds.md new file mode 100644 index 00000000..235ee76f --- /dev/null +++ b/guides/0-onboard/adding-funds.md @@ -0,0 +1,65 @@ +--- +sidebar_label: "Adding Funds" +title: Adding Funds +sidebar_position: 1 +description: Learn how to add funds to your wallet. +--- + + + Adding Funds + + + +Jupiter makes it easier than ever to convert your local currency into crypto assets on Solana through its seamless Onramp integration. + +With Onramper, Jupiter’s direct Onramp application lets you purchase Solana assets directly using your local currency. This tool aggregates the best onramp services like Stripe, Banxa, and MoonPay to provide the most competitive rates and options based on your region, amount, and payment method. + +--- + +## How It Works + +1. **Access the Onramp App:** Select the Onramp option at https://jup.ag/onboard/. +2. **Set Preferences:** + - Choose your language, review terms, and find support if needed. +3. **Choose Currency & Asset:** + - Input the amount you’d like to spend and select the Solana asset you want to purchase. + - We recommend always buying SOL, so you can use it for transaction fees and easily swap to other assets via Jupiter for the best price. +4. **Select Payment Processor:** + - Pick your desired processor from the list of available options. +5. **Complete the Transaction:** + - Click "Buy" and complete the transaction on the payment processor’s secure site. A new tab will open to finalize the purchase. + +:::note Fees +Jupiter **does not charge any additional fees** for Onramp transactions. +::: + +:::note Support +If you need help, please reach out to us on [Discord](https://discord.gg/jup). + +We will do our best to help you, however, please note that we are not the Onramp service nor the payment processor. +::: + +## Onramp UI + +1. **Options Menu:** Select your language preferences, review the Terms of Usage and Privacy Policy, and find Help & Support here. +2. **You Spend:** Selector to choose the currency and input the amount you would like to spend on your purchase. +3. **Spend Currency:** The currency you are spending. +4. **You Get:** Selector to choose the Solana asset and the output amount of that asset you will get for your input spend amount. +5. **Token:** The Solana asset you are purchasing. +6. **Payment Processor Selector:** Select your preferred payment processor to complete the Onramp purchase. +7. **Pay Using:** A dropdown to choose the payment method to use for the purchase. This includes credit, debit, Apple Pay, Google Pay and ACH options. +8. **Buy Button:** Click this to begin the Onramp purchase transaction. + +Once you click `Buy Button`, a new tab will open for you to complete the transaction through the payment processor's site with the inputs specified above. + +![Onramp UI](../../static/onboard/onramp.png) + +--- + +## CEX Transfers to Solana + +Transferring assets to Solana has never been easier. If you are looking to transfer assets from a Centralized Exchange (CEX), each CEX may have different requirements for external transfers. Be sure to refer to their respective guides for step-by-step instructions. + +:::tip +Always transfer a small amount first to ensure your wallet address is correct. +::: diff --git a/guides/0-onboard/bridging-funds.md b/guides/0-onboard/bridging-funds.md new file mode 100644 index 00000000..808c883a --- /dev/null +++ b/guides/0-onboard/bridging-funds.md @@ -0,0 +1,33 @@ +--- +sidebar_label: "Bridging Funds" +title: Bridging Funds +sidebar_position: 1 +description: Learn how to bridge funds to your wallet. +--- + + + Bridging Funds + + + +The crypto world is like a universe of isolated planets—each blockchain a silo of liquidity. But what if you could move seamlessly between these worlds? Thats where bridges come in. Bridges are the portals of the blockchain realm, designed to securely transfer assets across different chains. + +--- + +## What Are Bridges and How Do They Work? + +Bridges are specialized applications that handle assets the movement of assets between chains. They act as the middlemen, ensuring your tokens travel securely from one blockchain to another. There are different types of bridges, but on the surface, they mostly work in a similar fashion. + +1. **Start on the Bridge App:** Open the bridge application you plan to use. +2. **Connect Your Source Wallet:** This is the wallet that will fund your transaction. +3. **Select Tokens and Amounts:** Choose the token and amount you want to transfer from your source wallet. +4. **Connect Your Destination Wallet:** This wallet will receive your funds after the bridge process. +5. **Choose Destination Token:** Select the token you want to receive on the destination chain. +6. **Review Transaction Preview:** Check the total fees and amounts. +7. **Approve Transactions:** Confirm two separate transactions, one for the source chain and one for the destination chain. + +This process ensures your assets are safely transferred, but always double-check wallet addresses and token details to avoid mishaps. + +:::note +If you need any help with this, feel free to [reach out to us on our Discord](https://discord.gg/jup) and our team or community will walk you through the steps! +::: \ No newline at end of file diff --git a/guides/0-onboard/index.md b/guides/0-onboard/index.md new file mode 100644 index 00000000..28926a07 --- /dev/null +++ b/guides/0-onboard/index.md @@ -0,0 +1,58 @@ +--- +sidebar_label: "Onboarding" +title: Onboarding +sidebar_position: 1 +description: Learn how to onboard to Solana. +--- + + + Onboarding + + + +Welcome to Jupiverse and Solana! In this section, we will onboard you smoothly and get you started with Jupiter. + +--- + +## Getting Started with Jupiter + +- Download the Jupiter mobile app from your device's app store + + - [Android](https://play.google.com/store/apps/details?id=ag.jup.jupiter.android) + - [iOS](https://apps.apple.com/us/app/jupiter-mobile/id6484069059) + +- Access other Jupiter products on web (https://jup.ag/) and use the Magic Scan feature to log in +- Jupiter's mobile app offers several advantages: + + - **Seamless Onboarding**: Get started in minutes with an intuitive setup process + - **User-Friendly Interface**: Clean, smooth, and easy-to-navigate design + - **Wallet Connect**: Works flawlessly with other Solana applications + +:::tip Get invited by a friend +Get started with a mobile invite code from an existing user where they fund you some SOL to start! +::: + +:::info Alternative:Traditional Wallet Setup +You can also set up a Solana wallet (e.g., Phantom, Solflare, Backpack). +::: + +## Understanding Wallet Security + +1. **Never Disclose** + - Seed/recovery phrase + - Private keys + - Any sensitive wallet information + +2. **Safe Practices** + - Only connect to trusted, verified websites + - Verify all transaction details before signing + - Be cautious of phishing attempts + +3. **Support Channel Safety** + - Official support is only available through our Discord server + - Never trust direct messages claiming to be support + - Jupiter team will never ask for your private keys or seed phrase + +## Understanding Wallet Funding + +Every blockchain transaction requires a small fee (paid in SOL). These fees compensate validators for processing transactions as they help maintain the Solana blockchain and process/verify transactions. diff --git a/guides/0-onboard/security.md b/guides/0-onboard/security.md new file mode 100644 index 00000000..98b537cb --- /dev/null +++ b/guides/0-onboard/security.md @@ -0,0 +1,145 @@ +--- +sidebar_label: "Security" +description: Keeping your assets secure as you enjoy Jupiter and Solana. +title: Security +--- + + + Security + + + +:::tip This is a community contributed guide +This is a community guide to personal security on Solana, created by [@julianhzhu](https://twitter.com/julianhzhu). + +Anyone can contribute a guide to Jupiter Station! Simply send us a PR. +::: + +Personal security on Solana can be understood in two parts - **private key security** and **transaction security**. + +## Private Key Security + +Private key security is about ensuring that your private keys stay private and only known to you. +:::info +Like all blockchains, your assets on Solana are not actually “stored” in your wallet, they are “stored” on accounts on the blockchain. +::: +Whoever has the private key will be able to sign transactions and transfer these assets in the wallet to other accounts on the blockchain. Hence it is extremely important that you keep your private key safe and only known to yourself. + +Closely related to the private key is the concept of a seed phrase/passphrase. These are usually made up of 12 or 24 random words. Each passphrase can typically be used to generate many private keys and their corresponding public addresses. If your passphrase is stolen, the hacker will get access to **all** your wallets controlled by that passphrase. + +### Quick Recap + +- **One** seed phrase/passphrase → can generate **many** private keys. +- **One** private key → **One** public key/wallet address +- Whoever has the private key can take ownership of the assets on the wallet, so we should keep this private. + +### For the regular Web3 user + +:::tip A few simple steps you can take + +- Never screenshot or store your private key & seed phrases in plain text. +- If you need to store them on any device, consider using a password manager for example [Bitwarden](https://bitwarden.com/) that has a free version for personal use. This will ensure that they are stored with **encryption**. +- Install a trustworthy antivirus and malware scanner and keep it up-to-date with regular scheduled scans. E.g. [Bitdefender](https://www.bitdefender.com/), [Malwarebytes](https://www.malwarebytes.com/) are some of the highly-rated ones with a free option available for basic use. +- Avoid pointing any camera at your seed phrase & private key or revealing it in public. + +::: + +### Other Considerations + +#### Physical Security + +- Who else has access to the space where your device is stored? +- Are your hardware wallets and backups locked up in a safe? +- Do you have secondary backups in second physically secure location? + +#### Hardware + +- How secure is the user’s device? Are there any backdoors on the device itself? + +#### Software + +- Malware, virus, malicious files that scan your filesystem and steal the keypair files +- Input capture such as keyloggers, screen capture applications + +#### Best Practices + +- Use a safe hardware wallet where the private key never leaves the wallet. +- Consider the use of multisig wallets with keys stored separately and safely for high-valued assets. +- Encrypt all files containing the private key when stored on the local filesystem. +- Be careful when installing any software that may capture your system’s inputs and/or scan your file system. +- Avoid installing any fake/pirated software as these often contain malware. +- Install all wallet software from official sites only, double-check they are the correct URL before downloading as there are many fake wallet sites. + +## Transaction Security + +The second aspect of personal on-chain security is transaction security. This is different from private key security in that attackers do not need to get hold of your private key in order to steal your funds from you. All they need to do is to trick you to sign a transaction that does a malicious transfer of assets. + +The good news is that preventing this type of attacks is easy and 100% within your control as long as you incorporate a few good practices to your journey on Solana. + +### Transaction Simulation + +Transaction simulation by modern Solana wallets are extremely powerful tools to help safeguard you from loss of funds. + +Always pay attention to what is written and if a transaction simulation fails or is reverted, as a general rule, do **NOT** sign the transaction. You really only want to break this rule if you are a thousand percent certain that the site you are on is a legitimate site and that there is a very good reason that you are aware of as to why the transaction is failing to simulate. + +### Understanding URL Structure + +Learning to recognise the structure of URLs is very important so that you can avoid fraudulent sites. This practice is called typo-squatting and malicious sites will go to great lengths to mimic legitimate sites with the only difference being a single character in the URL. + +**Let’s take a look at an example** + +https://lfg.jup.ag/jup + +The trick is to always look for the position of the **dots** (periods) in the URL. + +A URL will either have 1 or 2 dots. + +In the example above, there are 2 dots, one after “lfg” and one after “jup”/before "ag". Double-check it for yourself and make sure you are following along with this example. + +Since there are 2 dots in this URL, then what you need to pay attention to is what is **after the first dot**. For example lfg.jup.ag, after the first dot is “jup.ag”. **If this is an official domain then it is safe.** + +If there is only 1 dot in an URL, for example https://twitter.com then you need to pay attention to the **parts surrounding the dot**. If that makes an official website domain, then the URL is safe. An example twitter.io would not be safe and could be malicious for example. + +Scammers will often register similar-looking domains such as lfg-jup.ag to try and trick you. Notice in this case there is only 1 dot, hence you need to look at both parts surrounding the dot. Clearly lfg-jup.ag is NOT an official site and it is a fake site trying to trick you. + +Here are some more links for you to practice your scam-link identification skills. Some of the urls may not even exist. The list is just for you to practice. + +- beta.jup.ag ✅ + - 2 dots, so we look at what's after the first dot, in this case jup.ag is an official site. +- www.jup.ag ✅ + - 2 dots, so we look at what's after the first dot, in this case jup.ag is an official site. +- beta-jup.ag ❌ + - 1 dot, so we look at what's surrounding the dot, in this case beta-jup.ag is not an official site. +- jup-ag.com ❌ + - 1 dot, so we look at what's surrounding the dot, in this case jup-ag.com is not an official site. +- jup.io ❌ + - 1 dot, so we look at what's surrounding the dot, in this case jup.io is not an official site. +- lfg-jup-ag.com ❌ + - 1 dot, so we look at what's surrounding the dot, in this case lfg-jup-ag.com is not an official site. +- jup.jup.ag ✅ + - 2 dots, so we look at what's after the first dot, in this case jup.ag is an official site. + +**Alpha:** You can also use this method to sometimes guess what the actual URLs of new releases or features may be and get there before everyone else! + +:::tip + +Always **double-check the URL** of the domain in the browser URL bar before interacting with any site. +::: + +### Social engineering attacks + +This can happen in Discord, Telegram, Twitter, basically anywhere with communication taking place. How it works is that scammers will try to post a fake link. If you are careful and check the URL in the browser bar before doing anything on a site, you will be safe. + +Note, even if you accidentally connect your wallet, As long as you did not sign any transactions, you are still safe. See the part on transaction simulation as a safeguard. + +### For the regular Web3 user + +:::tip A few simple steps you can take + +- Never rush. Whenever you rush, it is more likely that you will make mistakes. +- Avoid signing a transaction that does not clearly simulate in the wallet. Read all balance changes shown in the simulation carefully before signing any transaction. +- If you really really have to sign something on an untrusted site or sign a transaction that does not simulate, always use a separate wallet with very limited funds to minimize any possibility of a malicious transaction draining all of your funds. Creating a new wallet is very easy on most wallet apps and it is very cheap to fund new wallets on Solana due to low fees. Don’t be cheap or lazy. + +::: + +And with that, I wish you all the best on your journey on Solana. It no doubt has one of the best user experience across any blockchain and by following these tips I have shared here, I am confident that you will have a great time here. \ No newline at end of file diff --git a/guides/100-spot/100-instant/0-quickstart.md b/guides/100-spot/100-instant/0-quickstart.md new file mode 100644 index 00000000..e98bcb80 --- /dev/null +++ b/guides/100-spot/100-instant/0-quickstart.md @@ -0,0 +1,50 @@ +--- +title: Swap Quickstart +description: Introduction to Jupiter Swap +--- + + + Swap Quickstart + + + +Swapping tokens is a fundamental activity in the decentralized finance (DeFi), enabling users to trade from one cryptocurrency to another without relying on a centralized exchange or entity. + +On Solana, where speed and efficiency are paramount, **Jupiter Swap** focuses on providing you with safety, control and accessibility to diverse tokens with the best price. + +--- + +## What is a Token Swap? + +A token swap allows users to exchange from one cryptocurrency to another directly, using liquidity pools on DEXs. Instead of navigating multiple platforms to find the best rates or sufficient liquidity, Jupiter streamlines this process by aggregating routes and providing users with the most efficient and cost-effective paths for their trades. + +## Key Features of Jupiter Swap + +Solana is designed for trading, with its incredible speed and low transaction costs fueling the creation of thousands of new tokens, markets, and groundbreaking use cases. At **Jupiter**, our mission is to be your go-to platform—the **Everyday Exchange**—offering a smooth, reliable, and fast token-swapping experience. Here’s what makes swapping with Jupiter exceptional: + +### Trade with Safety + +Your safety and confidence are our priorities. Jupiter helps you make informed decisions by showing essential token details and trade conditions. + +- **Token Details:** View key information like metadata and authorities. +- **Filtered Search:** We automatically remove duplicate and imposter tokens while using community verification and real-time data (liquidity, volume) for smarter token searches. +- **Price Checks:** We estimate price impacts and cross check our quote prices with market prices to ensure you are notified of the trade outcome. + +### Trade with Control + +Whether you prefer simplicity or fine-tuned control, Jupiter has you covered: + +- **Auto Mode:** Set your max slippage and enable MEV protection, and we’ll handle the rest. Jupiter optimizes transaction fees, slippage, and market conditions for a hassle-free experience. +- **Manual Mode:** For advanced users who want full control, we offer options like Fixed Slippage and Dynamic Slippage settings. + +### Access to Diverse and New Tokens + +Jupiter Swap indexes all tradable tokens on Solana, providing accessibility and exposure to trade all types of assets (bluechips, liquid-staking tokens, memes, governance tokens, etc) and opportunities. + +Through **Instant Routing**, new markets on most DEXes are automatically added to Jupiter’s routing system, so you’ll always have access to the latest opportunities. + +### Access to Best Price + +Not all DEXs are built the same or have the same liquidity. Jupiter Swap ensures that users’ trades are routed through pools with the best liquidity at the point of quote, minimizing slippage and maximizing returns. + +This is all powered by our cutting-edge algorithms, the **Metis Routing Engine:**, ensuring you get the best rates with **zero protocol fees**. diff --git a/guides/100-spot/100-instant/1-how-swap-works.md b/guides/100-spot/100-instant/1-how-swap-works.md new file mode 100644 index 00000000..b916138f --- /dev/null +++ b/guides/100-spot/100-instant/1-how-swap-works.md @@ -0,0 +1,154 @@ +--- +sidebar_label: How Swap works +title: How Swap works? +description: Introduction to how Swap works +--- + + + How Swap works + + + +Jupiter Swap is simple to use but a complex system. In this article, we will breakdown the intricacies of how it works and how it has evolved over time. + +--- + +## Overview + +Jupiter Swap is built around various crucial on-chain data and using those data in algorithms or display them as information to aid users make informed swap decisions. + +Refering to the simple flowchart below, the sequence of events are as follows: + +1. You come to [jup.ag](https://jup.ag) or Jupiter Mobile. +2. You enter the tokens you want to swap. + + - Search Algorithm provides you with the results based on verification, volume, etc. + +3. You enter the amount to swap. + + - The Routing Engine will find the best possible swap based on on-chain liquidity data. + - The RFQ infrastructure will find market makers to fulfil the quote. + - Based on the results, we compare and provide you with the best amongst the two. + +4. You click swap, we build the transaction and send it on-chain to execute. + + - All through the simple interface. + +![Overview](../../../static/spot/swap/Overview.png) + + +## Best Experience + +Financial tools on blockchains can become complicated, actions such as handling slippage, preventing MEV, adjusting priority fees can become cumbersome to seasoned veterans and remain daunting for beginners. Solana trading environment is like nothing we have seen before, demanding a different level of execution. The Jupiter Swap interface is simple yet powerful, allowing you to swap with confidence, using token, price information and settings to ensure your swap works. + +### Ultra Mode + +Ultra Mode ⚡ is the best DeFi experience. +- It takes care of the entire execution flow and settings. +- 0 transaction fees (we pay all on your behalf even failed transactions). +- 0.1% swap fee applies (to help us help you land transactions effectively). +- Real Time Slippage Estimator (RTSE) uses real time historical data to estimate the slippage of your trade. +- Optimised transaction landing to ensure your transaction is paying sufficient priority fees without overpaying. + +### Manual Mode + +Switch to Manual Mode ⚙️, if you're a seasoned user and prefers to customise your settings with precision. +- You control your own exact slippage threshold and priority fees. +- You pay your own transaction fees but no additional swap fee applies. +- You get to utilise the full suite of swap settings (offered no where else) which includes AMM exclusions, custom transaction broadcast methods, etc. + +## Best Token Selection + +Since late 2023 and onwards, we see a gigantic surge in the number of tokens being minted and actively traded on Solana. Through this period, Jupiter has rebuilt and strengthen its infrastructure to scale with the big growing demand of trading new tokens. + +### Ecosystem List + +The Jupiter Ecosystem List started off as a simple Github CSV (deprecated) file where token creators can create Pull Requests to get themselves "strict listed" or verified. The list grew popular and became widely used in the ecosystem. However, as more tokens appeared, more pull requests were created, which significantly increased our manual load to hand verify each token. + +Today, the Ecosystem List is run by a group of contributors from various parts of our community. Additionally, more parameters are automatically reflected in the portal to aid them in verification of the tokens legitimacy/credibility. + +:::note Resources! +[Read about the full backstory and thought process](https://www.jupresear.ch/t/ecosystem-master-token-list/19786). + +[Read about the community verification process](https://www.jupresear.ch/t/get-your-token-a-community-tag-beta/18963). + +To verify your token, [check out this guide](./how-to-get-your-token-on-jupiter) or [head over to the site now](https://catdetlist.jup.ag/). + +Do note that this process will continue to improve/evolve and might have changes in the future. +::: + +### Search Algorithm + +With the Ecosystem List, there are still tens of thousands of tokens out in the wild. In order to prevent malicious or scam tokens from being bought, we apply a smart algorithm to the token search function. + +- Simple match algorithm to search token name or symbol. +- Direct token address search. +- Flag potential malicious tokens. + + - Tokens with name or symbol including a potential token address of another token. + - Tokens with freeze authority, transfer tax, permanent delegate, etc. + +### Organic Index + +Metrics like holders, volume and TVL can be easily gameable, we've built an organic index by using real time transactions from real user wallets to determine the organic score of tokens. + + +You can also [watch the workshop on YouTube](https://youtu.be/ieVMQPIVLe0?feature=shared)! + +
+ +
+ +## Best Price + +By default, Jupiter ensures you are getting the best price by comparing the Routing Engine results to the RFQ results. The following explains further of how each mechanism works to provide you with the best price. + +### Metis Routing Engine + +Pre 2023, there were only a handful of DEXes/AMMs built on the Solana blockchain. At that time, it was simpler to aggregate and provide the best possible route (less permutations of markets and tokens). However, as Solana gain traction, more market volume as well as more DEXes being built. + +Over time, Jupiter went through a few iterations of its routing engine and have been using the Metis version since. It is a heavily modified variant of the [Bellman-Ford algorithm](https://en.wikipedia.org/wiki/Bellman%E2%80%93Ford_algorithm) catered for the key requirements of offering best price routing at scale in a very dynamic operational space. + +- Operate seamlessly with Solana's hyper-fast blocktimes. +- Route can be provided quickly (without compromising on best price). +- Handle load and demand efficiently. + +![Metis Routing Engine](../../../static/spot/swap/Metis.png) + +You can also [watch it on YouTube](https://youtu.be/m29UNEFYWUE?si=wTWi-pfg9EwE4Wuz)! + +
+ +
+ +### JupiterZ + +JupiterZ, also known as Request For Quote (RFQ), is a pricing mechanism where users request a quote for a specific trade from a permissioned set of off-chain market makers, who then fulfil your swap request on-chain if you choose to accept. + +On-chain AMMs and DEXes continue to be complicated and volatile, Jupiter aggregates them to achieve the best price derived on-chain, however, with off-chain market makers, we can greatly improve user experience. + +1. Market makers offer firm quotes (guaranteed prices) instead of relying on fluctuating on-chain liquidity pools. + + - **0% slippage** + - **MEV protected** + +2. Market makers execute the swap for you. + - **0 transaction fees** diff --git a/guides/100-spot/100-instant/100-how-to-swap.md b/guides/100-spot/100-instant/100-how-to-swap.md new file mode 100644 index 00000000..15090645 --- /dev/null +++ b/guides/100-spot/100-instant/100-how-to-swap.md @@ -0,0 +1,82 @@ +--- +sidebar_label: How to swap +title: How to swap +description: Guide to your first Swap with Jupiter +--- + + + Swap Guide: Swap + + + +Swapping tokens on Jupiter is as easy as it gets! Whether you're diving into Solana for the first time or just want to make your trades more efficient, we’ve got you covered. Follow these simple steps, and you’ll be swapping like a pro in no time. + +--- + +:::tip Are you a beginner? +If this is your very first interaction in crypto, Web3, Solana, get started with the basics and necessary set ups in this guide. + +[Get Started!](./) +::: + +## Step 1: Pick Your Tokens + +Now, let’s set up your trade: + +1. In the **From** field, select the token you want to sell or trade. + + - Use the dropdown menu or search for the token name. + +2. In the **To** field, select the token you want to buy or receive. + +*[Screenshot: Swap interface showing selected tokens in both fields]* + +:::caution +It is always a good habit to use the token's mint address as the source of truth. + +If you use the name or symbol/ticker to search for the token, always cross reference the mint address. +::: + +## Step 2: Enter the Amount + +Enter how much of the token you want to sell in the **From** field. Jupiter will instantly calculate and reflect on the interface: + +- **Output Amounts:** How much you’ll get back. + + 1. The total output amount of the swap + 2. The minimum output amount (after accounting for slippage) of the swap + +- **Route Details:** Jupiter's GPS for your tokens. + + You can find and open the **1 Market** or **2 Routes + 2 Markets** above the Swap Button. It will show you the exact order routing path for the quote. + +You’ll also see some handy details which can help you make informed decisions: + +- **Price Impact:** Price Impact is influenced by the available liquidity to settle the trade. The larger the trade the larger the price impact on the selected assets. + +*[Screenshot: Swap interface with amount entered and trade details highlighted]* + +## Step 3: Review and Swap + +Here comes the fun part! + +1. Double-check the trade details like the amounts to sell and buy, the tokens involved. +2. Click **Swap** to kick things off. +3. Approve the transaction in your wallet when it pops up. +4. Once confirmed, track your transaction on the Solana blockchain explorer or Jupiter Portfolio. + +*[Screenshot: Swap confirmation screen with trade summary highlighted]* + +## Optional Step: Tweak the Settings + +Your swap is by default in **Auto Mode** where, Jupiter handles it for you by optimizing settings for an easy and quick swap. However, you can customize your preferred settings: + +1. Switch from Auto mode to **Manual mode**. +2. Adjust your **Settings**, mainly Slippage mode and Transaction Broadcasting settings, [read more about what these mean here](./). +3. Ensure your settings like the slippage threshold and transaction fees being paid are within your expectations. + +*[Screenshot: Settings menu with slippage and transaction speed options highlighted]* + +## Troubleshooting + +We've got your back! Reach out to us on [Discord](https://discord.gg/jup). \ No newline at end of file diff --git a/guides/100-spot/100-instant/102-how-to-swap-safely.md b/guides/100-spot/100-instant/102-how-to-swap-safely.md new file mode 100644 index 00000000..33f90c56 --- /dev/null +++ b/guides/100-spot/100-instant/102-how-to-swap-safely.md @@ -0,0 +1,87 @@ +--- +sidebar_label: How to swap safely +title: How to swap safely +description: Guide to Swap Safety +--- + + + Swap Guide: Swap Safety + + + +Swapping tokens is exciting, but staying safe is crucial. Jupiter equips you with the right tools and information to ensure you can make an well-informed swap decision. Let’s dive into how you can make the most of these safety features. + +--- + +## Swap Summary + +The summary provides key details about your trade, including the minimum amount you'll receive, transaction fees, and the price difference compared to the market rate. + +## Token Information + +Jupiter provides key token details to help bridge any information gaps you might encounter while trading. + +1. **Token Verification:** + + Verified tokens are clearly marked as `Verified ✅` or `Not Verified ⚠️`, giving you quick insight into their legitimacy. + + :::note Jupiter Community Verification + [Learn about how Jupiter Community verifies tokens in the Solana ecosystem.](./) + ::: + +2. **Token Shield:** (revisit) + + Based on price and liquidity checks of the token you are buying, we are able to detect if the token can be sold. If the token cannot be sold, we will display a warning to help you make an informed decision. + +3. **Token Features or Extensions:** + + Additionally, some tokens retain features or extensions which is displayed as easy-to-spot information pills for added clarity. + +### Common Token Features or Extensions on Solana + +| | **Definition** | **Valid Use** | **Misuse** | +|---|---|---|---| +| **Permanent Delegate** | Allows creators to grant unlimited delegation privileges over any account for that mint, including burning or transferring any tokens from any account. | Enables automatic payments, wallet recovery, and processing refunds. | Scam projects could drain tokens from users' wallets. | +| **Transfer Tax** | Enables fees to be withheld on each transfer, redeemable by those with withdraw authority. | Allows projects to generate revenue through service charges, or to collect royalties or taxes on transfers. | Scam projects might arbitrarily increase transaction taxes for the wrong intentions. | +| **Freeze Authority** | Allows issuers to halt token transfers or trading, temporarily or permanently. | Commonly used for regulated tokens (e.g., stablecoins) to meet legal standards; issuers can freeze tokens for compliance with legal or regulatory concerns. | Scam projects might use this to prevent selling or transferring, enabling market manipulation or potential fraud. | + +--- + +## Warnings + +Trading tokens can be thrilling, but it's essential to stay cautious to avoid unnecessary risks. Here are some key warnings that Jupiter shows to keep your Swap in check. + +1. **Price Impact** + + Price Impact is influenced by the available liquidity to settle the trade. The larger the trade the larger the price impact on the selected assets. + + :::tip + Try swapping with smaller sizes or use DCA with high frequency to sell your tokens gracefully. + ::: + +2. **JupiterZ (RFQ) Only Mode** + + JupiterZ is in beta production stage and it does not support all tokens, hence using JupiterZ **Only** Mode might result in unavailable swaps. + +3. **Exactout Mode** + + ExactOut occurs when you specify the exact amount of tokens you want to buy/receive rather than sell. However, ExactOut is not a widely supported option across all DEXes, leading to potential unfavorable swaps. + +4. **Direct Route Mode** + + When enabled, your swaps will route without intermediate tokens or hops, which results in routing using only 1 pool. This may often result in unfavorable swaps, with worse price or huge price impact. + +5. **Exclude AMMs** + + When enabled, your swaps will route through pools that are not excluded. This may often result in unfavorable swaps, but can be useful in times of bad pools. + + If you identify or suspect of a pool not working well, report to Jupiter's team on [Discord](https://discord.gg/jup). + +6. **Jito Only Mode** + + When enabled, Jupiter will only send your transactions directly to Jito block engines. This allows prevents and reduces the chances of sandwiching or being frontrun. + + :::caution + However, do note that this comes with higher transaction fees (in the form of Jito Tips) and lower transaction success rates. + ::: + diff --git a/guides/100-spot/100-instant/103-how-to-configure-swap-settings.md b/guides/100-spot/100-instant/103-how-to-configure-swap-settings.md new file mode 100644 index 00000000..75540190 --- /dev/null +++ b/guides/100-spot/100-instant/103-how-to-configure-swap-settings.md @@ -0,0 +1,60 @@ +--- +sidebar_label: How to configure swap settings +title: How to configure swap settings +description: Guide to Swap Settings +--- + + + Swap Guide: Swap Settings + + + +Trading on a blockchain comes with unique settings that might seem daunting at first but are essential for a secure and seamless experience. Here’s a detailed guide to help you navigate transaction fees, slippage, and advanced customization options on Jupiter. + +--- + +Jupiter is designed to make these configurations easier for everyone. Our platform offers two modes to suit different types of traders. + +- **Auto Mode:** Ideal for beginners, where settings are dynamically optimized for you. +- **Manual Mode:** Fine tune control for experienced users. + +Let’s break down each mode and how to make the most of them. + +## Auto Mode + +Auto Mode is recommended for beginners or traders who prefer simplicity. + +- **Dynamic Slippage:** + + Jupiter calculates the ideal slippage threshold based on factors like the token categories and simulations. + +- **Dynamic Transaction Fees:** + + The maximum capacity of your transaction fees are estimated using your trade size, the larger the size, the higher the cap, ensuring a balance of not overpaying and transaction success/speed. + +- **Jito Only (optional):** + + Minimize the risk of sandwich/frontrun attacks by sending transactions directly to Jito block engines. However, this might lead to higher transaction fees and lower success rates + +Swap with confidence! If you need any assistance, please reach out to us in [Discord](https://discord.gg/jup). + +## Manual Mode + +For advanced users who prefer granular control, Manual Mode lets you customize key settings: + +| Slippage Settings | Breakdown | +|---|---| +| **Dynamic** | Estimates a threshold based on the token categories and simulations. | +| **Fixed** | Set a specific percentage threshold for tighter control. | + +| Transaction Broadcasting Settings | Breakdown | +|---|---| +| **Broadcast Mode** | **Priority Fee:** Use a typical RPC with a Priority Fee to speed up inclusion.

**Jito Only:** Use a Jito RPC with a Jito tip to prevent sandwich/frontrun.

**Both:** Send your transaction via both methods.

*When using both at the same time, your priority fee will be paid when landed via typical RPCs. Both your priority fee and jito tip will be paid when landed via Jito client validators.* | +| **Speed**

*Used with `Fee Mode: Max Cap`.* | **Fast:** 25th percentile. Lowest fees but might yield slower and high rates of unsuccessful transactions.

**Turbo:** 50th percentile. Recommended to balance not overpaying while optimize for success rates.

**Ultra:** 75th Percentile. Highest fees optimized for transaction landing, especially for time critical swaps. | +| **Fee Mode** | **Max Cap:** When enabled, Jupiter estimates the transaction fees for you, and during transaction submission, it will never use more than your max cap.

**Exact Fee:** When enabled, you define the exact fee you want to use, this might not be favorable as you will need to estimate accurately for every swap. | + +## Advanced Settings + +- **Direct Route Only:** Restrict your trade to a single liquidity pool. While this simplifies routing, it might limit options and lead to less optimal prices. +- **Use wSOL:** Wrapped SOL (wSOL) makes frequent SOL trades faster by avoiding the need to wrap/unwrap tokens manually. +- **AMM Exclusion:** Exclude specific Automated Market Makers (AMMs) from routing. Keep in mind, this isn’t a permanent setting and resets after refreshing the page. \ No newline at end of file diff --git a/guides/100-spot/100-instant/104-how-to-get-your-token-on-jupiter.md b/guides/100-spot/100-instant/104-how-to-get-your-token-on-jupiter.md new file mode 100644 index 00000000..2d7ac318 --- /dev/null +++ b/guides/100-spot/100-instant/104-how-to-get-your-token-on-jupiter.md @@ -0,0 +1,84 @@ +--- +sidebar_label: How to get your token on Jupiter +title: How to get your token on Jupiter +description: Guide to Add Token to Jupiter +--- + + + Swap Guide: Add Token to Jupiter + + + +All tokens can be found on Jupiter, tokens that aren't verified are marked with a ⚠️ warning label, encouraging users to double-check mint addresses before trading. If you've created a token and want it verified on the Jupiter Ecosystem List, this guide will walkthrough the requirements. + +Tokens with liquidity pools that meet our liquidity requirement can be traded, if you have created a liquidity pool and want it to be routed on Jupiter, this guide will walkthrough the liquidity check. + +--- +## How to Get Your Token Verified + +**Step 1: Visit the Submission Portal:** + +Head over to [**catdetlist.jup.ag**](https://catdetlist.jup.ag/) to submit your token for review. + +**Step 2: Ensure Your Project Meets the Requirements:** + +To qualify for verification, your token must meet the following criteria: + +- **Age:** At least 21 days old. +- **Daily Volume:** More than $10,000 in trading volume. +- **Market Cap:** Exceed $100,000. +- **Unique Metadata:** Ensure the token's symbol and name are unique and not duplicates of existing projects. +- **Unique Holders:** Have more than 500 unique holders. + +:::warning Trade Without Verification +Your token doesn’t need to be verified to be tradable. Most new liquidity pools are supported for instant routing for 14 days. Afterward, pools are re-evaluated periodically. +::: + +:::tip Encourage Safe Trading +Remind your users to search using your **mint address** to ensure safe swaps. +::: + +:::tip Reach out for assistance +If you face any issues or have questions, feel free to [reach out to the community's token list channel on our Discord](https://discord.com/channels/897540204506775583/1076158397570875473). + +Do take note that the team and community members face large traffic of token listings everyday, we greatly appreciate your patience and we'll continue to look for ways to improve the process. +::: + +**Learn More About the Community Tag Initiative** + +Explore these resources to better understand the verification process: + +- 🌐 **Community Tag Application Site:** [catdetlist.jup.ag](https://catdetlist.jup.ag/) +- 📖 **Community Tag FAQ:** [FAQ Page](https://www.jupresear.ch/t/faq-jupiter-community-tag/23074) +- 🏷️ **Community Tag Overview:** [Overview Post](https://www.jupresear.ch/t/get-your-token-a-community-tag/18963) +- 📊 **Token API:** [Token API](https://station.jup.ag/docs) + +## How to Get Your Pool Routed on Jupiter + +To provide users access to new tokens, all new markets on supported AMMs are instantly routed for 14 days. + +After 14 days, markets that fit the criteria will continue to be routed on Jupiter. + +:::tip Supported AMMs +We currently support Fluxbeam, Meteora DLMM, Meteora CPMM, 1Intro, Pump.Fun, Raydium CLMM, Raydium CP, Raydium V4 and Whirlpools for Instant Routing. +::: + +To ensure your market gets routed on Jupiter after 14 days, your market must fit one of the following criteria: + +**1. Less than 30% price impact on $500** + +Using a benchmark position size of $500, a user should encounter less than 30% price impact after swapping in AND out of the token from the same pool. + +``` +Price Impact = ($500 - Final USD value) / $500 +``` + +For example, a user swaps $500 worth of SOL into the token, then swaps the same output amount back into SOL. We then use the formula to calculate the price impact percentage. + +If the price impact is more than 30%, it means that there is insufficient liquidity in the pool for the benchmark position size of $500. + +![Price Impact Criteria](../../../static/spot/swap/price-impact-criteria.jpg) + +***2. (For additional markets) Less than 20% price difference on new pools*** + +For additional markets on already supported tokens, there should be a variance of less than 20% between the new pool and the pool existing in routing. \ No newline at end of file diff --git a/guides/100-spot/100-instant/2-interface.md b/guides/100-spot/100-instant/2-interface.md new file mode 100644 index 00000000..c0ba7011 --- /dev/null +++ b/guides/100-spot/100-instant/2-interface.md @@ -0,0 +1,21 @@ +--- +sidebar_label: Swap Interface +title: Swap Interface +description: Introduction to Swap Interface +--- + + + Swap Interface + + + +In this section we go through what each setting on the Swap terminal means. + +- Swap Form +- Basic Swap Settings +- Advance Swap Settings +- Swap Chart +- Swap History +- Swap States? + +--- diff --git a/guides/100-spot/100-instant/3-security.md b/guides/100-spot/100-instant/3-security.md new file mode 100644 index 00000000..cc749126 --- /dev/null +++ b/guides/100-spot/100-instant/3-security.md @@ -0,0 +1,14 @@ +--- +sidebar_label: Swap Security +title: Swap Security +description: Understanding security of Jupiter Swap +--- + + + Swap Security + + + +Ensuring the security of your investments is paramount, we ensure our programs are audited and tested, additionally incorporating measures to protect against market exploitation. + +--- diff --git a/guides/100-spot/100-instant/4-faq.md b/guides/100-spot/100-instant/4-faq.md new file mode 100644 index 00000000..74e731fc --- /dev/null +++ b/guides/100-spot/100-instant/4-faq.md @@ -0,0 +1,74 @@ +--- +sidebar_label: Swap FAQ +title: Swap FAQ +description: Frequently Asked Questions of Jupiter Swap +--- + + + Swap FAQ + + + +In this section, we will cover the frequently asked questions of Jupiter Swap. + +:::note More Questions? +If you have more questions, please reach out to us on [Discord](https://discord.gg/jup) or open a ticket via the web chatbot below. +::: + +--- + +### 1. What are the fees associated with swaps? + +Using Ultra Mode has a 0.1% swap fee and we pay transactions fees on behalf of you (even failed ones), while Manual Mode does not incur any swap fee, but you pay transaction fees yourself. [Refer to Ultra and Manual Mode here](./how-swap-works#ultra-mode). + +:::note Other associated fees +Do take note, there are other associated fees / rent fees that may apply such as to create [ATA (Associated Token Accounts)](https://spl.solana.com/associated-token-account) or individual AMM fees. +::: + +### 2. Does the quote price include AMM fees? + +Yes. The quoted price, displayed when you enter your token and amount to swap, the quoted prices includes the AMM fees and price impact. + +### 3. Which wallets are supported? + +[Jup.ag](https://jup.ag) supports many types of wallets. We recommend using Jupiter Mobile App (scan to login!) or native Solana wallets such as Phantom, Solflare. You can find more wallets in the top right **"Connect Wallet"** buttonm, such as Google option via TipLink, WalletConnect and others. + +### 4. What should I do if my wallet doesn’t connect? + +It depends on what type of wallet you are using, you can try restart your browser, clear cache, rest wallet as a last option (but remember to write down your seedphrase/private key first!). However, if it is a non-native Solana wallet, please reach out to our team on [Discord](https://discord.gg/jup) to help take a look. + +### 5. What is slippage, and how do I adjust it? + +**Slippage** is the difference between the quoted proce and executed price. When you are quoted, it is based on latest market data, but by the time you execute your swap, the market has moved and the difference is the slippage. + +**Slippage Threshold** is a safety measure to apply on your swap, if your swap is 20% worse than what is quoted, and your slippage threshold is 1%, the swap will fail. + +**Ultra Mode** handles slippage threshold for you dynamically based on what you swap and market conditions. If you want to control your slippage threshold, you can use Manual Mode. + +### 6. Why is my transaction taking so long? + +In general, Solana transactions should land quickly, however, in times of congestion, your transaction might face difficulty landing due to various reasons. In Ultra Mode, Jupiter handles it for you, while in Manual Mode, you can still configure transaction broadcasting method or transaction fee amount. If you face any issues or need assistance, please reach out to us immediately on [Discord](https://discord.gg/jup). + +### 7. Why is my transaction failing? + +If it is failing due to slippage or transaction fees, refer to 4. and 5. above, however, if it is happening very often, [please reach out to us on Discord](https://discord.gg/jup). + +### 8. Why is my token frozen? + +If your token is frozen, this means that you have bought or received a token that retains its freeze authority functionality. Freeze authority allows the token owner to prevent a token account from selling or transferring the tokens out of the account. This can be useful is various situations, but can also be misused, [refer to this section to find out more](./how-to-swap-safely#common-token-features-or-extensions-on-solana). + +### 9. Can I swap any token pair? + +Yes (most)! Jupiter supports most DEXes/AMMs and aggregates pools that hit our liquidity requirements to be routable. + +### 10. How do I find out if my token is routed? + +In the Swap interface, you can attempt to swap the token, if the pool is tradable, it will be routed. If not it will show **"No route found"** in the swap button. If you have set up the necessary liquidity pools but cannot swap, [check out this guide](./how-to-get-your-token-on-jupiter#how-to-get-your-pool-routed-on-jupiter). + +### 11. What is JupiterZ and why should I use it? + +JupiterZ is our RFQ (Request For Quote) mechanism to allow for off-chain market makers to provide a quote and fulfil your swap trades. This method allows for guaranteed prices and they pay the transaction fee on behalf, JupiterZ is zero slippage and zero fees! + +### 12. Can I use Jupiter Swap programmatically? + +Yes! We have provisioned a Swap API for developers to build applications around it. We do support Price and Token API as well. [Find out more about our API in the developer documentation section](/docs)! diff --git a/guides/100-spot/200-trigger/0-quickstart.md b/guides/100-spot/200-trigger/0-quickstart.md new file mode 100644 index 00000000..d762ca19 --- /dev/null +++ b/guides/100-spot/200-trigger/0-quickstart.md @@ -0,0 +1,108 @@ +--- +title: Trigger Order Quickstart +description: Introduction to Jupiter Trigger Order +--- + + + Trigger Order Quickstart + + + +Trigger Order lets you buy or sell assets at a specified price, an alternative financial tool to market orders. Unlike market orders, trigger orders are not executed immediately at the current market price. They execute at a specific price at which you are willing to buy or sell. + +This allows you to have more control over your price instead of being at the mercy of the market. + +--- + +## What is Trigger Order? + +Trigger Order is like a reliable friend, always watching out for you and acting upon your needs. Instead of monitoring market conditions and price levels then execute based on those conditions on your own, Trigger Order helps you do just that. + +Here’s how it works: + +- You decide how much to buy or sell. +- You also decide at what price level. +- Jupiter keeps track of your order and market rates, and automatically executes your order via Jupiter Swap (with 0% slippage) when the condition of the price level is met. + +It’s simple and elegant to enter positions at your desired price level or exit positions to lock in profits. + +:::note Jupiter Trigger Order is different +Jupiter Trigger Order relies on the core mechanism of Jupiter Swap to execute your orders, which means it is different from the typical central limit orderbook (if you are familiar with traditional finance or centralized exchanges). + +[Read more about how it works here.](./how-trigger-order-works) +::: + +## Key Advantages of Trigger Orders + +1. **Price Control:** + + Trigger Order only executes at your desired price level. This allows you to have complete control over when the orders execute, instead of using market orders which prices can vary. + +2. **Reduced Emotional Trading:** + + By planning ahead and setting predefined prices you can avoid impulse decisions based trading and stick to your plan. + + +## When and how to use LO Effectively + +1. **When You Have a Target Price**: + + When you have a specific target price in mind and you are willing to wait. Limt order allows you to "set and forget" and automatically execute orders at your desired levels. + +2. **In Volatile Markets:** + + Instead of always monitoring price movements, Trigger Order allows you to set once and let the market play out on its own, and when volatily strikes, it will automatically capitalize on the price swings. + +3. **In Low Liquidity Markets:** + + In markets with low liquidity, Trigger Order ensures that you trade at favourable prices without suffering from price impacts and reducing loss of your potential profits. + +## Potential Use cases + +1. **Buying during price dips:** + + You can catch the tokens at lower prices without needing to time the market. + +2. **Selling to take profits:** + + You can take profits automatically by selling when the price hits your set target price. + +3. **Range Trading:** + + Trigger orders can be used for range trading strategies to buy near support levels and sell near resistance levels. + +4. **Trading in Illiquid Markets:** + + You can avoid large spreads by placing orders and ensuring that you get a favourable price. + +5. **Long Term Investing:** + + Investors can utilize Trigger Order to automatically accumulate assets at a target price across a longer timeframe. + +## How Every Investor Can Benefit from Trigger Orders + +- **For Beginners**: + + The core benefit for beginners is to remove emotional decision-making, which allows for better planning and discipline training. Additionally, it can help avoid overpaying or selling too cheaply. + +- **For Experienced Traders**: + + Traders can benefit from automation by setting trigger orders to buy/sell in fast-moving markets. They do not have to actively monitor the market. It prevents buying high or selling low during sudden market fluctuations. This can be applicable for other types of strategies too! + +- **For Long-Term Investors**: + + Trigger Order can used as a tool to aid accumulation or taking of profits at specific price points. + +## Why use Trigger Order on Jupiter? + +- **Best Prices**: + + Since it uses Jupiter Swap as the core execution mechanism, which means your Trigger Order gets the best price aggregated across Solana DeFi. Additionally, it allows for partial fulfilment of your orders to avoid price impact in illiquid markets, ensuring you always get the best deal available. + +- **User-Centric Design:** + + The simple interface works for beginners as well as experienced traders. + +- **Efficient Execution**: + + Jupiter prioritizes top liquid tokens or highly traded tokens in execution, this benefits sharper and higher execution rates for your orders. \ No newline at end of file diff --git a/guides/100-spot/200-trigger/1-how-trigger-order-works.md b/guides/100-spot/200-trigger/1-how-trigger-order-works.md new file mode 100644 index 00000000..d94d5082 --- /dev/null +++ b/guides/100-spot/200-trigger/1-how-trigger-order-works.md @@ -0,0 +1,99 @@ +--- +sidebar_label: How Trigger Order works +title: How Trigger Order works? +description: Introduction to how Trigger Order works +--- + + + How Trigger Order works + + + +Creating a Trigger Order is like setting up a reliable machine that monitors price conditions and execute your orders at the exact price, here’s how it works in a nutshell, let’s break it down into: + +- How the orders are created +- How your tokens are bought +- How the order is closed +- How Jupiter Trigger Order Differs from CLOB (Central Limit Order Book) + +--- + +Jupiter Trigger Order executes your order based on the price you have set by matching it with the available liquidity on-chain across Solana. This is not an order book system. The Trigger order system utilizes a keeper system to monitor token prices on-chain and trigger the fulfilment of orders if liquidity is available. + +In short, Jupiter Trigger Order is **an automated Jupiter Swap at 0% slippage**. + +## How the orders are created + +1. When you place a trigger order, the tokens you are selling, say USDC, will be transferred to an account co-owned with the Jupiter Trigger Order program. This also includes other information like the desired output mint, amount, expiry, etc. +2. Upon creation, the multiple keepers bots will constantly monitor your trigger order and the price condition. Think of keeper bots as the dedicated executors that work tirelessly to fill your order! + +::: + +## How your tokens are bought + +As mentioned, Jupiter Trigger Order is an automated Jupiter Swap at 0% slippage. The keeper bots does 2 main actions: monitoring and executing. + +1. Upon creation of order, the keeper bots constantly watches if the current market price has reached your specified price condition. +2. Upon meeting of price condition, the keeper bots attempts to fill the order using Jupiter Swap at 0% slippage. + +:::note Partial Fulfilment +If your order size is too large, the keeper bots will attempt for partial fulfilment to prevent price impact and maintain the exact market rate. + +However, this does not mean the order is complete, while the keeper bots will continue to try to fill the rest of the order. +::: + +:::note multiple keeper bots attempts +Jupiter utilizes multiple keeper bots to monitor and execute your orders. Hence, in most order histories, you can actually see the attempts of other keeper bots. +::: + +::::caution do not use as stop loss +Jupiter Trigger Order does not support using it as a **STOP LOSS**. + +If you attempt to set your order as a stop loss, the keeper bots will execute exactly as you quoted. + +Let's use this example: + +- Market Price: 1 SOL = 200 USDC +- Trigger Price: 1 SOL = 100 USDC +- Trigger Order: Sell 1 SOL to buy 100 USDC + +Refering to the image, you can see the warning of `Trigger price is 50% lower than market...`. This indicates that you are attempting to set a Trigger Order where the price level is lower than of market rate. + +The current Jupiter Trigger Order system does not support it as we do not utilize an oracle (a source of truth for price) to determine price checks and validity of the price/liquidity of the pool. If we cannot verify the price and liquidity of a pool, the execution may be invalid and wrongfully filled. + +:::note +The interface will attempt to prevent you from creating the order with sufficient warnings and checks, if you still manage to create, we are not liable for any of the loss. +::: + +![Trigger Order Connect Wallet](../../../static/spot/limit-order/limit-order-stop-loss.png) +:::: + +:::caution Price Wicks or Insufficient Liquidity +Jupiter Swap routes various DEXes which are built differently, the price condition being met does not always equate to sufficient liquidity for your order as other bots, users of Solana DeFi could have moved the market. + +When the market price reaches your trigger, your order becomes **eligible for execution**. Keepers attempt to fill it immediately. However, if the price briefly touches your trigger but lacks sufficient liquidity, the order may not execute fully. In such cases, you might notice failed transaction attempts in your wallet as the keepers repeatedly try to fill your order. +::: + +## How the Trigger Order is closed + +After the order is executed, regardless of partial or full fulfilment, the wallet which created the order will immediately and automatically receive the tokens you quoted for (minus platform fees charged by Jupiter). + +Upon 100% filled, the Trigger Order account will be closed on-chain and you should have received all of the amount. + +:::caution Caveat to Auto-Withdrawal: Keep Your ATAs Open +Always keep your Associated Token Accounts (ATAs) open! + +When creating the order, we automatically set up the necessary ATA for you to receive the tokens. However if you happen to close it, the Trigger Order will fail to fill the order as the transaction will fail. + +Hence, keep your ATAs open to ensure the order executes and transfers automatically into your wallet. +::: + +## How Jupiter Differs from CLOB (Central Limit Order Book) + +Central Limit Order Book (CLOB) is a mechanism used by traditional finance to facilitate trading between buyers and sellers. It acts as a hub where both buyers and sellers can submit their buy/sell orders, which are matched based on specific rules and executed accordingly. This mechanism requires a certain level of market-making for it to operate efficiently. For a particular market or token to be available for trading on the CLOB, it requires a market maker to be present and accessible. + +In contrast, Jupiter Trigger Order executes orders vaia Jupiter Swaps, an aggregated liquidity and markets based on more than 20 decentralized exchanges (DEXs) and automated market makers (AMMs). + +#### Why not CLOB? + +If Jupiter Trigger Order were to utilize the typical CLOB execution model, we will not be able to support **all tokens** across Solana DeFi seamlessly. There could be some improvements in terms of price or execution, however, we will lose the accessibility to the vast DeFi markets and introduce more user friction. diff --git a/guides/100-spot/200-trigger/100-how-to-create-trigger-order.md b/guides/100-spot/200-trigger/100-how-to-create-trigger-order.md new file mode 100644 index 00000000..c1dabe56 --- /dev/null +++ b/guides/100-spot/200-trigger/100-how-to-create-trigger-order.md @@ -0,0 +1,89 @@ +--- +sidebar_label: How to create a Trigger Order +title: How to create a Trigger Order +description: Guide to set up your first Trigger Order with Jupiter +--- + + + Create Trigger Order + + + +Setting up a Trigger Order plan on Jupiter is quick, simple, and designed to help you efficiently set up orders for your desired price levels to execute your strategy. + +--- + +## Step 1: Connect Your Wallet + +Before anything else, you’ll need to connect your wallet to Jupiter. + +1. Visit the [**Jupiter Trigger Order page**](https://jup.ag/limit). +2. Double-check that the URL is correct at https://jup.ag/limit and "Trigger” Tab is selected. +3. Click on the **“Connect Wallet”** button at the top right or use one of the other "Connect Wallet" buttons on the dashboard: Select your preferred wallet from the list (e.g., Phantom, Solflare, or any other supported wallet). +4. Approve the connection request in your wallet. + +![Trigger Order Connect Wallet](../../../static/spot/limit-order/limit-order-connect.png) + +## Step 2: Choose Your Tokens + +Now it’s time to decide which tokens you want to sell and buy. + +1. Upon clicking on the token selector to choose what token to sell and buy, the token list will open up. +2. Select the token you want to sell in the top selector, **“I Want To Allocate”**. +3. Select the token you want to buy in the bottom selector, **"To Buy”**. + +:::caution tokens not supported +Tokens with transfer fee extension enabled are not supported. +::: + +![Trigger Order Token Selector](../../../static/spot/limit-order/limit-order-tokens.png) + +## Step 3: Set Your Trigger Order + +1. **Enter the amount** of the token you are selling. +2. Enter the **rate** at which you want to buy/sell. This is the price at which the order will get executed at. + :::tip + Jupiter will calculate how many tokens you will get based on the input token amount and rate entered, shown in the **"You're Buying"** field. + ::: +3. Optional: **Choose the Expiry** of your order. This option lets you select the maximum period for which your order remains active. + :::tip + It can be 10 minutes or by default it is set to never expire. The expiry option ensures that if the order is not executed in your specific time then it will cancel. + ::: + +![Trigger Order Form Set Up](../../../static/spot/limit-order/limit-order-form-setup.png) + +## Step 4: Review and Place Trigger Order + +Before placing the order, double-check the details: + +1. The amount to sell. +2. The rate at which you buy/sell, **important to always check**. +3. The expiry, if necessary. + +Have a look at the Trigger Order Summary thoroughly. If everything looks good, click on the **“Place Trigger Order”** button. + +![Trigger Order Summary](../../../static/spot/limit-order/limit-order-summary.png) + +## Step 5: Approve the Transaction in Your Wallet + +Your wallet will prompt you to approve the transaction to create the Trigger Order + +1. Check the transaction details in your wallet. + - The selling amount + - The rent for accounts +2. Approve the transaction. + +Once approved, your Trigger Order will be created on-chain and keeper bots will begin monitoring it. + +A notification toast will appear that will notify you once the transaction has been sent and has completed. + +## Step 6: Track Your Orders + +Congratulations! Your first Trigger Order is now active. + +1. Navigate to the Active Orders section to monitor them. +2. See details like: + - Order details. + - Tokens purchased. + - To learn more about what each detail means, [read here](./interface). +3. You can also [cancel your order](./how-to-manage-trigger-orders) at any time. \ No newline at end of file diff --git a/guides/100-spot/200-trigger/101-how-to-manage-trigger-orders.md b/guides/100-spot/200-trigger/101-how-to-manage-trigger-orders.md new file mode 100644 index 00000000..23bd5ef1 --- /dev/null +++ b/guides/100-spot/200-trigger/101-how-to-manage-trigger-orders.md @@ -0,0 +1,47 @@ +--- +sidebar_label: How to manage Trigger Orders +title: How to manage Trigger Orders +description: Guide to manage your Trigger Orders with Jupiter +--- + + + Manage Trigger Order + + + +Jupiter makes it easy to manage multiple Trigger Orders seamlessly, whether you trade multiple tokens or rates. This guide will walk you through how to manage them with the interface. + +--- + +## Create New Trigger Order + +Simply create a new order just like you did before! If you’re starting out, head over to this [guide](./how-to-create-trigger-order)! + +## View Open Orders + +Once you have created your order, it will automatically populate on the dashboard and you can view all your **Active** Trigger Orders as well. + +1. Navigate to the “Open Orders” section. +2. Here you will see all your active Trigger Orders. + +This section shows the orders which are submitted to the system but they are yet to be executed as the target price is not yet reached. + +![Manage Active Trigger Orders](../../../static/spot/limit-order/limit-order-manage-active.png) + +### Understand The Details + +To dive deeper into each item of the Active Order interface, refer to the [Trigger Order Interface page](./interface)! + +### Close and Withdraw + +Use the button in your active Trigger Order to cancel and close the order. This will close the order account and send you back the amount left (full if not filled at all or some if partially filled) and rent. + +:::tip cancel all orders +If you have multiple active orders, you can use the `Cancel All` button to close all of them. +::: + +## View Order History + +Orders that are **Completed** or **Cancelled** (either partially filled or not filled at all) are shown here. + +![Manage Historical Trigger Orders](../../../static/spot/limit-order/limit-order-manage-history.png) \ No newline at end of file diff --git a/guides/100-spot/200-trigger/2-interface.md b/guides/100-spot/200-trigger/2-interface.md new file mode 100644 index 00000000..2d41f94d --- /dev/null +++ b/guides/100-spot/200-trigger/2-interface.md @@ -0,0 +1,76 @@ +--- +sidebar_label: Trigger Order Interface +title: Trigger Order Interface +description: Introduction to Trigger Order Interface +--- + + + Trigger Order Interface + + + +In this section we go through what each setting on the Trigger Order dashboard means. + +- Trigger Order Form +- Open/Historical Trigger Order + +--- + +## Trigger Order Form + +![Trigger Order Form](../../../static/spot/limit-order/limit-order-form.png) + +| Field | Description | +|---|---| +| **(1) Trigger** | Select the Trigger tab in the Spot navigation menu to arrive at the Trigger Order form. | +| **(2) Input Token Selector** | Select the token you want to sell. | +| **(3) Input Token Amount** | Enter the amount of the input tokens that you are looking to sell. | +| **(4) Output Token Selector** | Select the token that you want to buy/receive. | +| **(5) Output Token Amount** | Shows the amount of output tokens you will receive based on your **input amount** and **rate**. | +| **(6) Rate** | Enter the target price for the order to execute.

*Do always double check your rate, we always fill at exactly your quote.* | +| **(7) Expiry** | Select the time period where your Trigger Order will be active. | +| **(8) Order Summary** | Shows your selections and input for the Trigger Order. | +| **(9) Place Trigger Order** | Click to submit the transaction to create the Trigger Order. | + +## Open Orders + +![Trigger Order Active](../../../static/spot/limit-order/limit-order-active.png) + +| Field | Description | +|---|---| +| **(1) Open Orders** | This tab shows the active Trigger Orders. | +| **(2) Token Deposited Details** | Shows the amount of tokens you are selling and buying. | +| **(3) Target Price per Token** | Shows the target price of your selected token for the order to execute. Once the token reaches this price your order will execute.

*This refers to the "Rate" in the Trigger Order Form.* | +| **(4) Fill Percentage** | Shows how much of the order is filled. If 100%, it will marker order as completed in Order History tab, else other percentages represent partial fulfilment. | +| **(5) Expanded View** | Click to expand the specific active Trigger Order. | +| **(6) Overview** | Shows more details like expiry and filled amount. | +| **(7) View Transaction** | Click to open the transaction of the Trigger Order in a blockchain explorer. | +| **(8) Cancel Order** | It closes the specific Trigger Order. | +| **(9) Cancel All** | It closes all open Trigger Orders. | + +## Historical Orders + +![Trigger Order History](../../../static/spot/limit-order/limit-order-history.png) + +| Field | Description | +|---|---| +| **(1) Order History** | This tab shows the historical Trigger Orders. | +| **(2) Token Deposited Details** | Shows the amount of tokens you are selling and buying. | +| **(3) Target Price per Token** | Shows the target price of your selected token for the order to execute. Once the token reaches this price your order will execute.

*This refers to the "Rate" in the Trigger Order Form.* | +| **(4) Status** | Shows the final status of the order, if 100% filled, it is marked as completed, else it will be marked as cancelled. | +| **(5) Overview** | Shows more details like expiry and filled amount. | +| **(6) View Transactions** | Tab showing a list of transactions made by the specific Trigger Order such as creation, fills, etc. | + +## Transactions + +![Trigger Order Transactions](../../../static/spot/limit-order/limit-order-transactions.png) + +| Fields | Description | +|--------|-------------| +| **Date/Time** | The date and time when this transaction was executed. | +| **Status** | The type of transaction: Create, Trade, Attempted Trade or Withdrawn. | +| **Amount** | The amount of tokens sold and bought. | + +:::tip Explore Further With Blockchain Explorers +For advanced users, you can dive further into the details of each order. Simply click on the redirect link to view the transaction using a blockchain explorer. +::: \ No newline at end of file diff --git a/guides/100-spot/200-trigger/4-faq.md b/guides/100-spot/200-trigger/4-faq.md new file mode 100644 index 00000000..6c07a3a6 --- /dev/null +++ b/guides/100-spot/200-trigger/4-faq.md @@ -0,0 +1,61 @@ +--- +sidebar_label: Trigger Order FAQ +title: Trigger Order FAQ +description: Introduction to Trigger Order FAQ +--- + + + Trigger Order FAQ + + + +In this section, we will cover the frequently asked questions of Jupiter Trigger Order. + +:::note More Questions? +If you have more questions, please reach out to us on [Discord](https://discord.gg/jup) or open a ticket via the web chatbot below. +::: + +--- + +### 1. What happens if my Trigger Order doesn't execute? + +Trigger Orders remain active until either they are executed, cancelled by you, or expire (if you set an expiry time). If the trigger price is never reached, the order will stay pending until you cancel it. + +### 2. Can I modify my Trigger Order after setting it up? + +No, once a Trigger Order is placed, it cannot be modified. You would need to cancel the existing order and create a new one with your desired changes. + +### 3. How accurate is the price triggering mechanism? + +Jupiter's Trigger Order system monitors prices in real-time using our routing engine. Do not compare the prices on other exchanges or charts as they might differ. + +### 4. What happens to my funds when I place a Trigger Order? + +When you place a Trigger Order, the funds you're selling are locked in a secure order account until the order executes or is cancelled. This ensures the funds are available when the trigger price is reached. + +### 5. Can I set multiple Trigger Orders? + +Yes, you can set multiple Trigger Orders simultaneously as long as you have sufficient funds for each order. Each order operates independently. + +### 6. How do I know if my Trigger Order has executed? + +You can track your Trigger Orders in the "Active Orders" section of the interface. Once executed, the order will move to your transaction history, and the tokens will be transferred to your wallet. + +### 7. Can I use Trigger Order as a Stop Loss or Take Profit? + +You cannot use Trigger Order as a stop loss. Due to the design and limitations, Trigger Order will attempt to execute your order at the exact price you set, refer to [How Trigger Order Works](/guides/spot/trigger/how-trigger-order-works) for more details. + +### 8. Why might my Trigger Order fail to execute? + +Common reasons for failed execution include: +- Exceeding the 0% slippage tolerance +- Insufficient liquidity in the market +- Network congestion + +### 9. Is there a time limit for Trigger Orders? + +By default, Trigger Orders remain active indefinitely until executed or cancelled. However, you can optionally set an expiration time when creating the order. + +### 10. Can I cancel a Trigger Order that hasn't executed yet? + +Yes, you can cancel any pending Trigger Order at any time through the interface, including orders that have partially executed. The funds in the order account will be returned to your wallet upon cancellation. diff --git a/guides/100-spot/300-recurring/0-quickstart.md b/guides/100-spot/300-recurring/0-quickstart.md new file mode 100644 index 00000000..ed09116a --- /dev/null +++ b/guides/100-spot/300-recurring/0-quickstart.md @@ -0,0 +1,119 @@ +--- +title: Recurring Order Quickstart +description: Introduction to Jupiter Dollar Cost Average +--- + + + Recurring Order Quickstart + + + +Dollar-Cost Averaging (Recurring Order) is a proven investment strategy that helps investors navigate market volatility, improve price entry, and maintain discipline in their investment approach. + +Recurring Order works by splitting your investment into smaller, Recurring Order purchases over a set timeframe, reducing the risks and emotional challenges of market timing. Let’s explore why Recurring Order is valuable, potential use cases, and how to optimize it for different scenarios. + +--- + +## What is Recurring Order? + +Recurring Order is like that steady, reliable friend who always has your back. Instead of throwing all your money into a token at once and hoping for the best, Recurring Order helps you spread your investment over time. + +Here’s how it works: + +- You decide how much to invest and how often. +- Jupiter automates the rest, buying small amounts of your chosen token at regular intervals. +- Over time, the cost price of your entire purchase is averaged out across multiple smaller orders. + +It’s smart, stress-free, and perfect for those of us who don’t have a crystal ball to predict the market (spoiler: no one does). + +--- + +## Key Advantages of Recurring Order + +1. **Smooths Out Market Volatility** + + Markets are inherently unpredictable, and price fluctuations can lead to emotional decision-making. Recurring Order minimizes the impact of these fluctuations by spreading investments over time, allowing you to take advantage of both dips and surges. + +2. **Reduces Timing Stress** + + Timing the market perfectly is nearly impossible, even for seasoned investors. Recurring Order eliminates this pressure by automating regular investments, ensuring you consistently participate in the market regardless of its conditions. + +3. **Improves Price Averaging** + + By purchasing at different price points over time, Recurring Order naturally averages out your cost per unit, helping to mitigate the risk of buying all your assets at a peak price. + +4. **Accessible to All Budgets** + + Recurring Order is a strategy for everyone. Whether you’re investing $100 or $10,000, the flexibility of Recurring Order lets you customize the approach to fit your financial goals and cash flow. + +--- + +## When and How to Use Recurring Order Effectively + +The effectiveness of Recurring Order can vary depending on market conditions. Here are scenarios where Recurring Order shines and tips to optimize it: + +1. **In a Bear Market (Falling Prices):** + - Recurring Order is particularly effective when markets are declining or uncertain. By investing steadily during a bear market, you lower your average purchase cost as prices drop, setting yourself up for higher potential gains when the market recovers. + - Example: If SOL's price falls from $25 to $15 over three months, Recurring Order ensures you buy more SOL at the lower price points, optimizing your overall cost. +2. **In a Bull Market (Rising Prices):** + - While Recurring Order can still work in a bull market, it may not achieve the lowest entry price as the market trends upward. However, Recurring Order ensures consistent exposure without waiting for a potential pullback that may never come. +3. **In Sideways Markets (Stable Prices):** + - During periods of price consolidation, Recurring Order helps accumulate assets steadily. Even with minimal price changes, Recurring Order ensures disciplined investing, which can pay off when the market eventually breaks out. +4. **Volatile Markets:** + - Recurring Order reduces exposure to sudden price swings. Instead of committing all funds at once during high volatility, splitting investments minimizes the risk of drastic price impacts. + +--- + +## Potential Use Cases for Recurring Order + +1. **Building a Long-Term Portfolio** + + Investors aiming to build a robust portfolio over years can use Recurring Order to accumulate assets like Bitcoin, Ethereum, or other crypto projects without worrying about short-term volatility. + +2. **Managing Risk for High-Volatility Assets** + + Memecoins can experience extreme price movements or thin liquidity. Recurring Order lets you participate or exit without safely by accumulating incrementally or spreding out your exits in smaller sizes. + +3. **Testing the Waters with New Tokens** + + Unsure about an emerging token? Recurring Order allows you to gradually increase exposure while monitoring its performance and market conditions. + +4. **Breaking up Orders for Whales** + + For investors with large capital, Recurring Order minimizes price impact from large trades by spreading purchases over multiple smaller orders, ensuring efficient capital deployment. + +--- + +## How Every Investor Can Benefit from Recurring Order + +1. **For Beginners:** + + New investors often struggle with timing or emotional decision-making. Recurring Order introduces discipline and consistency, helping them start with smaller, manageable investments. + +2. **For Experienced Traders:** + + Seasoned investors can use Recurring Order to hedge against short-term risks, diversify portfolios, or automate complex strategies over time. + +3. **For Long-Term Investors:** + + Those looking to hold assets for years can accumulate positions without worrying about short-term market noise, staying focused on the bigger picture. + +--- + +## Why Recurring Order on Jupiter? + +1. **Best Price:** + + Jupiter Recurring Order leverages on the powerful Swap infrastructure, providing the best price based on aggregated on-chain liquidity. + +2. **Trade all tokens:** + + Web3 is not fun without memecoins, Recurring Order-ing memecoins is not a dream! Jupiter Swap infrastructure provides accessibility to all tradable tokens for you. + +3. **MEV Front-Running Mitigation:** + + Transactions on Jupiter’s Recurring Order program incorporate timing variability (+2 to 30 seconds) and slippage protection, making it highly resistant to front-running attempts. + +--- + +By combining the inherent advantages of Recurring Order with Jupiter’s robust features, investors of all levels can navigate market conditions confidently, building a solid portfolio over time without the stress of market timing. \ No newline at end of file diff --git a/guides/100-spot/300-recurring/1-how-recurring-order-works.md b/guides/100-spot/300-recurring/1-how-recurring-order-works.md new file mode 100644 index 00000000..641343e9 --- /dev/null +++ b/guides/100-spot/300-recurring/1-how-recurring-order-works.md @@ -0,0 +1,89 @@ +--- +sidebar_label: How Recurring Order works +title: How Recurring Order works? +description: Introduction to how Recurring Order works +--- + + + How Recurring Order works + + + +Creating a Recurring Order is like setting up a reliable machine that processes your trades in the intervals you set them at, here’s how it works in a nutshell, let’s break it down into: + +- How the orders are created +- How your tokens are bought +- How tokens are transferred after each order +- How the Recurring Order is (auto) closed + +--- + +## How the orders are created + +1. When you start a Recurring order, the total allocated tokens you’re selling, say USDC, will be transferred from your wallet into an order account owned by the Jupiter Recurring Order Program. This also includes other information like order interval, buying amount, etc. +2. Once you [create your first Recurring Order position](./how-to-create-recurring-order), your first order is processed right away! For example, if you're selling USDC into JupSOL, the full USDC amount you chose will be stored in your vault, and the first trade will happen immediately. +3. The remaining trades follow at regular intervals, based on the schedule you pick. + +:::tip **Heads-Up! Keep It Up with Randomness** +To keep your Recurring Order strategy less predictable, each trade will execute within a randomized window of ±30 seconds from your chosen time. Think of it as a little sprinkle of unpredictability to keep things fresh and secure. +::: + +## How your tokens are bought + +When you create a Recurring order account, your big order is split into smaller, bite-sized trades. The number of trades depends on the options you pick. Let’s break it down: + +Say you’re selling of $300 USDC into JupSOL over 3 days. Your order will be split into 3 trades of $100 USDC each, one for every day. Let’s see this in action: + +| Order # | Amount to sell | JupSOL Price | JupSOL Bought | Total JupSOL | Time | +|---------|-----------------|-----------|------------|-----------|---------------------------| +| 1 | $100 | $200 | 0.5 | 0.5 | Immediately upon creation | +| 2 | $100 | $210 | 0.476 | 0.976 | 1 day after creation | +| 3 | $100 | $180 | 0.555 | 1.531 | 2 days after creation | + +At the end of the example Recurring Order, you can see that the price of JupSOL has fluctuated and the average cost of your Recurring Order is $196.666. + +#### Backfills +:::note Missed order Purchases +Do note that, if your Recurring order misses multiple purchases, it will backlog these purchases. When it is available to fill, it attempts to backfill all missed purchases immediately (with some buffer between each purchase). + +Currently, it is not an option to backfill immediately or not. This is part of the current design of Recurring Order. +::: + +## How tokens are transferred after each order + +Every time an order executes, the purchased tokens will show up in your wallet within the same transaction. No extra steps required! Let’s break it down: + +Using the same example as above: + +**Day 1:** Your first $100 USDC order executes, and voila! You receive **0.4995 JupSOL** (net of fees) in your wallet. + +**Day 2:** Your second $100 USDC order processes, delivering **0.4755 JupSOL** (net of fees) to your wallet. + +**Day 3:** Your final $100 USDC order wraps things up with another **0.554 JupSOL** (net of fees) delivered to your wallet. + +:::caution **Caveat to Auto-Withdrawal: Keep Your ATAs Open** +If your purchased token isn’t SOL, automatic transfers only work if you have the correct **Associated Token Account (ATA)** set up. But don’t worry—Jupiter Recurring Order creates the necessary ATA when you set up your account. +::: + +**What if you closed your ATA?** + +If you manually close your purchased token’s ATA (via a wallet or a 3rd-party tool), auto-transfers after every order won’t work. Instead, tokens will stay in your Recurring Order vault safely and only transfer as a lump sum at the end of your Recurring Order cycle. + +:::tip **Pro Tip:** Manual withdraw +If you don’t want to wait, you can manually withdraw your tokens from the Recurring Order vault anytime through our user-friendly UI. +::: + +## How the Recurring Order is (auto) closed + +At the end of your Recurring Order cycle, Jupiter takes care of everything for you. Here’s how it works: + +- If your wallet’s Associated Token Account (ATA) stays open, your purchased tokens are transferred to your wallet with each order. (No one else can ever receive your tokens) +- If you’ve closed your token account mid-cycle (as mentioned above), don’t worry. The program recovers the rent from your Recurring Order account’s in-token PDA and uses it to re-open your token account, so your tokens can still reach you safely. + +**How Rent Works:** + +By default, **2/3 of the rent** from your Recurring Order account is sent back to you. The remaining **1/3 of the rent** isn’t taken by Jupiter or anyone else—it’s recoverable by you if you decide to close your ATA that holds your tokens later. + +:::caution **Do NOT close your ATA** +Do not clsoe your ATA, before withdrawing or swapping your tokens! If you do, it could result in token loss. This isn’t just a Jupiter thing, it’s how Solana wallets and accounts operate. +::: \ No newline at end of file diff --git a/guides/100-spot/300-recurring/100-how-to-create-recurring-order.md b/guides/100-spot/300-recurring/100-how-to-create-recurring-order.md new file mode 100644 index 00000000..6479c233 --- /dev/null +++ b/guides/100-spot/300-recurring/100-how-to-create-recurring-order.md @@ -0,0 +1,96 @@ +--- +sidebar_label: How to create a Recurring Order +title: How to create a Recurring Order +description: Guide to set up your first Recurring Order with Jupiter +--- + + + Create Recurring Orders + + + +Setting up a Recurring Order on Jupiter is quick, simple, and designed to help you build your portfolio without the anxiety of timing the market. Let’s dive into the steps to get started. + +--- + +## Step 1: Connect Your Wallet + +Before anything else, you’ll need to connect your wallet to Jupiter. + +1. Visit the [**Jupiter Recurring Order page**](https://jup.ag/dca/). +2. Double-check that the URL is correct at https://jup.ag/dca and **"Recurring Tab"** is selected. +3. Click on the **“Connect Wallet”** button at the top right or using one of the other "Connect Wallet" buttons on the dashboard: Select your preferred wallet from the list (e.g., Phantom, Solflare, or any other supported wallet). +4. Approve the connection request in your wallet. + +![Connect Wallet](../../../static/spot/dca/dca-100-1.png) + +## Step 2: Choose Your Tokens + +Now it’s time to decide which tokens you want to allocate and buy. + +1. Upon clicking on the token selector to choose what token to allocate and buy, the token list will open up. +2. Select the token you want to sell/allocate in the top selector, **“You’re Selling”**. +3. Select the token you want to buy in the bottom selector, **“You’re Buying”**. + +:::tip **Pro Tip:** +Choose tokens that align with your investment goals. If you’re unsure, start with popular ones like SOL or LSTs (Liquid Staking Tokens) like JupSOL. +::: + +![Choose Tokens](../../../static/spot/dca/dca-100-2.png) + +## Step 3: Set Your Recurring Order + +This is where the magic happens! + +1. **Enter the amount** you want to allocate to the entire Recurring Order (e.g., $100 worth of JupSOL). +2. Choose the **frequency** of your purchases: in minutes, hours, days, weeks or months. +3. Enter the number of orders you want your Recurring Order to be processed in. + +:::tip **Pro Tip:** Price Strategy +4. This is an optional setting, you can provide a minimum or maximum price range for your order. + +[Read this guide for more information!](./how-to-use-recurring-order-price-range) +::: + +![Recurring Order](../../../static/spot/dca/dca-100-3.png) + +## Step 4: Review and Start Recurring Order + +Before confirming, double-check the details: + +- The allocated token and token to buy. +- The frequency, total amount being used, amount per order. +- The price range, if necessary. + +Have a look at the Recurring Order Summary for a thorough overview. If everything looks good, click on **"Start Recurring Order"** button. + +![Recurring Order Summary](../../../static/spot/dca/dca-100-4.png) + +## Step 5: Approve the Transaction in Your Wallet + +Your wallet will prompt you to approve the transaction to set up the Recurring Order. + +1. Check the transaction details in your wallet. + - The allocation amount + - The rent for accounts +2. Approve the transaction. + +Once approved, Jupiter will handle all future transactions for you automatically. + +A notification toast will appear that will notify you once the transaction has been sent and has completed. + +![Recurring Order Created](../../../static/spot/dca/dca-100-5.png) + +## Step 6: Track Your Recurring Order + +Congratulations! Your first Recurring Order is now active. + +1. Navigate to the Active Recurring Orders section to monitor your active Recurring Orders. +2. See details like: + - Tokens purchased. + - Average purchase price. + - Next scheduled transaction, and more. + - To learn more about what each detail means, [read here](./interface). +3. You can also [close/cancel your plan](./how-to-manage-recurring-order) at any time. + +![Recurring Order Active](../../../static/spot/dca/dca-100-6.png) \ No newline at end of file diff --git a/guides/100-spot/300-recurring/101-how-to-manage-recurring-order.md b/guides/100-spot/300-recurring/101-how-to-manage-recurring-order.md new file mode 100644 index 00000000..37358480 --- /dev/null +++ b/guides/100-spot/300-recurring/101-how-to-manage-recurring-order.md @@ -0,0 +1,62 @@ +--- +sidebar_label: How to manage Recurring Orders +title: How to manage Recurring Orders +description: Guide to manage your Recurring Orders +--- + + + Manage Recurring Orders + + + +Jupiter makes it easy to manage multiple Recurring Orders seamlessly, whether you’re diversifying your portfolio or optimizing investments for different tokens. This guide will walk you throughhow to manage them and the interface. + +--- + +## Create New Recurring Order + +Simply create a new Recurring Order just like you did before! If you’re starting out, head over to this [guide](./how-to-create-recurring-order)! + +## View Active Recurring Order + +Right on the dashboard you can view all your active Recurring Orders. + +1. Navigate to the “Active Recurring Orders” section. +2. Here, you’ll see a list of all your active Recurring Orders. + +![View Active Recurring Order](../../../static/spot/dca/dca-101-1.png) + +### Understanding The Details + +Each plan in the “Active Recurring Order” section will display key details to help you track progress. [Refer to Recurring Order Interface guide to see the full breakdown of the details](./interface#activehistorical-recurring-order). + +1. **Active Recurring Orders:** This tab lists out all of your active Recurring Orders. +2. **Individual Recurring Orders:** Ongoing Recurring Orders with a percentage to indicate how much of the Recurring Order has been executed. +3. **Order Details:** To see the entire Recurring Order details, expand by clicking one of your ongoing Recurring Orders. +4. **Balance Summary:** This shows the Recurring Order balance progress where you can track the balances for the tokens you allocated, you are buying and you have withdrawn. +5. **Order Summary:** This will show the current ongoing Recurring Order, with information like: + +### Close and Withdraw + +Use the button in your active Recurring Order to cancel and close the Recurring Order. This will halt the progress on the Recurring Order and withdraw all funds in the order to your wallet. + +:::note +The previously completed purchases should have sent the tokens into your wallet upon each purchase, unless you have closed your ATA (Associated Token Account) which you may bulk withdraw them when you cancel and close the Recurring Order. +::: + +## View Recurring Order History + +This tab lists all Recurring Orders that have been completed or canceled. Each past plan will display: + +- The same Recurring Order details as stated above. +- Status (completed or canceled). + +Once you select a Past Recurring Order, you can view all the transactions for your Recurring Order. + +## View Recurring Order Transactions + +A Recurring Order can be made up of multiple transactions, such as the order creation transaction, multiple purchase transactions and the order close transaction. [Refer to Recurring Order Interface guide to see the full breakdown of the details](./interface#recurring-order-orders). + +In order to view each order's transactions, click on one of your orders and head over to the **"Orders"** tab. + +![View Recurring Order Transactions](../../../static/spot/dca/dca-101-2.png) \ No newline at end of file diff --git a/guides/100-spot/300-recurring/102-how-to-use-recurring-order-price-range.md b/guides/100-spot/300-recurring/102-how-to-use-recurring-order-price-range.md new file mode 100644 index 00000000..c70d7be6 --- /dev/null +++ b/guides/100-spot/300-recurring/102-how-to-use-recurring-order-price-range.md @@ -0,0 +1,71 @@ +--- +sidebar_label: How to use Price Range +title: How to use Price Range +description: Guide to use price range with Jupiter Recurring Order +--- + + + Recurring Order Price Range + + + +Jupiter Recurring Order has a unique **Price Range** feature, which in short, allows you to set a minimum and/or maximum price for the Recurring Order to only execute in. + +This feature ensures your orders align with your desired price range, offering better control and flexibility over your trades. + +--- + +## How to set up Price Range? + +1. **Navigate to the Jupiter Recurring Order Interface** + Once you're on the Recurring Order Interface, set up your order. + +2. **Enable Price Range** + Look for the fields just above the `Start Recurring Order` button. To enable the Price Range, simply set your desired Minimum Price or Maximum Price. + +![Recurring Order Price Range](../../../static/spot/dca/dca-102-1.png) + +3. **Set Your Minimum and/or Maximum Price** + - **Min Price:** Set the lowest price at which you want the Recurring Order to execute. + - **Max Price:** Set the highest price at which you want the Recurring Order to execute. + - **Example** + If you set the Min Price to $200 and Max Price to $250 for SOL/USDC, your Recurring Order will only execute when SOL is between $200 and $250. + + :::note + Do note that you can set up Min Price and Max Price independently. + ::: + +4. **Confirm and Start Your Recurring Order** + Review your price range settings and order details. Once confirmed, start the Recurring Order. + +--- + +## When to use Price Range? + +1. **Avoid High Prices in Volatile Markets** + If the market price of your chosen asset spikes suddenly, Price Range ensures you don’t DCA at undesirably high levels. + +2. **Capitalize on Buying the Dip** + Set a maximum price near recent lows to accumulate assets during a market correction without overspending. + +3. **Control Long-Term Recurring Order Execution** + For extended Recurring Order campaigns, use a reasonable Min/Max range to maintain cost efficiency over time. + +4. **"Trigger Order" Using Recurring Order** + Instead of a limit order with 0% slippage since it executes at the exact price, you can use Recurring Order Price Range to enter or exit positions with specific price ranges. + +--- + +## Tips + +- **Use Price Range with a Broader Range in Volatile Markets:** + Markets with frequent price swings may require a larger Min/Max price range to ensure your Recurring Order can still execute consistently. + +- **Combine with Smaller Recurring Order Intervals for Precision:** + Setting frequent intervals (e.g., hourly) alongside a price range helps you capture more optimal entry points. + +- **Monitor and Adjust as Needed:** + Regularly review your Price Range settings to ensure they align with changing market conditions. + +- **Avoid Overly Tight Ranges:** + Setting a very narrow Min/Max range could result in missed opportunities if prices fluctuate outside your bounds. diff --git a/guides/100-spot/300-recurring/103-how-to-optimize-recurring-order.md b/guides/100-spot/300-recurring/103-how-to-optimize-recurring-order.md new file mode 100644 index 00000000..93a51776 --- /dev/null +++ b/guides/100-spot/300-recurring/103-how-to-optimize-recurring-order.md @@ -0,0 +1,74 @@ +--- +sidebar_label: How to optimize Recurring Order +title: How to optimize Recurring Order +description: Guide to optimize your strategy with Jupiter Recurring Order +--- + + + Optimize Recurring Order + + + +Recurring Order is a popular investment strategy that minimizes risk by spreading your purchases over time. While its core simplicity makes it effective, optimizing your Recurring Order approach can enhance results, whether you're navigating volatile memecoin markets or building a long-term portfolio. Here are some steps to refine your strategy! + +--- + +## 1. Clearly Define Your Investment Goals + +Begin by establishing what you want to achieve: + +- **Are you looking for steady accumulation?** Recurring Order works well for assets you believe will grow in value over the long term. +- **Do you want to mitigate volatility?** Recurring Order helps reduce the mental stress of market ups and downs. + +:::note Think of it this way +If your goal is to steadily build a position in a stable asset like JupSOL, Recurring Order ensures you’re consistently investing, no matter the market’s mood. +::: + +## 2. Choose the Right Asset + +Not every asset is equally suitable for Recurring Order. Selecting the right one depends on your research and belief in its potential. + +Here’s what to evaluate: + +- **Volatility:** Highly volatile assets benefit the most from Recurring Order, as price fluctuations allow you to average down your cost. +- **Growth Prospects:** Look for assets with strong fundamentals or use cases that align with your vision. +- **Your Conviction:** Only invest in assets you’re willing to hold for a longer time period. + +## 3. Determine the Optimal Timeframe and Frequency + +Recurring Order is versatile for different types of situations: + +- **How long will you Recurring Order?** Shorter timeframes are better for taking advantage of a market dip, while longer timeframes smooth out volatility over months or years. +- **How often will you make purchases?** Frequent intervals like daily or weekly trades can capture price swings better, while monthly intervals keep things simpler. + +**Example:** +- A **short-term plan** for $1,000 could involve investing $100 daily over 10 days. +- A **long-term plan** for $1,000 could mean investing $100 monthly over 10 months. + +## 4. Set a Realistic and Consistent Budget + +Your Recurring Order strategy is only as effective as the budget you can commit to consistently. + +- Calculate how much you’re willing to invest overall and divide it by your chosen timeframe. +- Stick to this budget no matter what. This consistency is what makes Recurring Order powerful. + +**Example:** If you have $1,800 to invest over 6 months and decide to Recurring Order weekly, you’d allocate $75 per week. + +## 5. Leverage Market Insights Strategically + +While Recurring Order removes the need to time the market, being aware of market trends can help refine your strategy: + +- **In Bull Markets:** A shorter Recurring Order duration can lock in profits sooner, ensuring you don’t miss out on rapid price increases. +- **In Bear Markets:** Extending your Recurring Order period can help you accumulate more assets at lower prices. + +:::tip Volatile Memecoin Markets +A Recurring Order can spread your 1 large order into multiple smaller orders, helping reduce price impact when exiting your position. +::: + +## 6. Track Your Progress Regularly + +Though Recurring Order is a “set it and forget it” strategy, periodic reviews ensure you’re on track: + +- **Monitor your portfolio:** How has your asset’s value evolved? +- **Check your Recurring Order account:** Ensure all orders are executing as planned. +- **Reassess your goals:** If your financial situation changes or your conviction in the asset wanes, adjust accordingly. \ No newline at end of file diff --git a/guides/100-spot/300-recurring/2-interface.md b/guides/100-spot/300-recurring/2-interface.md new file mode 100644 index 00000000..34f94bd2 --- /dev/null +++ b/guides/100-spot/300-recurring/2-interface.md @@ -0,0 +1,61 @@ +--- +sidebar_label: Recurring Order Interface +title: Recurring Order Interface +description: Introduction to Recurring Order Interface +--- + + + Recurring Order Interface + + + +In this section we go through what each setting on the Recurring Order dashboard means. + +- Recurring Order Form +- Active/Historical Recurring Order + +--- + +## Recurring Order Form + +![Recurring Order Form](../../../static/spot/dca/dca-2-1.png) + +| Field | Description | +|---|---| +| **(1) Recurring Order** | Select the Recurring Order tab in the Spot navigation menu to arrive at the Recurring Order form. | +| **(2) Input Token Selector** | Select the token you want to spend/allocate with your Recurring Orders. | +| **(3) Input Token Amount** | Enter the amount of the input tokens that you are looking to spend/allocate **in total** with your Recurring Orders. | +| **(4) Output Token Selector** | Select the token that you are looking to Buy. | +| **(5) Interval** | Specify the time in between each purchase with a numerical input and the dropdown selector for time unit. | +| **(6) Total Orders** | The number of orders you want the Recurring Order to be spread out over. | +| **(7) Price Range** | Set a minimum and maximum price range under which only your Recurring Order would be executed (optional parameter). | +| **(8) Order Summary** | Specify the details for the current Recurring Order you are creating:

**Sell Total:** 50 USDC (You are selling USDC).

**Sell Per Order:** The Sell Total divided by the Total Orders (50 USDC / 12).

**Receive:** JUP (You are buying JUP).

**Order Interval:** 5 minutes (A trade will take place every 5 minutes).

**Start Date:** The Recurring Order will begin immediately upon submission.

**Estimated End Date:** The final Recurring Order will finish by this date.

**Estimated Price Impact Per Order:** Estimated impact on the market price per Recurring Order trade.

**Platform Fee:** 0.1% platform fee for Recurring Orders. | +| **(9) Start Recurring Order** | Click to submit the Recurring Order and start the Recurring Order. | + +## Active/Historical Recurring Order + +![Active/Historical Recurring Order Overview](../../../static/spot/dca/dca-2-2.png) + +| Field | Description | +|---|---| +| **(1) Active/ Historical Recurring Orders** | Select either the Active or Historical tab to view respectively. | +| **(2) Individual Recurring Orders** | Active: Ongoing Recurring Orders percentage to indicate how much of the orders has been executed.

History: Status of order, either Completed, Cancelled or Withdrawn. | +| **(3) Information Tabs** | Select either Overview or Orders to view respectively. | +| **(4) Balance Summary** | This shows the Recurring Order balance progress where you can track the balances for the tokens you allocated, you are buying and you have withdrawn. | +| **(5) Order Summary** | **Total Deposited:** The input amount and token that you are selling or swapping from.

**Total Spent:** The progress of the Recurring Order, or the amount spent to swap from.

**Every:** The time interval specified in the Frequency fields.

**Over:** The total number of purchases.

**Each Order Size:** Total deposited divide by Total number of purchases

**Orders Remaining:** The number of purchases left to complete the Recurring Order.

**Current Average Price:** Sum of the price of each transaction divide by Total current completed purchases

**Current Price:** The price of the token your are buying now.

**# of Orders Left:** The number of orders remaining with this Recurring Order request.

**Created At:** The date and time when the Recurring Order was submitted.

**Next Order At** The date and time of the next order to be executed. | +| **(6) Close and Withdraw** | Click to submit and start the Recurring Order. | + +## Recurring Orders + +![Active/Historical Recurring Orders](../../../static/spot/dca/dca-2-3.png) + +| Fields | Description | +|--------|-------------| +| **Date/Time** | The date and time when this transaction was executed. | +| **Status** | The type of transaction: Create, Trade, Close or Withdrawn. | +| **From/To** | The amount of tokens sold and bought. | +| **Rate** | The rate of the purchase for the transaction. | + +:::tip Explore Further With Blockchain Explorers +For advanced users, you can dive further into the details of each order. Simply click on the redirect link to view the transaction using a blockchain explorer. +::: \ No newline at end of file diff --git a/guides/100-spot/300-recurring/3-security.md b/guides/100-spot/300-recurring/3-security.md new file mode 100644 index 00000000..d3acb21d --- /dev/null +++ b/guides/100-spot/300-recurring/3-security.md @@ -0,0 +1,47 @@ +--- +sidebar_label: Recurring Order Security +title: Recurring Order Security +description: Understanding security of Jupiter Recurring Order +--- + + + Recurring Order Security + + + +Ensuring the security of your investments is paramount, we ensure our programs are audited and tested, additionally incorporating measures to protect against market exploitation. + +:::note Working on new updates +We are improving Recurring Order to help tackle this more efficiently and provide more coverage. +::: + +--- + +## Mitigation of Front-running Risks + +MEV or Front-running occurs when bots exploit predictable transactions to gain risk-free profits. Jupiter’s Recurring Order program is designed to make front-running a highly risky endeavor, rendering it unprofitable. + +- **Order Timing Variability:** Orders are not executed at fixed times but within a randomized window of +2 to 30 seconds. This variability introduces uncertainty, making it nearly impossible for exploiters to anticipate the exact moment a transaction will occur. + +- **Pre-Validation of Transactions** Before a transaction is sent to the network, Jupiter pre-calculates the estimated amount of the purchased token (out-token) based on current prices. + +## Slippage Protections + +Transactions have fail-safes to protect users from adverse price impacts. + +Slippage thresholds (configured by the team) protect users from unacceptable price variations for their trades. If market conditions or anomalies push the token amount outside these limits, the transaction fails. + +- While this does not prevent front-running, similar to a regular AMM swap, users are guaranteed to receive a minimum amount of out-token. + +- Transactions can be reverted if an inadequate amount of out-token is received. This ensures prices will not slip to a level where it is sufficiently profitable or at-all profitable for potential front-running bots. + +## Natural Protection By Design + +The inherent nature of Recurring Order reduces vulnerabilities to MEV attacks: + +- Orders are split into smaller transactions over time, minimizing the potential price impact of 1 bigger single trade. +- By spreading purchases across different price points and time windows, Recurring Order reduces the profitability of front-running activities. + +## Why This Matters to You + +Jupiter’s proactive measures ensure your investments are secure from market exploitation, while its fail-safe mechanisms give you confidence in receiving fair value for your trades. By combining randomized execution, real-time validations, and Recurring Order’s natural resilience, Jupiter protects your portfolio from unnecessary risks, allowing you to focus on achieving your investment goals. \ No newline at end of file diff --git a/guides/100-spot/300-recurring/5-faq.md b/guides/100-spot/300-recurring/5-faq.md new file mode 100644 index 00000000..5c8db4d3 --- /dev/null +++ b/guides/100-spot/300-recurring/5-faq.md @@ -0,0 +1,53 @@ +--- +sidebar_label: Recurring Order FAQ +title: Recurring Order FAQ +description: Frequently Asked Questions of Jupiter Recurring Order +--- + + + Recurring Order FAQ + + + +In this section, we will cover the frequently asked questions of Jupiter Recurring Order. + +:::note More Questions? +If you have more questions, please reach out to us on [Discord](https://discord.gg/jup) or open a ticket via the web chatbot below. +::: + +--- + +### 1. How can I view past transactions or history of my Recurring Orders? + +You can track your Recurring Orders' history and past transactions by connecting your wallet to https://jup.ag/dca. Your transaction history is linked to a blockchain explorer where you can find in the Recurring Order dashboard. + +### 2. Does my Recurring Order automatically retry? + +Yes, if a Recurring Order fails due to network issues, slippage thresholds met, or other reasons, Jupiter's Recurring Order program automatically retries the order. This ensures minimal disruption to your Recurring Order strategy. [(Do take note of **backfills** if the Recurring Order misses multiple orders.)](./how-recurring-order-works#backfills) + +### 3. Can I get notified when a purchase is made? + +Currently, Jupiter or Jupiter Mobile does not natively send notifications on Recurring Orders. However, you can monitor your wallet activity through explorers like Solana Explorer or third-party wallet apps that support alerts for transactions. + +### 4. How is the price calculated with each purchase? + +The price for each Recurring Order purchase is calculated at the time the transaction is executed. Jupiter checks the **current market price** and includes parameters like slippage settings to ensure you receive a minimum amount of tokens. If the price exceeds the slippage threshold, the transaction will fail in order to protect your funds. + +### 5. How can I export my Recurring Order history for tax or other purposes? + +Currently, Jupiter does not natively support this feature. However there are a few ways you can export via third-party apps. +- Blockchain explorers, but requires you to search of Recurring Order accounts and craft the export manually. +- Blockchain indexers like Dune or Flipside, but require you to write your own queries. +- Community built Recurring Order history export, [check out the X (Twitter) post here](https://x.com/callum_codes/status/1847734657107874080). + +### 6. What happens to my Recurring Order if the network has issues? + +If the Solana network experiences issues, your Recurring Order may temporarily fail. Jupiter's Recurring Order program will **automatically retry** these transactions until the network stabilizes, ensuring your plan continues with minimal disruption. + +### 7. Can I make changes to my Recurring Order after setting it up? + +No, once a Recurring Order is set up, it cannot be modified. To make changes, you would need to cancel the existing plan and create a new one with your updated preferences. + +### 8. Can I pause my Recurring Order temporarily and resume it later? + +No, Jupiter's Recurring Order program does not currently support pausing and resuming Recurring Orders. If you need to stop the Recurring Order purchases, you must cancel the plan and create a new one when you're ready to resume. \ No newline at end of file diff --git a/guides/100-spot/index.md b/guides/100-spot/index.md new file mode 100644 index 00000000..2dbba0bc --- /dev/null +++ b/guides/100-spot/index.md @@ -0,0 +1,30 @@ +--- +sidebar_label: Spot +title: Spot +sidebar_position: 1 +description: Learn about Jupiter Spot and how to use the products. +--- + + + Spot Guide: Directory + + + +Jupiter Spot offers a comprehensive suite of trading tools designed to meet all your DeFi trading needs. From instant swaps to advanced order types, Jupiter Spot equips you with everything necessary to trade effectively in the Solana ecosystem. + +--- + +### Instant Swap +The foundation of Jupiter Spot, executing trades immediately at the best possible prices across Solana's DEX ecosystem. Jupiter's routing engine ensures you always get the most optimal rates. + +Check out [Instant Swap](/guides/spot/instant/quickstart), or launch [Spot](https://jup.ag/). + +### Trigger Orders +Set up automated trades that execute when specific price conditions are met. + +Check out [Trigger Orders](/guides/spot/trigger/quickstart), or launch [Spot](https://jup.ag/limit). + +### Recurring Orders +Automate your DeFi investment strategy with scheduled recurring trades. + +Check out [Recurring Orders](/guides/spot/recurring/quickstart), or launch [Spot](https://jup.ag/dca). diff --git a/guides/500-perps/0-quickstart.md b/guides/500-perps/0-quickstart.md new file mode 100644 index 00000000..bb26d894 --- /dev/null +++ b/guides/500-perps/0-quickstart.md @@ -0,0 +1,80 @@ +--- +title: Perps Quickstart +description: Introduction to the Jupiter Perpetual Exchange +--- + + + Perps Quickstart + + + +Apart from Spot products like Swap or DCA, Jupiter has its own Perpetual Exchange, providing both liquidity provisioning opportunities and leverage trading! Don’t worry if you’re new to this, we’ve got your back. This guide will help you navigate the basics of Jupiter Perps. + +--- + +## Overview + +Welcome to Jupiter Perpetuals, a perpetual exchange where you can trade with leverage (**up to 100x!**) on popular tokens like **SOL**, **ETH**, **wBTC**. + +:::info Statistics Dashboards +You can find various metrics on Jupiter Perpetuals on the following dashboards: +1. [Chaos Labs Dashboard](https://community.chaoslabs.xyz/jupiter/risk/overview) +2. [Gauntlet Dashboard](https://app.gauntlet.xyz/protocols/jupiter) +3. [Dune Analytics](https://dune.com/jupiterexchange/jupiter-perps) +::: + +The Jupiter Perpetuals exchange is a trader-to-LP exchange which means liquidity providers (LPs) provide liquidity to the exchange, while the traders borrow tokens from the liquidity pool (the JLP pool) for leverage. + +1. **Jupiter Liquidity Providers** + + Liquidity for the Jupiter Perpetuals exchange is provided by the JLP Pool, which holds SOL, ETH, wBTC, USDC, and USDT as the underlying tokens. The pool provides ample liquidity for traders to open highly-leveraged positions, while earning an attractive return on a portion of the trading fees. + + [Learn more about how the JLP Pool works here](./jlp-pool-and-token). + +2. **Traders** + + Traders can deposit collateral to enter positions and borrowing the rest of the position from the pool. Subsequently, they can manage their positions by withdrawing collateral to close their positions fully or partially. The Jupiter Perpetuals Exchange features a simple interface and underlying trading mechanisms to provide a safe and seamless trading experience. + + [Learn more about how trading works here](./position-management). + +--- + +## Key Features for Liquidity Providers + +- **Rewards and Earnings** + + By contributing to the JLP Pool, liquidity providers earn a portion of the trading fees and traders' profits and losses, which is redistributed to pool. + +- **Composability** + + The JLP token is an SPL token, making it easily transferable and tradable like any other SPL tokens within the Solana ecosystem. This also allows for AMM pools to be established for trading JLP tokens. + +- **No Active Management** + + LPs do not need to actively "stake" tokens or "harvest" yields - APR earnings are embedded within each JLP token and accumulate automatically (reflected as an increase in the JLP token price). + +## Key Features for Traders + +- **Liquidity and Leverage** + + The JLP Pool provides ample liquidity for traders to open highly-leveraged positions, up to 100x. + +- **Collateral** + + Traders can use any tokens as collateral, this is powered by Jupiter Swap, where traders can indicate the token they want to use as collateral and Jupiter Swap will swap the token to the required collateral token. + +- **Price Oracles** + + The exchange uses price oracles for pricing, this benefits traders by allowing them to trade with leverage without worrying about price impact like traditional derivatives platforms (however, there is a [price impact fee](./fees#price-impact-fees)). + +- **Risk and Economic Management** + + Jupiter Perps is working closely with different economic and risk teams to ensure a stable, fair yet competitive trading environment. Refer to the assessments at https://www.jupresear.ch/tag/risk. + +- **Limit Orders** + + Traders can place limit orders to enter their long or short positions at a specific price. This allows for more control over the entry price of their positions. + +- **Gasless Orders** + + Traders can place orders without paying for transaction fees. This is powered by a new keeper execution model where you submit a request to execute an order (direct to keepers instead of a transaction on-chain), and the keeper will execute the order for you. diff --git a/guides/500-perps/10-position-management.md b/guides/500-perps/10-position-management.md new file mode 100644 index 00000000..6c43e99e --- /dev/null +++ b/guides/500-perps/10-position-management.md @@ -0,0 +1,168 @@ +--- +sidebar_label: Position Management +title: Position Management +description: How the Jupiter Perpetuals Exchange Position Management works +--- + + + Perps: Position Management + + + +By understanding how the Jupiter Perpetuals Exchange works, you can manage your positions more effectively. This guide will help you understand how to manage your collateral for each type of positions and how to calculate your PnL. + +--- + +## Longs + +Traders to open or increase long positions for **SOL**, **ETH**, and **wBTC**, with leverage up to **100x** based on the initial margin (collateral). By going long, traders bet that the price of their selected token will rise, aiming to profit from upward price movements. + +### Collateral Management + +Collateral plays a crucial role in maintaining and managing a long position. Proper collateral management ensures that positions remain open and sustainable during volatile market conditions. + +- **Depositing Collateral in Long Positions** + + When traders add collateral, the **liquidation price** decreases, and leverage is reduced, making the position safer. This increases the **maintenance margin**, providing more room for market fluctuations. + +- **Withdrawing Collateral in Long Positions** + + Removing collateral increases the **liquidation price** and leverage, making the position riskier. This reduces the **maintenance margin**, leaving less buffer against adverse price movements. + +### Underlying Collateral + +For long positions, the underlying collateral is the token being longed. Profits and withdrawals from the position are settled in the same token. + +| Position | Collateral | +| --------- | ---------- | +| Long SOL | SOL | +| Long wETH | wETH | +| Long wBTC | wBTC | + +### Example + +For example, if a trader opens a long position on **SOL** and earns a profit, they will receive **SOL** when the position is closed, along with any collateral withdrawals. + +--- + +## Shorts + +Traders can open or decrease short positions for **SOL**, **ETH**, and **wBTC**, with leverage up to **100x** based on the initial margin (collateral). By going short, traders bet that the price of their selected token will fall, aiming to profit from downward price movements. + +### Collateral Management + +Collateral plays a crucial role in maintaining and managing a long position. Proper collateral management ensures that positions remain open and sustainable during volatile market conditions. + +- **Depositing Collateral in Short Positions** + + Adding collateral increases the **liquidation price** and reduces leverage, making the position safer by increasing the **maintenance margin**. + +- **Withdrawing Collateral in Short Positions** + + Removing collateral decreases the **liquidation price** and increases leverage, making the position riskier by reducing the **maintenance margin**. + +### Underlying Collateral + +For short positions, the underlying collateral is either USDC or USDT, **determined by the utilization rates of these stablecoins when the position is opened**. Profits and collateral withdrawals are always paid out in the same stablecoin used as collateral. + +| Position | Collateral | +| ---------- | ----------- | +| Short SOL | USDC / USDT | +| Short wETH | USDC / USDT | +| Short wBTC | USDC / USDT | + +### Example + +For example, a trader with a profitable short SOL position using USDC as collateral will receive USDC when they close the position or withdraw profits. + +--- + +## Take-Profit/ Stop-Loss + +An active [Associate Token Account (ATA)](https://spl.solana.com/associated-token-account) is needed for TP/SL to be triggered and executed. + +- ATA will be automatically created for you when you create a TP/SL. +- If you close the position manually, the associated TP/SL will be automatically cancelled and closed. + +:::warning Closing Required ATA +If you have closed the required ATA, **the TP/SL will not be triggered**. + +Either manually close the position or reopen the required ATA (you can do so by using Jupiter Swap to swap a small amount of the token). +::: + +:::info +When TP/SL is set, keepers will monitor the mark price, when reaching the specified price level, TP/SL will close the whole position. More info on the keeper execution of TP/SL [here](./keeper). +::: + +| Position Type | Required ATA | +|---------------|---------------| +| SOL-Long | SOL ATA | +| ETH-Long | ETH ATA | +| wBTC-Long | wBTC ATA | +| ALL Short positions | USDC or USDT ATA | + +## Profit and Loss + +When you open a position on Jupiter Perps (long or short), your PnL updates in real-time as the market moves. The PnL value can either be positive (profit) or negative (loss), depending on whether the price is moving in your favor or against you. + +For **long positions**, if the price of your asset goes up, your **PnL** increases. If the price drops, your **PnL** decreases. For example: + +- Position: 100 USD long on SOL +- If SOL price increases by 10%: You profit 10 USD +- If SOL price decreases by 10%: You lose 10 USD + +For **short positions**, the opposite happens. If the price of the asset goes down, your **PnL** increases. If the price rises, your **PnL** decreases. For example: + +- Position: 100 USD short on SOL +- If SOL price decreases by 10%: You profit 10 USD +- If SOL price increases by 10%: You lose 10 USD + +### Calculating Realized and Unrealized PnL + +:::tip Calculate PnL Programmatically +This [code snippet](https://github.com/julianfssen/jupiter-perps-anchor-idl-parsing/blob/main/src/examples/get-position-pnl.ts) shows an example of calculating a position's PNL. +::: + +1. Get the exit price. + +2. Determine if the position is profitable by checking if the exit price is greater than the position's average price for longs, or if the exit price is less than the position's average price for shorts + + ``` + IF position_is_long + is_profitable = exit_price > position_avg_price + + ELSE position_is_short + is_profitable = exit_price < position_avg_price + ``` + +3. Calculate the absolute delta between the exit price and the position's average price + + ``` + price_delta = |exit_price - position_avg_price| + ``` + +4. Calculate the PnL delta for the closed portion of the position: multiply the size being closed (`trade_size_usd`) by the price delta, then divide by the entry price to get the PnL delta + + ``` + pnl_delta = (trade_size_usd * price_delta) / position_avg_price + ``` + +5. Calculate the final unrealized PnL depending on whether the position is profitable or not + + ``` + IF is_profitable + unrealized_pnl = pnl_delta + + ELSE + unrealized_pnl = -pnl_delta + ``` + +6. Deduct the outstanding fees from the unrealized PnL to get the final realized PnL + + :::info + [Read the Jupiter Perpetuals fee breakdown here](./fees) for more info on open / close fees, price impact fees, and borrow fees. + ::: + + ``` + realized_pnl = unrealized_pnl - (close_base_fee + price_impact_fee + borrow_fee) + ``` diff --git a/guides/500-perps/100-how-to-open-position.md b/guides/500-perps/100-how-to-open-position.md new file mode 100644 index 00000000..e92ecc9f --- /dev/null +++ b/guides/500-perps/100-how-to-open-position.md @@ -0,0 +1,108 @@ +--- +sidebar_label: How to open position +title: How to open position? +description: Introduction to how to open position +--- + + + How to open position + + + +Welcome to the world of Jupiter Perps, where trading gets fast, exciting, and packed with potentials! Whether you're looking to go long or short on top tokens like SOL, ETH, or wBTC, this guide will walk you through every step to master the platform. + +--- + +### Step 1: Connect Your Wallet + +To begin trading on Jupiter Perps, head to the Jupiter Perps platform at https://jup.ag/perps and click on the **“Connect Wallet”** button in the top-right corner. From there, select your preferred Solana wallet, such as Phantom or Solflare, and approve the connection. Once connected, you’re ready to dive into the trading interface! + +![Connect Wallet](../../static/perps/trade-connect-wallet.png) + +--- + +### Step 2: Select the Market + +The next step is choosing the market you want to trade in. Using the **Perp Token Selector**, pick from the supported tokens: **SOL**, **ETH**, or **wBTC**. This defines the token for which you will open a leveraged long or short position on. + +![Perp Token Selector](../../static/perps/trade-perp-token-selector.png) + +--- + +### Step 3: Choose Long or Short + +Now it’s decision time! Use the **Long/Short Selector** to choose your position. Selecting **Long** means you believe the token’s price will rise, while **Short** indicates you expect the price to fall. + +![Long/Short Selector](../../static/perps/trade-long-short-selector.png) + +--- + +### Step 4: Set Your Collateral + +After deciding your position, it’s time to set your collateral. In the **Input Token Selector**, choose the token you want to use as collateral for your trade and specify the amount you wish to use. + +:::tip Top Verified Solana Tokens +You can use any Solana token that is verified and top 100 in terms of volume as collateral for your trade. + +For example, you are opening a long position on SOL, you can use JUP as collateral for your trade. + +Jupiter Swap will automatically convert JUP to SOL and use it as collateral for your trade. +::: + +![Input Token Selector](../../static/perps/trade-input-token-selector.png) + +--- + +### Step 5: Adjust Leverage + +With your collateral in place, use the **Leverage Slider** to set your desired leverage. You can choose anywhere from a modest **1.1x** to a maximum of **100x** leverage. Remember, higher leverage increases both potential rewards and risks, so adjust thoughtfully! + +![Leverage Slider](../../static/perps/trade-leverage-slider.png) + +--- + +### Step 6: Review Position + +Before opening your position, you can make use of details such as the borrow rate, available liquidity above the order form, or confirm your entry price, liquidation price and fees information. This will help you make an informed trading decision. + +:::caution Liquidation Price on Order Form +The Liquidation Price shown on the form is the simulated liquidation price based on the position requested. If you have an existing position, the liquidation price on the form will be the new liquidation price of your position after the new position is opened and combined with your existing position. +::: + +![Review Position](../../static/perps/trade-review-position.png) + +--- + +### Step 7: Submit Your Order + +Whenever you are ready, click the **"Open Long"** or **"Open Short"** button to agree to the position details and create a transaction for your request. You’ll need to approve the transaction in your connected wallet. Once approved, your request is submitted and when it has landed and **confirmed** on the blockchain, only then your position is opened. + +:::caution Always check your transactions +You can utilise blockchain explorers like [Solscan](https://solscan.io/) to check the status of your transaction. + +If your position is not confirmed, but you have attempted to submit, it does not mean your position is opened. +::: + +![Submit Position](../../static/perps/trade-submit-position.png) + +--- + +### Step 8: Monitor and Manage Your Position + +After your trade is live, head to the **Positions Tab** to monitor it. Here, you can track real-time profit and loss (PnL), add or withdraw collateral, or add Take Profit or Stop Loss to your position. This tab ensures you stay updated and in control of your trades. + +Refer to [How to manage your position](./how-to-manage-position) for more information. + +--- + +### Step 9: Closing Your Position + +When you’re ready to close your trade, go to the **Positions Tab** and select the position you wish to exit. You can choose to close it partially or fully based on your strategy. Confirm the closure and approve the transaction in your wallet to finalize the trade. + +:::caution Always check your transactions +You can utilise blockchain explorers like [Solscan](https://solscan.io/) to check the status of your transaction. + +If your request to close your position is not confirmed, but you have attempted to submit, it does not mean your position is closed. +::: + +Refer to [How to close your position](./how-to-close-position) for more information. \ No newline at end of file diff --git a/guides/500-perps/101-how-to-manage-position.md b/guides/500-perps/101-how-to-manage-position.md new file mode 100644 index 00000000..59679da4 --- /dev/null +++ b/guides/500-perps/101-how-to-manage-position.md @@ -0,0 +1,78 @@ +--- +sidebar_label: How to manage position +title: How to manage position? +description: Introduction to how to manage position +--- + + + How to manage position + + + +Now that you have [opened a position](./how-to-open-position), in this guide, we will show you how to manage your position. + +--- + +## Position Details + +After you have opened a position, you can view the details of your position by opening the Positions tab. In this tab, you can see the details of your position. + +| Field | Description | +|-------|-------------| +| Market | The market you are trading on, SOL, ETH or wBTC. | +| Side | The side of the position, either long or short. | +| Leverage | The current leverage. | +| PNL | The profit or loss of the position.

(To include/exclude fees in PNL, navigate to the settings in Trade Form's top right corner to toggle on/off.) | +| Entry Price | The price at which you entered the position. | +| Mark Price | The current price of the market. | +| Liquidation Price | The price at which the position will be liquidated.

(The liquidation price is always changing as the market price fluctuates and your collateral is being used to pay for borrow fees to maintain the position.) | +| Size | The size of the position.

(Your collateral multiply by leverage.) | +| Collateral | The current amount of collateral in the position.

(Collateral is used to maintain the position by paying for borrow fees and is locked in the position until the position is closed.) | +| Take Profit Price | The price at which the position will be closed (used for taking profits). | +| Stop Loss Price | The price at which the position will be closed (used for stopping losses). | + +:::tip How Trading Works +Refer to how trading works section in the documentation to learn more about how to better manage your position. +::: + +![Position Details](../../static/perps/trade-position-details.png) + +--- + +## Managing Collateral + +To manage your collateral, you can navigate your position's **"Collateral"** indicator and click on the **pencil icon** to edit the amount of collateral. + +In the Collateral modal, you can see the current leverage, liquidation price and amount of collateral in the position in USD. By depositing or withdrawing collateral, you can visualise how it will impact your position. + +:::caution Always check your transactions +You can utilise blockchain explorers like [Solscan](https://solscan.io/) to check the status of your transaction. + +If your request to deposit/withdraw collateral is not confirmed, but you have attempted to submit, it does not mean your position is updated. +::: + +![Manage Collateral](../../static/perps/trade-manage-collateral.png) + +--- + +## Managing Take Profit and Stop Loss + +To manage your take profit price and stop loss price, you can navigate your position's **"Take Profit"** and **"Stop Loss"** indicator and click on the **pencil icon** to edit the price. + +In the edit modal, you can see the current take profit price and stop loss price, manage them by editting the price fields. + +:::tip Valid prices +For Take Profit price, you can only set a price higher than the entry price. + +For Stop Loss price, you can only set a price lower than the entry price but higher than the liquidation price. + +![Valid Prices](../../static/perps/trade-manage-tp-sl-valid-prices.png) +::: + +:::caution Always check your transactions +You can utilise blockchain explorers like [Solscan](https://solscan.io/) to check the status of your transaction. + +If your request to edit take profit or stop loss is not confirmed, but you have attempted to submit, it does not mean your position is updated. +::: + +![Manage Take Profit and Stop Loss](../../static/perps/trade-manage-tp-sl.png) \ No newline at end of file diff --git a/guides/500-perps/102-how-to-close-position.md b/guides/500-perps/102-how-to-close-position.md new file mode 100644 index 00000000..33003152 --- /dev/null +++ b/guides/500-perps/102-how-to-close-position.md @@ -0,0 +1,56 @@ +--- +sidebar_label: How to close position +title: How to close position? +description: Introduction to how to close position +--- + + + How to close position + + + +In this guide, we will walk you through how to close your position on Jupiter Perps. Remember to always check your transactions on blockchain explorers like [Solscan](https://solscan.io/) to ensure your position is closed. + +--- + +### Step 1: Navigate to Positions Tab + +In the **Positions Tab**, select the position you want to close. Do take note of the position details to ensure you are closing the correct position. + +### Step 2: Open Close Position Modal + +In the position details, click on the **"Close"** button to open the close position modal. In this modal, you can see the current position details and the amount of collateral you will receive after closing the position. + +Again, do take note of the position details to ensure you are closing the correct position. + +![Close Position Modal](../../static/perps/trade-close-position.png) + +### Step 3: Edit Close Size + +You can edit the close size to close your position partially or fully. + +:::tip Partial Close +If you choose to close your position partially, when you decide to open a new position in the same market, the current partially closed position will be combined with the new position, meaning you will only have 1 position for each market. + +For example, if you have a 100 SOL position and you close 50 SOL. When you open a new position, the 50 SOL will be combined with the new position. +::: + +![Close Position Size](../../static/perps/trade-close-position-size.png) + +### Step 4: Choose Token to Receive + +You can choose which tokens you want to receive after closing the position. The collateral tokens will be swapped via Jupiter Swap to the token you choose. + +![Close Position Token](../../static/perps/trade-close-position-token.png) + +### Step 5: Submit Transaction + +After reviewing the position details, click on the **"Confirm"** button to agree to the details and create a transaction for your request. You’ll need to approve the transaction in your connected wallet. Once approved, your request is submitted and when it has landed and **confirmed** on the blockchain, only then your position is closed. + +:::caution Always check your transactions +You can utilise blockchain explorers like [Solscan](https://solscan.io/) to check the status of your transaction. + +If your request to close your position is not confirmed, but you have attempted to submit, it does not mean your position is closed. +::: + +![Close Position Confirm](../../static/perps/trade-close-position-confirm.png) diff --git a/guides/500-perps/103-how-to-use-limit-order.md b/guides/500-perps/103-how-to-use-limit-order.md new file mode 100644 index 00000000..7947ba6d --- /dev/null +++ b/guides/500-perps/103-how-to-use-limit-order.md @@ -0,0 +1,57 @@ +--- +sidebar_label: How to use limit order +title: How to use limit order? +description: Introduction to how to use limit order +--- + + + How to use limit order + + + +In this guide, we will walk you through how to use limit order on Jupiter Perps. + +--- + +### Step 1: Create a Limit Order + +You can create a limit order to open or increase a position using either USDC or the underlying asset as collateral. For example, when trading SOL-PERP, you can use either USDC or SOL as collateral. + +### Step 2: Set Your Limit Price + +When creating a limit order, you can set your desired entry price either above or below the current market price. +- Set buy orders below market price to enter on dips +- Set sell orders above market price to enter on rallies + +**Long Position Limit Price** + +- The maximum limit price of a long position can only be **1% below the current market price**. +- The minimum limit price of a long position is **half of the current market price**. +- If the current market price is 100, the maximum limit price of a long position is 98 and minimum limit price is 50. + +**Short Position Limit Price** + +- The maximum limit price of a short position can only be **1% above the current market price**. +- The minimum limit price of a short position is **twice the current market price**. +- If the current market price is 100, the maximum limit price of a short position is 102 and minimum limit price is 200. + +### Step 3: Understand How Limit Orders Work + +Limit orders operate independently from your existing positions. + +- They remain active until either triggered at your specified price or manually cancelled. +- If triggered, they will either: + 1. Open a new position if you have no existing position. + 2. Increase and combine with your existing position in that market. +- They stay active even if you close or get liquidated on an existing position. + +:::caution Liquidation Price on Order Form +If you do not have an existing position, the liquidation price on the order form for a Limit Order will be the simulated liquidation price based on the position requested. + +If you have an existing position, the liquidation price on the order form will **not** be the new liquidation price of your position after your limit order executes, as the limit order will be executed in the future where we do not know the state of the current existing position. +::: + +## Limitations + +- The Perps V2 Beta does not support multiple limit orders, please cancel the existing limit order before creating a new one. +- When the selected market's utilisation is above 80%, new limit orders cannot be created. \ No newline at end of file diff --git a/guides/500-perps/11-leverage-management.md b/guides/500-perps/11-leverage-management.md new file mode 100644 index 00000000..d2500aa8 --- /dev/null +++ b/guides/500-perps/11-leverage-management.md @@ -0,0 +1,37 @@ +--- +sidebar_label: Leverage Management +title: Leverage Management +description: How the Jupiter Perpetuals Exchange Leverage Management works +--- + + + Perps: Leverage Management + + + +Leverage allows you to trade larger positions than your initial collateral by borrowing funds. On Jupiter Perps, you can use leverage to increase your position size, allowing you to amplify potential profits. However, leverage also increases risk, as both gains and losses are magnified. + +--- + +## How Leverage Works + +To allow for leverage, traders borrow assets from the JLP pool to create a larger position. For example, a 2x leverage long position SOL-USD requires 1x SOL as collateral and 1x SOL as borrow. + +#### Leverage Limits + +Jupiter Perps offers leverage up to **100x** for SOL, ETH, and wBTC. You can adjust your leverage depending on the size of your position and the risk you’re willing to take. The more leverage you use, the higher the potential profit, but the greater the risk of liquidation. + +#### Borrow Fees + +This borrow leads to an **hourly borrow rate** to be paid to the JLP pool. Positions always pay [borrow fees](./fees) and are never paid funding. + +This means actual leverage for a position will be slightly lower as the calculation takes into account all fees associated with maintaining the position. + +#### Reducing Position Size +When reducing a position’s size, the collateral is also adjusted accordingly to maintain the same leverage. For example, if you’re holding a position with 10x leverage and reduce the size by 50%, the collateral is decreased by the same proportion to ensure that the leverage remains at 10x. + +#### Auto Closing Positions that Exceed Maximum Leverage + +The maximum allowed leverage is 500x. + +Positions will be liquidated if the trader's collateral, after subtracting fees, adding unrealized profits or subtracting unrealized losses, is less than 0.2% of the position size. diff --git a/guides/500-perps/12-liquidation.md b/guides/500-perps/12-liquidation.md new file mode 100644 index 00000000..c662338a --- /dev/null +++ b/guides/500-perps/12-liquidation.md @@ -0,0 +1,57 @@ +--- +sidebar_label: Liquidation +title: Liquidation +description: How the Jupiter Perpetuals Exchange Liquidation works +--- + + + Perps: Liquidation + + + +Liquidation is a mechanism that automatically closes a position when the trader's collateral is insufficient to maintain the position. On Jupiter Perps, keepers monitor the liquidation price and automatically close positions when the price falls below the liquidation price. + +If you face any issues, please reach out to us on [Discord](https://discord.gg/jup). + +--- + +:::caution Fluctuating Liquidation Price +It's crucial to note that the liquidation price is subject to change over time, particularly positions with leverage exceeding 10x and positions held across a long period of time, accumulating borrow fees. + +To mitigate the risk of liquidation: +1. Collateral adjustments and leverage fine-tuning can be performed through the `Edit` button in the position row. +2. Regularly monitor your liquidation price. +::: + +## Long + +Liquidation for long positions occurs when the current token price falls below the liquidation price. + +For example, if the liquidation price is $90, the long position will be closed if the token's price drops to $90 or lower. + +## Short + +Liquidation for short positions occurs when the current token price rises above the liquidation price. + +For example, if the liquidation price is $110, the short position will be closed if the token price rises to $110 or higher. + +## Calculating Liquidation Price + +The liquidation price can be calculated with the following formula. + +| Variable | Description | +|----------|-------------| +| `price` | The average price (USD) of the position | +| `collateral_size` | The collateral size (USD) for the position | +| `close_fee` | The fee (USD) charged for closing the position | +| `borrow_fee` | The accumulated borrowing fees (USD) for maintaining a leveraged position | +| `size` | The size (USD) of the position | +| `max_lev` | The maximum allowed leverage (**500x** is the maximum allowed leverage in the Jupiter Perpetuals exchange for now) | + +**For long positions** + +![Long Position Calculation](../../static/perps/long-formula.png) + +**For short positions** + +![Short Position Calculation](../../static/perps/short-formula.png) diff --git a/guides/500-perps/13-fees.md b/guides/500-perps/13-fees.md new file mode 100644 index 00000000..feb63c14 --- /dev/null +++ b/guides/500-perps/13-fees.md @@ -0,0 +1,372 @@ +--- +sidebar_label: Fees +title: Fees +description: How the Jupiter Perpetuals Exchange Fees works +--- + + + Perps: Fees + + + +There are 4 types of fees on Jupiter Perps: + +1. A flat 0.06% (6bps) base fee, applied on notional position size. +2. A price impact fee, simulating the orderbook impact given notional size. +3. Borrow fee, paid hourly on open positions, based on notional size. +4. Transaction & Priority fee to create trade requests. + +--- + +## Base Fees + +A flat rate of **0.06%** of the position amount is charged when opening or closing a position. This base fee is also charged when a position is closed partially. + +### Calculating Base Fees + +Position size * 0.06% = Base Fee + +
+ +
+
+ Price Impact Fee Example +
+
+ + +``` +BPS_POWER = 10^4 // 10_000 + +// 1. Get the base fee (BPS) from the JLP pool account's `fees.increasePositionBps` for open position requests +// or `fees.decreasePositionBps` for close position requests +// https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#pool-account +baseFeeBps = pool.fees.increasePositionBps + +// 2. Convert `baseFeeBps` to decimals +baseFeeBpsDecimals = baseFeeBps / BPS_POWER + +// 3. Calculate the final open / close fee in USD by multiplying `baseFeeBpsDecimals` against the trade size +openCloseFeeUsd = tradeSizeUsd * baseFeeBpsDecimals +``` + +
+ +--- + +## Price Impact Fees + +Large trades on the Jupiter Perpetuals exchange inherently incur no price impact since token prices are sourced from price oracles. While this is favourable for traders, it poses risks to the Jupiter Liquidity Pool (JLP). + +1. Large, profitable trades can put stress on the liquidity pool’s reserves. +2. The platform becomes more vulnerable to potential order manipulation. + +To address these risks, Jupiter Perpetuals implements a **price impact fee**. This fee is designed to simulate trading conditions in traditional exchanges, where larger orders typically experience more price slippage due to limited liquidity at each price level. + +![Price Impact Fee](../../static/perps/price-impact-fee-graph.png) + +### Benefits of Price Impact Fees + +1. **Trader Incentives:** + + The fee encourages traders to consider the size of their trades, where larger trades will incur higher price impact fees. Also, splitting large orders to smaller sizes can expose traders to price changes between updates from the oracle. + +2. **Fair Compensation to JLP Holders:** + + JLP Pool receives trading fees, whether traders open large trades or split them up. This keeps the liquidity pool balanced and protects it from excessive depletion. + +3. **Market Integrity:** + + The fee structure mimics traditional order book dynamics, where the fee is proportional to the impact a trade might have on the market, making the environment fairer for both traders and liquidity providers. + +### Calculating Price Impact Fees + +![Price Impact Fee Calculation](../../static/perps/price-impact-fee-formula.png) + +
+ +
+
+ Price Impact Fee Example +
+
+ + +``` +USDC_DECIMALS = 10^6 // 1_000_000 +BPS_POWER = 10^4 // 10_000 + +Calculate Price Impact Fee: + +// 1. Get the trade impact fee scalar from the custody account's `pricing.tradeImpactFeeScalar` constant +// https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#custody-account +tradeImpactFeeScalar = custody.pricing.tradeImpactFeeScalar + +// 2. Convert trade size to USDC decimal format +tradeSizeUsd = tradeSizeUsd * USDC_DECIMALS + +// 3. Scale to BPS format for fee calculation +tradeSizeUsdBps = tradeSizeUsd * BPS_POWER + +// 4. Calculate price impact fee percentage in BPS +priceImpactFeeBps = tradeSizeUsdBps / tradeImpactFeeScalar + +// 5. Calculate final price impact fee in USD +priceImpactFeeUsd = (tradeSizeUsd * priceImpactFeeBps / BPS_POWER) / USDC_DECIMALS +``` + +
+ +--- + +## Borrow Fees + +On the Jupiter Perpetuals exchange, traders can open leveraged positions by borrowing assets from the liquidity pool. Unlike other exchanges that charge funding rates, Jupiter Perps uses a borrow fee system. The borrow fees compound hourly based on the amount borrowed for the leveraged position. + +:::caution Deducted from Collateral +Borrow fees are continuously accrued and deducted from your collateral. This ongoing deduction has two important consequences: + +1. Your effective leverage increases over time as your collateral decreases. +2. Your liquidation price moves closer to the current market price. + +It's crucial to regularly monitor your borrow fees and liquidation price. Failure to do so may result in unexpected liquidation, especially during periods of high market volatility or extended position duration. +::: + +:::tip +The hourly borrow rates for JLP assets can be retrieved from the Borrow rate field of the Jupiter Perpetuals trade form or fetched onchain via the [custody account's `funding_rate_state.hourly_funding_dbps` field](../../docs/perp-api/custody-account#fundingratestate). Note that these rates represent the maximum charged at 100% utilization. +::: + +#### Dual Slope Model + +Jupiter's hourly borrow fee is calculated using a **dual slope model** that adjusts based on the custody's utilization rates. For each custody, the model defines a target utilization level. + +When utilization is below the target level, the borrow rate is lower which incentivizes traders to borrow from the pool, thus increasing utilization and yield for the JLP. Once utilization exceeds the target level, the borrow rate increases aggressively. + +![Dual Slope Borrow Fee](../../static/perps/dual-slope-borrow-fee.png) + +### Benefits of Dual Slope Model + +1. **Incentivizing Trading Opportunities** + + Low utilization results in a lower borrow rate, incentivizing traders to borrow from the pool which increases utilization and yield for the JLP. + +2. **Risk Mitigation** + + High utilization results in a higher borrow rate, incentivizing traders to reduce their position size as the higher borrowing costs outweigh potential returns, preventing excessive leverage and overutilization of the JLP's assets; while also incentivizing additional liquidity providers to enter the market. + +3. **Incentivizing Liquidity Provisioning** + + High borrow rates also incentivize additional liquidity providers to enter the market, which benefits the traders with more liquidity in the pool. + +### Calculating Borrow Fees + +The dual slope model uses four parameters to calculate the borrow rate: + +- **Minimum rate**: The lowest borrow rate, applied at 0% utilization +- **Maximum rate**: The highest borrow rate, applied at 100% utilization +- **Target rate**: The borrow rate when utilization reaches its target level +- **Target utilization**: The optimal utilization level for the custody + +
+ +
+
+ Calculating Borrow Rate +
+
+ + +The parameters above can be fetched onchain from the min_rate_bps, max_rate_bps, target_rate_bps, and target_utilization_rate fields via the [custody account's jump_rate_state field](../../docs/perp-api/custody-account#jumpratestate). + +``` +# First, calculate the slopes for both curves +lower_slope = (target_rate - minimum_rate) / target_utilization +upper_slope = (maximum_rate - target_rate) / (1 - target_utilization) + +# Calculate the borrow rate based on current utilization +if utilization < target_utilization: + # Below target utilization: Use gentler slope starting from minimum_rate + borrow_rate = minimum_rate + (lower_slope * utilization) +else: + # Above target utilization: Use steeper slope starting from target_rate + borrow_rate = target_rate + (upper_slope * (utilization - target_utilization)) +``` + +:::info +The borrow rate is calculated above is expressed as the annual rate (APR). To get the hourly borrow rate, divide the APR by 8,760 hours. +::: + +
+ +
+ +
+
+ Calculating Utilization Rate +
+
+ + +To determine the current utilization rate, access the asset's [on-chain account](../../docs/perp-api/custody-account) and apply the following calculation: + +``` +// Calculate utilization percentage +if (custody.assets.owned > 0 AND custody.assets.locked > 0) then + utilizationPct = custody.assets.locked / custody.assets.owned +else + utilizationPct = 0 +``` + +
+ +
+ +
+
+ Hourly Borrow Fee Example +
+
+ + +#### Worked Example + +Assume the borrow rate parameters are as below: + +* `Minimum Rate`: 10% +* `Max Rate`: 230% +* `Target Rate`: 60% +* `Target Utilization`: 80% + +Based on the formula above, we can obtain the upper slope and lower slope values for the dual slope borrow rate curve: + +* `Lower Slope` = (60% - 10%) / 80% = 62.5% +* `Upper Slope` = (230% - 60%) / 20% = 850% + +Assume the trader is opening a position with size **$10,000**. + +#### Scenario 1: 40% Utilization (below target level) + +* `Borrow Rate` = 10% + (62.5% × 40%) = 10% + 25% = 35% + +The hourly borrow rate is calculated by dividing the borrow rate by the number of hours in a year: + +* `Hourly Borrow Rate` = 35% / 8760 = ~0.004% + +This means the position will accrue a borrow fee of `0.004% * $10,000 = $0.40` every hour. + +#### Scenario 2: 90% Utilization (above target level) + +Assume the current utilization rate is 85% which is above the target utilization level of 80% from the example above, the calculation is as follows: + +* `Borrow Rate` = 60% + (850% × 10%) = 60% + 85% = 145% + +The hourly borrow rate is calculated by dividing the borrow rate by the number of hours in a year: + +* `Hourly Borrow Rate` = 145% / 8760 = ~0.0166% + +This means the position will accrue a borrow fee of `0.0166% * $10,000 = $1.66` every hour. + +
+ +
+ +
+
+ How does the Jupiter Perpetuals contract calculate borrow fees? +
+
+ + +Due to Solana's blockchain architecture, calculating funding fees in real-time for each position would be computationally expensive and impractical. Instead, the Jupiter Perpetuals contract uses a counter-based system to calculate borrow fees for open positions. + +The [pool](../../docs/perp-api/pool-account) and [position](../../docs/perp-api/position-account) accounts maintain two key fields: + +* The pool account maintains a global cumulative counter through its `fundingRateState.cumulativeInterestRate` field, which accumulates interest rates over time +* Each position account tracks its own `cumulativeInterestSnapshot` field, which captures the global counter's value whenever a trade is made: when the position is opened, when its size is increased, when collateral is deposited or withdrawn, or when the position is closed + +To calculate a position's borrow fee, the contract takes the difference between the current global interest rate counter and the position's snapshot, then multiplies this by the position size. This approach enables efficient on-chain calculation of borrow fees over a given time period without needing real-time updates for each position. + +The example below demonstrates the borrow fee calculation: + +``` +// Constants: +BPS_DECIMALS = 4 // 10^4, for basis points +DBPS_DECIMALS = 5 // 10^5, decimal basis points for precision +RATE_DECIMALS = 9 // 10^9, for funding rate calculations +USD_DECIMALS = 6 // 10^6, for USD amounts as per the USDC mint's decimals + +// Main calculation: +1. Get the cumulative interest rate from the pool account: + cumulativeInterestRate = pool.cumulative_interest_rate + +2. Get the position's borrow rate snapshot: + borrowRateSnapshot = position.cumulative_interest_snapshot + +3. Get the position's borrow rate interval: + borrowRate = cumulativeInterestRate - borrowRateSnapshot + +4. Calculate final borrow fee (USD): + borrowFeeUsd = (borrowRate * position.size_usd) / (10 ^ RATE_DECIMALS) / (10 ^ USD_DECIMALS) +``` + +
+ +--- + +## Funding rate + +**There is no funding rate for Jupiter Perps**. The Jupiter Perps platform does not behave like a standard futures platform where longs pay shorts (or vice-versa) based on the funding rate, since traders borrow from the JLP Pool which incurs a [borrow fee](#borrow-fee). + +--- + +## Example Trade + +Suppose a trader wants to open a 2x long SOL position at a position size of $1000 USD by depositing $500 USD worth of SOL as a collateral and borrowing $500 USD worth of SOL from the pool. Assume the hourly borrow rate for SOL is **0.012%**. + +| Initial Position Value | $1000 | +| --- | ----- | +| Initial Deposit | $500 | +| Borrowed Amount | $500 | +| Leverage | 2x | +| Initial SOL Price | $100 | +| Utilization Rate | 50% | +| Hourly Borrow Rate | 0.012% per hour | +| Position Opening Fee | `0.06% * $1000 = $0.6` | + +The trader keeps this position open for 2 days, and the price of SOL appreciates by 10%. + +| Final Position Value | $1100 | +| --- | ----- | +| Final SOL Price | $110 | +| Holding Period | 2 days (48 hours) | +| Position Closing Fee | `0.06% * $1100 = $0.66` | + +The borrow fee accumulated throughout this period can be calculated as: + +- `Hourly Borrow Fee = Tokens Borrowed/Tokens in the Pool * Hourly Borrow Rate * Position Size` +- `Total Borrow Fee = 50% * 0.012% * 1000 * 48 = $2.88 USD` + +The trader's final profit can be calculated as: + +- `Final Profit = Final Position Value - Initial Position Value - Borrow Fee - Opening Fee - Closing Fee` +- `$1100 - $1000 - $2.88 - $0.6 - $0.66 = $95.86` + +The trader gets a final profit of **$95.86 USD** after this trade. + +--- + +## Calculating Programmatically + +This [code repository](https://github.com/julianfssen/jupiter-perps-anchor-idl-parsing/blob/main/src/examples/) contains the examples on calculating the different fees programmatically. + +## References + +Jupiter is working with experts like [Chaos Labs](https://www.chaoslabs.xyz/) and [Gauntlet](https://www.gauntlet.xyz/) to optimize and maintain a fair, safe and competitive environment by analyzing different fee structures and their impact on the exchange. Here are some of the references on the recommendations. + +- [Jul 2024:Gauntlet's proposal and analysis on the price impact fee here](https://www.jupresear.ch/t/gauntlet-comprehensive-analysis-jupiter-perpetuals-price-impact-structure-implementation-and-proposed-adjustments/19127) + +- [Aug 2024: Gauntlet's proposal and analysis on the borrow fee here](https://www.jupresear.ch/t/gauntlet-jupiter-perpetuals-optimization-borrowing-rate-reduction-and-competitive-analysis-vs-okx-and-bybit/21580) + +- [Dec 2024: Dual Slope Model](https://www.jupresear.ch/t/gauntlet-dual-slope-borrowing-rate-model-implementation-and-recommendations-12-19-24/29072) + +- [Dec 2024: Borrowing Rate Jump Model](https://www.jupresear.ch/t/chaos-labs-borrowing-rate-jump-rate-model-recommendations/29203) diff --git a/guides/500-perps/14-oracle.md b/guides/500-perps/14-oracle.md new file mode 100644 index 00000000..f202a966 --- /dev/null +++ b/guides/500-perps/14-oracle.md @@ -0,0 +1,40 @@ +--- +sidebar_label: Oracle +title: Oracle +description: How the JupiterPerpetuals Exchange Oracle works +--- + + + Perps: Oracle + + + +Jupiter Perps utilizes a robust Oracle Network, **Dove Oracle**, co-designed by **Jupiter** and **Chaos Labs** and audited by **Offside Labs**. This oracle is built specifically for **Jupiter Perpetuals** and leverages **Chaos' Edge Pricing Data**, ensuring real-time accuracy and reliability. It is also fully accessible for anyone on **Solana**. + +--- + +## Dove Oracle + +The Dove Oracle is designed with **Jupiter Perps** in mind, addressing unique needs like **compute efficiency** and **rapid updates**, allowing us to update all 5 oracles (SOL, BTC, ETH, USDC, USDT) when opening and closing positions. + +:::tip Using Dove Oracle +To understand the account structure of Dove Oracle and to use the oracle in your own applications, please refer to the [Price Feed Accounts](../../docs/perp-api/price-feed-account) page. +::: + +![Dove Oracle](../../static/perps/dove-oracle.png) + +### Key Benefits +| Benefits | Old Oracle | Our Oracle | +| --- | ----- | ----- | +| Reliability | Position requests fail if the oracle doesn’t update in 45 seconds. | Position requests are processed instantly with the oracle update in the same transaction. | +| Latency | Trades are delayed as keepers wait for the oracle update before placing orders. | Trades are executed immediately as the oracle data is incorporated into the transaction. | +| Chart | Discrepancy between trades placed and chart data. | Our oracle powers both the trading view chart and position requests, eliminating discrepancies. | + +## Oracle Redundancy + +It is critical to ensure oracle redundancy, this allows for additional checks, fallbacks to ensure the exchange has the correct price data. The Perps Keepers also utilize Pyth Oracles. + +- As a reference price check (sanity check) against the Dove Oracle, ensuring that the deviation is not too big. +- As a fallback price if our oracle's prices are stale. + +This way, Jupiter Perps benefits from the Dove oracle while still being able to rely on the Pyth oracle. diff --git a/guides/500-perps/15-keeper.md b/guides/500-perps/15-keeper.md new file mode 100644 index 00000000..a2edde87 --- /dev/null +++ b/guides/500-perps/15-keeper.md @@ -0,0 +1,66 @@ +--- +sidebar_label: Keeper +title: Keeper +description: How the Jupiter Perpetuals Exchange Keeperworks +--- + + + Perps: Keeper + + + +Jupiter Perpetual Exchange operates using a request fulfilment model to create and execute trade requests. + +--- + +The process for executing a typical trader action involves two key steps: + +1. The **trader** submits a **request** to our backend via API. +2. The **keeper** monitors the request, then validates and **executes** it on-chain. + +:::note What is a keeper? +Keepers are offchain services that listen to events and perform actions based on it. They enable automatic and timely execution of trade requests without manual intervention. +::: + +![Keeper](../../static/perps/keeper.png) + +## Create trade request + +A trader can perform the following actions on the Jupiter Perpetuals exchange. + +- Open position +- Close position +- Increase position size +- Decrease position size / close partial position +- Deposit collateral +- Withdraw collateral +- Create take profit (TP) / stop loss (SL) order +- Edit TP / SL order +- Close TP / SL order + +The trader performs the actions above through the Jupiter Perpetuals platform or via the API. The frontend or API server then verifies the action and submits a request to keepers to execute the action on-chain. + +For example, if the trader created an open position request, the request would contain data such as the trade size, collateral size, position side, and other data required to fulfil the request and ultimately the keeper would open the position on-chain. + +## Fulfil trade request + +Jupiter hosts keepers that monitors for trade requests. Once a trade request is fetched by a keeper, it verifies the trade request before creating and submitting the transaction to execute the trade on-chain. + +The request is executed **only** when the transaction succeeds and is confirmed by the Solana blockchain. This means, for every trade requests, you do not need to pay for transaction fees, as the keeper will pay for it, making the Jupiter Perpetuals exchange a **zero-fee** exchange. + +## Frequently Asked Questions + +### Is the keeper open source? + +No, the keeper is not open source. However, our keepers are audited and are tested extensively before they're deployed. + +### Can I host my own keeper? + +We do not allow community members to run their own keepers at the moment. As mentioned above, our keepers are audited and tested extensively so they're able to execute trade requests reliably. + +### Where do I see the keeper accounts? + +We currently run two keepers: + +- https://solscan.io/account/A2rCQdCqQB4wu72x9Q7iq1QugtdZmcyWsiSPfgfZzu2u +- https://solscan.io/account/DFZcDnmEYNUK1khquZzx5dQYiEyjJ3N5STqaDVLZ88ZU diff --git a/guides/500-perps/20-jlp-pool-and-token.md b/guides/500-perps/20-jlp-pool-and-token.md new file mode 100644 index 00000000..fcafcae8 --- /dev/null +++ b/guides/500-perps/20-jlp-pool-and-token.md @@ -0,0 +1,75 @@ +--- +sidebar_label: JLP Pool and Token +title: JLP Pool and Token +description: Introduction to the JLP Pool and Token +--- + + + JLP Pool and Token + + + +The Jupiter Liquidity Provider (JLP) Pool is a liquidity pool that acts as a counterparty to traders on Jupiter Perps. Traders borrow tokens from the pool to open leveraged positions on the Jupiter Perpetuals exchange. + +--- + +## The Pool + +The Jupiter Perpetuals exchange is a trader-to-LP exchange which means traders borrow tokens from the liquidity pool (the JLP pool) for leverage. + +Instead of periodic funding payments between long and short traders, Jupiter Perpetuals implements an hourly borrow fee mechanism. + +Traders pay these fees to the pool based on the amount of tokens they've borrowed. This mechanism helps secure the balance of the pool's assets and compensates liquidity providers for the use of their tokens. + +:::note Relationship between the pool and traders +The pool is a counterparty to traders on Jupiter Perps. Traders borrow tokens from the pool to open leveraged positions on the Jupiter Perpetuals exchange. + +It is very important to everyone that the relationship between the liquidity providers and traders remain healthy yet competitive, to provide a vibrant experience for everyone. +::: + +--- + +## The JLP Token + +The JLP token is an SPL token that represents a share of the JLP Pool. The value of the token is dervied from: + +- The index fund of **SOL, ETH, WBTC, USDC, USDT**. +- The trader's profit and loss. +- 75% of all trading fees. + - Base fees. + - Price impact fees. + - Borrow fees. + +### Adding Liquidity + +JLP can be acquired by swapping directly on Jupiter Swap to achieve the best price, which can be either purchasing it off the open market (like from other AMMs) or swapping it to one of JLP's underlying tokens and depositing that into JLP directly. + +While JLP is still being minted, your assets may be deposited into the relevant token pool increasing the current weightage. At the point of depositing assets into the JLP pool, the protocol will re-price the TVL in the USD value. + +### Removing Liquidity + +JLP can also be sold via Jupiter Swap to any tradable token. It can be either transferred to another trader or redeemed by the JLP Pool, which the JLP token will be burned and releasing some of the currency contained in the pool. + +:::info +This automatic minting/burning mechanism is unique to Jupiter Swap and programs that route via Jupiter Swap. If you're interacting directly on a different DEX, you will trade JLP at the price offered by the DEX instead of the virtual price of JLP. + +**Only the Jupiter Perpetuals program (which is integrated in Jupiter Swap) has the authority to mint and burn JLP tokens.** +::: + +--- + +## Advantages of the JLP System + +The JLP system offers a user-friendly method for participants to earn passive income while contributing to the liquidity and stability of the trading environment: + +- LPs do not need to actively "stake" tokens or "harvest" yields - APR earnings are embedded within each JLP token and accumulate automatically (reflected as an increase in the JLP token price). +- The JLP token is also an SPL token, making it easily transferable and tradable like other SPL tokens within the Solana ecosystem. +- AMM pools can be established for trading JLP tokens. + +## How to Become a Liquidity Provider + +Anyone can become a Liquidity Provider by contributing assets or tokens to the Jupiter Liquidity Provider Pool (JLP Pool). + +- JLP tokens represent your share of the pool. +- You can buy JLP tokens directly on Jupiter Swap, using any tradable tokens. +- There are fees associated with buying into the JLP pool (see Target Ratio and Fees). diff --git a/guides/500-perps/21-jlp-fee-distribution.md b/guides/500-perps/21-jlp-fee-distribution.md new file mode 100644 index 00000000..807b6fcf --- /dev/null +++ b/guides/500-perps/21-jlp-fee-distribution.md @@ -0,0 +1,108 @@ +--- +sidebar_label: Fee Distribution +title: Fee Distribution +description: How fees are distributed back to the JLP Pool +--- + + + JLP Fee Distribution + + + +In this section, we will discuss the fees generated by the exchange, how to estimate the yield, APR and how it is distributed back to the JLP Pool. + +--- + +## Fees + +The exchange generates fees in various ways and **75% of all fees generated go into the pool**. + +| Action | Fee | +| ---------------------------|----------------------------------------------------------------------------------------| +| Opening a Position | 6 BPS (variable) | +| Closing a Position | 6 BPS (variable) | +| Price Impact Fee | Dependent on size of the trade (variable) | +| Swap Fee (Mint / Burn JLP) | Between 0 BPS to 150 BPS depending on pool weightage | +| Borrow Rate | Dynamically updated based on utilization and market conditions | + +:::tip Fee Breakdown +To fully understand each fee and how they are imposed, [please refer to the trader's guide on fees](./fees). +::: + +--- + +## Fee Distribution + +The fees are distributed back to the JLP Pool **hourly**. It occurs at the start of every hour, in UTC time (e.g. `00:00 UTC`, `01:00 UTC`, `02:00 UTC`, and so on). + +During the distribution, 75% of realised fees are withdrawn from each custody account's `assets.fees_reserves` and deposited back into the JLP Pool (while the remaining 25% is sent to Jupiter as a protocol fee). + +:::tip +[Learn more about the on-chain accounts associated with JLP and Jupiter Perps in the developer documentation](../../docs/perp-api/position-account). +::: + +## APR Calculation + +The JLP Pool maintains a `pool_apr.last_updated` field on-chain which records a UNIX timestamp of the latest APR update. After a **consecutive week** of hourly fee distributions have passed, the APR is recalculated and updated to `pool_apr.fee_apr_bps`. + +
+ + APR Calculation Formula + + +``` +if current_time > (last_updated_time + 1_WEEK): + time_diff = current_time - last_updated_time + // 10_000 represents the scaling factor used to calculate the BPS for the pool's APR + apr_bps = (realized_fee_usd * YEAR_IN_SECONDS * 10_000) / (pool_amount_usd * time_diff) +``` + +
+ +## Estimating Yield + +To provide an estimated perspective, you can calculate potential revenue by taking the Jupiter Perpetual Exchange's daily or weekly total volume and multiplying it by a fee percentage. + +:::info Yield Calculation Factor +It is essential to note that pool earnings and losses (index token appreciation/depreciation) are not factored in the overall yield calculation. +::: + +### Calculate Total Estimated Revenue + +To determine the total estimated revenue (excluding price impact and hourly borrow fees) to be deposited into JLP pool, use the following formula. + +
+ +![Estimated Revenue Formula](../../static/perps/jlp-revenue.png) + +
+ +Using the example values, the estimated revenue to be deposited into JLP pool would be: + +- Total Daily Volume: 50 million +- Fee Percentage: 0.06% +- Price Impact Fees: Minimum 0.01% +- Revenue Share Percentage: 75% +- **Estimated Revenue: 50_000_000 x 0.06% x 75% = 22_500** + +### Calculate Estimated Share + +To determine your specific share or weight in the total JLP pool, use the following formula. + +
+ +![Estimated Share Formula](../../static/perps/jlp-share.png) + +
+ +Using the example values, the estimated share percentage would be: + +- Your contribution: 1_000 +- Total pool amount: 4_000_000 +- **Your share percentage: 1_000 / 4_000_000 x 100 = 0.025%** + +### CalculateEstimated Revenue Share + +Finally, you can calculate your estimated generated revenue share by multiplying the results of the first and second calculations: + +**Estimated revenue share you generate = 22_500 x 0.025% = $5.625** diff --git a/guides/500-perps/22-jlp-pool-weightage.md b/guides/500-perps/22-jlp-pool-weightage.md new file mode 100644 index 00000000..fe1912ef --- /dev/null +++ b/guides/500-perps/22-jlp-pool-weightage.md @@ -0,0 +1,58 @@ +--- +sidebar_label: Pool Weightage +title: Pool Weightage +description: How the JLP Pool Weightage works +--- + + + JLP Pool Weightage + + + +In the JLP Pool, each asset is assigned a target weight, which is set by the team. + +--- + +## Managing Pool Weightage + +Jupiter is working with [Chaos Labs](https://chaoslabs.xyz/) and [Gauntlet](https://gauntlet.xyz/) to conduct regular risk assessments and market analyses in response to the evolving market conditions. These assessments are also discussed with the community before they are presented to the team for deployment. + +:::info +The risk assessments can be found at https://www.jupresear.ch/tag/risk. +::: + +![Target Weight](../../static/perps/jlp-weightage.png) + +## Maintaing Target Weight + +The weightages of each asset in the JLP Pool will differ based on market activity, particularly spot trading or deposit and withdrawal of assets into JLP Pool. To help maintain the Target Weight, JLP dynamically sets a Swap Fee or Mint/Redeem Fee. + +**USDC Example** + +- Current weightage of USDC is **higher** than its advised target weightage. + + USDC deposits into the JLP Pool will incur additional fees, while USDC withdrawals will receive a fee discount. + +- Current weightage of USDC is **lower** than its advised target weightage. + + USDC deposits into the JLP Pool will receive a fee discount, while USDC withdrawals will incur additional fees. + +![Target Weight Balancing](../../static/perps/jlp-target-weight-balancing.jpg) + +Simply put, transactions that shift an asset’s current weightage further away from the target weightage incur additional fees while transactions that shift it closer to the target weightage will receive a discount on fees. This is based on the fee incurred when minting or burning JLP during the swap. + +This allows JLP to maintain its target weight as liquidity providers are incentivized to maintain the target weightage amid high volumes of spot trading or deposit/withdrawal activity. + +## Failsafe Mechanism + +> How far can the current weightage of an asset deviate from its target weightage? + +An asset’s current weightage can deviate from its target weightage by a maximum of 20% of the target weightage value. + +**Example** + +- If the advised target weightage of **USDC** in the JLP pool is **26%**, the current weightage of the asset in the JLP pool can deviate between a range of **20.8% (-20%) and 31.2% (+20%)**. + - USDC cannot be **deposited** into the pool if the current weightage goes above **31.2%**. + - USDC cannot be **withdrawn** from the pool if the current weightage goes below **20.8%**. + +This means that during a Black Swan event where a JLP asset depegs, the maximum loss is `Target Weight * 1.2`. diff --git a/guides/500-perps/23-jlp-risks.md b/guides/500-perps/23-jlp-risks.md new file mode 100644 index 00000000..4b73a34b --- /dev/null +++ b/guides/500-perps/23-jlp-risks.md @@ -0,0 +1,50 @@ +--- +sidebar_label: Risks +title: Risks +description: Risks associated with holding JLP +--- + + + JLP Risks + + + +There are risks associated with holding JLP and in this section, we will discuss them to understand better. + +--- + +## Opportunity Cost + +Capital allocated to acquiring JLP could potentially earn higher returns if allocated elsewhere. In bull markets for example, JLP may underperform compared to simply holding the underlying assets. + +--- + +## Profit and Loss Dynamics + +Traders' PnL from perpetual trading impacts the JLP pool. If a trader incurs a net positive PnL, the losses are sourced from the JLP pool to compensate the trader. Conversely, if a trader's PnL is a net negative, the gains are deposited into the JLP pool for LP holders. + +- **Long Trade Scenario** + + If the trader profits on the long, the JLP pool will lose in token quantity but not in USD value because the underlying token value in the pool appreciates in value as well. + + ![Long Trade](../../static/perps/jlp-long-scenarios.png) + +- **Short Trade Scenario** + + If the trader profits on the short, the JLP pool will lose some of the stablecoins but the shorted token will remain the same. This causes a net USD loss on the Pool. + + ![Short Trade](../../static/perps/jlp-short-scenarios.png) + +*This in-depth [research article](https://skribr.io/app/article/exploring-jupiters-perpetual-futures-a-comprehensive-research-analysis/) from LeeWay provides a detailed analysis on how this works.* + +--- + +## Market Volatility + +The JLP pool consists of both stable and non-stable tokens. Fluctuations in token prices can affect the value of JLP. As a result, users may find that their withdrawn tokens can be worth less compared to their initial deposit. Additionally, deposit and withdrawal fees for the JLP Pool may further reduce the number of tokens withdrawn, particularly for shorter holding periods. + +--- + +## Can JLP go down? + +Yes. Extreme market events or black swan scenarios may cause correlations between assets to break down, potentially amplifying losses instead of mitigating them. Additionally, as shown in the trader profiting on a short trade, JLP in USD value will go down when the fees generated are lower than depreciation of assets and payout from traders' profit. \ No newline at end of file diff --git a/guides/500-perps/24-jlp-economics.md b/guides/500-perps/24-jlp-economics.md new file mode 100644 index 00000000..68b3d5ae --- /dev/null +++ b/guides/500-perps/24-jlp-economics.md @@ -0,0 +1,207 @@ +--- +sidebar_label: Economics +title: Economics +description: Economics of JLP +--- + + + JLP Economics + + + +In this section, we will discuss the economics of JLP and understand how it works. + +--- + +## Custodies + +The JLP Pool manages several custodies (tokens) for liquidity providers. + +- SOL: [7xS2gz2bTp3fwCC7knJvUWTEU9Tycczu6VhJYKgi1wdz](https://solscan.io/account/7xS2gz2bTp3fwCC7knJvUWTEU9Tycczu6VhJYKgi1wdz) +- ETH: [AQCGyheWPLeo6Qp9WpYS9m3Qj479t7R636N9ey1rEjEn](https://solscan.io/account/AQCGyheWPLeo6Qp9WpYS9m3Qj479t7R636N9ey1rEjEn) +- BTC: [5Pv3gM9JrFFH883SWAhvJC9RPYmo8UNxuFtv5bMMALkm](https://solscan.io/account/5Pv3gM9JrFFH883SWAhvJC9RPYmo8UNxuFtv5bMMALkm) +- USDC: [G18jKKXQwBbrHeiK3C9MRXhkHsLHf7XgCSisykV46EZa](https://solscan.io/account/G18jKKXQwBbrHeiK3C9MRXhkHsLHf7XgCSisykV46EZa) +- USDT: [4vkNeXiYEUizLdrpdPS1eC2mccyM4NUPRtERrk6ZETkk](https://solscan.io/account/4vkNeXiYEUizLdrpdPS1eC2mccyM4NUPRtERrk6ZETkk) + +:::info Custody Account +More info on the Custody account is explained in the [developer documentation](../../docs/perp-api/custody-account). +::: + +### Assets Under Management + +The AUM for each `Custody` account in the pool is calculated differently for stable and non-stable tokens. + +The [Earn page](https://jup.ag/perps-earn) provides a simplified quick overview of the pool's AUM, however, it does not account for the traders' unrealized PnL and only shows the `owned` value in USD. + +To calculate the JLP Pool's true AUM, follow these steps. + +
+ + True AUM Calculation + + +#### Stable Tokens + +
+ +![Stable Token AUM](../../static/perps/jlp-economics-aum-stable.png) + +
+ +#### Non-Stable Tokens + +To calculate the AUM for non-stable tokens, we need to factor in the global short position's profits or losses. + +1. **Calculate the global short position's profits or losses (Unrealised PnL in USD)** + +
+ +![Global Short Position's Unrealised PnL](../../static/perps/jlp-economics-global-short-positions-unrealised-pnl.png) + +
+ +:::tip +If `current_price` > `global_short_average_prices`, traders are losing on short positions. +::: + +2. **Calculate the Net Asset Value (NAV)** + +
+ +![Guaranteed USD](../../static/perps/jlp-economics-guaranteed-usd.png) + +
+ +![Net Asset Value](../../static/perps/jlp-economics-nav.png) + +
+ +:::info +The `guaranteed_usd` value in each `Custody` account represents an estimate of the total size of all long positions. It is only an estimate as `guaranteed_usd` is only updated when positions are updated (i.e. opening / closing positions, updating collateral). It does not update in real-time when asset prices change. + +`guaranteed_usd` is used to calculate the pool's AUM as well as the overall PnL for all long positions efficiently. +::: + +3. **Calculate the AUM** + +If traders are losing on short positions, the losses are added to the pool's AUM. + +Otherwise, trader's profits are deducted from the pool's AUM. + +
+ +![AUM Calculation](../../static/perps/jlp-economics-aum-losses.png) + +
+ +![AUM Calculation](../../static/perps/jlp-economics-aum-profits.png) + +
+ +#### Total AUM + +The Total AUM is then calculated as the sum of all the custodies' AUM. + +
+ +![Total AUM](../../static/perps/jlp-economics-total-aum.png) + +
+ +:::info Fetch True AUM Programmatically +You can also fetch the true AUM programmatically using this [code snippet](https://github.com/julianfssen/jupiter-perps-anchor-idl-parsing/blob/main/src/examples/get-pool-aum.ts). +::: + +### AUM Limit + +Usually, users can mint new JLP or redeem (burn) them at the Virtual Price. However, when the AUM limit is hit, new minting of JLP is disabled to cap the amount of TVL in the pool. + +When this happens, the demand for JLP on the market usually leads to a premium for JLP compared to the virtual price. + +You may sell your JLP for the Market Price at any time. If the Market Price is below the Virtual Price, your JLP tokens are redeemed (burned) at the virtual price instead of the market price. + +#### Virtual Price + +
+ +![Virtual Price](../../static/perps/jlp-economics-virtual-price.png) + +
+ +#### Market Price + +
+ +![Market Price](../../static/perps/jlp-economics-market-price.png) + +
+ +:::tip +You can view the current TVL and AUM Limit on the [Earn page](https://jup.ag/perps-earn). + +![TVL and AUM Limit](../../static/perps/jlp-economics-tvl-aum-limit.png) +::: + +:::info Calculate JLP Virtual Price Programmatically +You can also calculate the JLP Virtual Price programmatically using this [code snippet](https://github.com/julianfssen/jupiter-perps-anchor-idl-parsing/blob/main/src/examples/get-jlp-virtual-price.ts). +::: + +### Global Unrealised PnL + +#### Unrealised PnL for Longs + +The most accurate way to calculate the unrealized PnL for all open long positions is to loop through all open positions (by fetching them from onchain accounts) and use the unrealized PnL calculation shown in [calculating unrealized PnL](./position-management##calculating-realized-and-unrealized-pnl). + +To get an estimate of the global unrealized PnL for longs, you can use the following calculation. + +
+ + Estimated Unrealised PnL for Longs + + +``` +// 1) Get the custody account you're interested in calculating unrealized PnL for longs +// https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#custody-account + +// 2) Get the `assets.guaranteedUsd` field which stores the value of `position.sizeUsd - position.collateralUsd` for +// all open long positions for the custody. Note that a position's `sizeUsd` value is only updated when a trade is made, which +// is the same for `guaranteedUsd` as well. It does *not* update in real-time when the custody's price changes + +guaranteedUsd = custody.assets.guaranteedUsd + +// 3) Multiply `custody.assets.locked` by the custody's current price to get the USD value of the tokens locked +// by the pool to pay off traders' profits + +lockedTokensUsd = custody.assets.locked * currentTokenPriceUsd + +// 4) Subtract `guaranteedUsd` from `lockedTokensUsd` to get the estimate of unrealized PnL for all open long positions. Note that +// the final value is greater than the actual unrealized PNL as it includes traders' collateral + +globalUnrealizedLongPnl = lockedTokensUsd - guaranteedUsd +``` +
+ +#### Unrealised PnL for Shorts + +The custody accounts store a `global_short_sizes` value that stores the USD value of all open short positions in the platform. The `global_short_average_prices` value stores the average price (USD) for all open short positions and is used together with `global_short_sizes` to get an estimate of the global unrealized PnL for shorts, as shown below. + +``` +globalUnrealizedShortPnl = (custody.assets.globalShortSizes * (|custody.assets.globalShortAveragePrices - currentTokenPriceUsd|)) / custody.assets.globalShortAveragePrices) +``` + +## Yield + +The JLP token adopts a growth-focused approach, similar to accumulating ETFs like VWRA or ARKK. Rather than distributing yield through airdrops or additional token mints. The JLP token's value is designed to appreciate over time and it is driven by the growth of the JLP pool's AUM, which is used to derive the virtual price. + +Similarly, ETFs reinvist dividends, the JLP Pool also reinvests 75% of all fees generated from Jupiter Perpetuals trading, token swaps, and JLP minting/burning into the JLP pool. This reinvestment strategy compounds the pool's liquidity, steadily increasing the JLP token's price and intrinsic value. The remaining 25% is allocated to Jupiter as protocol fees, supporting ongoing development and maintenance. + +## Exposue + +The intrinsic value of the JLP token is linked to the price movements of the liquidity pool's underlying tokens (SOL, ETH, BTC, USDC, and USDT). As a JLP holder, your portfolio is exposed to market movements, particularly to the performance of the non-stablecoin tokens: SOL, ETH, and BTC. If these tokens decrease in price, the value of your JLP position will likely decrease as well. + +The JLP usually outperforms its underlying assets during sideways or bearish market conditions since traders often struggle to be profitable in bear markets. However, during strong bull markets, the situation can reverse. Traders may open more long positions which can lead to trader profitability at the expense of JLP holders. + +To navigate market fluctuations, JLP investors have two primary strategies: + +- **Time the market**: Attempt to exit JLP positions before or during bullish trends. +- **Hedging**: Maintain JLP holdings for yield while implementing hedges against the underlying assets in the pool. This approach aims to mitigate downside risk during adverse market movements. diff --git a/guides/600-apepro/0-quickstart.md b/guides/600-apepro/0-quickstart.md new file mode 100644 index 00000000..9bf8578a --- /dev/null +++ b/guides/600-apepro/0-quickstart.md @@ -0,0 +1,39 @@ +--- +sidebar_label: "Quickstart" +title: Ape Pro +sidebar_position: 1 +description: Learn about Ape Pro and how to use the product. +--- + + + Ape Pro Quickstart + + + +Ape Pro is Solana’s Memecoin Terminal, bringing traders pro-performance while having superior mobile optimisations. + +It is designed to cater to both beginners who are looking for a simple and cost effective way to start as well as seasoned traders who are seeking advanced tools and speed for their strategy. + +--- + +## Key Features 🍌 + +- **Real-Time Token Discovery** + + With instant updating data like Explore Feed and Hunt Gems Feed to help you find the latest memes to ape. + +- **Advanced Analytics** + + Cuts the research time from hours to minutes with real-time charts, data, multiple timeline options and over 14 filters to narrow your search. *"Faster Search, Faster Ape."* + +- **Abstracted Instant Transactions** + + Trade seamlessly without the need to sign transactions as the Ape Pro system executes on behalf of you. + +- **Secure Social & Web3 Login Options** + + Start trading quickly using Google, X, Discord, or connect via wallets like Phantom. This is powered by Multiparty Computation based AA program powered by Web3Auth!. + +- **Best price** + + Swap with the lowest platform fees (0.5%) through direct route Swaps powered by Jupiter's routing engine. diff --git a/guides/600-apepro/1-how-to-set-up-account.md b/guides/600-apepro/1-how-to-set-up-account.md new file mode 100644 index 00000000..3003ceae --- /dev/null +++ b/guides/600-apepro/1-how-to-set-up-account.md @@ -0,0 +1,76 @@ +--- +sidebar_label: "How to set up account" +title: How to set up account +sidebar_position: 1 +description: Learn how to set up an account on Ape Pro +--- + + + Ape Pro: Account Set Up + + + +Ape Pro supports both social logins and web3 methods. They are seamless and secure, allowing you to deposit funds and trade with ease. + +--- + +## Login + +Head over to (top right corner of the page) the **"Login"** button, which will open up the Login page. From there, simply select your preferred login method and the account will be created. + +You can either use social logins or web3 wallets to login. + +:::caution +You will need to know the passwords or seed phrase/private key to your login method. + +Please save them securely and do not share them with anyone. +::: + +:::note 1 Login Method = 1 Ape Account +There is currently no way to link multiple login methods to an account. Each login method is an entirely separate Ape Account. + +Additionally, the email address of your social account determines your Ape Account. Changing your email will result in a different Ape Account. +::: + +![Login](../../static/apepro/login.png) + +## Account Activation + +To begin trading, you need to activate your account, simply by depositing a minimum of 0.1 SOL into your Ape Account. + +You can find your Ape Account address in 2 places. + +1. **Profile page**: Click on the wallet icon at the top right corner and navigate to the deposit section. +2. **Deposit page**: The deposit address can be found here. Use this address to add funds into your Ape Account. (Or if you are logging in for the first time, we will automatically prompt you to deposit 0.1 SOL) + +![Deposit](../../static/apepro/deposit.png) + +## Deposit Funds + +To deposit funds, you will need to use your Ape Account's address and send SOL to it. + +1. Copy the Ape Account's address from the Profile or Deposit page. +2. Depending on where your funds are coming from, for example: + - If you are depositing from a Solana wallet like Backpack, Phantom or Solflare, you can use a Solana wallet to send SOL to your Ape Account. + - If you are depositing from a centralised exchange, you can use their deposit function to send SOL to your Ape Account. + - If you are depositing from another blockchain, you can use a bridge to send SOL to your Ape Account. + +Once deposited, your Ape Account will be activated and displayed with the SOL you transferred. You can now begin aping! + +## Withdraw + +1. Select the wallet on top right. +2. Go to **Withdraw**. +3. Select which token you want to withdraw. +4. Enter the amount. +5. Enter the recipient address. + +:::tip +Ape Pro supports withdrawal of all the tokens in your wallet. +::: + +:::note Exporting Private Key +While you own the private key to the Ape Account, the platform is currently restricting access to exporting the private key. As current wallet providers like Phantom and Solflare do not support this, and this will cause more user confusion than good, hence the restriction. +::: + +![Withdraw](../../static/apepro/withdraw.png) \ No newline at end of file diff --git a/guides/600-apepro/10-faq.md b/guides/600-apepro/10-faq.md new file mode 100644 index 00000000..86a49877 --- /dev/null +++ b/guides/600-apepro/10-faq.md @@ -0,0 +1,41 @@ +--- +sidebar_label: "FAQ" +title: FAQ +sidebar_position: 1 +description: Frequently Asked Questions about Ape Pro +--- + + + Ape Pro: FAQ + + + +This section is a collection of frequently asked questions about Ape Pro. If you need further help or have questions, please reach out to us at [Discord](https://discord.gg/jup). + +--- + +### 1. What fees does Ape Pro charge? + +A platform fee of 0.5% is applied to swap transactions. You can earn or incur lesser fees via [referrals](./referral). + +### 2. I am getting failed transactions, what should I do? + +It depends on what type of failed transactions, typically they are either due to insufficient funds, slippage (market volatility) or fail to land transactions (network congestion). For slippage, you can try to increase the slippage tolerance and for transaction fees, you can try to increase the max cap. + +If you face repeated failures or are unsure, please reach out to us at [Discord](https://discord.gg/jup). + +### 3. I can't login, what should I do? + +Please double check and ensure your wallet or social account is properly linked. If you need help, please reach out to us at [Discord](https://discord.gg/jup). + +### 4. I can't see my tokens, what should I do? + +Refresh your portfolio view or reconnect your wallet. + +### 5. How to recover your wallet if you forget your password? + +You don't need a password for login! The login methods are either social logins or wallet, which of course you will need to know the passwords or seed phrase/private key to. + +:::caution +Please save them securely and do not share them with anyone. +::: diff --git a/guides/600-apepro/2-feeds.md b/guides/600-apepro/2-feeds.md new file mode 100644 index 00000000..03ed1a6f --- /dev/null +++ b/guides/600-apepro/2-feeds.md @@ -0,0 +1,118 @@ +--- +sidebar_label: "Feeds" +title: Feeds +sidebar_position: 1 +description: Learn how to use different discovery feeds on Ape Pro +--- + + + Ape Pro: Discovery Feeds + + + +Solana memecoins and markets are booming and fast moving, Ape Pro gives an edge to all traders, offering a range of tools to help you discover new tokens and make informed trading decisions. + +--- + +## Explore Feed + +The Explore Feed categorises tokens to make discovery simple and efficient. + +- **New Tokens** + + Discover and buy tokens launched in the past 24 hours. Tokens are arranged by launch time, with the most recently launched token displayed first. + +- **Top Traded** + + See the tokens with the highest trading volumes across the platform. Helps you identify tokens with the most market activity, ensuring liquidity and price movement. + +- **AI/Agent Coins** + + Trending AI and agent-based tokens, reflecting the latest trends in the AI-powered crypto space. Includes tokens with significant attention in the AI sector, ideal for tech-focused investors. + +- **S&P50 Tokens** + + Top 50 tokens categorised as "Surviving and Pumped-launched," indicating longevity where they are a PumpFun launched token but yet still surviving strongly. Ideal for users seeking tokens with this specific profile. + +![Explore Feed](../../static/apepro/explore.png) + +## Hunt Gems Feed + +The Hunt Gems Feed is an advanced view of the new tokens feed, designed to help you take your token discovery to the next level. Hunt Gems Feed helps you identify tokens in specific profiles such as New Creations, Graduating Soon or Graduated tokens. + +- **New Creations** + + Recently launched tokens in the last 24 hours with at least 1 liquidity pool. + +- **Graduating Soon** + + Pump.fun tokens with 50% and above bonding curve progress. + +- **Graduated** + + Pump.fun tokens with 50% and above bonding curve progress. + +![Hunt Gems Feed](../../static/apepro/hunt-gems.png) + +## Global Search + +Click on the search icon in the top navigation bar, or press a designated keyboard shortcut (Ctrl+K or Cmd+K, “/”). + +- **By Name or Symbol** + + Find tokens by their name or ticker symbol (e.g., "SOL" for Solana). + +- **Contract Address (CA)** + + Search directly using the token’s mint address to get precise results. + +![Global Search](../../static/apepro/search.png) + +## Discovery Interface + +### Narrow Your Search + +Ape Pro offers multiple features to help you filter and refine token discovery according to your strategy. + +- **Filters** + + Apply filters to narrow down promising tokens based on your criteria. There are over 14 filters available and we have covered them in detail (revisit). + +- **Timelines** + + Analyse metrics like Volume and Transactions over specific timeframes: 5 minutes, 1 hour, 6 hours, 24 hours. + +- **Search tokens** + + Useful for further filtering tokens with specific tickers or names, or for finding if a token is part of this filtered list. + +### Metrics + +Ape Pro is for both beginners and advanced traders. All the tokens have the following details available at a glance to provide all types of traders with the information they need. + +| Metric | Description | +|--------|-------------| +| Token | Name of the token. | +| Age | Time since the token was minted. | +| Links | Access essential links - Pumpfun, X, Telegram, Website (whichever is available). | +| Copy | Copy the token/mint address or "CA". | +| Add to watchlist | Add the token to your personal watchlist. | +| Market Cap | Circulating Supply multiplied by Current Price. | +| 24h Volume | The total trading volume of the token in the past 24 hours. The time window can be changed to 5 minutes, 1 hour, 6 hours, 24 hours. | +| 24h Transactions | The number of token transactions executed in the past 24 hours. The time window can be changed to 5 minutes, 1 hour, 6 hours, 24 hours. | +| Liquidity | The total amount of funds available in the token's liquidity pool for trading. | +| Holders | Number of unique wallet addresses holding the token. | +| Checklist |
  • Mint Authority: Shows if developers retain the ability to mint new tokens. Tokens with restricted minting capabilities are likely safer. Green check if the Mint Authority is disabled.

  • Freeze Authority: Displays whether developers can freeze token accounts. A lack of freeze authority typically indicates higher security. Green check if the Freeze authority is disabled.

  • Liquidity Pool Burned/Locked: Indicates the percentage of the liquidity pool that has been burned or locked. A Green Check is shown if more than 50% is burned or locked.

  • Top 10 Holders: Shows the percentage of tokens held by the top 10 wallets. A Green Check appears if the top 10 holders own less than 15%, reducing the risk of price manipulation.
    • | + +### Quick Buy + +Every token in the Explore Feed interface has a **"Quick Buy"** button. This button allows you to buy the token directly from the feed. + +- Of course, by design, there is no transaction signing needed, making your quick buys quicker. +- Instead of opening the detailed token page, you can buy directly from the feed. + +:::info +Click on any token row in the Explore Feed to view its detailed token page with information such as real-time charts, transaction history, and more order options like Limit Order! + +[Read the Token Profile guide for more information.](./token-profile-and-chart) +::: diff --git a/guides/600-apepro/3-filters.md b/guides/600-apepro/3-filters.md new file mode 100644 index 00000000..66fa7d63 --- /dev/null +++ b/guides/600-apepro/3-filters.md @@ -0,0 +1,52 @@ +--- +sidebar_label: "Filters" +title: Filters +sidebar_position: 1 +description: Learn how to use the Filters on Ape Pro +--- + + + Ape Pro: Filters + + + +There are over 14 filters available to find your Token. Narrow down your search based on your strategy. + +--- + +**General Filters** + +| Filter | Description | +|--------|-------------| +| Show Pump.fun | This filter shows the tokens created via Pump.fun | +| Mint Auth Disabled | Shows those tokens where developers cannot mint new tokens | +| Freeze Auth Disabled | Shows those tokens where developers cannot freeze token accounts | +| LP Burned≥50% | Shows the tokens where more than 50% of the liquidity pool is burned | +| Top 10 Holders <15% | Shows the tokens where the top 10 holders own is less than 15% | +| At least 1 social | Shows tokens which have a presence in at least 1 social media | + +--- + +**Filters with Min/Max Values** + +| Filter | Description | +|--------|-------------| +| Market Cap $ | The total value of the token's circulating supply at the current market price (Circulating Supply X Current Price) | +| 24h Volume $ | The total trading volume of the token | +| Bonding Curve % | The percentage progress along the bonding curve for tokens following a bonding curve issuance model, indicating remaining supply | +| Dev Launched Mints | The number of tokens launched by the developer | +| 24h Txns | The number of token transactions executed | +| 24h Buys | The number of token buys executed | +| 24h Sells | The number of token sells executed | +| Liquidity $ | The total amount of funds available in the token's liquidity pool for trading | + +--- + +**Filter Actions** + +| Action | Description | +|--------|-------------| +| Reset | Reset whatever you customized in 1 click | +| Share | You can share your filter configuration with others | +| Save | Save the customized filter configuration to it use it later | +| Import | Import a filter shared by someone else with you | diff --git a/guides/600-apepro/4-token-profile-and-chart.md b/guides/600-apepro/4-token-profile-and-chart.md new file mode 100644 index 00000000..b03ac5ce --- /dev/null +++ b/guides/600-apepro/4-token-profile-and-chart.md @@ -0,0 +1,117 @@ +--- +sidebar_label: "Token Profile and Chart" +title: Token Profile and Chart +sidebar_position: 1 +description: Learn how to use the Token Profile and Chart +--- + + + Ape Pro: Token Profile and Chart + + + +Each token on Ape Pro has a dedicated profile page, offering detailed analytics and real-time charts to help users make data-driven decisions. + +You can access this page by clicking on any token in the Explore Feed, Hunt Gems Feed or simply by searching for the token. + +--- + +![Token Profile](../../static/apepro/token-profile.png) + +## Real-time Charts + +This section provides real-time visual data to track token performance with prices and market cap movements + +- **Show Price or Market Cap** + + Switch the charts by price or market cap based on your preference. Displays minute-by-minute or hour-by-hour movements for the token. + +- **Quote Denomination** + + Toggle between USD and SOL denominations based on your preference. + +- **Dev (Developer)Trades** + + Highlights on the chart whenever the token developer executes a buy or sell, providing transparency on developer activity. + +## Transactions, History, Orders, Holders + +Ape Pro provides details for monitoring token activity and personal trades. + +### Transactions + +View all recent trades involving the token, including type, volume, price and the wallet details. The transactions data are flowing in in real-time. + +:::tip +Hover over the Transactions interface and the flow will be paused, allowing you to see the details of a specific transaction before it gets pushed to the bottom or out of the view. +::: + +### History + +View your Ape Account's trade history for the specific token, helping you keep track with ease. + +### Orders + +View all orders involving the token, including type, volume, price and the wallet details. + +### Positions + +Monitor your positions for the token, including amount bought and profits and losses. + +### Holders + +Access detailed insights into the token’s holder distribution, including percentages held by the wallets. + +:::info +You can also view a bubble map view of the token's holders via **"Bubble Map"** button. +::: + +## Token Details + +The Token Details section provides essential information about a token’s underlying fundamentals. + +| Metric | Description | +|--------|-------------| +| Price USD | Shows the current market price in USD. | +| Price SOL | Shows the current market price in SOL. | +| Age | Time since the token was launched. | +| Market Cap | Represents the total value of the token's circulating supply at the current market price (Circulating Supply multiplied by Current Price). | +| FDV | Fully Diluted Valuation is the valuation of the token assuming all possible tokens in its total supply are in circulation (Total Supply multiplied by Current Price). | +| Liquidity | The total amount of funds available in the token's liquidity pool for trading. Adequate liquidity reduces slippage and ensures smoother trades. | + +The following metrics can be analyzed for different time windows (5 minutes, 1 hour, 6 hours, 24 hours). + +| Metric | Description | +|--------|-------------| +| Volume | Total trading volume within the selected timeframe, split into Buy Volume and Sell Volume. | +| Transactions | Number of transactions during the selected time window, further divided into Buy Transactions and Sell Transactions. | +| Traders | Total number of unique wallets that traded the token during the timeframe, along with the split between Buyers and Sellers. | +| Bonding Curve Progress | Displays how far the token has progressed along its bonding curve, indicating how much supply remains available for issuance. | +| Token Mint | Token mint address is a unique blockchain address to identify the token, which is critical for verifying token authenticity. | +| Discussions on X | Ape Pro aggregates discussions about the token on platforms like X (formerly Twitter), giving insights into the token's popularity and virality. | +| Links | Links to important resources like Pump.fun, X, Telegram, and the token's official website. | +| Add to watchlist | Click to add the token to your personalized watchlist for quick access later. Your complete watchlist can be accessed here at https://ape.pro/watchlist. | +| Share | Copy the Token Profile page URL to share it easily with others. | + +## Token Checklist + +The Token Checklist helps users reduce risks by evaluating the token’s basic fundamentals. Each metric is highlighted in Red if it poses a risk or Green if it passes the basic safety checks. + +| Metric | Description | +|--------|-------------| +| Mint Authority | Shows if developers retain the ability to mint new tokens. Tokens with restricted minting capabilities are maybe safer. Green check if the Mint Authority is disabled. | +| Freeze Authority | Displays whether developers can freeze token accounts. A lack of freeze authority typically indicates higher security. Green check if the Freeze authority is disabled. | +| Liquidity Pool Burned/Locked | Indicates the percentage of the liquidity pool that has been burned or locked. A Green Check is shown if more than 50% is burned or locked. | +| Top 10 Holders | Shows the percentage of tokens held by the top 10 wallets. A Green Check appears if the top 10 holders own less than 15%, reducing the risk of price manipulation. | + +There are couple of more additional metrics also available to ensure that you know more details about the token. + +| Metric | Description | +|--------|-------------| +| Dev (Developer) Address | The blockchain address associated with the token developer. | +| Dev Mints | The total number of tokens minted by the developer, helping users track potential minting abuse. | +| Info | A reminder to conduct thorough research, as meeting checklist criteria does not entirely eliminate risks. | + +:::caution +A reminder to conduct thorough research, as meeting checklist criteria does not entirely eliminate risks. +::: diff --git a/guides/600-apepro/5-buying.md b/guides/600-apepro/5-buying.md new file mode 100644 index 00000000..6c78973a --- /dev/null +++ b/guides/600-apepro/5-buying.md @@ -0,0 +1,95 @@ +--- +sidebar_label: "Buying" +title: Buying +sidebar_position: 1 +description: Learn how to buy tokens on Ape Pro +--- + + + Ape Pro: Buying + + + +Buying tokens on Ape Pro is easy and fast. + +There are 3 ways to buy tokens on Ape Pro, Quick Buy from the New Tokens Feed or Hunt Gems Feed, Market Buy from Token Profile, and Limit Order from Token Profile. + +--- + +## Quick Buy + +You can buy tokens directly from the [Explore Feed](./feeds#explore-feed) or [Hunt Gems Feed](./feeds#hunt-gems-feed). + +- Decide which token to buy with the relevant data and filters. +- Click on the **"Quick Buy"** button. +- And your tokens are bought (it has to succeed or confirmed on the blockchain to be bought)! + +:::tip +You can customise how much your Quick Buy amounts are, by entering the amount in the **"BUY: ..."** field. +::: + +:::info +Do note that Quick Buys are market buys, based on the current best price from Jupiter's routing engine. +::: + +![Quick Buy](../../static/apepro/quick-buy.png) + +## Buy/ Sell + +You can buy or sell tokens with more features to customise your orders. + +- **Preset Amounts** + + You can preset different Quick Buy amounts and use them seamlessly. + +![Buy or Sell modal](../../static/apepro/buy-sell-modal.png) + +- **Slippage Settings** + + You can set the slippage for your order. Your trades are MEV-Protected! You can set higher slippage for more volatile tokens, to increase the success rate of your APES! + +- **Transaction Fee Settings** + + You can set the transaction fee for your order. Ape Pro intelligently calculates the transaction fee for you, you can set a max fee to prevent overpaying. + +- **MEV Protection (Jito)** + + You can set the MEV Protection for your order (Default to ON). If turned on, your transactions will be sent to a Jito Validator to process. + +![Trade Settings](../../static/apepro/trade-settings.png) + +## Limit Order + +Ape Pro Limit Order (v1) allows users to set a Target Price / Market Cap (to be referred to interchangeably) for a trade to be automatically executed once pre-determined conditions are met. Once the order is placed, Ape Pro's Keeper will continuously monitor the target level and execute the swap when the market price reaches your specified price. + +This allows you to APE with control over your price instead of being at the mercy of the market. + +![Limit Order](../../static/apepro/limit-order.png) + +### Understanding Limit Orders + +On Ape Pro, limit orders are executed as **market orders within a specified slippage tolerance** once certain price conditions are met. While you can input a target market cap as a reference, **the actual trigger for executing your order is the token's price**, not its market cap. + +When you create your orders, **your MEV protection and slippage settings are saved** and will be applied when the target price is reached. Consequently, the success of your limit orders depends on whether sending transactions via RPC or Jito (MEV Protect) is most suitable under current market conditions. + +![Limit Order Explainer](../../static/apepro/limit-order-explainer.png) + +### Types of Limit Orders + +Ape Pro supports all 4 types of Limit Orders, allowing you to enter or exit at a specific price. + +- **Take Profit** + + Sell a token when it hits your determined Target Price or Market Cap. + +- **Stop Loss** + + Sell a token when it hits your determined Stop Loss Price or Market Cap. + +- **Buy Dip** + + Buy a token when it hits your determined Buy Dip Price or Market Cap. + +- **Buy Above** + + Buy a token when it hits your determined Buy Above Price or Market Cap. diff --git a/guides/600-apepro/6-portfolio.md b/guides/600-apepro/6-portfolio.md new file mode 100644 index 00000000..cffb7297 --- /dev/null +++ b/guides/600-apepro/6-portfolio.md @@ -0,0 +1,32 @@ +--- +sidebar_label: "Portfolio" +title: Portfolio +sidebar_position: 1 +description: Learn how to use Portfolio on Ape Pro +--- + + + Ape Pro: Portfolio + + + +The Portfolio section is a feature that allows you to gain a complete overview of your holdings and performance. + +![Portfolio](../../static/apepro/portfolio.png) + +--- + +## Portfolio Metrics + +| Metric | Description | +|--------|-------------| +| Net Worth | View your total holdings in USD and SOL denominations. | +| Total PnL | View your overall profits or losses in the tokens, inclusive of unrealised and realised PnL. | +| Unrealised PnL | View your PnL before you sell the tokens. | +| Realised PnL | View your PnL after you have sold the tokens. | + +:::info +You can also get more information about your Portfolio's tokens and positions in the table below the Portfolio Metrics. + +The table includes open positions, profitable trades (realised PnL), and recent trades. +::: \ No newline at end of file diff --git a/guides/600-apepro/7-leaderboard.md b/guides/600-apepro/7-leaderboard.md new file mode 100644 index 00000000..3ed483ca --- /dev/null +++ b/guides/600-apepro/7-leaderboard.md @@ -0,0 +1,27 @@ +--- +sidebar_label: "Leaderboard" +title: Leaderboard +sidebar_position: 1 +description: Learn how to use Leaderboard on Ape Pro +--- + + + Ape Pro: Leaderboard + + + +The Leaderboard section features Ape Pro's top traders and their performance. + +![Leaderboard](../../static/apepro/leaderboard.png) + +--- + +## Leaderboard Metrics + +The Leaderboard is sorted by the highest total PnL of all of Ape Pro's traders. + +You can also view the top traders' net worth and volume traded on the leaderboard and click on their address to view their [Portfolio](./portfolio). + +:::tip +Maybe you can see how these traders are ape-ing to gain some insights? 🙈 +::: \ No newline at end of file diff --git a/guides/600-apepro/8-referral.md b/guides/600-apepro/8-referral.md new file mode 100644 index 00000000..6898f07b --- /dev/null +++ b/guides/600-apepro/8-referral.md @@ -0,0 +1,39 @@ +--- +sidebar_label: "Referral" +title: Referral +sidebar_position: 1 +description: Learn how to use Referral on Ape Pro +--- + + + Ape Pro: Referral + + + +Ape Pro offers a Referral Program to reward users for inviting ape friends to the platform. Your invite reward you and your friend. + +![Referral](../../static/apepro/share.png) + +--- + +## For Referrers + +**Earnings**: Earn 50% of the platform fees from your referees. + +**How to get Referral Link?** The Referral page is accessible via the Refer button on top right. + +:::info +You will need to activate your Ape Pro account (by depositing 0.1 SOL minimally) to generate a referral link to share with your friends. +::: + +![Referral](../../static/apepro/referral.png) + +## For Referees + +**Discount**: Receive a 10% discount on platform fees (undiscounted fee is 0.5%) when signing up through a referral link. + +**Activation Requirement**: Deposit a minimum of 0.1 SOL to activate your account and start earning referral fees. + +:::info +The referral link format is `https://ape.pro/?ref=[referral_id]`. +::: diff --git a/guides/600-apepro/9-mobile.md b/guides/600-apepro/9-mobile.md new file mode 100644 index 00000000..b9a5ccae --- /dev/null +++ b/guides/600-apepro/9-mobile.md @@ -0,0 +1,46 @@ +--- +sidebar_label: "Mobile" +title: Mobile +sidebar_position: 1 +description: Learn how to use Ape Pro on Mobile +--- + + + Ape Pro: Mobile + + + +Ape Pro is mobile optimised! Experience everything on the web directly on your mobile device. + +APE ON THE GO! + +--- + +## Ape App??? + +You can add the Ape Pro web app to your home screen for an app-like experience. This Progressive Web App (PWA) provides an immersive, full-screen experience and is accessible with a single tap. + +
    + +
    + +### iOS (Safari Browser) + +1. Open https://ape.pro/ in Safari. +2. Tap the Share icon at the bottom of the screen. +3. Scroll down and select **“Add to Home Screen”**. +4. Tap **Add** in the upper-right corner. + +### Android (Chrome Browser) + +1. Open https://ape.pro/ in Chrome. +2. Tap the Menu icon (three dots) in the upper-right corner. +3. Select **“Add to Home screen”**. +4. Tap **Add**. diff --git a/guides/index.md b/guides/index.md index 4fe33df5..54c43b3a 100644 --- a/guides/index.md +++ b/guides/index.md @@ -1,49 +1,57 @@ --- -sidebar_label: "Overview" -title: Guides Overview +sidebar_label: "Welcome to Station" +title: Welcome to Station sidebar_position: 1 -description: Learn about Jupiter and how to use Jupiter with these beginner friendly guides. +description: Learn about Jupiter and how to use the products. --- - Jupiter Guides: Welcome Catdets! + Guides +Jupiter’s Station is your gateway to accessing and managing various financial tools on the Solana blockchain. It serves as a unified platform that simplifies trading, portfolio management, and access to Solana’s vibrant ecosystem of decentralized applications. The Station is designed for both seasoned crypto users and newcomers alike, offering a seamless and intuitive experience. -![Cats](../guides/img/cat_banner.png) +--- -## Getting Started -Hello, curious cat! We're so glad you're here to learn more about Jupiter and our products. These guides were created to get new cats like yourself up to speed and to explain the inner workings of Jupiter products. +:::tip Navigating Station +To navigate Station, you can use the navigation bar at the top of the page to find the product you are looking for. Within each product section, you can find the breakdown of the product features and guides in the sidebar. +::: -Here's a list of all our official links. Please always double check the URL matches these! +:::info Contribute to Station +If you're not a developer, you can open an issue on the [Station GitHub repository](https://github.com/jup-ag/space-station/issues/) and provide your feedback! -| Platform | Purpose | Official Link | -| -------- | ------- | ------------- | -| Website | Experience all Jupiter products for yourself | [https://jup.ag](https://jup.ag)| -| Discord | Engage with the community and us by sharing feedback and ideas | [https://discord.gg/jup](https://discord.gg/jup)| -| Twitter | Follow [@JupiterExchange] to stay up-to-date with all updates | [https://twitter.com/JupiterExchange](https://twitter.com/JupiterExchange)| -| Documentation | Read all about Jupiter products, for both users and devs | [https://station.jup.ag/](https://station.jup.ag/)| -| YouTube | Tune in to Planetary Calls and watch tutorials and guides relating to Jupiter and Solana DeFi | [https://www.youtube.com/@JUPecosystem](https://www.youtube.com/@JUPecosystem)| -| Reddit | Join our Reddit community to chat with fellow Catdets on all things Jupiter and DeFi | [https://www.reddit.com/r/jupiterexchange/](https://www.reddit.com/r/jupiterexchange/)| -| Jupresearch | Participate in forum discussion regarding Jupiter initiatives, ecosystem projects, and broader decentralised meta | [https://www.jupresear.ch/](https://www.jupresear.ch/)| -| Launchpad | Discover and participate in token launches by LFG Launchpad | [https://lfg.jup.ag/](https://lfg.jup.ag/)| -| Governance | Vote with your staked JUP on DAO proposals and earn Active Staker Rewards | [https://vote.jup.ag/](https://vote.jup.ag/)| -| J.U.P DAO | Be a part of Jupiter United Planet or Jupiverse and contribute to governance and voting | [https://www.jup.eco/](https://www.jup.eco/)| -| Token List | Understand how token verification works on Jupiter and get your token verified| [https://catdetlist.jup.ag/](https://catdetlist.jup.ag/)| -| Edge | Test out the latest product changes before they are live on the main website | [https://edge.jup.ag/](https://edge.jup.ag/)| -| Ape Pro | Ape into new tokens in a seamless, fast, yet secure manner with secure vault model | [https://ape.pro/](https://ape.pro/)| -| Welcome to Solana | Join us to welcome you to Solana every step of the way | [https://welcome.jup.ag/](https://welcome.jup.ag/)| +If you're a developer, you can make a PR directly and we will review it. +We would love to hear your feedback, suggestions and see your contributions! +::: ---- +## Onboarding Solana + +New here? Get started immediately with our [onboarding guides](/guides/onboard)! + +## Products + +### Spot + +Spot trading allows you to swap between tokens instantly. It’s the foundation of DeFi trading and enables users to access the best rates for token swaps. Jupiter Spot simplifies the process of trading on blockchains by optimising and estimating settings in the background, providing the best experience for users. + +Check out [Spot guides](/guides/spot), or launch [Spot](https://jup.ag/). + +### Ape Pro + +Ape Pro is tailored for advanced traders and provides enhanced analytics and charting tools, real-time insights for high-volume or frequent trading, and exclusive features to optimize trading strategies. + +Check out [Ape Pro guides](/guides/apepro/quickstart), or launch [Ape Pro](https://ape.pro/). + +### Perps + +Perpetual trading enables users to trade futures contracts with no expiration date. It offers leveraged trading for higher exposure to market movements, risk management tools to hedge against market volatility, and access to a variety of perpetual pairs on Solana. + +Check out [Perps guides](/guides/perps/quickstart), or launch [Perps](https://jup.ag/perps). + +## Developers -## Navigating this Guide -- **Spot:** Read detailed walkthroughs on all Spot features: Swap, Limit Order, Dollar Cost Averaging (DCA), Value Averaging (VA). Deep dive into how each of them work individually and together to provide the best trading experience for you! -- **Perpetual Exchange:** Learn about the [Jupiter Perpetuals Exchange](/guides/perpetual-exchange/overview) and the [JLP Pool](/guides/jlp/jlp) and its role in securing liquidity for the Perpetuals Exchange. -- **Ape:** Discover how the vault model, auto-retry, and removal of wallet signature enables fast and secure trades. -- **JupSOL:** Check out [JupSOL](/guides/jupsol/jupsol) to learn about the official Jupiter LST which supports the Jupiter Validator! -- **Onboard:** If you're coming to Solana for the first time, we care to provide a seamless experience for you. Read our guide on Bridge, Onramp, and CEX transferring. -- **General Guides:** Discover general guides relating to the Solana ecosystem such as personal security, using a block explorer to verify swaps, actions & blinks, token guide for creators, the Jupiter Media Kit, and FAQs about the Jupiter Platform. +For developers, we have a dedicated section to get you started with the Jupiter APIs and tool kits to build world class applications. -Welcome to the community, J4J (JUP 4 JUP)! +Check out the [Developer Documentation](/docs) to get started. diff --git a/guides/jupsol.md b/guides/jupsol.md new file mode 100644 index 00000000..959558cb --- /dev/null +++ b/guides/jupsol.md @@ -0,0 +1,64 @@ +--- +sidebar_label: "JupSOL" +title: JupSOL +sidebar_position: 1 +description: Learn about JupSOL, the Jupiter liquid stake token on Solana. +--- + + + JupSOL + + + +JupSOL represents staked Solana (SOL) tokens with Jupiter’s validator, which is hosted and managed by Triton. Jupiter passes all validator rewards collected and 100% of MEV (Maximal Extractable Value) along to stakers for maximum yield. The JupSOL token is issued through Sanctum. + +Review the official JupSOL announcement forum post [here](https://www.jupresear.ch/t/jupsol-jupiter-staked-sol/14666). + + +:::info What is a Liquid Staking Token? +Liquid staking lets you participate in DeFi while earning staking yields. Liquid staking solves the [Staking Dilemma](https://learn.sanctum.so/guides/more-about-sanctum/sanctums-value-proposition) by giving you the best of both worlds – it lets you secure the network and use your SOL at the same time. + +You can think of staking as putting gold in a vault, and liquid staking as issuing a piece of paper money (an IOU, "I owe you") for the gold in that vault. In the same way that a paper IOU can be redeemed at any time for the gold, a liquid staking token (LST) can be redeemed at any time for unstaked SOL. Unlike natively-staked SOL, this liquid staking token is transferable. It can be used in all of DeFi – borrow-lend, perps, stablecoin issuance, etc. +::: + +## How does JupSOL Work? + +SOL that’s deposited into JupSOL is staked. The staking rewards from that SOL accrue to the JupSOL token, which starts at 1:1 with SOL and grows in value over time relative to SOL. (Note that while JupSOL will always increase relative to SOL, it may still lose value in dollar terms.) By simply holding JupSOL, you will earn staking rewards. + +### Where does the yield come from? + +JupSOL earns staking yields and MEV kickbacks from Jupiter’s validator, which has no fees. Additionally, the Jupiter team has delegated 100K SOL to the Jupiter validator. They will use the yield from that SOL to enhance the APY of JupSOL. Expect to see higher than average APYs on JupSOL compared to regular LSTs. + +![jupSOL](../static/jupsol/jupsol.png) + +For Example: +- When the JupSOL validator pool was launched, 1 JupSOL = 1 SOL. +- Assuming a 10% APR (inclusive of all rewards) and a Solana epoch time of ~2 days that equates to ~0.000547945 SOL rewards per epoch. +- At the end of one epoch, 1 JupSOL = ~1.000547945 SOL. +- At the end of two epochs, 1 JupSOL = ~1.001096191 SOL. +- And at the end of one year, 1 JupSOL = ~1.105163349 SOL due to compounding rewards. + +## JupSOL Fees +- 0% management fee +- 0% validator commission +- 0% stake deposit fee +- 0.1% SOL deposit fee +- 0% withdrawal fee + +:::info Arbitrage Protection +Jupiter charges a small SOL deposit fee to prevent an arbitrage attack on the pool. +::: + +## JupSOL Security + +JupSOL is powered by the SPL stake pool program. The SPL stake pool program is one of the safest programs in the world. It has been [audited multiple times](https://learn.sanctum.so/docs/security/audits), is used by the largest stake pools like jitoSOL and bSOL, and has secured more than $1B of staked SOL for years without any issues. + +The program authority is secured by a multisig that includes, among others, members from Sanctum, Jupiter, Mango, marginfi and Jito. Any changes to the program will have to be approved by a majority vote from this multisig. No single party can unilaterally change the program. We plan to significantly grow the size of the multisig and eventually freeze the program. + +For more details, check out this post on [Sanctum](https://learn.sanctum.so/docs/security/is-sanctum-safe). + +## Benefits of Holding JupSOL + +Buying and holding JupSOL helps you earn native staking yields on your SOL; this is the “risk-free” rate of SOL. As an extra incentive to hold JupSOL, Jupiter is returning all validator MEV rewards to JupSOL. This should lead to higher APY than native staking. + +When you hold JupSOL, you also help Jupiter improve its transaction inclusion rate, making it easier for all Jupiter users to swap, DCA or place limit orders in congested conditions. diff --git a/guides/lock.md b/guides/lock.md new file mode 100644 index 00000000..e450c45e --- /dev/null +++ b/guides/lock.md @@ -0,0 +1,318 @@ +--- +sidebar_label: "Jupiter Lock" +title: Jupiter Lock +sidebar_position: 1 +description: Jupiter Lock is an open-sourced, audited, and free ecosystem tool to lock and distribute tokens over-time. +--- + + + Jupiter Lock + + + +import DownloadBox from '/src/components/DownloadBox'; + +Jupiter Lock (https://lock.jup.ag/) is an [open-sourced](https://github.com/jup-ag/jup-lock), audited and free way to lock and distribute tokens over-time. Lock will be free for all project teams to lock tokens, implement cliff, and vest non-circulating supply in a clear and transparent manner. + +### Jupiter Lock Specifications + +Jupiter Lock is currently in Beta, we aim to improve and introduce additional features. Let us know what you are interested in! + +Audited Twice by [OtterSec](https://github.com/jup-ag/jup-lock/blob/main/audits/OtterSec_2024_08_15.pdf) & [Sec3](https://github.com/jup-ag/jup-lock/blob/main/audits/Sec3_2024_08_05.pdf). + +Program code is available here: https://github.com/jup-ag/jup-lock + +Mainnet Deployment: `LocpQgucEQHbqNABEYvBvwoxCPsSbG91A1QaQhQQqjn` + +The **IDL** for the Jupiter Lock program can be found on [Solscan](https://solscan.io/account/LocpQgucEQHbqNABEYvBvwoxCPsSbG91A1QaQhQQqjn#anchorProgramIdl), or available here: + +   + +:::info Jupiter Lock is in Beta +Feel free to submit PRs, suggestions, or reach out to us! If you need help with Jupiter Lock or have any feedback on how to improve, let us know on Discord or [Telegram](https://t.me/xianxlb). +::: + +--- + +### How to Use Jupiter Lock + +**Create Token Lock** + + + +Video credits: [Aremia Vincenzo](https://twitter.com/Arimiyahu1) + +1. Navigate to https://lock.jup.ag/. +2. Click `+ Create Token Lock` button. +3. Click `Connect Wallet` button. Note that you can only lock the tokens you have in your connected wallet. +4. Search for the token you wish to lock via contract address or ticker. +5. Fill in the required details: + 1. Lock Title. Name this lock e.g. Team Tokens. + 2. Lock Amount. You can see the amount of token within your wallet. + 3. Recipient Wallet Address. The tokens can be claimable by this wallet after the defined vesting period. + 4. Vesting Start Date. You can select any future date and time. This is based on your current timezone. + 5. Vesting Duration and intervals. Vesting Duration determines the entire vesting schedule from the Start Date. + 6. (Optional) Cliff Period & intervals. Cliff refers to a time period that has to pass before the tokens start vesting. + 7. Unlock Schedule. This determines how much tokens is being vested and unlocked within that regular time interval. + 8. Who can cancel the contract and who can change the recipient. Choose None, Only Creator, Only Recipient or Either Creator or Recipient +6. (Optional) Add more locks for the same token but with different parameters by clicking `Add Another Lock` button. +7. Press `Proceed` to review the token lock contract. After confirming all the details, click `Create Contract` button. +8. Navigate to Jupiter Lock home page is to view the lock that you’ve created! + +--- + +**View Locks & Claim Tokens** + +1. Navigate to https://lock.jup.ag/. You will be able to see All Locks powered by Jupiter Lock. +2. Click `Connect Wallet` at the upper right corner to check Your Locked Tokens and Locks You Created. + 1. Your Locked Tokens include tokens that others and yourself have locked and your wallet is a recipient. + 2. Locks You Created shows the locks that you created. +3. Select the token of interest and check all locks associated, powered by Jupiter Lock. The details include: + 1. Lock Title: Title describes the lock. Clicking on this will be directed to the explorer. + 2. Unlocked/Total: Amounts of token vested and unlocked over the total locked amount. + 3. Actions: The `Claim` button will light up if there's unlocked tokens to claim. + 4. Vesting Schedule: The schedule shows the full vesting period, including date and time. + 5. Cliff Date: If a cliff date was added to the contract, it will show up here. + 6. Unlock Rate: The amount of token vested and unlocked will be shown against the time period. + 7. Creator/Recipient: The wallet addresses of Creator and Recipient. + 8. Claim Progress: Progress bar showing the tokens claimed against locked amount. + + +
    + Jupiter Lock Terms and Conditions + +Last Updated: 27 September 2024 + +These Terms and Conditions of Use (these "Terms") are between you (also referred to herein as "user", "you" and "your") and Block Raccoon S.A., a company incorporated under the laws of Panama ("Jupiter Lock", "we", "us" and "our"). These Terms govern your use of the services provided by Jupiter Lock described below (the "Services"). By accessing the Services made available on https://lock.jup.ag/ (the "Website") you agree that you have read, understand, and accept all of the terms and conditions contained in these Terms. + +We may make changes to these Terms from time to time. If we do this, we will post the revised Terms on the Website and will indicate at the top of this page the date the was last revised. You understand and agree that your continued use of the Service or the Website after we have made any such changes constitutes your acceptance of the new Terms. + +1. INTRODUCTION + +1.1. Eligibility +To be eligible to use the Website you must be at least eighteen (18) years of age or older. The Website, interface and Services (as defined below) is strictly NOT offered to persons or entities who reside in, are citizens of, are incorporated in, or have a registered office in any Restricted Territory, as defined below (any such person or entity from a Restricted Territory shall be a “Restricted Person”). If you are a Restricted Person, then do not attempt to access or use the Website. Jupiter Lock will implement technical measures such as "geoblocking" to ensure that the Website, interface and Services are not available to Restricted Persons. Use of a virtual private network (e.g., a VPN) or other means by Restricted Persons to access or use the Website, interface or Services is prohibited. For the purpose of these Terms, Restricted Territory shall mean the United States, People's Republic of China, Russia, Democratic People’s Republic of Korea (North Korea), or any other state, country or region that is subject to sanctions enforced by the United States, the United Kingdom or the European Union. + +1.2. Terms +We reserve the right to disable access to the Website interface at any time in the event of any breach of the Terms, including without limitation, if we, in our sole discretion, believe that you, at any time, fail to satisfy the eligibility requirements set forth in the Terms. Further, we reserve the right to limit or restrict access to the Website interface by any person or entity, or within any geographic area or legal jurisdiction, at any time and at our sole discretion. We will not be liable to you for any losses or damages you may suffer as a result of or in connection with the Website interface being inaccessible to you at any time or for any reason. + +1.3. Legality +You are solely responsible for adhering to all laws and regulations applicable to you and your use or access to the Website and interface thereon. Your use of the Website and Services is prohibited by and otherwise violate or facilitate the violation of any applicable laws or regulations, or contribute to or facilitate any illegal activity. We make no representations or warranties that the information, products, or services provided through the Website, are appropriate for access or use in other jurisdictions. We reserve the right to limit the availability of our Website to any person, geographic area, or jurisdiction, at any time and at our sole and absolute discretion. + +2. THE SERVICES + +2.1. Jupiter Lock and Services + +Jupiter Lock is a open-sourced, audited and free tool for users to lock and distribute their own digital assets over-time, allowing project teams to lock tokens, implement cliffs, and vest non-circulating supply in a clear and transparent manner. Jupiter Lock performs its core functions via interoperable smart contracts, functioning solely as a back-end technical tool allowing users to perform the above functions. + +2.2. Peer-to-peer interactions +The Services facilitates peer-to-peer interactions between users (for example, between third party project teams which decide to utilise the Services to lock their tokens and the community members of such third party projects) and we are not a party to any such arrangements. Accordingly, you agree that we are not responsible for any activities between users accessing the Services, and you shall bear all risks (including civil claims or regulatory risk) of (a) all activities being performed by you in connection with any other user utilising the Services, and (b) all activities and interactions with other users. Any claims arising in connection with the foregoing shall be directly against the relevant user, and we shall not be liable for the same. + +Users are solely responsible for the acquisition and security (including without limitation enabling of access, applying appropriate security measures, encrypting sensitive data, and not allowing unauthorised access to) while utilising the Services. + +2.3. Usage of Services +Jupiter Lock may launch, change, upgrade, impose conditions to, suspend, or stop offering the Services or any component, feature, element or function of the same, including additional sign-on procedures and requirements, and the manner of access to the Services (including any code repositories or URLs used in connection therewith) without prior notice. + +2.4. Non-custodial nature of smart contracts +The user interface will allow you to access a non-custodial smart contract to perform a variety of transactions. In particular, you confirm that all actions and functions performed via the Jupiter Lock smart contract are irrevocable. You remain in full control of your digital assets, which are not held or controlled in any way by Jupiter Lock. Jupiter Lock does not custody your digital assets, nor collect or hold your keys or information - accordingly, if you lose control over these assets, Jupiter Lock cannot access your digital assets; digital backups; recover keys, passwords, or other information; reset passwords; or reverse transactions. You are solely responsible for the safety of your digital assets and your use of the Services, including without limitation for storing, backing up, and maintaining the confidentiality of your private keys, passwords, and information, and for the security of any transactions you perform using the Website. You expressly relieve and release Jupiter Lock from any and all liability and/or loss arising from your use of the Services. + +2.5. Service fees +If you elect to utilise the Services, all transactions will be conducted solely through the relevant blockchain network (on which your tokens are issued). We will have no insight into or control over these payments or transactions, nor do we have the ability to reverse any transactions. With that in mind, we will have no liability to you or to any third party for any claims or damages that may arise as a result of any transactions that you engage in via the Website, or using the smart contracts, or any other transactions that you conduct via the relevant blockchain network. + +The underlying blockchain network typically requires the payment of a transaction fee ("Gas Fee") for every transaction that occurs on the relevant blockchain network. The Gas Fee funds the network of validators, nodes or resource providers that run the decentralised network. This means that you will need to pay a Gas Fee for each transaction that occurs via the Website. + +Jupiter Lock also reserves the right to levy additional fees for access via the smart contracts or the Website in the future. You agree to promptly pay all aforementioned fees and commissions. + +2.6. Not an Offering of Banking business, Trust business, Custodial business, Escrow business, Securities or Commodities +You understand and affirm that Jupiter Lock is a non-custodial provider of technical smart-contract services which allow users to manage their digital assets. The content of the Website and the Services do not constitute any banking business, trust business, custodial business, escrow business, any offer to buy or sell, or a solicitation of an offer to buy or sell investments, securities, partnership interests, commodities or any other financial instruments in any jurisdiction. The content or the Website and the Services also do not constitute, and may not be used for or in connection with, an offer or solicitation by anyone in any state or jurisdiction in which such an offer or solicitation is not authorized or permitted, or to any person to whom it is unlawful to make such offer or solicitation. In particular, the Services do not constitute any "banking business" within the meaning of any banking laws, "custody" within the meaning of any virtual assets law, or "capital markets products" or "securities" within the meaning of any securities law. + +2.7. No Advice +Jupiter Lock makes no representation or warranty, express or implied, to the extent not prohibited by applicable law, regarding the advisability of participating in digital assets on any blockchain, any financial products, securities, funds, commodity interests, partnership interests or other investments or funding or purchasing loans. Jupiter Lock is merely a technology service provider allowing you to manage your own digital assets connecting you with various third parties and does not offer fiduciary services, and is not your agent, trustee, advisor or fiduciary. + +2.8. Non-reliance +The Services allow users to create a variety of applications. It is solely your responsibility to determine the legality of the applications created and the legal relationship created between you and your end user in respect of such developed applications/users services. Jupiter Lock provides no guarantees as to the suitability or legality of the Services or software tools. + +2.9. Taxes +It is your sole responsibility to determine whether, and to what extent, any taxes apply to any interest received through the Services, and to withhold, collect, report and remit the correct amount of tax to the appropriate tax authorities. + +2.10. Amendment or Withdrawal of Services +Jupiter Lock may impose additional terms for the usage of the Service, as set forth in separate Service-specific Terms and Conditions. Jupiter Lock may increase or restrict the scope of Services, and may modify, limit or discontinue existing Services, from time to time and at Jupiter Lock 's sole discretion. + +2.11. Technical documentation +You must comply with all relevant technical documentation applicable to the Services as posted and updated by Jupiter Lock from time to time on the Website. You further agree, as a continuing condition for your use of the Services, to abide by all license terms and conditions of all third-party software components, libraries and application programme interfaces comprised in any Services as from time to time notified on the Website. + +3. USER TERMS + +3.1. User Conduct +You agree that you are responsible for your own conduct while accessing or using the Website or the Services, and for any consequences thereof. You agree to use the Website and the Services only for purposes that are legal, proper and in accordance with these Terms and any applicable laws or regulations, including without limitation you may not: (a) send, upload, distribute or disseminate any unlawful, defamatory, harassing, abusive, fraudulent, obscene, or otherwise objectionable content; (b) distribute viruses, worms, defects, Trojan horses, corrupted files, hoaxes, or any other items of a destructive or deceptive nature; (c) impersonate another person (via the use of an email address or otherwise); (d) upload, post, transmit or otherwise make available through the Website or the Services any content that infringes the intellectual proprietary rights of any party; (e) use the Website or the Services to violate the legal rights (such as rights of privacy and publicity) of others; (f) engage in, promote, or encourage illegal activity (including, without limitation, money laundering); (g) interfere with other users' enjoyment of the Website or the Services; (h) exploit the Website or the Services for any unauthorised commercial purpose; (i) modify, adapt, translate, decompile, disassemble or reverse engineer any portion of the Website or the Services; (j) attempt to bypass any measure of the Website or the Services designed to prevent or restrict access to the same (or any portion thereof); (k) harass, intimidate, or threaten any of our employees or agents engaged in providing any portion of the Website or the Services to you; (l) remove any copyright, trademark or other proprietary rights notices contained in the Website, the Services or the Content (or any part thereof); (m) reformat or frame any portion of the Website; (n) display any content on the Website or the Services that contains any hate-related or violent content or contains any other material, products or services that violate or encourage conduct that would violate any criminal laws, any other applicable laws, or any third party rights; (o) use any robot, spider, site search/retrieval application, or other device to retrieve or index any portion of the Website or the Services or the content thereon, or to collect information about its users for any unauthorised purpose; (p) upload or transmit (or attempt to upload or to transmit) any material that acts as a passive or active information collection or transmission mechanism, including without limitation, clear graphics interchange formats (“gifs”), 1×1 pixels, web bugs, cookies, or other similar devices (sometimes referred to as “spyware” or “passive collection mechanisms” or “pcms”); (q) access or use the Website or the Services by automated means or under false or fraudulent pretences; (r) access or use the Website or the Services for the purpose of, directly or indirectly, creating or enabling a party to create a product or service that is competitive with any of our products or services; (s) use the Website, the Services or the underlying smart contracts to advertise or offer to sell goods and services; (t) conduct any activity that violates any applicable law, rule, or regulation concerning the integrity of trading markets, including (but not limited to) the manipulative tactics commonly known as spoofing, wash trading, cornering, accommodation trading, fictitious transactions, "money pass" (i.e. transactions without a net change in either party's open positions but with a resulting profit to one party and a loss to the other party), or pre-arranged or non-competitive transactions, or (u) disparage, tarnish, or otherwise harm, in our opinion, us and/or the Website or the Services. If you engage in any of the activities prohibited by this section 3, we may, at our sole and absolute discretion, without notice to you, and without limiting any of our other rights or remedies at law or in equity, immediately suspend or terminate your access to the Website or the Services and delete all your provided input as well as output generated/processed in connection with the Services. + +3.2. User Representations and Warranties +By using the Website, the Services or the underlying smart contracts, you represent and warrant that: (a) you have read and understood these Terms and all documentation on the Website and/or relating to the Services; (b) you have good and sufficient experience and understanding of the functionality, usage, storage, transmission mechanisms and other material characteristics of cryptographic tokens, token storage mechanisms (such as token wallets), blockchain technology, blockchain-like technology and blockchain-based software systems to understand these Terms and to appreciate the risks and implications of using or otherwise interacting with the Website or the Services; (c) you acknowledge and agree that we may impose eligibility criteria to access certain functionality in respect of the Services which may require you to incur additional time and money costs; (d) you use and/or interact with the Website and the Services for your own account and shall not do the same on behalf of any other entity or person; (e) your usage and/or interaction with the Website and the Services complies with applicable law and regulation in your jurisdiction, and the law and regulation of any jurisdiction to which you may be subject (including, but not limited to legal capacity and any other threshold requirements for using and/or interacting with the Website or the Services, interacting with other users of the Website or the Services, and any governmental or other consents that may need to be obtained; (f) all information you submit will be true, accurate, current, and complete (if you provide any information that is untrue, inaccurate, not current, or incomplete, we have the right to refuse or terminate your current or future use of the Website or the Services (or any portion thereof); (g) you will maintain the accuracy of such information and promptly update such information as necessary; (h) you have the legal capacity and you agree to comply with these Terms; (i) you are not a minor in the jurisdiction in which you reside; (j) you will not use the Website, the Services or the underlying smart contracts for any illegal and unauthorised purpose; (k) you will not use the Website or the Service or the underlying smart contracts for any commercial purpose (save as approved by us in writing); (l) your use of the Website, the Services and the underlying smart contracts will not violate any applicable law or regulation; and (m) any funds or digital assets you use to interact with the Website or the Services are not derived from or related to any unlawful activities, including but not limited to money laundering or terrorist financing and all applicable statutes of all jurisdictions in which you are located, resident, organised or operating, and/or to which it may otherwise be subject and the rules and regulations thereunder (collectively, the "Compliance Regulations"), and you will not use the Website, the Services or the underlying smart contracts to finance, engage in, or otherwise support any unlawful activities or in a manner which aids or facilitates another party in the same. To the extent required by applicable laws and regulations, you shall fully comply with all Compliance Regulations. + +4. RISK FACTORS + +You acknowledge and agree that the Services are currently in the initial development stages and there are a variety of unforeseeable risks with utilising the Services or Website. In the worst scenario, this could lead to the loss of all or part of your digital assets associated with the Services. IF YOU DECIDE TO UTILISE SERVICES YOU EXPRESSLY ACKNOWLEDGE, ACCEPT AND ASSUME THE BELOW RISKS AND AGREE NOT TO HOLD JUPITER LOCK OR ANY OF THEIR RELATED PARTIES RESPONSIBLE FOR THE FOLLOWING RISKS: + +4.1. Third-party Risk +The Services rely on whole or partly, on third-party open and closed source software networks, and the continued development and support of third parties. There is no assurance or guarantee that those third parties will maintain their support of their software, which might have a material adverse effect on the Services. Further, where digital assets are locked as collateral for applications built with Jupiter Lock tools and/or are deployed by such third party applications towards third-party decentralized finance protocols to further generate yield, a failure or security incident in respect of such third-party protocol may result in users losing all or substantially all of their digital assets. + +4.2. No Insurance +Digital assets are not legal tender, are not backed by the government, and are not subject to the Deposit Insurance Scheme or protections under any banking or securities laws. Jupiter Lock is not a bank and does not offer fiduciary services, nor does it offer any security broking services. + +4.3. New Technical Risk +The software used for Jupiter Lock is new. While this software has been extensively tested, the underlying smart contracts and software used for the Services is still relatively new and could have bugs or security vulnerabilities. Further, the software is still under development and may undergo significant changes over time that may not meet users’ expectations. + +4.4. Risks +The underlying smart contracts run on a variety of supported blockchain networks, using specially-developed smart contracts. Accordingly, upgrades to the relevant blockchain network, a hard fork in the relevant blockchain network, re-organisations of blockchain structure or blocks, or a change in how transactions are confirmed on the relevant blockchain network may have unintended, adverse effects on the smart contracts built thereon, including Jupiter Lock software and smart contracts. + +4.5. Information Security Risk +Digital assets, and use of the Services may be subject to expropriation and/or theft. Hackers or other malicious groups or organizations may attempt to interfere with the Services in a variety of ways, including, but not limited to, malware attacks, denial of service attacks, consensus-based attacks, Sybil attacks, smurfing and spoofing. Furthermore, because the underlying blockchain networks comprise open-source software, there is the software underlying the Services may contain intentional or unintentional bugs or weaknesses that may negatively affect the Services or result in the loss of the user’s digital assets, the loss of the user’s ability to access or control their digital assets. In the event of such a software bug or weakness, there may be no remedy, and users are not guaranteed any remedy, refund or compensation. + +4.6. Regulatory risks +The regulatory status of digital assets, and distributed ledger technology is unclear or unsettled in many jurisdictions. While every effort has been taken to ensure that the Services are compliant with local laws, it is difficult to predict how or whether regulatory agencies may apply existing regulation with respect to the Services. It is likewise difficult to predict how or whether legislatures or regulatory agencies may implement changes to law and regulation affecting distributed ledger technology and its applications, including the Services. Regulatory actions could negatively impact Jupiter Lock in various ways, and thus the Services may not be available in certain areas. + +4.7. Taxation Risk +The tax characterization of digital assets, and the usage of the Services are uncertain. It is possible that the user's intended treatment of digital assets may be challenged. You must seek your own tax advice in connection with the Services provided by Jupiter Lock, which may result in adverse tax consequences to you, including, without limitation, withholding taxes, transfer taxes, value-added taxes, income taxes and similar taxes, levies, duties or other charges and tax reporting requirements. + +4.8. Additional conditions of usage of the Website and Services + +Your usage of the Website and Services is subject to the following additional conditions: +(a) Unlawful Activity: you agree not to engage, or assist, in any activity that violates any law, statute, ordinance, regulation, or sanctions program, including but not limited to the U.S. Department of Treasury’s Office of Foreign Assets Control (OFAC), or that involves proceeds of any unlawful activity. +(b) Abusive Activity: you agree not to engage in any activity that poses a threat to Jupiter Lock or the Website, for example by distributing a virus or other harmful code, or through unauthorized access to the Website or other users’ digital assets. +(c) Inappropriate Behaviour: you agree not to interfere with other users’ access to or use of the Services. +(d) Communication: you agree not to communicate with other users for purposes of (1) sending unsolicited advertising or promotions, requests for donations, or spam; (2) harassing or abusing other users; (3) interfering with transactions of other users. You agree not to use data collected from the Website to contact individuals, companies, or other persons or entities outside the Website for any purpose, including but not limited to marketing activity. +(e) Fraud: you agree not to engage in any activity which operates to defraud Jupiter Lock, other users, or any other person; or to provide any false, inaccurate, or misleading information to Jupiter Lock. +(f) Gambling: you agree not to utilize the Services to engage in any lottery, bidding fee auctions, contests, sweepstakes, or other games of chance. +5. WEBSITE AVAILABILITY AND ACCURACY + +5.1. Access and Availability +Access to the Services may become degraded or unavailable on Jupiter Lock during times of significant volatility or volume. This could result in the inability to interact with Jupiter Lock, or third-party services for periods of time and may also lead to support response time delays. Users will, however, be able to access these third-party services through other means. Although we strive to provide you with excellent service, we do not guarantee that the Website or Services will be available without interruption and we do not guarantee that requests to interact with third-party services will be successful. + +5.2. Website Accuracy +Although we intend to provide accurate and timely information on the Website, the Website (including, without limitation, the Services and the content on the Website may not always be entirely accurate, complete or current and may further also include technical inaccuracies or typographical errors. In an effort to continue to provide you with as complete and accurate information as possible, information may, to the extent permitted by applicable law, be changed or updated from time to time without notice, including without limitation information regarding our policies, products and services. Accordingly, you should verify all information before relying on it, and all decisions based on information contained on the Website are your sole responsibility and we shall have no liability for such decisions. Links to third-party materials (including without limitation any websites) may be provided as a convenience but are not controlled by us. You acknowledge and agree that we are not responsible for any aspect of the information, content, or services contained in any such third-party materials accessible or linked to from the Website. + +5.3. Not a Backup or Storage Site +The Website is intended solely to provide you with a visual interface to access and use the Services. It is not intended for use as a data backup or storage site. You are solely responsible for ensuring that you maintain copies of your applications developed, code base, or other content. Except as may be required under applicable data privacy or other laws and regulations, Jupiter Lock is under no obligation to provide you with access to any data or other materials stored on the Website or to ensure their reliability or availability. + +6. CONSENT TO ELECTRONIC DISCLOSURES AND SIGNATURES + +6.1. General +Because Jupiter Lock operates only on the Internet, it is necessary for you to consent to transact business with us online and electronically. As part of doing business with us, therefore, we also need you to consent to our providing you certain disclosures electronically, either via our Website or to the email address (if applicable) you provide to us. By agreeing to these Terms, you agree to receive electronically all documents, communications, notices, contracts, and agreements arising from or relating to your use of the Website and Service. + +6.2. Scope of Consent +Your consent to receive disclosures and transact business electronically, and our agreement to do so, applies to any transactions to which such disclosures relate, whether between you and Jupiter Lock or a third party by and through the Service. Your consent will remain in effect for so long as you are a user and, if you are no longer a user, will continue until such a time as all disclosures relevant to Services received through the Website. + +6.3. Withdrawing Consent +You may withdraw your consent to receive agreements or disclosures electronically by contacting us at legal@jup.ag. However, once you have withdrawn your consent you will not be able to access the Services. + +7. INTELLECTUAL PROPERTY, COPYRIGHTS AND IDENTIFYING MARKS + +7.1. Jupiter Lock Intellectual Property +You acknowledge that all Intellectual Property Rights in Jupiter Lock smart contracts, the Website, or any service/product thereon (including without limitation any information, licenses, business plans, data, patent disclosures, system applications, structures, models, flow charts, techniques, processes, compositions, compounds, software, programs, source code and object code, comments to the source or object code, specifications, documents, reports, presentations, test results, findings, ideas, knowhow, copyright, trade secrets, abstracts and/or summaries thereof) exclusively belongs and shall exclusively belong to Jupiter Lock, and you shall have no rights in or to such Intellectual Property Rights, save that you are granted a license during the term of this Agreement to utilise the published Jupiter Lock contracts issued under the relevant [BSL] License) at code repository [*], and subject always to the provisions of these Terms. + + To the extent any Jupiter Lock intellectual property rights are deemed to belong to you, you hereby irrevocably assigns and transfers to Jupiter Lock all right, title and interest in all such intellectual property rights, and agrees to execute all documents reasonably requested by Jupiter Lock for the purpose of perfecting such assignment and/or transfer and applying for and obtaining any domestic and foreign patent and copyright registrations. + +7.2. Limited License +All content on the Website, including but not limited to designs, text, graphics, pictures, video, information, software, music, sound and other files, and their selection and arrangement (the "Content"), are the proprietary property of Jupiter Lock with all rights reserved. No Content may be modified, copied, distributed, framed, reproduced, republished, downloaded, displayed, posted, transmitted, or sold in any form or by any means, in whole or in part, without Jupiter Lock's prior written permission, except as provided in the following sentence and except that the foregoing does not apply to your own User Content (as defined below) that you legally post on the Website. Provided that you are eligible for use of the Website, you are granted a limited license to access and use the Website and Services, and to download or print a copy of any portion of the Content solely for your use in connection with your use of the Website or Service, provided that you keep all copyright or other proprietary notices intact. Except for your own User Content (as defined below), you may not republish Content on any Internet, Intranet or Extranet site or incorporate the information in any other database or compilation, and any other use of the Content is strictly prohibited. Any use of the Website or the Content other than as specifically authorized herein, without the prior written permission of Jupiter Lock, is strictly prohibited and will terminate the license granted herein. Such unauthorized use may also violate applicable laws including without limitation copyright and trademark laws and applicable communications regulations and statutes. Unless explicitly stated herein, nothing in these Terms shall be construed as conferring any license to intellectual property rights, whether by estoppel, implication or otherwise. This license is revocable by us at any time without notice and with or without cause. + +7.3. Trademarks +Jupiter Lock and other Jupiter Lock graphics, logos, designs, page headers, button icons, scripts, and service names are registered trademarks, trademarks or trade dress of Jupiter Lock in Panama and/or other countries. Jupiter Lock's trademarks and trade dress may not be used, including as part of trademarks and/or as part of domain names, in connection with any product or service in any manner that is likely to cause confusion and may not be copied, imitated, or used, in whole or in part, without the prior written permission of Jupiter Lock. Jupiter Lock may, at its sole discretion, limit access to the Website by any users who infringe any intellectual property rights of Jupiter Lock or others. + +7.4. Copyright Complaints +If you believe that any material on the Website infringes upon any copyright which you own or control, you may send a written notification of such infringement to Jupiter Lock at legal@jup.ag. + +7.5. Suggestions +You acknowledge and agree that any questions, comments, suggestions, ideas, feedback or other information about the Website or the Service ("Suggestions"), provided by you to Jupiter Lock are non-confidential and shall become the sole property of Jupiter Lock. Jupiter Lock shall own exclusive rights, including all intellectual property rights, and shall be entitled to the unrestricted use and dissemination of these Suggestions for any purpose, commercial or otherwise, without acknowledgment or compensation to you. + +8. DATA PROTECTION AND SECURITY + +8.1. Loss or Compromise +Any loss or compromise of your electronic device or your security details may result in unauthorized access to your digital assets by third parties and the loss or theft of such assets. + +8.2. Shared Access +You should never allow remote access or share your computer screen with someone else when you are accessing the Services. Jupiter Lock will never under any circumstances ask you for your private keys or passwords, or to screen share or otherwise seek to access your computer or digital assets. You should not provide your details to any third party for the purposes of remotely accessing your computer or digital assets. + +8.3. Safety and Security of Your Computer and Devices +Jupiter Lock is not liable for any damage or interruptions caused by any computer viruses or other malicious code that may affect your computer or other equipment, or any phishing, spoofing or other attacks. We advise the regular use of a reputable and readily available virus screening and prevention software. + +9. USER FEEDBACK, QUERIES, COMPLAINTS, DISPUTES + +9.1. Contact Jupiter Lock +If you have feedback or general questions, please contact us via our User Support at legal@jup.ag. When you contact us please provide us with your name, email address, and any other information we may need to identify you, your transactions conducted, and digital assets held. + +9.2. Dispute Resolution +PLEASE READ THIS SECTION CAREFULLY BECAUSE IT CONTAINS CERTAIN PROVISIONS, SUCH AS A BINDING ARBITRATION SECTION AND CLASS ACTION WAIVER, WHICH AFFECT YOUR LEGAL RIGHTS. THIS SECTION REQUIRES YOU TO ARBITRATE CERTAIN DISPUTES AND CLAIMS WITH JUPITER LOCK AND LIMITS THE MANNER IN WHICH YOU CAN SEEK RELIEF FROM US. +Each party (i) waives all its respective right(s) to have any and all disputes, claims, suits, actions, causes of action, demands or proceedings (collectively, "Disputes") arising from or related to these Terms resolved in a court, and (ii) waive all its respective right(s) to have any Disputes heard before a court. Instead, each party shall arbitrate Disputes through binding arbitration (which is the referral of a Dispute to one or more persons charged with reviewing the Dispute and making a final and binding determination to resolve it instead of having the Dispute decided by a judge or jury in court). + +Any Dispute arising out of or related to these Terms is personal to you and will be resolved solely through individual arbitration, and in no circumstances shall be brought as a class arbitration, class action or any other type of representative proceeding. There will be no class arbitration or arbitration in which an entity attempts to resolve a Dispute as a representative of another individual or group of individuals. Further, a Dispute cannot be brought as a class or other type of representative action, whether within or outside of arbitration, or on behalf of any other individual or group of individuals. + +Any Dispute arising out of or in connection with these Terms (including without limitation the enforceability of this section or any question regarding its existence, validity or termination) shall be referred to and finally resolved by arbitration administered by Panama Conciliation and Arbitration Centre in accordance with its procedural rules for the time being in force. The tribunal shall consist of 1 arbitrator. The language of the arbitration shall be English. + +Each party will notify the other party in writing of any Dispute within thirty (30) days of the date it arises, so that the Parties can attempt in good faith to resolve the Dispute informally. Notice to Jupiter Lock shall be sent by e-mail to Jupiter Lock at legal@jup.ag. Notice to you shall be either posted on the Website or, if available, will be sent by email to your email on record. Your notice must include (i) your name, postal address, email address and telephone number, (ii) a full and sufficient description of the nature or basis of the Dispute, and (iii) the specific relief that you are seeking. If you and Jupiter Lock cannot agree on how to resolve the Dispute within thirty (30) days after the date the notice is received by the applicable party, then either you or Jupiter Lock may, as appropriate and in accordance with this section, commence an arbitration proceeding or, to the extent specifically provided for in this section, file a claim in court. + +The arbitrator does not have the authority to conduct a class arbitration or a representative or class action, which is prohibited by these Terms. The arbitrator may only conduct an individual arbitration and may not consolidate more than one individual’s claims, preside over any type of class or representative proceeding or preside over any proceeding involving more than one individual. + +If any term, clause or provision of this section is held invalid or unenforceable, it will be held to the minimum extent applicable and required by law, and all other terms, clauses and provisions of this section will remain valid and enforceable. Further, the waivers set forth in this section are severable from the other provisions of these Terms and will remain valid and enforceable, except as prohibited by applicable law. + +You agree that this section of these Terms has been included to rapidly and inexpensively resolve any disputes with respect to the matters described herein, and that this section shall be grounds for dismissal of any court action commenced by you with respect to a dispute arising out of such matters. + +A printed version of these Terms shall be admissible in judicial or administrative proceedings. + +9.3. Disclaimers +None of Jupiter Lock, its parent, any of its affiliates, subsidiaries, providers or their respective officers, directors, employees, agents, independent contractors or licensors (collectively the "Indemnified Parties") guarantees the accuracy, adequacy, timeliness, reliability, completeness, or usefulness of the Services or the Content, and the Indemnified Parties disclaim liability for errors or omissions in the Content. This Website, the Services and all of the Content is provided "as is" and "as available," without any warranty, either express or implied, including the implied warranties of merchantability, fitness for a particular purpose, non-infringement or title. Without prejudice to the generality of the foregoing, Jupiter Lock provides no warranties as to the results of your use of the Services or Content, or any application development in connection therewith. The Indemnified Parties do not warrant that the Website is free of viruses or other harmful components. This does not affect those warranties which are incapable of exclusion, restriction or modification under the laws applicable to these Terms. Jupiter Lock cannot guarantee and does not promise any specific results from use of the Website and/or the Service. + +9.4. Availability +The Website and the Service may be temporarily unavailable from time to time for maintenance or other reasons. Jupiter Lock assumes no responsibility for any error, omission, interruption, deletion, defect, delay in operation or transmission, communications line failure, theft or destruction or unauthorized access to, or alteration of, user communications. Jupiter Lock is not responsible for any problems or technical malfunction of any telephone network or lines, computer online systems, servers or providers, computer equipment, software, failure of email or players on account of technical problems or traffic congestion on the Internet or on the Website or combination thereof, including injury or damage to users or to any other person's computer related to or resulting from participating or downloading materials in connection with the Website and/or in connection with the Service. Under no circumstances will Jupiter Lock be responsible for any loss or damage, including any loss or damage to any user Content, financial damages or lost profits, loss of business, or personal injury or death, resulting from anyone's use of the Website or the Service, any User Content or Third Party Content posted on or through the Website or the Service or transmitted to users, or any interactions between users of the Website, whether online or offline. + +9.5. Limitation on Liability +EXCEPT IN JURISDICTIONS WHERE SUCH PROVISIONS ARE RESTRICTED, IN NO EVENT WILL JUPITER LOCK OR ITS DIRECTORS, EMPLOYEES OR AGENTS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY INDIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, SPECIAL OR PUNITIVE DAMAGES, INCLUDING FOR ANY LOST PROFITS OR LOST DATA ARISING FROM YOUR USE OF THE WEBSITE OR THE SERVICE OR ANY OF THE CONTENT OR OTHER MATERIALS ON OR ACCESSED THROUGH THE WEBSITE, EVEN IF JUPITER LOCK IS AWARE OR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +NOTWITHSTANDING ANYTHING TO THE CONTRARY CONTAINED HEREIN, TO THE EXTENT PERMITTED BY APPLICABLE LAW JUPITER LOCK'S LIABILITY TO YOU FOR ANY CAUSE WHATSOEVER, AND REGARDLESS OF THE FORM OF THE ACTION, WILL AT ALL TIMES BE LIMITED TO THE AMOUNT PAID, IF ANY, BY YOU TO JUPITER LOCK FOR THE SERVICES. IN NO CASE WILL JUPITER LOCK'S LIABILITY TO YOU EXCEED $200. YOU ACKNOWLEDGE THAT IF NO FEES ARE PAID TO JUPITER LOCK FOR THE SERVICE, YOU SHALL BE LIMITED TO INJUNCTIVE RELIEF ONLY, UNLESS OTHERWISE PERMITTED BY LAW, AND SHALL NOT BE ENTITLED TO DAMAGES OF ANY KIND FROM JUPITER LOCK, REGARDLESS OF THE CAUSE OF ACTION. + +CERTAIN LOCAL, STATE OR FEDERAL LAWS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF CERTAIN DAMAGES OR LIMITATIONS ON IMPLIED WARRANTIES. IF THESE LAWS APPLY TO YOU, SOME OR ALL OF THE ABOVE DISCLAIMERS, EXCLUSIONS OR LIMITATIONS MAY NOT APPLY TO YOU, AND YOU MAY HAVE ADDITIONAL RIGHTS. + +9.6. Governing Law; Venue and Jurisdiction +By visiting or using the Website and/or the Service, you agree that the laws of Panama, without regard to any principles of conflict of laws that would require or permit the application of the laws of any other jurisdiction, will govern these Terms. If you contract with any third party through Jupiter Lock, the terms of such contract will be governed by the contractual terms prescribed by such third party. + +9.7. Indemnity +You agree to indemnify and hold the Indemnified Parties, its subsidiaries and affiliates, and each of their directors, officers, agents, contractors, partners and employees, harmless from and against any loss, liability, claim, demand, damages, costs and expenses, including reasonable attorney's fees, arising out of any dispute with another user of the Website or any third party. You also agree to indemnify and hold the Indemnified Parties, its subsidiaries and affiliates and service providers, and each of its or their respective officers, directors, agents, joint venturers, employees and representatives, harmless from any claim or demand (including attorneys' fees and any fines, fees or penalties imposed by any regulatory authority) arising out of or related to your breach of these Terms or your violation of any law, rule or regulation, or the rights of any third party. + +10. GENERAL PROVISIONS + +10.1. Amendments +We may amend or modify these Terms by posting on the Website the revised Terms, and the revised Terms shall be effective at such time. If you do not agree with any such modification, your sole and exclusive remedy is to terminate your use of the Services and Website. You agree that we shall not be liable to you or any third party for any modification or termination of the Services, or suspension or termination of your access to the Services, except to the extent otherwise expressly set forth herein. If the revised Terms include a material change, we will endeavour to provide you advanced notice via the Website before the material change becomes effective. + +10.2. Force Majeure +Jupiter Lock shall not be liable for delays, failure in performance or interruption of service which result directly or indirectly from any cause or condition beyond our reasonable control, including but not limited to, significant market volatility, any delay or failure due to any act of God, act of civil or military authorities, act of terrorists, civil disturbance, war, strike or other labour dispute, fire, interruption in telecommunications or Internet services or network provider services, failure of equipment and/or software, other catastrophe or any other occurrence which is beyond our reasonable control and shall not affect the validity and enforceability of any remaining provisions. + +10.3. Links to Other Web Websites and Content +The Website contains (or you may be sent through the Website or the Services) links to other websites ("Third Party Websites"), as well as articles, photographs, text, graphics, pictures, designs, music, sound, video, information, software and other content belonging to or originating from third parties (the "Third Party Content"). Such Third Party Websites and Third Party Content are not investigated, monitored or checked for accuracy, appropriateness, or completeness by us, and we are not responsible for any Third Party Websites accessed through the Website or any Third Party Content posted on the Website, including without limitation the content, accuracy, offensiveness, opinions, reliability or policies of or contained in the Third Party Websites or the Third Party Content. Inclusion of or linking to any Third Party Website or any Third Party Content does not imply approval or endorsement thereof by us. If you decide to leave the Website and access Third Party Websites, you do so at your own risk and you should be aware that our terms and policies no longer govern. You should review the applicable terms and policies, including privacy and data gathering practices, of any site to which you navigate from the Website. + +10.4. Assignment +These Terms, or your rights and obligations hereunder, may not be transferred by you, but may be assigned by us without restriction (without having to seek your prior consent). Any attempted transfer or assignment by you in violation hereof shall be null and void. These Terms shall be binding and inure to the benefit of the parties hereto, our successors, and permitted assigns. + +10.5. No-Waiver +The failure of Jupiter Lock to exercise or enforce any right or provision of these Terms shall not constitute a waiver of such right or provision in that or any other instance. If any provision of these Terms is held invalid, the remainder of these Terms shall continue in full force and effect. If any provision of these Terms shall be deemed unlawful, void or for any reason unenforceable, then that provision shall be deemed severable from these Terms and shall not affect the validity and enforceability of any remaining provisions. + +10.6. Relationship of the parties +You agree and understand that nothing in these Terms shall be deemed to constitute, create, imply, give effect to, or otherwise recognize a partnership, employment, joint venture, or formal business entity of any kind; and the rights and obligations of the parties shall be limited to those expressly set forth herein. Except for the indemnity and exculpation provisions herein, nothing expressed in, mentioned in, or implied from these Terms is intended or shall be construed to give any person other than the parties hereto any legal or equitable right, remedy, or claim under or in respect to these Terms to enforce any of its terms which might otherwise be interpreted to confer such rights to such persons, and these Terms and all representations, warranties, covenants, conditions and provisions hereof are intended to be and are for the exclusive benefit of you and us. + +10.7. Notices +To give us notice under these Terms, the user must contact Jupiter Lock by email at legal@jup.ag. + +10.8. Entire Agreement +These Terms and our Privacy Policy, incorporated by reference herein, comprise the entire understanding and agreement entered into by and between you and us as to the subject matter hereof, and supersede any and all prior discussions, agreements, and understandings of any kind (including without limitation any prior versions of these Terms), as well as every nature between and among you and us. + +10.9. Severability +If any provision of these Terms shall be determined to be invalid or unenforceable under any rule, law, or regulation of any local, state, or federal government agency, such provision will be changed and interpreted to accomplish the objectives of the provision to the greatest extent possible under any applicable law and the validity or enforceability of any other provision of these Terms shall not be affected. If such construction is not possible, the invalid or unenforceable portion will be severed from these Terms but the rest of these Terms will remain in full force and effect. + +10.10. Survival +The following provisions of these Terms shall survive termination of your use or access to the Website: the sections concerning Intellectual Property, Disclaimer of Warranties, Limitation on Liability, Waiver, Applicable Law and Dispute Resolution, and General Provisions, and any other provision that by its terms survives termination of your use or access to the Website. + +10.11. English language +Notwithstanding any other provision of these Terms, any translation of these Terms is provided for your convenience. The meanings of terms, conditions, and representations herein are subject to their definitions and interpretations in the English language. In the event of conflict or ambiguity between the English language version and translated versions of these terms, the English language version shall prevail. You acknowledge that you have read and understood the English language version of these Terms. + +
    \ No newline at end of file diff --git a/guides/10-onboard/1-bridging.md b/guides_versioned_docs/version-old/10-onboard/1-bridging.md similarity index 100% rename from guides/10-onboard/1-bridging.md rename to guides_versioned_docs/version-old/10-onboard/1-bridging.md diff --git a/guides/10-onboard/2-onramp.md b/guides_versioned_docs/version-old/10-onboard/2-onramp.md similarity index 100% rename from guides/10-onboard/2-onramp.md rename to guides_versioned_docs/version-old/10-onboard/2-onramp.md diff --git a/guides/10-onboard/_category_.json b/guides_versioned_docs/version-old/10-onboard/_category_.json similarity index 100% rename from guides/10-onboard/_category_.json rename to guides_versioned_docs/version-old/10-onboard/_category_.json diff --git a/guides/11-jupiter-lock/1-jupiter-lock.md b/guides_versioned_docs/version-old/11-jupiter-lock/1-jupiter-lock.md similarity index 100% rename from guides/11-jupiter-lock/1-jupiter-lock.md rename to guides_versioned_docs/version-old/11-jupiter-lock/1-jupiter-lock.md diff --git a/guides/11-jupiter-lock/_category_.json b/guides_versioned_docs/version-old/11-jupiter-lock/_category_.json similarity index 100% rename from guides/11-jupiter-lock/_category_.json rename to guides_versioned_docs/version-old/11-jupiter-lock/_category_.json diff --git a/guides/12-general/1-personal-security-on-solana.md b/guides_versioned_docs/version-old/12-general/1-personal-security-on-solana.md similarity index 100% rename from guides/12-general/1-personal-security-on-solana.md rename to guides_versioned_docs/version-old/12-general/1-personal-security-on-solana.md diff --git a/guides/12-general/2-verify-swaps-with-SolanaFM.md b/guides_versioned_docs/version-old/12-general/2-verify-swaps-with-SolanaFM.md similarity index 100% rename from guides/12-general/2-verify-swaps-with-SolanaFM.md rename to guides_versioned_docs/version-old/12-general/2-verify-swaps-with-SolanaFM.md diff --git a/guides/12-general/3-blinks.md b/guides_versioned_docs/version-old/12-general/3-blinks.md similarity index 100% rename from guides/12-general/3-blinks.md rename to guides_versioned_docs/version-old/12-general/3-blinks.md diff --git a/guides/12-general/4-get-your-token-on-jupiter.md b/guides_versioned_docs/version-old/12-general/4-get-your-token-on-jupiter.md similarity index 100% rename from guides/12-general/4-get-your-token-on-jupiter.md rename to guides_versioned_docs/version-old/12-general/4-get-your-token-on-jupiter.md diff --git a/guides/12-general/5-wrapped-sol.md b/guides_versioned_docs/version-old/12-general/5-wrapped-sol.md similarity index 100% rename from guides/12-general/5-wrapped-sol.md rename to guides_versioned_docs/version-old/12-general/5-wrapped-sol.md diff --git a/guides/12-general/6-faq.md b/guides_versioned_docs/version-old/12-general/6-faq.md similarity index 96% rename from guides/12-general/6-faq.md rename to guides_versioned_docs/version-old/12-general/6-faq.md index 5fadc7ae..729d377d 100644 --- a/guides/12-general/6-faq.md +++ b/guides_versioned_docs/version-old/12-general/6-faq.md @@ -25,7 +25,7 @@ description: "Discover FAQs on Jupiter Swap, DCA, and more. Get quick answers an - Slippage occurs because of changing market conditions between the moment the transaction is submitted and its verification. - Your slippage rate is an important setting, it works as a protection. If the price falls below your slippage rate, then the transaction will fail in order to prevent you from getting less tokens than you want. - You can adjust your slippage. By default, slippage is set to 0.5%, meaning if the price slips more than 0.5% of your quote, the trade will not be completed. -- Learn more about [slippage and price impact](/guides/2-spot/1-swap/3-how-swap-works.md) +- Learn more about slippage and price impact ### What does it mean when I get the 'some routes failed to load...' @@ -52,7 +52,7 @@ Protocols / Projects are free to integrate Jupiter swap with [Swap API](/docs/ol A few scenarios or cases where the order is not being fulfill - If the order size is too large *(and there is insufficient liquidity on-chain)* - in this case, Jupiter keeper will attempt to execute your order in a smaller chunk to partially fill your orders and will continue to do so until order is fully executed - The price wick happen for a very short period of time, and the liquidity have all been taken up at that price. -- For more information on how Jupiter Limit Order works - [How Limit Order Works](/guides/2-spot/3-limit-order/2-how-lo-work.md) +- For more information on how Jupiter Limit Order works ### In the Wallet transaction history, of using the Limit order, I see many failed transactions, did I pay for that transaction fees? @@ -72,7 +72,7 @@ A few scenarios or cases where the order is not being fulfill ### Will there be any risk of my order getting frontrun? - Jupiter DCA added some randomness in executing order to prevent potential frontrunning . -- For more information on how Jupiter DCA works - [How DCA Works](../../guides/dca/how-dca-work) +- For more information on how Jupiter DCA works ---- @@ -95,7 +95,7 @@ A few scenarios or cases where the order is not being fulfill ### How do I get my new project token to be available to trade on Jupiter? - All new tokens on supported AMMs are instantly routed on Jupiter for 14 days, and are marked with a '⚠️’ label to encourage users to double-check that the mint addresses are the right ones before trading. -- Learn more about how to get your token verified and routed on Jupiter [here](/guides/12-general/4-get-your-token-on-jupiter.md). +- Learn more about how to get your token verified and routed on Jupiter ### How do I get my new token to the strict list / remove the unknown tag? diff --git a/guides/12-general/7-media-kit.md b/guides_versioned_docs/version-old/12-general/7-media-kit.md similarity index 100% rename from guides/12-general/7-media-kit.md rename to guides_versioned_docs/version-old/12-general/7-media-kit.md diff --git a/guides/12-general/8-edge.md b/guides_versioned_docs/version-old/12-general/8-edge.md similarity index 100% rename from guides/12-general/8-edge.md rename to guides_versioned_docs/version-old/12-general/8-edge.md diff --git a/guides/12-general/_category_.json b/guides_versioned_docs/version-old/12-general/_category_.json similarity index 100% rename from guides/12-general/_category_.json rename to guides_versioned_docs/version-old/12-general/_category_.json diff --git a/guides/2-spot/0-spot.mdx b/guides_versioned_docs/version-old/2-spot/0-spot.mdx similarity index 71% rename from guides/2-spot/0-spot.mdx rename to guides_versioned_docs/version-old/2-spot/0-spot.mdx index 3c2a755f..4e86ead3 100644 --- a/guides/2-spot/0-spot.mdx +++ b/guides_versioned_docs/version-old/2-spot/0-spot.mdx @@ -6,8 +6,6 @@ pagination_prev: index sidebar_class_name: "hidden" --- -![spot-overview](../../guides/img/jupiter-spot.png) - Welcome to **Jupiter Spot**, the most powerful way to trade tokens on Solana. Jupiter Spot relies on **Jupiter Routing**, a universal routing algorithm with over **22 AMMs** on Solana, intelligently finding the best prices for your trades, and across all the tokens on Solana. @@ -22,39 +20,39 @@ Let's go through them in this overview! --- -![spot-swap](../../static/img/spot/spot-swap.png) +![spot-swap](/img/spot/spot-swap.png) **Swap between any token on Solana, with the best prices and 0 fees with a single click.** -- Jupiter also automatically minimizes [slippage](https://station.jup.ag/guides/jupiter-swap/how-swap-works/metropolis-features#dynamic-slippage) and set [priority fees](https://station.jup.ag/guides/jupiter-swap/swap#transaction-priority-fees) for you, while [flagging potential concerns](https://station.jup.ag/guides/jupiter-swap/how-swap-works/#safety-notifications). +- Jupiter also automatically minimizes [slippage](https://station.jup.ag/guides/old/jupiter-swap/how-swap-works/metropolis-features#dynamic-slippage) and set [priority fees](https://station.jup.ag/guides/old/jupiter-swap/swap#transaction-priority-fees) for you, while [flagging potential concerns](https://station.jup.ag/guides/old/jupiter-swap/how-swap-works/#safety-notifications). - All you have to do is to set the max slippage & priority fees you are willing to pay, before swapping without worry. -- Detailed walkthrough on how to swap on Jupiter & UI features: [How to Swap](https://station.jup.ag/guides/jupiter-swap/swap) +- Detailed walkthrough on how to swap on Jupiter & UI features: [How to Swap](https://station.jup.ag/guides/old/jupiter-swap/swap) --- -![spot-lo](../../static/img/spot/spot-lo.png) +![spot-lo](/img/spot/spot-lo.png) **Specify a set price to execute your trade, across most tokens on Solana.** - When your desired price is hit, Jupiter’s Keepers attempt to fill the order for you. - Note: You will get filled at exactly the rate you specified. Use our UI to help guide you in setting the right orders! - - Detailed walkthrough on how to set limit orders & UI features: [How to use Limit Order](https://station.jup.ag/guides/limit-order/limit-order) + - Detailed walkthrough on how to set limit orders & UI features: [How to use Limit Order](https://station.jup.ag/guides/old/limit-order/limit-order) --- -![spot-dca](../../static/img/spot/spot-dca.png) +![spot-dca](/img/spot/spot-dca.png) **Automate regular investments with DCA, with a 0.1% fee per order.** - Based on your Interval (Weekly, Monthly, etc) and Number of Orders, DCA will swap on your behalf. - Automatically retry and minimize priority fees + slippage for DCA orders, without you needing to. - - Detailed walkthrough on how to set DCA orders & UI features: [How to use DCA](https://station.jup.ag/guides/dca/how-to-dca) + - Detailed walkthrough on how to set DCA orders & UI features: [How to use DCA](https://station.jup.ag/guides/old/dca/how-to-dca) --- -![spot-va](../../static/img/spot/spot-va.png) +![spot-va](/img/spot/spot-va.png) **DCA, but price weighted. Buy more when prices are low, and buy less when prices are up.** - VA maintains a “target portfolio increase”, where it will buy more tokens when prices fall, and less when prices are high, instead of a fixed purchase quantity at every interval. - - Detailed walkthrough on how to set VA orders & UI features: [How to use VA](https://station.jup.ag/guides/va/how-to-va) + - Detailed walkthrough on how to set VA orders & UI features: [How to use VA](https://station.jup.ag/guides/old/va/how-to-va) diff --git a/guides/2-spot/1-swap/1-features.md b/guides_versioned_docs/version-old/2-spot/1-swap/1-features.md similarity index 100% rename from guides/2-spot/1-swap/1-features.md rename to guides_versioned_docs/version-old/2-spot/1-swap/1-features.md diff --git a/guides/2-spot/1-swap/2-tutorials/1-how-to-swap.md b/guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/1-how-to-swap.md similarity index 100% rename from guides/2-spot/1-swap/2-tutorials/1-how-to-swap.md rename to guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/1-how-to-swap.md diff --git a/guides/2-spot/1-swap/2-tutorials/2-how-to-configure-settings.md b/guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/2-how-to-configure-settings.md similarity index 100% rename from guides/2-spot/1-swap/2-tutorials/2-how-to-configure-settings.md rename to guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/2-how-to-configure-settings.md diff --git a/guides/2-spot/1-swap/2-tutorials/3-how-to-trade-safely.md b/guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/3-how-to-trade-safely.md similarity index 97% rename from guides/2-spot/1-swap/2-tutorials/3-how-to-trade-safely.md rename to guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/3-how-to-trade-safely.md index f9242c6f..150cc552 100644 --- a/guides/2-spot/1-swap/2-tutorials/3-how-to-trade-safely.md +++ b/guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/3-how-to-trade-safely.md @@ -25,8 +25,6 @@ If your trade shows a large price impact and difference, please trade with cauti Jupiter shows relevant token information to reduce information asymmetry you may face when trading. Token Verification shows as "Verified ✅" or "Not Verified ⚠️" and Token2022 extensions appears as information pills. -More on Token Verification criteria [here](/guides/12-general/4-get-your-token-on-jupiter.md#how-to-get-your-token-verified). - More on Token2022 extensions below: | | **Definition** | **Valid Use** | **Misuse** | diff --git a/guides/2-spot/1-swap/2-tutorials/4-how-to-earn-referral-fees.md b/guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/4-how-to-earn-referral-fees.md similarity index 100% rename from guides/2-spot/1-swap/2-tutorials/4-how-to-earn-referral-fees.md rename to guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/4-how-to-earn-referral-fees.md diff --git a/guides/2-spot/1-swap/2-tutorials/_category_.json b/guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/_category_.json similarity index 100% rename from guides/2-spot/1-swap/2-tutorials/_category_.json rename to guides_versioned_docs/version-old/2-spot/1-swap/2-tutorials/_category_.json diff --git a/guides/2-spot/1-swap/3-how-swap-works.md b/guides_versioned_docs/version-old/2-spot/1-swap/3-how-swap-works.md similarity index 100% rename from guides/2-spot/1-swap/3-how-swap-works.md rename to guides_versioned_docs/version-old/2-spot/1-swap/3-how-swap-works.md diff --git a/guides/2-spot/1-swap/_category_.json b/guides_versioned_docs/version-old/2-spot/1-swap/_category_.json similarity index 100% rename from guides/2-spot/1-swap/_category_.json rename to guides_versioned_docs/version-old/2-spot/1-swap/_category_.json diff --git a/guides/2-spot/1-swap/img/Metis-2.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/Metis-2.png similarity index 100% rename from guides/2-spot/1-swap/img/Metis-2.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/Metis-2.png diff --git a/guides/2-spot/1-swap/img/Metis-3.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/Metis-3.png similarity index 100% rename from guides/2-spot/1-swap/img/Metis-3.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/Metis-3.png diff --git a/guides/2-spot/1-swap/img/Metis-4.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/Metis-4.jpg similarity index 100% rename from guides/2-spot/1-swap/img/Metis-4.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/Metis-4.jpg diff --git a/guides/2-spot/1-swap/img/exactout.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/exactout.png similarity index 100% rename from guides/2-spot/1-swap/img/exactout.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/exactout.png diff --git a/guides/2-spot/1-swap/img/mev-protect.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/mev-protect.png similarity index 100% rename from guides/2-spot/1-swap/img/mev-protect.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/mev-protect.png diff --git a/guides/2-spot/1-swap/img/referral.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral.png similarity index 100% rename from guides/2-spot/1-swap/img/referral.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral.png diff --git a/guides/2-spot/1-swap/img/referral1.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral1.jpg similarity index 100% rename from guides/2-spot/1-swap/img/referral1.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral1.jpg diff --git a/guides/2-spot/1-swap/img/referral3.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral3.jpg similarity index 100% rename from guides/2-spot/1-swap/img/referral3.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral3.jpg diff --git a/guides/2-spot/1-swap/img/referral4.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral4.jpg similarity index 100% rename from guides/2-spot/1-swap/img/referral4.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral4.jpg diff --git a/guides/2-spot/1-swap/img/referral5.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral5.jpg similarity index 100% rename from guides/2-spot/1-swap/img/referral5.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral5.jpg diff --git a/guides/2-spot/1-swap/img/referral6.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral6.jpg similarity index 100% rename from guides/2-spot/1-swap/img/referral6.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral6.jpg diff --git a/guides/2-spot/1-swap/img/referral7.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/referral7.jpg similarity index 100% rename from guides/2-spot/1-swap/img/referral7.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/referral7.jpg diff --git a/guides/2-spot/1-swap/img/routing-map.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/routing-map.png similarity index 100% rename from guides/2-spot/1-swap/img/routing-map.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/routing-map.png diff --git a/guides/2-spot/1-swap/img/routing.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/routing.png similarity index 100% rename from guides/2-spot/1-swap/img/routing.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/routing.png diff --git a/guides/2-spot/1-swap/img/spot-dca.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/spot-dca.png similarity index 100% rename from guides/2-spot/1-swap/img/spot-dca.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/spot-dca.png diff --git a/guides/2-spot/1-swap/img/spot-lo.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/spot-lo.png similarity index 100% rename from guides/2-spot/1-swap/img/spot-lo.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/spot-lo.png diff --git a/guides/2-spot/1-swap/img/spot-swap.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/spot-swap.png similarity index 100% rename from guides/2-spot/1-swap/img/spot-swap.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/spot-swap.png diff --git a/guides/2-spot/1-swap/img/spot-va.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/spot-va.png similarity index 100% rename from guides/2-spot/1-swap/img/spot-va.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/spot-va.png diff --git a/guides/2-spot/1-swap/img/step-3-4.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/step-3-4.png similarity index 100% rename from guides/2-spot/1-swap/img/step-3-4.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/step-3-4.png diff --git a/guides/2-spot/1-swap/img/step-4.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/step-4.png similarity index 100% rename from guides/2-spot/1-swap/img/step-4.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/step-4.png diff --git a/guides/2-spot/1-swap/img/step-5.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/step-5.png similarity index 100% rename from guides/2-spot/1-swap/img/step-5.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/step-5.png diff --git a/guides/2-spot/1-swap/img/step-6.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/step-6.png similarity index 100% rename from guides/2-spot/1-swap/img/step-6.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/step-6.png diff --git a/guides/2-spot/1-swap/img/swap-summary.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/swap-summary.png similarity index 100% rename from guides/2-spot/1-swap/img/swap-summary.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/swap-summary.png diff --git a/guides/2-spot/1-swap/img/swapdetails.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/swapdetails.png similarity index 100% rename from guides/2-spot/1-swap/img/swapdetails.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/swapdetails.png diff --git a/guides/2-spot/1-swap/img/token-info.jpg b/guides_versioned_docs/version-old/2-spot/1-swap/img/token-info.jpg similarity index 100% rename from guides/2-spot/1-swap/img/token-info.jpg rename to guides_versioned_docs/version-old/2-spot/1-swap/img/token-info.jpg diff --git a/guides/2-spot/1-swap/img/token-info.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/token-info.png similarity index 100% rename from guides/2-spot/1-swap/img/token-info.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/token-info.png diff --git a/guides/2-spot/1-swap/img/warnings.png b/guides_versioned_docs/version-old/2-spot/1-swap/img/warnings.png similarity index 100% rename from guides/2-spot/1-swap/img/warnings.png rename to guides_versioned_docs/version-old/2-spot/1-swap/img/warnings.png diff --git a/guides/2-spot/3-limit-order/1-limit-order.md b/guides_versioned_docs/version-old/2-spot/3-limit-order/1-limit-order.md similarity index 97% rename from guides/2-spot/3-limit-order/1-limit-order.md rename to guides_versioned_docs/version-old/2-spot/3-limit-order/1-limit-order.md index f0d60e5a..5428d6a4 100644 --- a/guides/2-spot/3-limit-order/1-limit-order.md +++ b/guides_versioned_docs/version-old/2-spot/3-limit-order/1-limit-order.md @@ -30,7 +30,7 @@ The Jupiter Limit Order feature has a minimum order size requirement of $5 (unde **Let's go through the Limit Order Settings in more detail below.** :::info -Global Settings still apply to the Limit Order Functionality, please reference [global settings](https://station.jup.ag/guides/jupiter-swap/swap#global-settings) for more information. +Global Settings still apply to the Limit Order Functionality, please reference [global settings](https://station.jup.ag/guides/old/jupiter-swap/swap#global-settings) for more information. ::: ## Jupiter Limit Order Settings diff --git a/guides/2-spot/3-limit-order/2-how-lo-work.md b/guides_versioned_docs/version-old/2-spot/3-limit-order/2-how-lo-work.md similarity index 100% rename from guides/2-spot/3-limit-order/2-how-lo-work.md rename to guides_versioned_docs/version-old/2-spot/3-limit-order/2-how-lo-work.md diff --git a/guides/2-spot/3-limit-order/3-lo-partners.md b/guides_versioned_docs/version-old/2-spot/3-limit-order/3-lo-partners.md similarity index 100% rename from guides/2-spot/3-limit-order/3-lo-partners.md rename to guides_versioned_docs/version-old/2-spot/3-limit-order/3-lo-partners.md diff --git a/guides/2-spot/3-limit-order/_category_.json b/guides_versioned_docs/version-old/2-spot/3-limit-order/_category_.json similarity index 100% rename from guides/2-spot/3-limit-order/_category_.json rename to guides_versioned_docs/version-old/2-spot/3-limit-order/_category_.json diff --git a/guides/2-spot/4-dca/1-how-to-dca.md b/guides_versioned_docs/version-old/2-spot/4-dca/1-how-to-dca.md similarity index 98% rename from guides/2-spot/4-dca/1-how-to-dca.md rename to guides_versioned_docs/version-old/2-spot/4-dca/1-how-to-dca.md index ce748010..922c48a8 100644 --- a/guides/2-spot/4-dca/1-how-to-dca.md +++ b/guides_versioned_docs/version-old/2-spot/4-dca/1-how-to-dca.md @@ -12,7 +12,7 @@ slug: /dca/how-to-dca Jupiter DCA is a dollar cost averaging solution designed to enable users to automate the purchase or sale of any SPL tokens at regular intervals over a specified period of time. -The DCA feature has some very powerful use cases, such as interacting with low liquidity markets, long term accumulation, or consistent profit taking without disrupting the market price too much. Check out this [Explainer Page](https://station.jup.ag/guides/dca/explainer) to learn more about DCA other use cases. +The DCA feature has some very powerful use cases, such as interacting with low liquidity markets, long term accumulation, or consistent profit taking without disrupting the market price too much. Check out this [Explainer Page](https://station.jup.ag/guides/old/dca/explainer) to learn more about DCA other use cases. ## Basic DCA User Flow diff --git a/guides/2-spot/4-dca/2-how-dca-work.md b/guides_versioned_docs/version-old/2-spot/4-dca/2-how-dca-work.md similarity index 96% rename from guides/2-spot/4-dca/2-how-dca-work.md rename to guides_versioned_docs/version-old/2-spot/4-dca/2-how-dca-work.md index f930590e..00c16431 100644 --- a/guides/2-spot/4-dca/2-how-dca-work.md +++ b/guides_versioned_docs/version-old/2-spot/4-dca/2-how-dca-work.md @@ -81,7 +81,7 @@ At the end of your DCA orders, you do not need to perform any additional actions By default, if your wallet’s ATA remains open, your purchase tokens are automatically transferred to you on every order (the program only allows your tokens to be sent to your wallet and no one else’s). -However, if there are still tokens yet to be transferred to you (ie. if you close your wallet’s token account for your purchase token halfway through the DCA cycle as described in [auto-withdrawal section](https://station.jup.ag/guides/dca/how-dca-work#automatic-transfer-of-purchased-tokens-on-every-order)), the DCA program will close the PDA in-token account and utilize the rent recovered to open your wallet's token account. +However, if there are still tokens yet to be transferred to you (ie. if you close your wallet’s token account for your purchase token halfway through the DCA cycle as described in [auto-withdrawal section](https://station.jup.ag/guides/old/dca/how-dca-work#automatic-transfer-of-purchased-tokens-on-every-order)), the DCA program will close the PDA in-token account and utilize the rent recovered to open your wallet's token account. This allows the program to transfer the remaining purchased tokens to you. As such, you would only receive 2/3 of the rent incurred to initialise your DCA account. Having said that, this 1/3 rent is not absorbed by any third-party. This rent will remain recoverable by you if you decide to close your ATA that “holds” your purchased token. diff --git a/guides/2-spot/4-dca/3-explainer.md b/guides_versioned_docs/version-old/2-spot/4-dca/3-explainer.md similarity index 100% rename from guides/2-spot/4-dca/3-explainer.md rename to guides_versioned_docs/version-old/2-spot/4-dca/3-explainer.md diff --git a/guides/2-spot/4-dca/_category_.json b/guides_versioned_docs/version-old/2-spot/4-dca/_category_.json similarity index 100% rename from guides/2-spot/4-dca/_category_.json rename to guides_versioned_docs/version-old/2-spot/4-dca/_category_.json diff --git a/guides/2-spot/5-va/1-how-to-va.md b/guides_versioned_docs/version-old/2-spot/5-va/1-how-to-va.md similarity index 100% rename from guides/2-spot/5-va/1-how-to-va.md rename to guides_versioned_docs/version-old/2-spot/5-va/1-how-to-va.md diff --git a/guides/2-spot/5-va/2-how-va-work.md b/guides_versioned_docs/version-old/2-spot/5-va/2-how-va-work.md similarity index 97% rename from guides/2-spot/5-va/2-how-va-work.md rename to guides_versioned_docs/version-old/2-spot/5-va/2-how-va-work.md index 244e14ec..3889afe5 100644 --- a/guides/2-spot/5-va/2-how-va-work.md +++ b/guides_versioned_docs/version-old/2-spot/5-va/2-how-va-work.md @@ -97,7 +97,7 @@ At the end of your VA orders, you do not need to perform any additional actions. By default, if your wallet’s ATA remains open, your purchase tokens are automatically transferred to you on every order (the program only allows your tokens to be sent to your wallet and no one else’s). -However, if there are still tokens yet to be transferred to you (ie. if you close your wallet’s token account for your purchase token halfway through the VA cycle as described in [auto-withdrawal section](https://station.jup.ag/guides/va/how-va-work#automatic-transfer-of-purchased-tokens-on-every-order)), the VA program will close the PDA in-token account and utilize the rent recovered to open your wallet's token account. +However, if there are still tokens yet to be transferred to you (ie. if you close your wallet’s token account for your purchase token halfway through the VA cycle as described in [auto-withdrawal section](https://station.jup.ag/guides/old/va/how-va-work#automatic-transfer-of-purchased-tokens-on-every-order)), the VA program will close the PDA in-token account and utilize the rent recovered to open your wallet's token account. This allows the program to transfer the remaining purchased tokens to you. As such, you would only receive 2/3 of the rent incurred to initialise your VA account. Having said that, this 1/3 rent is not absorbed by any third-party. This rent will remain recoverable by you if you decide to close your ATA that “holds” your purchased token. diff --git a/guides/2-spot/5-va/3-explainer.md b/guides_versioned_docs/version-old/2-spot/5-va/3-explainer.md similarity index 100% rename from guides/2-spot/5-va/3-explainer.md rename to guides_versioned_docs/version-old/2-spot/5-va/3-explainer.md diff --git a/guides/2-spot/5-va/_category_.json b/guides_versioned_docs/version-old/2-spot/5-va/_category_.json similarity index 100% rename from guides/2-spot/5-va/_category_.json rename to guides_versioned_docs/version-old/2-spot/5-va/_category_.json diff --git a/guides/2-spot/_category_.json b/guides_versioned_docs/version-old/2-spot/_category_.json similarity index 100% rename from guides/2-spot/_category_.json rename to guides_versioned_docs/version-old/2-spot/_category_.json diff --git a/guides/6-ape/1-overview.md b/guides_versioned_docs/version-old/6-ape/1-overview.md similarity index 100% rename from guides/6-ape/1-overview.md rename to guides_versioned_docs/version-old/6-ape/1-overview.md diff --git a/guides/6-ape/2-limit-order.md b/guides_versioned_docs/version-old/6-ape/2-limit-order.md similarity index 100% rename from guides/6-ape/2-limit-order.md rename to guides_versioned_docs/version-old/6-ape/2-limit-order.md diff --git a/guides/6-ape/3-referral-program.md b/guides_versioned_docs/version-old/6-ape/3-referral-program.md similarity index 100% rename from guides/6-ape/3-referral-program.md rename to guides_versioned_docs/version-old/6-ape/3-referral-program.md diff --git a/guides/6-ape/4-faq.md b/guides_versioned_docs/version-old/6-ape/4-faq.md similarity index 100% rename from guides/6-ape/4-faq.md rename to guides_versioned_docs/version-old/6-ape/4-faq.md diff --git a/guides/6-ape/_category_.json b/guides_versioned_docs/version-old/6-ape/_category_.json similarity index 100% rename from guides/6-ape/_category_.json rename to guides_versioned_docs/version-old/6-ape/_category_.json diff --git a/guides/7-jlp/1-JLP.md b/guides_versioned_docs/version-old/7-jlp/1-JLP.md similarity index 100% rename from guides/7-jlp/1-JLP.md rename to guides_versioned_docs/version-old/7-jlp/1-JLP.md diff --git a/guides/7-jlp/2-How-JLP-Works.md b/guides_versioned_docs/version-old/7-jlp/2-How-JLP-Works.md similarity index 100% rename from guides/7-jlp/2-How-JLP-Works.md rename to guides_versioned_docs/version-old/7-jlp/2-How-JLP-Works.md diff --git a/guides/7-jlp/3-How-To-Get-JLP.md b/guides_versioned_docs/version-old/7-jlp/3-How-To-Get-JLP.md similarity index 97% rename from guides/7-jlp/3-How-To-Get-JLP.md rename to guides_versioned_docs/version-old/7-jlp/3-How-To-Get-JLP.md index 675ba8b7..14fa6bed 100644 --- a/guides/7-jlp/3-How-To-Get-JLP.md +++ b/guides_versioned_docs/version-old/7-jlp/3-How-To-Get-JLP.md @@ -11,7 +11,7 @@ title: How To Get JLP ### Method 1: Jupiter Swap -For a detailed breakdown of swaps, check out [How to Swap](https://station.jup.ag/guides/jupiter-swap/swap). +For a detailed breakdown of swaps, check out [How to Swap](https://station.jup.ag/guides/old/jupiter-swap/swap). 1. Go to the [USDC-JLP](https://jup.ag/swap/USDC-JLP) pair on Jupiter Swap 2. Make sure your wallet is connected. There should be an icon on the top right showing your connection status. diff --git a/guides/7-jlp/4-JLP-Economics.md b/guides_versioned_docs/version-old/7-jlp/4-JLP-Economics.md similarity index 99% rename from guides/7-jlp/4-JLP-Economics.md rename to guides_versioned_docs/version-old/7-jlp/4-JLP-Economics.md index af1d09ba..b9a8cee3 100644 --- a/guides/7-jlp/4-JLP-Economics.md +++ b/guides_versioned_docs/version-old/7-jlp/4-JLP-Economics.md @@ -114,7 +114,7 @@ To get an estimate of the global unrealized PnL for longs, you can use the follo ``` // 1) Get the custody account you're interested in calculating unrealized PnL for longs -// https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#custody-account +// https://station.jup.ag/guides/old/perpetual-exchange/onchain-accounts#custody-account // 2) Get the `assets.guaranteedUsd` field which stores the value of `position.sizeUsd - position.collateralUsd` for // all open long positions for the custody. Note that a position's `sizeUsd` value is only updated when a trade is made, which diff --git a/guides/7-jlp/_category_.json b/guides_versioned_docs/version-old/7-jlp/_category_.json similarity index 100% rename from guides/7-jlp/_category_.json rename to guides_versioned_docs/version-old/7-jlp/_category_.json diff --git a/guides/7-jlp/jlp-long-scenarios.png b/guides_versioned_docs/version-old/7-jlp/jlp-long-scenarios.png similarity index 100% rename from guides/7-jlp/jlp-long-scenarios.png rename to guides_versioned_docs/version-old/7-jlp/jlp-long-scenarios.png diff --git a/guides/7-jlp/jlp-short-scenarios.png b/guides_versioned_docs/version-old/7-jlp/jlp-short-scenarios.png similarity index 100% rename from guides/7-jlp/jlp-short-scenarios.png rename to guides_versioned_docs/version-old/7-jlp/jlp-short-scenarios.png diff --git a/guides/7-jlp/jlp-weightage.png b/guides_versioned_docs/version-old/7-jlp/jlp-weightage.png similarity index 100% rename from guides/7-jlp/jlp-weightage.png rename to guides_versioned_docs/version-old/7-jlp/jlp-weightage.png diff --git a/guides/7-jlp/weightage-rebalancing.jpg b/guides_versioned_docs/version-old/7-jlp/weightage-rebalancing.jpg similarity index 100% rename from guides/7-jlp/weightage-rebalancing.jpg rename to guides_versioned_docs/version-old/7-jlp/weightage-rebalancing.jpg diff --git a/guides/8-perpetual-exchange/1-overview.md b/guides_versioned_docs/version-old/8-perpetual-exchange/1-overview.md similarity index 98% rename from guides/8-perpetual-exchange/1-overview.md rename to guides_versioned_docs/version-old/8-perpetual-exchange/1-overview.md index 15ed1f3b..8dd94b2c 100644 --- a/guides/8-perpetual-exchange/1-overview.md +++ b/guides_versioned_docs/version-old/8-perpetual-exchange/1-overview.md @@ -31,7 +31,7 @@ You can find various metrics on Jupiter Perpetuals on the following dashboards: ![Perp1](../img/perps/perps-1.png) 1. **Perpetual Trading Tab:** This is where all the trading action happens. You can trade long or short on the three main blue-chip markets we offer: SOL, ETH, and WBTC, with leverage of up to 100x. -2. **Earn Tab:** This is where passive users can participate. Users can join the liquidity pool and earn passive fees generated from trading activities. (For information on the earn tab and the liquidity used by perpetuals, head over to [JLP](/guides/jlp/jlp)). +2. **Earn Tab:** This is where passive users can participate. Users can join the liquidity pool and earn passive fees generated from trading activities. (For information on the earn tab and the liquidity used by perpertuals, head over to [JLP](/guides/old/jlp/jlp)). 3. **Perp Market Selector:** Currently, we only support the three main blue-chip markets: SOL, ETH, and BTC. 4. **Price Stats:** Here, you can find a quick overview of the current real-time stats, including the current index price, 24-hour price movement, 24-hour highs, and 24-hour lows. 5. **Long/Short Selector:** Choose whether you want to go 'Long' or 'Short' on the respective market. diff --git a/guides/8-perpetual-exchange/2-how-it-works.md b/guides_versioned_docs/version-old/8-perpetual-exchange/2-how-it-works.md similarity index 98% rename from guides/8-perpetual-exchange/2-how-it-works.md rename to guides_versioned_docs/version-old/8-perpetual-exchange/2-how-it-works.md index b2841631..87e2b0b3 100644 --- a/guides/8-perpetual-exchange/2-how-it-works.md +++ b/guides_versioned_docs/version-old/8-perpetual-exchange/2-how-it-works.md @@ -219,7 +219,7 @@ BPS_POWER = 10^4 // 10_000 // 1. Get the base fee (BPS) from the JLP pool account's `fees.increasePositionBps` for open position requests // or `fees.decreasePositionBps` for close position requests -// https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#pool-account +// https://station.jup.ag/guides/old/perpetual-exchange/onchain-accounts#pool-account baseFeeBps = pool.fees.increasePositionBps // 2. Convert `baseFeeBps` to decimals @@ -266,7 +266,7 @@ BPS_POWER = 10^4 // 10_000 Calculate Price Impact Fee: // 1. Get the trade impact fee scalar from the custody account's `pricing.tradeImpactFeeScalar` constant -// https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#custody-account +// https://station.jup.ag/guides/old/perpetual-exchange/onchain-accounts#custody-account tradeImpactFeeScalar = custody.pricing.tradeImpactFeeScalar // 2. Convert trade size to USDC decimal format @@ -352,7 +352,7 @@ The borrow rate is calculated above is expressed as the annual rate (APR). To ge #### Calculating Utilization Rate -To determine the current utilization rate, access the asset's on-chain account ([as shown here](https://station.jup.ag/guides/perpetual-exchange/onchain-accounts)) and apply the following calculation: +To determine the current utilization rate, access the asset's on-chain account ([as shown here](https://station.jup.ag/guides/old/perpetual-exchange/onchain-accounts)) and apply the following calculation: ``` // Calculate utilization percentage @@ -413,7 +413,7 @@ It's crucial to regularly monitor your borrow fees and liquidation price. Failur Due to Solana's blockchain architecture, calculating funding fees in real-time for each position would be computationally expensive and impractical. Instead, the Jupiter Perpetuals contract uses a counter-based system to calculate borrow fees for open positions. -The [pool](https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#pool-account) and [position](https://station.jup.ag/guides/perpetual-exchange/onchain-accounts#position-account) accounts maintain two key fields: +The [pool](https://station.jup.ag/guides/old/perpetual-exchange/onchain-accounts#pool-account) and [position](https://station.jup.ag/guides/old/perpetual-exchange/onchain-accounts#position-account) accounts maintain two key fields: * The pool account maintains a global cumulative counter through its `fundingRateState.cumulativeInterestRate` field, which accumulates interest rates over time * Each position account tracks its own `cumulativeInterestSnapshot` field, which captures the global counter's value whenever a trade is made: when the position is opened, when its size is increased, when collateral is deposited or withdrawn, or when the position is closed diff --git a/guides/8-perpetual-exchange/3-onchain-accounts.md b/guides_versioned_docs/version-old/8-perpetual-exchange/3-onchain-accounts.md similarity index 98% rename from guides/8-perpetual-exchange/3-onchain-accounts.md rename to guides_versioned_docs/version-old/8-perpetual-exchange/3-onchain-accounts.md index 5c826a1b..ad739ba4 100644 --- a/guides/8-perpetual-exchange/3-onchain-accounts.md +++ b/guides_versioned_docs/version-old/8-perpetual-exchange/3-onchain-accounts.md @@ -169,7 +169,7 @@ Each `Custody` account contains the following data: * `is_stable`: Sets whether the custody is a stablecoin. * `oracle`: Contains data for the price oracle used for the custody. * `pricing`: Contains data for the custody's price-related logic. - * `trade_impact_fee_scalar`: Sets the base value when calculating price impact fees when opening or closing positions. For more info on the price impact fee, read more [here](guides/8-perpetual-exchange/2-how-it-works.md#fees). + * `trade_impact_fee_scalar`: Sets the base value when calculating price impact fees when opening or closing positions. * `max_leverage`: Sets the max leverage for this custody's positions. The max leverage for all custodies is `500x` at the time of writing. * `max_global_long_sizes`: The maximum total position size (USD) for long positions. * `max_global_short_sizes`: The maximum total position size (USD) for short positions. @@ -186,7 +186,7 @@ Each `Custody` account contains the following data: * `cumulative_interest_rate`: 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. To calculate borrow fees more efficiently, each custody account contains a value called `cumulative_interest_rate`. Correspondingly, each position account stores a `cumulative_interest_snapshot`. This snapshot captures the value of `cumulative_interest_rate` 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 `cumulative_interest_rate` for the custody is updated. The difference between the custody's `cumulative_interest_rate` and the position's `cumulative_interest_snapshot` is then used to calculate the position's borrow fees. * `last_updated`: The UNIX timestamp for when the custody's borrow fee data was last updated. * `hourly_funding_dbps`: **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 `hourly_funding_dbps` to respond to traders' feedback and market conditions. -* `jump_rate_state`: Contains data used to calculate the [dual slope borrow rate model](guides/8-perpetual-exchange/2-how-it-works.md#borrow-fee). +* `jump_rate_state`: Contains data used to calculate the dual slope borrow rate model. * `min_rate_bps`: The lowest borrow rate, applied at 0% utilization. * `max_rate_bps`: The highest borrow rate, applied at 100% utilization. * `target_rate_bps`: The borrow rate when utilization reaches its target level. diff --git a/guides/8-perpetual-exchange/4-request-fulfillment-model.md b/guides_versioned_docs/version-old/8-perpetual-exchange/4-request-fulfillment-model.md similarity index 100% rename from guides/8-perpetual-exchange/4-request-fulfillment-model.md rename to guides_versioned_docs/version-old/8-perpetual-exchange/4-request-fulfillment-model.md diff --git a/guides/8-perpetual-exchange/5-faq.md b/guides_versioned_docs/version-old/8-perpetual-exchange/5-faq.md similarity index 96% rename from guides/8-perpetual-exchange/5-faq.md rename to guides_versioned_docs/version-old/8-perpetual-exchange/5-faq.md index e1760886..9d5e5754 100644 --- a/guides/8-perpetual-exchange/5-faq.md +++ b/guides_versioned_docs/version-old/8-perpetual-exchange/5-faq.md @@ -81,7 +81,7 @@ Take note that this only applies for the Trading View Chart on Jupiter Perpetual There is an hourly borrow fee on every position, the hourly borrow fee will change the liquidation price over time. -If you want to understand how the hourly borrow rate works, you can check it out [here](https://station.jup.ag/guides/perpetual-exchange/how-it-works#hourly-borrow-rate). +If you want to understand how the hourly borrow rate works, you can check it out [here](https://station.jup.ag/guides/old/perpetual-exchange/how-it-works#hourly-borrow-rate). ### 5. I deposited 1 SOL (where 1 SOL = $100) for a 5x leveraged SOL-Long position and profited $50 (where 1 SOL = $110). Why did I get less than the full amount? @@ -134,7 +134,7 @@ The underlying collateral for long positions are the tokens themselves (SOL, wBT This is to protect the pool from scenarios that might put the pool at risk, for example a series of ongoing profitable trades that deplete the pool's reserves. -For more information on this, consult the [JLP pool documentation](https://station.jup.ag/guides/jlp/How-JLP-Works#risks-associated-with-holding-jlp) which describes the dynamics between traders and the liquidity pool for long and short scenarios. +For more information on this, consult the [JLP pool documentation](https://station.jup.ag/guides/old/jlp/How-JLP-Works#risks-associated-with-holding-jlp) which describes the dynamics between traders and the liquidity pool for long and short scenarios. ### 9. How are token prices determined? diff --git a/guides/8-perpetual-exchange/_category_.json b/guides_versioned_docs/version-old/8-perpetual-exchange/_category_.json similarity index 100% rename from guides/8-perpetual-exchange/_category_.json rename to guides_versioned_docs/version-old/8-perpetual-exchange/_category_.json diff --git a/guides/8-perpetual-exchange/dual-slope-borrow-rate.png b/guides_versioned_docs/version-old/8-perpetual-exchange/dual-slope-borrow-rate.png similarity index 100% rename from guides/8-perpetual-exchange/dual-slope-borrow-rate.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/dual-slope-borrow-rate.png diff --git a/guides/8-perpetual-exchange/faq1.png b/guides_versioned_docs/version-old/8-perpetual-exchange/faq1.png similarity index 100% rename from guides/8-perpetual-exchange/faq1.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/faq1.png diff --git a/guides/8-perpetual-exchange/hourly-borrow-fee.png b/guides_versioned_docs/version-old/8-perpetual-exchange/hourly-borrow-fee.png similarity index 100% rename from guides/8-perpetual-exchange/hourly-borrow-fee.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/hourly-borrow-fee.png diff --git a/guides/8-perpetual-exchange/image-2.png b/guides_versioned_docs/version-old/8-perpetual-exchange/image-2.png similarity index 100% rename from guides/8-perpetual-exchange/image-2.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/image-2.png diff --git a/guides/8-perpetual-exchange/jlp-long-scenarios.png b/guides_versioned_docs/version-old/8-perpetual-exchange/jlp-long-scenarios.png similarity index 100% rename from guides/8-perpetual-exchange/jlp-long-scenarios.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/jlp-long-scenarios.png diff --git a/guides/8-perpetual-exchange/long-formula.png b/guides_versioned_docs/version-old/8-perpetual-exchange/long-formula.png similarity index 100% rename from guides/8-perpetual-exchange/long-formula.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/long-formula.png diff --git a/guides/8-perpetual-exchange/our-oracle.png b/guides_versioned_docs/version-old/8-perpetual-exchange/our-oracle.png similarity index 100% rename from guides/8-perpetual-exchange/our-oracle.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/our-oracle.png diff --git a/guides/8-perpetual-exchange/price-impact-fee-graph.png b/guides_versioned_docs/version-old/8-perpetual-exchange/price-impact-fee-graph.png similarity index 100% rename from guides/8-perpetual-exchange/price-impact-fee-graph.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/price-impact-fee-graph.png diff --git a/guides/8-perpetual-exchange/request-fulfillment-model.png b/guides_versioned_docs/version-old/8-perpetual-exchange/request-fulfillment-model.png similarity index 100% rename from guides/8-perpetual-exchange/request-fulfillment-model.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/request-fulfillment-model.png diff --git a/guides/8-perpetual-exchange/returned1.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned1.png similarity index 100% rename from guides/8-perpetual-exchange/returned1.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned1.png diff --git a/guides/8-perpetual-exchange/returned2-1.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned2-1.png similarity index 100% rename from guides/8-perpetual-exchange/returned2-1.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned2-1.png diff --git a/guides/8-perpetual-exchange/returned2-2.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned2-2.png similarity index 100% rename from guides/8-perpetual-exchange/returned2-2.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned2-2.png diff --git a/guides/8-perpetual-exchange/returned2-3.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned2-3.png similarity index 100% rename from guides/8-perpetual-exchange/returned2-3.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned2-3.png diff --git a/guides/8-perpetual-exchange/returned2.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned2.png similarity index 100% rename from guides/8-perpetual-exchange/returned2.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned2.png diff --git a/guides/8-perpetual-exchange/returned3.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned3.png similarity index 100% rename from guides/8-perpetual-exchange/returned3.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned3.png diff --git a/guides/8-perpetual-exchange/returned4.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned4.png similarity index 100% rename from guides/8-perpetual-exchange/returned4.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned4.png diff --git a/guides/8-perpetual-exchange/returned5.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned5.png similarity index 100% rename from guides/8-perpetual-exchange/returned5.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned5.png diff --git a/guides/8-perpetual-exchange/returned6.png b/guides_versioned_docs/version-old/8-perpetual-exchange/returned6.png similarity index 100% rename from guides/8-perpetual-exchange/returned6.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/returned6.png diff --git a/guides/8-perpetual-exchange/short-formula.png b/guides_versioned_docs/version-old/8-perpetual-exchange/short-formula.png similarity index 100% rename from guides/8-perpetual-exchange/short-formula.png rename to guides_versioned_docs/version-old/8-perpetual-exchange/short-formula.png diff --git a/guides/9-jupsol/1-jupsol.md b/guides_versioned_docs/version-old/9-jupsol/1-jupsol.md similarity index 95% rename from guides/9-jupsol/1-jupsol.md rename to guides_versioned_docs/version-old/9-jupsol/1-jupsol.md index de675c4b..9c7f4279 100644 --- a/guides/9-jupsol/1-jupsol.md +++ b/guides_versioned_docs/version-old/9-jupsol/1-jupsol.md @@ -59,7 +59,7 @@ When you hold JupSOL, you also help Jupiter improve its transaction inclusion ra ### What is a Liquid Staking Token? -Liquid staking lets you participate in DeFi while earning staking yields. Liquid staking solves the [Staking Dilemma](https://learn.sanctum.so/guides/more-about-sanctum/sanctums-value-proposition) by giving you the best of both worlds – it lets you secure the network and use your SOL at the same time. +Liquid staking lets you participate in DeFi while earning staking yields. Liquid staking solves the [Staking Dilemma](https://learn.sanctum.so/guides/old/more-about-sanctum/sanctums-value-proposition) by giving you the best of both worlds – it lets you secure the network and use your SOL at the same time. You can think of staking as putting gold in a vault, and liquid staking as issuing a piece of paper money (an IOU, "I owe you") for the gold in that vault. In the same way that a paper IOU can be redeemed at any time for the gold, a liquid staking token (LST) can be redeemed at any time for unstaked SOL. Unlike natively-staked SOL, this liquid staking token is transferable. It can be used in all of DeFi – borrow-lend, perps, stablecoin issuance, etc. diff --git a/guides/9-jupsol/_category_.json b/guides_versioned_docs/version-old/9-jupsol/_category_.json similarity index 100% rename from guides/9-jupsol/_category_.json rename to guides_versioned_docs/version-old/9-jupsol/_category_.json diff --git a/guides/img/30MM_cat.jpeg b/guides_versioned_docs/version-old/img/30MM_cat.jpeg similarity index 100% rename from guides/img/30MM_cat.jpeg rename to guides_versioned_docs/version-old/img/30MM_cat.jpeg diff --git a/guides/img/CexToSolana.png b/guides_versioned_docs/version-old/img/CexToSolana.png similarity index 100% rename from guides/img/CexToSolana.png rename to guides_versioned_docs/version-old/img/CexToSolana.png diff --git a/guides/img/SolanaFM_banner.png b/guides_versioned_docs/version-old/img/SolanaFM_banner.png similarity index 100% rename from guides/img/SolanaFM_banner.png rename to guides_versioned_docs/version-old/img/SolanaFM_banner.png diff --git a/guides/img/ape-lo-1.png b/guides_versioned_docs/version-old/img/ape-lo-1.png similarity index 100% rename from guides/img/ape-lo-1.png rename to guides_versioned_docs/version-old/img/ape-lo-1.png diff --git a/guides/img/bridge/bridge-1.png b/guides_versioned_docs/version-old/img/bridge/bridge-1.png similarity index 100% rename from guides/img/bridge/bridge-1.png rename to guides_versioned_docs/version-old/img/bridge/bridge-1.png diff --git a/guides/img/bridge/bridge-2.png b/guides_versioned_docs/version-old/img/bridge/bridge-2.png similarity index 100% rename from guides/img/bridge/bridge-2.png rename to guides_versioned_docs/version-old/img/bridge/bridge-2.png diff --git a/guides/img/bridge/bridge-3.png b/guides_versioned_docs/version-old/img/bridge/bridge-3.png similarity index 100% rename from guides/img/bridge/bridge-3.png rename to guides_versioned_docs/version-old/img/bridge/bridge-3.png diff --git a/guides/img/bridge/bridge-4.png b/guides_versioned_docs/version-old/img/bridge/bridge-4.png similarity index 100% rename from guides/img/bridge/bridge-4.png rename to guides_versioned_docs/version-old/img/bridge/bridge-4.png diff --git a/guides/img/bridge/bridge-5.png b/guides_versioned_docs/version-old/img/bridge/bridge-5.png similarity index 100% rename from guides/img/bridge/bridge-5.png rename to guides_versioned_docs/version-old/img/bridge/bridge-5.png diff --git a/guides/img/bridge/bridge-6.png b/guides_versioned_docs/version-old/img/bridge/bridge-6.png similarity index 100% rename from guides/img/bridge/bridge-6.png rename to guides_versioned_docs/version-old/img/bridge/bridge-6.png diff --git a/guides/img/cat_banner.png b/guides_versioned_docs/version-old/img/cat_banner.png similarity index 100% rename from guides/img/cat_banner.png rename to guides_versioned_docs/version-old/img/cat_banner.png diff --git a/guides/img/cat_coins_banner.png b/guides_versioned_docs/version-old/img/cat_coins_banner.png similarity index 100% rename from guides/img/cat_coins_banner.png rename to guides_versioned_docs/version-old/img/cat_coins_banner.png diff --git a/guides/img/cat_in_space.webp b/guides_versioned_docs/version-old/img/cat_in_space.webp similarity index 100% rename from guides/img/cat_in_space.webp rename to guides_versioned_docs/version-old/img/cat_in_space.webp diff --git a/guides/img/changelog.png b/guides_versioned_docs/version-old/img/changelog.png similarity index 100% rename from guides/img/changelog.png rename to guides_versioned_docs/version-old/img/changelog.png diff --git a/guides/img/dca/DCA(1).png b/guides_versioned_docs/version-old/img/dca/DCA(1).png similarity index 100% rename from guides/img/dca/DCA(1).png rename to guides_versioned_docs/version-old/img/dca/DCA(1).png diff --git a/guides/img/dca/btc-2018-bear-market-accumulation.png b/guides_versioned_docs/version-old/img/dca/btc-2018-bear-market-accumulation.png similarity index 100% rename from guides/img/dca/btc-2018-bear-market-accumulation.png rename to guides_versioned_docs/version-old/img/dca/btc-2018-bear-market-accumulation.png diff --git a/guides/img/dca/dca-1.png b/guides_versioned_docs/version-old/img/dca/dca-1.png similarity index 100% rename from guides/img/dca/dca-1.png rename to guides_versioned_docs/version-old/img/dca/dca-1.png diff --git a/guides/img/dca/dca-2.png b/guides_versioned_docs/version-old/img/dca/dca-2.png similarity index 100% rename from guides/img/dca/dca-2.png rename to guides_versioned_docs/version-old/img/dca/dca-2.png diff --git a/guides/img/dca/dca-3.png b/guides_versioned_docs/version-old/img/dca/dca-3.png similarity index 100% rename from guides/img/dca/dca-3.png rename to guides_versioned_docs/version-old/img/dca/dca-3.png diff --git a/guides/img/dca/dca-4.png b/guides_versioned_docs/version-old/img/dca/dca-4.png similarity index 100% rename from guides/img/dca/dca-4.png rename to guides_versioned_docs/version-old/img/dca/dca-4.png diff --git a/guides/img/dca/dca-5.png b/guides_versioned_docs/version-old/img/dca/dca-5.png similarity index 100% rename from guides/img/dca/dca-5.png rename to guides_versioned_docs/version-old/img/dca/dca-5.png diff --git a/guides/img/deleveraging.png b/guides_versioned_docs/version-old/img/deleveraging.png similarity index 100% rename from guides/img/deleveraging.png rename to guides_versioned_docs/version-old/img/deleveraging.png diff --git a/guides/img/dexlab-limitorder.jpg b/guides_versioned_docs/version-old/img/dexlab-limitorder.jpg similarity index 100% rename from guides/img/dexlab-limitorder.jpg rename to guides_versioned_docs/version-old/img/dexlab-limitorder.jpg diff --git a/guides/img/dexlab-mint1.jpg b/guides_versioned_docs/version-old/img/dexlab-mint1.jpg similarity index 100% rename from guides/img/dexlab-mint1.jpg rename to guides_versioned_docs/version-old/img/dexlab-mint1.jpg diff --git a/guides/img/dexlab-mint2.jpg b/guides_versioned_docs/version-old/img/dexlab-mint2.jpg similarity index 100% rename from guides/img/dexlab-mint2.jpg rename to guides_versioned_docs/version-old/img/dexlab-mint2.jpg diff --git a/guides/img/edge-banner.png b/guides_versioned_docs/version-old/img/edge-banner.png similarity index 100% rename from guides/img/edge-banner.png rename to guides_versioned_docs/version-old/img/edge-banner.png diff --git a/guides/img/edge-discord.png b/guides_versioned_docs/version-old/img/edge-discord.png similarity index 100% rename from guides/img/edge-discord.png rename to guides_versioned_docs/version-old/img/edge-discord.png diff --git a/guides/img/fff.jpg b/guides_versioned_docs/version-old/img/fff.jpg similarity index 100% rename from guides/img/fff.jpg rename to guides_versioned_docs/version-old/img/fff.jpg diff --git a/guides/img/full-routing-banner.png b/guides_versioned_docs/version-old/img/full-routing-banner.png similarity index 100% rename from guides/img/full-routing-banner.png rename to guides_versioned_docs/version-old/img/full-routing-banner.png diff --git a/guides/img/jlp-v2.png b/guides_versioned_docs/version-old/img/jlp-v2.png similarity index 100% rename from guides/img/jlp-v2.png rename to guides_versioned_docs/version-old/img/jlp-v2.png diff --git a/guides/img/jlp/jlp-1.png b/guides_versioned_docs/version-old/img/jlp/jlp-1.png similarity index 100% rename from guides/img/jlp/jlp-1.png rename to guides_versioned_docs/version-old/img/jlp/jlp-1.png diff --git a/guides/img/jlp/jlp-TVL.png b/guides_versioned_docs/version-old/img/jlp/jlp-TVL.png similarity index 100% rename from guides/img/jlp/jlp-TVL.png rename to guides_versioned_docs/version-old/img/jlp/jlp-TVL.png diff --git a/guides/img/jlp1.jpg b/guides_versioned_docs/version-old/img/jlp1.jpg similarity index 100% rename from guides/img/jlp1.jpg rename to guides_versioned_docs/version-old/img/jlp1.jpg diff --git a/guides/img/jlp2.jpg b/guides_versioned_docs/version-old/img/jlp2.jpg similarity index 100% rename from guides/img/jlp2.jpg rename to guides_versioned_docs/version-old/img/jlp2.jpg diff --git a/guides/img/jup-swap/Metis2.png b/guides_versioned_docs/version-old/img/jup-swap/Metis2.png similarity index 100% rename from guides/img/jup-swap/Metis2.png rename to guides_versioned_docs/version-old/img/jup-swap/Metis2.png diff --git a/guides/img/jup-swap/Metis3.png b/guides_versioned_docs/version-old/img/jup-swap/Metis3.png similarity index 100% rename from guides/img/jup-swap/Metis3.png rename to guides_versioned_docs/version-old/img/jup-swap/Metis3.png diff --git a/guides/img/jup-swap/Metis4.jpg b/guides_versioned_docs/version-old/img/jup-swap/Metis4.jpg similarity index 100% rename from guides/img/jup-swap/Metis4.jpg rename to guides_versioned_docs/version-old/img/jup-swap/Metis4.jpg diff --git a/guides/img/jup-swap/Metropolis-1.jpeg b/guides_versioned_docs/version-old/img/jup-swap/Metropolis-1.jpeg similarity index 100% rename from guides/img/jup-swap/Metropolis-1.jpeg rename to guides_versioned_docs/version-old/img/jup-swap/Metropolis-1.jpeg diff --git a/guides/img/jup-swap/authority-warning.png b/guides_versioned_docs/version-old/img/jup-swap/authority-warning.png similarity index 100% rename from guides/img/jup-swap/authority-warning.png rename to guides_versioned_docs/version-old/img/jup-swap/authority-warning.png diff --git a/guides/img/jup-swap/jup-swap-1.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-1.png similarity index 100% rename from guides/img/jup-swap/jup-swap-1.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-1.png diff --git a/guides/img/jup-swap/jup-swap-2.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-2.png similarity index 100% rename from guides/img/jup-swap/jup-swap-2.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-2.png diff --git a/guides/img/jup-swap/jup-swap-3.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-3.png similarity index 100% rename from guides/img/jup-swap/jup-swap-3.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-3.png diff --git a/guides/img/jup-swap/jup-swap-4.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-4.png similarity index 100% rename from guides/img/jup-swap/jup-swap-4.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-4.png diff --git a/guides/img/jup-swap/jup-swap-5.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-5.png similarity index 100% rename from guides/img/jup-swap/jup-swap-5.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-5.png diff --git a/guides/img/jup-swap/jup-swap-6.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-6.png similarity index 100% rename from guides/img/jup-swap/jup-swap-6.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-6.png diff --git a/guides/img/jup-swap/jup-swap-7.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-7.png similarity index 100% rename from guides/img/jup-swap/jup-swap-7.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-7.png diff --git a/guides/img/jup-swap/jup-swap-8.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-8.png similarity index 100% rename from guides/img/jup-swap/jup-swap-8.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-8.png diff --git a/guides/img/jup-swap/jup-swap-old.png b/guides_versioned_docs/version-old/img/jup-swap/jup-swap-old.png similarity index 100% rename from guides/img/jup-swap/jup-swap-old.png rename to guides_versioned_docs/version-old/img/jup-swap/jup-swap-old.png diff --git a/guides/img/jupiter-spot.png b/guides_versioned_docs/version-old/img/jupiter-spot.png similarity index 100% rename from guides/img/jupiter-spot.png rename to guides_versioned_docs/version-old/img/jupiter-spot.png diff --git a/guides/img/jupsol/jupSOL-1.png b/guides_versioned_docs/version-old/img/jupsol/jupSOL-1.png similarity index 100% rename from guides/img/jupsol/jupSOL-1.png rename to guides_versioned_docs/version-old/img/jupsol/jupSOL-1.png diff --git a/guides/img/limit-order/birdeye.png b/guides_versioned_docs/version-old/img/limit-order/birdeye.png similarity index 100% rename from guides/img/limit-order/birdeye.png rename to guides_versioned_docs/version-old/img/limit-order/birdeye.png diff --git a/guides/img/limit-order/limit-order-1.png b/guides_versioned_docs/version-old/img/limit-order/limit-order-1.png similarity index 100% rename from guides/img/limit-order/limit-order-1.png rename to guides_versioned_docs/version-old/img/limit-order/limit-order-1.png diff --git a/guides/img/limit-order/limit-order-2.png b/guides_versioned_docs/version-old/img/limit-order/limit-order-2.png similarity index 100% rename from guides/img/limit-order/limit-order-2.png rename to guides_versioned_docs/version-old/img/limit-order/limit-order-2.png diff --git a/guides/img/limit-order/limit-order-3.png b/guides_versioned_docs/version-old/img/limit-order/limit-order-3.png similarity index 100% rename from guides/img/limit-order/limit-order-3.png rename to guides_versioned_docs/version-old/img/limit-order/limit-order-3.png diff --git a/guides/img/limit-order/limit-order3.png b/guides_versioned_docs/version-old/img/limit-order/limit-order3.png similarity index 100% rename from guides/img/limit-order/limit-order3.png rename to guides_versioned_docs/version-old/img/limit-order/limit-order3.png diff --git a/guides/img/limit-order/limit-order4.png b/guides_versioned_docs/version-old/img/limit-order/limit-order4.png similarity index 100% rename from guides/img/limit-order/limit-order4.png rename to guides_versioned_docs/version-old/img/limit-order/limit-order4.png diff --git a/guides/img/lst-overview.png b/guides_versioned_docs/version-old/img/lst-overview.png similarity index 100% rename from guides/img/lst-overview.png rename to guides_versioned_docs/version-old/img/lst-overview.png diff --git a/guides/img/marginfi.jpg b/guides_versioned_docs/version-old/img/marginfi.jpg similarity index 100% rename from guides/img/marginfi.jpg rename to guides_versioned_docs/version-old/img/marginfi.jpg diff --git a/guides/img/meteora1.jpg b/guides_versioned_docs/version-old/img/meteora1.jpg similarity index 100% rename from guides/img/meteora1.jpg rename to guides_versioned_docs/version-old/img/meteora1.jpg diff --git a/guides/img/mev-new.png b/guides_versioned_docs/version-old/img/mev-new.png similarity index 100% rename from guides/img/mev-new.png rename to guides_versioned_docs/version-old/img/mev-new.png diff --git a/guides/img/minting.png b/guides_versioned_docs/version-old/img/minting.png similarity index 100% rename from guides/img/minting.png rename to guides_versioned_docs/version-old/img/minting.png diff --git a/guides/img/money_cat.png b/guides_versioned_docs/version-old/img/money_cat.png similarity index 100% rename from guides/img/money_cat.png rename to guides_versioned_docs/version-old/img/money_cat.png diff --git a/guides/img/orca1.jpg b/guides_versioned_docs/version-old/img/orca1.jpg similarity index 100% rename from guides/img/orca1.jpg rename to guides_versioned_docs/version-old/img/orca1.jpg diff --git a/guides/img/perps/perps-1.png b/guides_versioned_docs/version-old/img/perps/perps-1.png similarity index 100% rename from guides/img/perps/perps-1.png rename to guides_versioned_docs/version-old/img/perps/perps-1.png diff --git a/guides/img/perps/perps-2.png b/guides_versioned_docs/version-old/img/perps/perps-2.png similarity index 100% rename from guides/img/perps/perps-2.png rename to guides_versioned_docs/version-old/img/perps/perps-2.png diff --git a/guides/img/perps/perps-3.png b/guides_versioned_docs/version-old/img/perps/perps-3.png similarity index 100% rename from guides/img/perps/perps-3.png rename to guides_versioned_docs/version-old/img/perps/perps-3.png diff --git a/guides/img/perps/perps-4.png b/guides_versioned_docs/version-old/img/perps/perps-4.png similarity index 100% rename from guides/img/perps/perps-4.png rename to guides_versioned_docs/version-old/img/perps/perps-4.png diff --git a/guides/img/perps1.jpg b/guides_versioned_docs/version-old/img/perps1.jpg similarity index 100% rename from guides/img/perps1.jpg rename to guides_versioned_docs/version-old/img/perps1.jpg diff --git a/guides/img/perps2.jpg b/guides_versioned_docs/version-old/img/perps2.jpg similarity index 100% rename from guides/img/perps2.jpg rename to guides_versioned_docs/version-old/img/perps2.jpg diff --git a/guides/img/perps3.jpg b/guides_versioned_docs/version-old/img/perps3.jpg similarity index 100% rename from guides/img/perps3.jpg rename to guides_versioned_docs/version-old/img/perps3.jpg diff --git a/guides/img/perps4.jpg b/guides_versioned_docs/version-old/img/perps4.jpg similarity index 100% rename from guides/img/perps4.jpg rename to guides_versioned_docs/version-old/img/perps4.jpg diff --git a/guides/img/personal-security/example_of_transaction_simulation_correct.png b/guides_versioned_docs/version-old/img/personal-security/example_of_transaction_simulation_correct.png similarity index 100% rename from guides/img/personal-security/example_of_transaction_simulation_correct.png rename to guides_versioned_docs/version-old/img/personal-security/example_of_transaction_simulation_correct.png diff --git a/guides/img/price-impact-criteria.jpg b/guides_versioned_docs/version-old/img/price-impact-criteria.jpg similarity index 100% rename from guides/img/price-impact-criteria.jpg rename to guides_versioned_docs/version-old/img/price-impact-criteria.jpg diff --git a/guides/img/price-impact.png b/guides_versioned_docs/version-old/img/price-impact.png similarity index 100% rename from guides/img/price-impact.png rename to guides_versioned_docs/version-old/img/price-impact.png diff --git a/guides/img/price-warning.png b/guides_versioned_docs/version-old/img/price-warning.png similarity index 100% rename from guides/img/price-warning.png rename to guides_versioned_docs/version-old/img/price-warning.png diff --git a/guides/img/protocol-leverage.png b/guides_versioned_docs/version-old/img/protocol-leverage.png similarity index 100% rename from guides/img/protocol-leverage.png rename to guides_versioned_docs/version-old/img/protocol-leverage.png diff --git a/guides/img/raydium1.jpg b/guides_versioned_docs/version-old/img/raydium1.jpg similarity index 100% rename from guides/img/raydium1.jpg rename to guides_versioned_docs/version-old/img/raydium1.jpg diff --git a/guides/img/repayment.png b/guides_versioned_docs/version-old/img/repayment.png similarity index 100% rename from guides/img/repayment.png rename to guides_versioned_docs/version-old/img/repayment.png diff --git a/guides/img/safety-modal.png b/guides_versioned_docs/version-old/img/safety-modal.png similarity index 100% rename from guides/img/safety-modal.png rename to guides_versioned_docs/version-old/img/safety-modal.png diff --git a/guides/img/sfm_swap1.png b/guides_versioned_docs/version-old/img/sfm_swap1.png similarity index 100% rename from guides/img/sfm_swap1.png rename to guides_versioned_docs/version-old/img/sfm_swap1.png diff --git a/guides/img/sfm_swap2.png b/guides_versioned_docs/version-old/img/sfm_swap2.png similarity index 100% rename from guides/img/sfm_swap2.png rename to guides_versioned_docs/version-old/img/sfm_swap2.png diff --git a/guides/img/sfm_swap3.png b/guides_versioned_docs/version-old/img/sfm_swap3.png similarity index 100% rename from guides/img/sfm_swap3.png rename to guides_versioned_docs/version-old/img/sfm_swap3.png diff --git a/guides/img/sfm_swap4.png b/guides_versioned_docs/version-old/img/sfm_swap4.png similarity index 100% rename from guides/img/sfm_swap4.png rename to guides_versioned_docs/version-old/img/sfm_swap4.png diff --git a/guides/img/slippage-new.png b/guides_versioned_docs/version-old/img/slippage-new.png similarity index 100% rename from guides/img/slippage-new.png rename to guides_versioned_docs/version-old/img/slippage-new.png diff --git a/guides/img/slippage-setting.png b/guides_versioned_docs/version-old/img/slippage-setting.png similarity index 100% rename from guides/img/slippage-setting.png rename to guides_versioned_docs/version-old/img/slippage-setting.png diff --git a/guides/img/solanafm_default.png b/guides_versioned_docs/version-old/img/solanafm_default.png similarity index 100% rename from guides/img/solanafm_default.png rename to guides_versioned_docs/version-old/img/solanafm_default.png diff --git a/guides/img/space_cat_office.png b/guides_versioned_docs/version-old/img/space_cat_office.png similarity index 100% rename from guides/img/space_cat_office.png rename to guides_versioned_docs/version-old/img/space_cat_office.png diff --git a/guides/img/terminal1.jpg b/guides_versioned_docs/version-old/img/terminal1.jpg similarity index 100% rename from guides/img/terminal1.jpg rename to guides_versioned_docs/version-old/img/terminal1.jpg diff --git a/guides/img/token-permissions.png b/guides_versioned_docs/version-old/img/token-permissions.png similarity index 100% rename from guides/img/token-permissions.png rename to guides_versioned_docs/version-old/img/token-permissions.png diff --git a/guides/img/tokenomics/Tokenomics-1.png b/guides_versioned_docs/version-old/img/tokenomics/Tokenomics-1.png similarity index 100% rename from guides/img/tokenomics/Tokenomics-1.png rename to guides_versioned_docs/version-old/img/tokenomics/Tokenomics-1.png diff --git a/guides/img/tokenomics/Tokenomics-2.png b/guides_versioned_docs/version-old/img/tokenomics/Tokenomics-2.png similarity index 100% rename from guides/img/tokenomics/Tokenomics-2.png rename to guides_versioned_docs/version-old/img/tokenomics/Tokenomics-2.png diff --git a/guides/img/user-liquidation.png b/guides_versioned_docs/version-old/img/user-liquidation.png similarity index 100% rename from guides/img/user-liquidation.png rename to guides_versioned_docs/version-old/img/user-liquidation.png diff --git a/guides/img/va/va-1.png b/guides_versioned_docs/version-old/img/va/va-1.png similarity index 100% rename from guides/img/va/va-1.png rename to guides_versioned_docs/version-old/img/va/va-1.png diff --git a/guides/img/va/va-2.png b/guides_versioned_docs/version-old/img/va/va-2.png similarity index 100% rename from guides/img/va/va-2.png rename to guides_versioned_docs/version-old/img/va/va-2.png diff --git a/guides/img/va/va-3.png b/guides_versioned_docs/version-old/img/va/va-3.png similarity index 100% rename from guides/img/va/va-3.png rename to guides_versioned_docs/version-old/img/va/va-3.png diff --git a/guides/img/va/va-4.png b/guides_versioned_docs/version-old/img/va/va-4.png similarity index 100% rename from guides/img/va/va-4.png rename to guides_versioned_docs/version-old/img/va/va-4.png diff --git a/guides/img/va/va-5.png b/guides_versioned_docs/version-old/img/va/va-5.png similarity index 100% rename from guides/img/va/va-5.png rename to guides_versioned_docs/version-old/img/va/va-5.png diff --git a/guides/img/verify-token-banner.png b/guides_versioned_docs/version-old/img/verify-token-banner.png similarity index 100% rename from guides/img/verify-token-banner.png rename to guides_versioned_docs/version-old/img/verify-token-banner.png diff --git a/guides/img/wsol.png b/guides_versioned_docs/version-old/img/wsol.png similarity index 100% rename from guides/img/wsol.png rename to guides_versioned_docs/version-old/img/wsol.png diff --git a/guides/img/wsol2.png b/guides_versioned_docs/version-old/img/wsol2.png similarity index 100% rename from guides/img/wsol2.png rename to guides_versioned_docs/version-old/img/wsol2.png diff --git a/guides/img/wsol3.png b/guides_versioned_docs/version-old/img/wsol3.png similarity index 100% rename from guides/img/wsol3.png rename to guides_versioned_docs/version-old/img/wsol3.png diff --git a/guides_versioned_docs/version-old/index.md b/guides_versioned_docs/version-old/index.md new file mode 100644 index 00000000..07b77fd2 --- /dev/null +++ b/guides_versioned_docs/version-old/index.md @@ -0,0 +1,46 @@ +--- +sidebar_label: "Overview" +title: Guides Overview +sidebar_position: 1 +description: Learn about Jupiter and how to use Jupiter with these beginner friendly guides. +--- + + + Jupiter Guides: Welcome Catdets! + + + +## Getting Started +Hello, curious cat! We're so glad you're here to learn more about Jupiter and our products. These guides were created to get new cats like yourself up to speed and to explain the inner workings of Jupiter products. + +Here's a list of all our official links. Please always double check the URL matches these! + +| Platform | Purpose | Official Link | +| -------- | ------- | ------------- | +| Website | Experience all Jupiter products for yourself | [https://jup.ag](https://jup.ag)| +| Discord | Engage with the community and us by sharing feedback and ideas | [https://discord.gg/jup](https://discord.gg/jup)| +| Twitter | Follow [@JupiterExchange] to stay up-to-date with all updates | [https://twitter.com/JupiterExchange](https://twitter.com/JupiterExchange)| +| Documentation | Read all about Jupiter products, for both users and devs | [https://station.jup.ag/](https://station.jup.ag/)| +| YouTube | Tune in to Planetary Calls and watch tutorials and guides relating to Jupiter and Solana DeFi | [https://www.youtube.com/@JUPecosystem](https://www.youtube.com/@JUPecosystem)| +| Reddit | Join our Reddit community to chat with fellow Catdets on all things Jupiter and DeFi | [https://www.reddit.com/r/jupiterexchange/](https://www.reddit.com/r/jupiterexchange/)| +| Jupresearch | Participate in forum discussion regarding Jupiter initiatives, ecosystem projects, and broader decentralised meta | [https://www.jupresear.ch/](https://www.jupresear.ch/)| +| Launchpad | Discover and participate in token launches by LFG Launchpad | [https://lfg.jup.ag/](https://lfg.jup.ag/)| +| Governance | Vote with your staked JUP on DAO proposals and earn Active Staker Rewards | [https://vote.jup.ag/](https://vote.jup.ag/)| +| J.U.P DAO | Be a part of Jupiter United Planet or Jupiverse and contribute to governance and voting | [https://www.jup.eco/](https://www.jup.eco/)| +| Token List | Understand how token verification works on Jupiter and get your token verified| [https://catdetlist.jup.ag/](https://catdetlist.jup.ag/)| +| Edge | Test out the latest product changes before they are live on the main website | [https://edge.jup.ag/](https://edge.jup.ag/)| +| Ape Pro | Ape into new tokens in a seamless, fast, yet secure manner with secure vault model | [https://ape.pro/](https://ape.pro/)| +| Welcome to Solana | Join us to welcome you to Solana every step of the way | [https://welcome.jup.ag/](https://welcome.jup.ag/)| + + +--- + +## Navigating this Guide +- **Spot:** Read detailed walkthroughs on all Spot features: Swap, Limit Order, Dollar Cost Averaging (DCA), Value Averaging (VA). Deep dive into how each of them work individually and together to provide the best trading experience for you! +- **Perpetual Exchange:** Learn about the [Jupiter Perpetuals Exchange](/guides/old/perpetual-exchange/overview) and the [JLP Pool](/guides/old/jlp/jlp) and its role in securing liquidity for the Perpetuals Exchange. +- **Ape:** Discover how the vault model, auto-retry, and removal of wallet signature enables fast and secure trades. +- **JupSOL:** Check out [JupSOL](/guides/old/jupsol/jupsol) to learn about the official Jupiter LST which supports the Jupiter Validator! +- **Onboard:** If you're coming to Solana for the first time, we care to provide a seamless experience for you. Read our guide on Bridge, Onramp, and CEX transferring. +- **General Guides:** Discover general guides relating to the Solana ecosystem such as personal security, using a block explorer to verify swaps, actions & blinks, token guide for creators, the Jupiter Media Kit, and FAQs about the Jupiter Platform. + +Welcome to the community, J4J (JUP 4 JUP)! diff --git a/guides/static/media/configure-settings-1.mp4 b/guides_versioned_docs/version-old/static/media/configure-settings-1.mp4 similarity index 100% rename from guides/static/media/configure-settings-1.mp4 rename to guides_versioned_docs/version-old/static/media/configure-settings-1.mp4 diff --git a/guides/static/media/configure-settings-2.mp4 b/guides_versioned_docs/version-old/static/media/configure-settings-2.mp4 similarity index 100% rename from guides/static/media/configure-settings-2.mp4 rename to guides_versioned_docs/version-old/static/media/configure-settings-2.mp4 diff --git a/guides/static/media/dynamic-slippage-video.mp4 b/guides_versioned_docs/version-old/static/media/dynamic-slippage-video.mp4 similarity index 100% rename from guides/static/media/dynamic-slippage-video.mp4 rename to guides_versioned_docs/version-old/static/media/dynamic-slippage-video.mp4 diff --git a/guides/static/media/how-to-swap-jupiter.mp4 b/guides_versioned_docs/version-old/static/media/how-to-swap-jupiter.mp4 similarity index 100% rename from guides/static/media/how-to-swap-jupiter.mp4 rename to guides_versioned_docs/version-old/static/media/how-to-swap-jupiter.mp4 diff --git a/guides/static/media/instant-routing-video.mp4 b/guides_versioned_docs/version-old/static/media/instant-routing-video.mp4 similarity index 100% rename from guides/static/media/instant-routing-video.mp4 rename to guides_versioned_docs/version-old/static/media/instant-routing-video.mp4 diff --git a/guides/static/media/lock-walkthrough.mp4 b/guides_versioned_docs/version-old/static/media/lock-walkthrough.mp4 similarity index 100% rename from guides/static/media/lock-walkthrough.mp4 rename to guides_versioned_docs/version-old/static/media/lock-walkthrough.mp4 diff --git a/guides/static/media/master-token-list-video.mp4 b/guides_versioned_docs/version-old/static/media/master-token-list-video.mp4 similarity index 100% rename from guides/static/media/master-token-list-video.mp4 rename to guides_versioned_docs/version-old/static/media/master-token-list-video.mp4 diff --git a/guides/static/media/safety-warnings-video.mp4 b/guides_versioned_docs/version-old/static/media/safety-warnings-video.mp4 similarity index 100% rename from guides/static/media/safety-warnings-video.mp4 rename to guides_versioned_docs/version-old/static/media/safety-warnings-video.mp4 diff --git a/guides/static/media/token-search-video.mp4 b/guides_versioned_docs/version-old/static/media/token-search-video.mp4 similarity index 100% rename from guides/static/media/token-search-video.mp4 rename to guides_versioned_docs/version-old/static/media/token-search-video.mp4 diff --git a/guides_versioned_sidebars/version-old-sidebars.json b/guides_versioned_sidebars/version-old-sidebars.json new file mode 100644 index 00000000..6a76c042 --- /dev/null +++ b/guides_versioned_sidebars/version-old-sidebars.json @@ -0,0 +1,8 @@ +{ + "ecosystem": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/guides_versions.json b/guides_versions.json new file mode 100644 index 00000000..95598e1d --- /dev/null +++ b/guides_versions.json @@ -0,0 +1,3 @@ +[ + "old" +] diff --git a/package.json b/package.json index 386eaef3..238fea41 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", - "build": "docusaurus build", + "generate-links": "node src/GenerateLinks.ts", + "build": "pnpm run generate-links && docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", diff --git a/redirects.json b/redirects.json index 4bf169b8..d5649e98 100644 --- a/redirects.json +++ b/redirects.json @@ -1,106 +1,151 @@ [ - {"to":"/docs/old/additional-topics/audits","from":"/docs/additional-topics/audits"}, - {"to":"/docs/old/additional-topics/builder-tips","from":"/docs/additional-topics/builder-tips"}, - {"to":"/docs/old/additional-topics/composing-with-versioned-transaction","from":"/docs/additional-topics/composing-with-versioned-transaction"}, - {"to":"/docs/old/additional-topics/displaying-jup-stats","from":"/docs/additional-topics/displaying-jup-stats"}, - {"to":"/docs/old/additional-topics/links-and-contract-addresses","from":"/docs/additional-topics/links-and-contract-addresses"}, - {"to":"/docs/old/additional-topics/wallet-list","from":"/docs/additional-topics/wallet-list"}, - {"to":"/docs/old/apis/adding-fees","from":"/docs/apis/adding-fees"}, - {"to":"/docs/old/apis/c-sharp-example","from":"/docs/apis/c-sharp-example"}, - {"to":"/docs/old/apis/cpi","from":"/docs/apis/cpi"}, - {"to":"/docs/old/apis/flash-fill","from":"/docs/apis/flash-fill"}, - {"to":"/docs/old/apis/landing-transactions","from":"/docs/apis/landing-transactions"}, - {"to":"/docs/old/apis/payments-api","from":"/docs/apis/payments-api"}, - {"to":"/docs/old/apis/price-api","from":"/docs/apis/price-api"}, - {"to":"/docs/old/apis/price-api-v2","from":"/docs/apis/price-api-v2"}, - {"to":"/docs/old/apis/self-hosted","from":"/docs/apis/self-hosted"}, - {"to":"/docs/old/apis/swap-api","from":"/docs/apis/swap-api"}, - {"to":"/docs/old/apis/troubleshooting","from":"/docs/apis/troubleshooting"}, - {"to":"/docs/old/dca/dca-sdk","from":"/docs/dca/dca-sdk"}, - {"to":"/docs/old/dca/integration","from":"/docs/dca/integration"}, - {"to":"/docs/old/dca/lock-dca-campaign","from":"/docs/dca/lock-dca-campaign"}, - {"to":"/docs/old/jupiter-terminal/jupiter-terminal","from":"/docs/jupiter-terminal/jupiter-terminal"}, - {"to":"/docs/old/jupiter-terminal/terminal-integration-guide","from":"/docs/jupiter-terminal/terminal-integration-guide"}, - {"to":"/docs/old/jupiter-terminal/unified-wallet-kit","from":"/docs/jupiter-terminal/unified-wallet-kit"}, - {"to":"/docs/old/legacy/apis/adding-fees","from":"/docs/legacy/apis/adding-fees"}, - {"to":"/docs/old/legacy/apis/payments-api","from":"/docs/legacy/apis/payments-api"}, - {"to":"/docs/old/legacy/apis/swap-api","from":"/docs/legacy/apis/swap-api"}, - {"to":"/docs/old/legal/privacy-policy","from":"/docs/legal/privacy-policy"}, - {"to":"/docs/old/legal/sdk-api-license-agreement","from":"/docs/legal/sdk-api-license-agreement"}, - {"to":"/docs/old/legal/terms-of-use","from":"/docs/legal/terms-of-use"}, - {"to":"/docs/old/limit-order/limit-order","from":"/docs/limit-order/limit-order"}, - {"to":"/docs/old/limit-order/limit-order-api","from":"/docs/limit-order/limit-order-api"}, - {"to":"/docs/old/projects-and-dexes/integration-guidelines","from":"/docs/projects-and-dexes/integration-guidelines"}, - {"to":"/docs/old/projects-and-dexes/rust-integration","from":"/docs/projects-and-dexes/rust-integration"}, - {"to":"/docs/old/token-api-standard","from":"/docs/token-api-standard"}, - {"to":"/docs/old/token-list/token-list-api","from":"/docs/token-list/token-list-api"}, + {"to":"/guides/old/apepro/faq","from":"/guides/apepro/faq"}, + {"to":"/guides/old/apepro/limit-order","from":"/guides/apepro/limit-order"}, + {"to":"/guides/old/apepro/overview","from":"/guides/apepro/overview"}, + {"to":"/guides/old/apepro/referral","from":"/guides/apepro/referral"}, + {"to":"/guides/old/dca/explainer","from":"/guides/dca/explainer"}, + {"to":"/guides/old/dca/how-dca-work","from":"/guides/dca/how-dca-work"}, + {"to":"/guides/old/dca/how-to-dca","from":"/guides/dca/how-to-dca"}, + {"to":"/guides/old/general","from":"/guides/general"}, + {"to":"/guides/old/general/blinks","from":"/guides/general/blinks"}, + {"to":"/guides/old/general/edge","from":"/guides/general/edge"}, + {"to":"/guides/old/general/faq","from":"/guides/general/faq"}, + {"to":"/guides/old/general/get-your-token-on-jupiter","from":"/guides/general/get-your-token-on-jupiter"}, + {"to":"/guides/old/general/media-kit","from":"/guides/general/media-kit"}, + {"to":"/guides/old/general/personal-security-on-solana","from":"/guides/general/personal-security-on-solana"}, + {"to":"/guides/old/general/verify-swaps-with-SolanaFM","from":"/guides/general/verify-swaps-with-SolanaFM"}, + {"to":"/guides/old/general/wrapped-sol","from":"/guides/general/wrapped-sol"}, + {"to":"/guides/old/jlp/How-JLP-Works","from":"/guides/jlp/How-JLP-Works"}, + {"to":"/guides/old/jlp/How-To-Get-JLP","from":"/guides/jlp/How-To-Get-JLP"}, + {"to":"/guides/old/jlp/JLP","from":"/guides/jlp/JLP"}, + {"to":"/guides/old/jlp/JLP-Economics","from":"/guides/jlp/JLP-Economics"}, + {"to":"/guides/old/jupiter-lock/jupiter-lock","from":"/guides/jupiter-lock/jupiter-lock"}, + {"to":"/guides/old/jupsol/jupsol","from":"/guides/jupsol/jupsol"}, + {"to":"/guides/old/limit-order/how-lo-work","from":"/guides/limit-order/how-lo-work"}, + {"to":"/guides/old/limit-order/limit-order","from":"/guides/limit-order/limit-order"}, + {"to":"/guides/old/limit-order/lo-partners","from":"/guides/limit-order/lo-partners"}, + {"to":"/guides/old/onboard/bridge","from":"/guides/onboard/bridge"}, + {"to":"/guides/old/onboard/onramp","from":"/guides/onboard/onramp"}, + {"to":"/guides/old/perpetual-exchange","from":"/guides/perpetual-exchange"}, + {"to":"/guides/old/perpetual-exchange/faq","from":"/guides/perpetual-exchange/faq"}, + {"to":"/guides/old/perpetual-exchange/how-it-works","from":"/guides/perpetual-exchange/how-it-works"}, + {"to":"/guides/old/perpetual-exchange/onchain-accounts","from":"/guides/perpetual-exchange/onchain-accounts"}, + {"to":"/guides/old/perpetual-exchange/overview","from":"/guides/perpetual-exchange/overview"}, + {"to":"/guides/old/perpetual-exchange/request-fulfillment-model","from":"/guides/perpetual-exchange/request-fulfillment-model"}, + {"to":"/guides/old/swap/features","from":"/guides/swap/features"}, + {"to":"/guides/old/swap/how-swap-works","from":"/guides/swap/how-swap-works"}, + {"to":"/guides/old/swap/tutorials","from":"/guides/swap/tutorials"}, + {"to":"/guides/old/swap/tutorials/configure-settings","from":"/guides/swap/tutorials/configure-settings"}, + {"to":"/guides/old/swap/tutorials/earn-referral-fees","from":"/guides/swap/tutorials/earn-referral-fees"}, + {"to":"/guides/old/swap/tutorials/how-to-swap","from":"/guides/swap/tutorials/how-to-swap"}, + {"to":"/guides/old/swap/tutorials/trade-safely","from":"/guides/swap/tutorials/trade-safely"}, + {"to":"/guides/old/va/explainer","from":"/guides/va/explainer"}, + {"to":"/guides/old/va/how-to-va","from":"/guides/va/how-to-va"}, + {"to":"/guides/old/va/how-va-work","from":"/guides/va/how-va-work"}, + {"to":"/docs/api/","from":"/api-v6/get-quote"}, {"to":"/docs/api/","from":"/api-v6/post-swap"}, {"to":"/docs/api/","from":"/api-v6/post-swap-instructions"}, {"to":"/docs/api/","from":"/api-v6/get-program-id-to-label"}, {"to":"/docs/api/","from":"/api-v6/tokens"}, - { - "to": "/guides/swap/how-swap-works", + {"to":"/docs","from":"/docs/old/"}, + {"to":"/docs","from":"/docs/old/additional-topics/audits"}, + {"to":"/docs","from":"/docs/old/additional-topics/builder-tips"}, + {"to":"/docs","from":"/docs/old/additional-topics/composing-with-versioned-transaction"}, + {"to":"/docs","from":"/docs/old/additional-topics/displaying-jup-stats"}, + {"to":"/docs","from":"/docs/old/additional-topics/links-and-contract-addresses"}, + {"to":"/docs","from":"/docs/old/additional-topics/wallet-list"}, + {"to":"/docs","from":"/docs/old/apis/adding-fees"}, + {"to":"/docs","from":"/docs/old/apis/c-sharp-example"}, + {"to":"/docs","from":"/docs/old/apis/cpi"}, + {"to":"/docs","from":"/docs/old/apis/flash-fill"}, + {"to":"/docs","from":"/docs/old/apis/landing-transactions"}, + {"to":"/docs","from":"/docs/old/apis/payments-api"}, + {"to":"/docs","from":"/docs/old/apis/price-api"}, + {"to":"/docs","from":"/docs/old/apis/price-api-v2"}, + {"to":"/docs","from":"/docs/old/apis/self-hosted"}, + {"to":"/docs","from":"/docs/old/apis/swap-api"}, + {"to":"/docs","from":"/docs/old/apis/troubleshooting"}, + {"to":"/docs","from":"/docs/old/dca/dca-sdk"}, + {"to":"/docs","from":"/docs/old/dca/integration"}, + {"to":"/docs","from":"/docs/old/dca/lock-dca-campaign"}, + {"to":"/docs","from":"/docs/old/jupiter-terminal/jupiter-terminal"}, + {"to":"/docs","from":"/docs/old/jupiter-terminal/terminal-integration-guide"}, + {"to":"/docs","from":"/docs/old/jupiter-terminal/unified-wallet-kit"}, + {"to":"/docs","from":"/docs/old/legacy/apis/adding-fees"}, + {"to":"/docs","from":"/docs/old/legacy/apis/payments-api"}, + {"to":"/docs","from":"/docs/old/legacy/apis/swap-api"}, + {"to":"/docs","from":"/docs/old/legal/privacy-policy"}, + {"to":"/docs","from":"/docs/old/legal/sdk-api-license-agreement"}, + {"to":"/docs","from":"/docs/old/legal/terms-of-use"}, + {"to":"/docs","from":"/docs/old/limit-order/limit-order"}, + {"to":"/docs","from":"/docs/old/limit-order/limit-order-api"}, + {"to":"/docs","from":"/docs/old/projects-and-dexes/integration-guidelines"}, + {"to":"/docs","from":"/docs/old/projects-and-dexes/rust-integration"}, + {"to":"/docs","from":"/docs/old/token-api-standard"}, + {"to":"/docs","from":"/docs/old/token-list/token-list-api"}, + { + "to": "/guides/old/swap/how-swap-works", "from": "/guides/jupiter-swap/how-swap-works/metropolis-features" }, { - "to": "/guides/swap/how-swap-works", + "to": "/guides/old/swap/how-swap-works", "from": "/guides/jupiter-swap/how-swap-works/how-swap-works" }, { - "to": "/guides/swap/how-swap-works", + "to": "/guides/old/swap/how-swap-works", "from": "/guides/jupiter-swap/how-swap-works/metis-routing" }, { - "to": "/guides/swap/how-swap-works", + "to": "/guides/old/swap/how-swap-works", "from": "/guides/jupiter-swap/swap" }, { - "to": "/guides/swap/tutorials/earn-referral-fees", + "to": "/guides/old/swap/tutorials/earn-referral-fees", "from": "/guides/jupiter-swap/how-referral-works" }, { - "to": "/guides/swap/how-swap-works", + "to": "/guides/old/swap/how-swap-works", "from": "/guides/jupiter-swap/how-swap-works/metropolis" }, { - "to": "/guides/perpetual-exchange/overview", + "to": "/guides/old/perpetual-exchange/overview", "from": "/labs/perpetual-exchange/overview" }, { - "to": "/guides/perpetual-exchange/how-it-works", + "to": "/guides/old/perpetual-exchange/how-it-works", "from": "/guides/perpetual-exchange/trading" }, { - "to": "/guides/perpetual-exchange/overview", + "to": "/guides/old/perpetual-exchange/overview", "from": "/labs" }, { - "to": "/guides/perpetual-exchange/how-it-works", + "to": "/guides/old/perpetual-exchange/how-it-works", "from": "/labs/perpetual-exchange/trading" }, { - "to": "/guides/jlp/JLP", + "to": "/guides/old/jlp/JLP", "from": "/labs/perpetual-exchange/jlp-pool" }, { - "to": "/guides/jlp/How-JLP-Works", + "to": "/guides/old/jlp/How-JLP-Works", "from": "/labs/perpetual-exchange/how-it-works" }, { - "to": "/guides/jlp/How-JLP-Works", + "to": "/guides/old/jlp/How-JLP-Works", "from": "/labs/faq/faq" }, { - "to": "/guides/general/get-your-token-on-jupiter", + "to": "/guides/old/general/get-your-token-on-jupiter", "from": "/docs/get-your-token-onto-jup" }, { - "to": "/guides/general/get-your-token-on-jupiter", + "to": "/guides/old/general/get-your-token-on-jupiter", "from": "/guides/general/new-token-guide" }, { - "to": "/guides/jlp/How-JLP-Works", + "to": "/guides/old/jlp/How-JLP-Works", "from": "/labs/perps-faq" }, { @@ -108,19 +153,19 @@ "from": "/blog" }, { - "to": "/guides/onboard", + "to": "/guides/old/onboard", "from": "/guides/bridge-comparator" }, { - "to": "/guides/onboard", + "to": "/guides/old/onboard", "from": "/guides/bridge/comparator" }, { - "to": "/guides/onboard/bridge", + "to": "/guides/old/onboard/bridge", "from": "/guides/bridge/bridging" }, { - "to": "/guides/onboard/onramp", + "to": "/guides/old/onboard/onramp", "from": "/guides/bridge/onramp" } ] \ No newline at end of file diff --git a/sidebars-docs.js b/sidebars-docs.js index 1a56c40c..e1892a94 100644 --- a/sidebars-docs.js +++ b/sidebars-docs.js @@ -136,7 +136,7 @@ const sidebars = { items: [ { type: 'doc', - id: 'perp-api/index', + id: 'perp-api/perp-api', }, ], }, diff --git a/sidebars-guides.js b/sidebars-guides.js index 3c58dc1d..dada760e 100644 --- a/sidebars-guides.js +++ b/sidebars-guides.js @@ -2,7 +2,467 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - ecosystem: [{ type: "autogenerated", dirName: "." }], + welcome: [ + { + type: 'doc', + id: 'index', + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: 'Getting Started', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'onboard/index', + }, + { + type: 'doc', + id: 'onboard/adding-funds', + }, + { + type: 'doc', + id: 'onboard/bridging-funds', + }, + { + type: 'doc', + id: 'onboard/security', + }, + ] + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: 'General', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'jupsol', + }, + { + type: 'doc', + id: 'lock', + }, + ] + } + ], + spot: [ + { + type: 'doc', + id: 'spot/index', + }, + { + type: 'category', + label: 'Categories', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/instant/quickstart', + label: 'Instant', + }, + { + type: 'doc', + id: 'spot/trigger/quickstart', + label: 'Trigger' + }, + { + type: 'doc', + id: 'spot/recurring/quickstart', + label: 'Recurring', + }, + ], + }, + ], + instant: [ + { + type: 'category', + label: 'Getting Started', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/instant/quickstart', + }, + { + type: 'doc', + id: 'spot/instant/how-swap-works', + }, + { + type: 'doc', + id: 'spot/instant/faq', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: "How To's", + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/instant/how-to-swap', + }, + { + type: 'doc', + id: 'spot/instant/how-to-swap-safely', + }, + { + type: 'doc', + id: 'spot/instant/how-to-configure-swap-settings', + }, + { + type: 'doc', + id: 'spot/instant/how-to-get-your-token-on-jupiter', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + ], + trigger: [ + { + type: 'category', + label: 'Getting Started', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/trigger/quickstart', + }, + { + type: 'doc', + id: 'spot/trigger/how-trigger-order-works', + }, + { + type: 'doc', + id: 'spot/trigger/faq', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: "How To's", + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/trigger/how-to-create-trigger-order', + }, + { + type: 'doc', + id: 'spot/trigger/how-to-manage-trigger-orders', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + ], + recurring: [ + { + type: 'category', + label: 'Getting Started', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/recurring/quickstart', + }, + { + type: 'doc', + id: 'spot/recurring/how-recurring-order-works', + }, + { + type: 'doc', + id: 'spot/recurring/faq', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: "How To's", + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'spot/recurring/how-to-create-recurring-order', + }, + { + type: 'doc', + id: 'spot/recurring/how-to-manage-recurring-order', + }, + { + type: 'doc', + id: 'spot/recurring/how-to-use-recurring-order-price-range', + }, + { + type: 'doc', + id: 'spot/recurring/how-to-optimize-recurring-order', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + ], + perps: [ + { + type: 'category', + label: 'Getting Started', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'perps/quickstart', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: "Trader", + collapsible: false, + collapsed: false, + items: [ + { + type: 'category', + label: "How Trading Works", + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'perps/position-management', + }, + { + type: 'doc', + id: 'perps/leverage-management', + }, + { + type: 'doc', + id: 'perps/liquidation', + }, + { + type: 'doc', + id: 'perps/fees', + }, + { + type: 'doc', + id: 'perps/oracle', + }, + { + type: 'doc', + id: 'perps/keeper', + }, + ], + }, + { + type: 'category', + label: "How To's", + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'perps/how-to-open-position', + }, + { + type: 'doc', + id: 'perps/how-to-manage-position', + }, + { + type: 'doc', + id: 'perps/how-to-close-position', + }, + { + type: 'doc', + id: 'perps/how-to-use-limit-order', + }, + ], + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: "JLP", + collapsible: false, + collapsed: false, + items: [ + { + type: 'category', + label: "How JLP Works", + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'perps/jlp-pool-and-token', + }, + { + type: 'doc', + id: 'perps/jlp-fee-distribution', + }, + { + type: 'doc', + id: 'perps/jlp-pool-weightage', + }, + { + type: 'doc', + id: 'perps/jlp-risks', + }, + { + type: 'doc', + id: 'perps/jlp-economics', + }, + ], + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + ], + apepro: [ + { + type: 'category', + label: 'Getting Started', + className: 'ape', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'apepro/quickstart', + }, + { + type: 'doc', + id: 'apepro/how-to-set-up-account', + }, + { + type: 'doc', + id: 'apepro/faq', + }, + ], + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: 'Discovery', + className: 'ape', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'apepro/feeds', + }, + { + type: 'doc', + id: 'apepro/filters', + }, + { + type: 'doc', + id: 'apepro/token-profile-and-chart', + }, + ] + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: 'Trading', + className: 'ape', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'apepro/buying', + }, + { + type: 'doc', + id: 'apepro/portfolio', + }, + { + type: 'doc', + id: 'apepro/mobile', + }, + ] + }, + { + type: 'html', + value: '
    ', + }, + { + type: 'category', + label: 'Ape Friends', + className: 'ape', + collapsible: false, + collapsed: false, + items: [ + { + type: 'doc', + id: 'apepro/leaderboard', + }, + { + type: 'doc', + id: 'apepro/referral', + }, + ] + }, + { + type: 'html', + value: '
    ', + }, + ], }; module.exports = sidebars; diff --git a/sidebars-jup.js b/sidebars-jup.js deleted file mode 100644 index 0e3e07d7..00000000 --- a/sidebars-jup.js +++ /dev/null @@ -1,8 +0,0 @@ -// @ts-check - -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const sidebars = { - community: [{ type: 'autogenerated', dirName: '.' }], -}; - -module.exports = sidebars; diff --git a/src/GenerateLinks.ts b/src/GenerateLinks.ts new file mode 100644 index 00000000..a679a613 --- /dev/null +++ b/src/GenerateLinks.ts @@ -0,0 +1,43 @@ +const fs = require('fs'); +const path = require('path'); + +function generateLinks(directory, baseUrl) { + const files = fs.readdirSync(directory); + return files + .filter( + (file) => + (file.endsWith('.md') || file.endsWith('.mdx')) && // Include only Markdown files + path.basename(file).toLowerCase() !== 'index.md' && // Exclude index.md + path.basename(file).toLowerCase() !== 'index.mdx' // Exclude index.mdx + ) + .sort((a, b) => { + // Extract leading numbers for sorting + const getNumber = (filename) => { + const match = filename.match(/^(\d+)-/); // Match numbers at the beginning followed by a dash + return match ? parseInt(match[1], 10) : 999; // Default to 999 for files without numbers + }; + return getNumber(a) - getNumber(b); + }) + .map((file) => ({ + text: path + .basename(file, path.extname(file)) + .replace(/^\d+-/, '') // Remove leading numbers and dash + .replace(/-/g, ' ') // Replace remaining dashes with spaces + .replace(/^\w/, (c) => c.toUpperCase()), // Capitalize the first letter + link: `${baseUrl}/${path.basename(file, path.extname(file))}`, + })); +} + +// Directories to generate links for +const directories = { + instant: { path: path.resolve(__dirname, '../guides/100-spot/100-instant'), baseUrl: '/guides/spot/instant' }, + trigger: { path: path.resolve(__dirname, '../guides/100-spot/200-trigger'), baseUrl: '/guides/spot/trigger' }, + recurring: { path: path.resolve(__dirname, '../guides/100-spot/300-recurring'), baseUrl: '/guides/spot/recurring' }, +}; + +const linkData = {}; +Object.entries(directories).forEach(([key, { path: dirPath, baseUrl }]) => { + linkData[key] = generateLinks(dirPath, baseUrl); +}); + +fs.writeFileSync(path.resolve(__dirname, '../src/links/links.json'), JSON.stringify(linkData, null, 2)); diff --git a/src/components/DocsLanding.tsx b/src/components/DocsLanding.tsx index f33af03d..3474731d 100644 --- a/src/components/DocsLanding.tsx +++ b/src/components/DocsLanding.tsx @@ -24,7 +24,7 @@ const ProductCard: React.FC = ({ image, title, description, li padding: '20px', display: 'flex', margin: '10px', - boxShadow: isHovered ? '0 0 10px darkseagreen' : '0 2px 5px rgba(0, 0, 0, 0.1)', + boxShadow: isHovered ? '0 0 10px rgb(0, 180, 90)' : '0 2px 5px rgba(0, 0, 0, 0.1)', textAlign: 'left', height: 'auto', minHeight: '120px', diff --git a/src/components/ProductSection.module.css b/src/components/ProductSection.module.css new file mode 100644 index 00000000..7b834564 --- /dev/null +++ b/src/components/ProductSection.module.css @@ -0,0 +1,65 @@ +/* .container { + text-align: center; + margin: 2rem auto; + padding: 1rem; + max-width: 800px; + } */ + + /* .title { + margin-bottom: 1.5rem; + font-size: 1.5rem; + font-weight: bold; + } */ + + .grid { + display: grid; + grid-template-columns: 1fr; + gap: 1rem 2rem; /* Spacing between grid items */ + } + + @media (min-width: 768px) { + .grid { + grid-template-columns: repeat(2, 1fr); + } + } + + .gridItem { + /* padding: 1rem; + background-color: #f9f9f9; + border: 1px solid #ddd; */ + /* border-radius: 8px; */ + /* text-decoration: none; */ + overflow-wrap: break-word; /* Prevent text overflow */ + display: flex; + /* align-items: center; */ + /* justify-content: center; */ + height: 100%; /* Ensure uniform height */ + } + + /* .gridItem:hover { + background-color: #f1f1f1; + border-color: #ccc; + } */ + + .buttonContainer { + margin-top: 2rem; + margin-bottom: 4rem; + } + + .button { + display: inline-block; + padding: 0.2rem 4rem; + background-color: transparent; + color: grey; + border: 0.5px solid grey; + border-radius: 4px; + font-size: small; + /* text-decoration: none; */ + /* font-weight: bold; */ + } + + .button:hover { + color: darkgreen !important; + /* background-color: #0056b3; */ + } + \ No newline at end of file diff --git a/src/components/ProductSection.tsx b/src/components/ProductSection.tsx new file mode 100644 index 00000000..52511cbc --- /dev/null +++ b/src/components/ProductSection.tsx @@ -0,0 +1,38 @@ +import React from 'react'; +import styles from './ProductSection.module.css'; +import linkData from '/src/links/links.json'; // Import pre-generated data, safe to ignore + +const ProductSection = ({ title, sectionKey, linkColor, buttonLink }) => { + const links = linkData[sectionKey] || []; + const gridLinks = links.slice(0, 8); + const overflowLinks = links.slice(8); + + return ( +
    + {title &&

    {title}

    } + +
    + {gridLinks.map((item, index) => ( + + {item.text} + + ))} +
    + + {overflowLinks.length > 0 && ( +
    + + View all {gridLinks.length + overflowLinks.length} + +
    + )} +
    + ); +}; + +export default ProductSection; diff --git a/src/constant.ts b/src/constant.ts index 4e58e96b..e9b6e926 100644 --- a/src/constant.ts +++ b/src/constant.ts @@ -2,17 +2,96 @@ export const navbarConfigs = { '/docs': [ { to: '/docs/', label: 'API Setup', position: 'left' }, { to: '/docs/swap-api/get-quote', label: 'Swap API', position: 'left' }, - { to: '/docs/perp-api/', label: 'Perp API', position: 'left' }, + { to: '/docs/perp-api/perp-api', label: 'Perp API', position: 'left' }, { to: '/docs/tool-kits/swap-terminal', label: 'Tool Kits', position: 'left' }, { to: '/docs/utility/price-api', label: 'Utility', position: 'left' }, { to: '/docs/api', label: 'API Reference', position: 'left' }, ], '/guides': [ - { to: '/guides/', label: 'Guides', position: 'left' }, - { to: '/docs/', label: 'Docs', position: 'left' }, + { to: '/guides/', label: 'General', position: 'left' }, + { + to: '/guides/spot', + label: 'Spot', + position: 'left', + items: [ + { to: '/guides/spot/instant/quickstart', label: 'Instant', position: 'left' }, + { to: '/guides/spot/trigger/quickstart', label: 'Trigger', position: 'left' }, + { to: '/guides/spot/recurring/quickstart', label: 'Recurring', position: 'left' }, + ] + }, + { to: '/guides/perps/quickstart', label: 'Perps', position: 'left' }, + { to: '/guides/apepro/quickstart', label: 'Ape Pro', position: 'left' }, ], '/': [ - { to: '/guides/', label: 'Guides', position: 'left' }, + { to: '/guides/', label: 'Guides', position: 'left' }, // to do, or yet to fix, navbar as mobile sidebar does not respect this, only follows docusaurus.config.js navbar config { to: '/docs/', label: 'Docs', position: 'left' }, + { to: 'https://jup.com', label: 'Jupiverse', position: 'left' }, ], -}; \ No newline at end of file +}; + +// used in home page /src/pages/index.tsx +export const PRODUCT_CARDS = [ + { + title: "Onboard", + links: [ + { text: "Guide", href: "/guides/onboard" }, + { text: "Launch", href: "https://jup.ag/onboard" } + ] + }, + { + title: "Spot - Instant", + links: [ + { text: "Guide", href: "/guides/spot/swap/quickstart" }, + { text: "Launch", href: "https://jup.ag/swap" } + ] + }, + { + title: "Spot - Trigger", + links: [ + { text: "Guide", href: "/guides/spot/trigger/quickstart" }, + { text: "Launch", href: "https://jup.ag/limit" } + ] + }, + { + title: "Spot - Recurring", + links: [ + { text: "Guide", href: "/guides/spot/recurring/quickstart" }, + { text: "Launch", href: "https://jup.ag/dca" } + ] + }, + { + title: "Trade Perps", + links: [ + { text: "Guide", href: "/guides/perps/quickstart" }, + { text: "Launch", href: "https://jup.ag/perps" } + ] + }, + { + title: "JLP Pool", + links: [ + { text: "Guide", href: "/guides/perps/jlp-pool-and-token" }, + { text: "Launch", href: "https://jup.ag/perps-earn" } + ] + }, + { + title: "Mobile", + links: [ + { text: "iOS", href: "https://apps.apple.com/us/app/jupiter-mobile/id6484069059" }, + { text: "Android", href: "https://play.google.com/store/apps/details?id=ag.jup.jupiter.android" } + ] + }, + { + title: "Ape Pro", + links: [ + { text: "Guide", href: "/guides/apepro/quickstart" }, + { text: "Launch", href: "https://ape.pro/" } + ] + }, + { + title: "Lock", + links: [ + { text: "Guide", href: "/guides/" }, + { text: "Launch", href: "https://lock.jup.ag/" } + ] + }, +]; diff --git a/src/css/apepro.css b/src/css/apepro.css new file mode 100644 index 00000000..ee455abb --- /dev/null +++ b/src/css/apepro.css @@ -0,0 +1,293 @@ +#__docusaurus:has([data-section-id="apepro"]) { + background-color: #09090b !important; + color: white !important; + --ifm-breadcrumb-separator-filter: invert(100%) !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar { + background-color: #09090b !important; + color: #fbbf24 !important; + box-shadow: 0 0 0 1px #71717A !important; +} + +/* Hide the default title/logo when in Ape Pro section */ +#__docusaurus:has([data-section-id="apepro"]) .navbar__title { + display: none; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar__brand .navbar__logo { + content: url('../../static/apepro/apepro-logo.svg'); + display: inline-block; + color: #fbbf24 !important; + padding: 0 0 0 2rem; +} + +/* small screen size */ +@media (max-width: 768px) { + #__docusaurus:has([data-section-id="apepro"]) .navbar__brand .navbar__logo { + padding: 0 0 0 0; + } +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar__toggle { + color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar__toggle:hover { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar__link { + color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar__link.navbar__link--active, +#__docusaurus:has([data-section-id="apepro"]) .navbar__link.navbar__link--active:hover { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar__link:hover { + color: white !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .dropdown__menu { + background: #09090b !important; + border: 1px solid #fbbf24 !important; + border-radius: var(--ifm-border-radius); +} + +#__docusaurus:has([data-section-id="apepro"]) .dropdown__trigger::after { + color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .dropdown__trigger:hover::after { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .dropdown__link { + color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .dropdown__link:hover { + color: white !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .breadcrumbs__link { + color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .breadcrumbs__item--active .breadcrumbs__link { + color: #fbbf24 !important; + background: #1B110D !important; + border: 0.1rem solid #fbbf24 !important; +} + + +/* navbar search */ +#__docusaurus:has([data-section-id="apepro"]) .navbarSearchContainer .DocSearch-Button { + width: 36px !important; + height: 36px !important; + padding: 0 !important; + border-radius: 50% !important; + background: #1B110D !important; + border: 1px solid #fbbf24 !important; + transition: all 0.2s ease !important; + display: flex !important; + align-items: center !important; + justify-content: center !important; + box-shadow: none !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbarSearchContainer .DocSearch-Button-Placeholder, +#__docusaurus:has([data-section-id="apepro"]) .navbarSearchContainer .DocSearch-Button-Keys { + display: none !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbarSearchContainer .DocSearch-Search-Icon { + margin: 0 !important; + width: 16px !important; + height: 16px !important; + color: #fbbf24 !important; + stroke-width: 2px !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbarSearchContainer .DocSearch-Button:hover { + background: #1B110D !important; + border-color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbarSearchContainer .DocSearch-Button:hover .DocSearch-Search-Icon { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-menu { + padding: 0.2rem 0 0.2rem 0.2rem; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-menu .menu__list-item-collapsible .menu__link { + color: white !important; + font-weight: 700 !important; + background: none !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-menu .menu__list-item-collapsible:hover .menu__link { + color: white !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-menu .menu__link--active { + color: #fbbf24 !important; + background-color: #18181b !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-menu .menu__link:hover { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-menu .menu__link--active:hover { + color: #fbbf24 !important; + background-color: #18181b !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-sidebar-container { + border-right: 1px solid #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar-sidebar { + background-color: #09090b !important; + box-shadow: 0 1px 2px 0 rgb(113, 113, 122, 0.5) !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar-sidebar__backdrop { + background-color: #09090b 80% !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .navbar-sidebar__brand { + box-shadow: 0 1px 2px 0 rgb(113, 113, 122, 0.5) !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .sidebar-line-break { + border-top: 1px solid #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .table-of-contents__left-border { + border-left: 1px solid rgb(113, 113, 122, 0.5) !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .table-of-contents__link--active { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) h1, +#__docusaurus:has([data-section-id="apepro"]) h2, +#__docusaurus:has([data-section-id="apepro"]) h3, +#__docusaurus:has([data-section-id="apepro"]) h4, +#__docusaurus:has([data-section-id="apepro"]) h5, +#__docusaurus:has([data-section-id="apepro"]) h6 { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-edit-this-page, +#__docusaurus:has([data-section-id="apepro"]) .pagination-nav__label +{ + color: #71717A !important; + border-color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .pagination-nav__link:hover { + border-color: #fbbf24 !important; + text-decoration: none !important; +} + +/* Mobile TOC styling for Ape Pro theme */ +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile { + background-color: #18181b !important; + /* padding: 0.4rem 0.8rem; */ +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile .table-of-contents { + border-left: 0 !important; + border-top: 1px solid rgb(113, 113, 122, 0.5) !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile .clean-btn { + color: #71717A !important; + width: 100%; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile .clean-btn::after { + background-color: #fbbf24 !important; + mask-image: var(--ifm-menu-link-sublist-icon); + -webkit-mask-image: var(--ifm-menu-link-sublist-icon); + mask-position: 50% 50%; + -webkit-mask-position: 50% 50%; + mask-repeat: no-repeat; + -webkit-mask-repeat: no-repeat; + mask-size: 2rem 2rem; + -webkit-mask-size: 2rem 2rem; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile .table-of-contents__link { + color: #71717A !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile .table-of-contents__link:hover { + color: white !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-toc-mobile .table-of-contents__link--active { + color: #fbbf24 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) table th { + color: #fbbf24; + border-color: #71717A; +} + +#__docusaurus:has([data-section-id="apepro"]) table td { + color: white; + border-color: #71717A; +} + +#__docusaurus:has([data-section-id="apepro"]) table tr { + background-color: #09090b; +} + +/* Admonition styling for Ape Pro theme */ +#__docusaurus:has([data-section-id="apepro"]) .theme-admonition { + border-left-width: 6px !important; + border-left-width: var(--ifm-alert-border-radius) !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-admonition-note { + border-left-color: #fbbf24 !important; + background-color: #fffbeb !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-admonition-info { + border-left-color: #60a5fa !important; + background-color: #eff6ff !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-admonition-tip { + border-left-color: #34d399 !important; + background-color: #ecfdf5 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-admonition-warning { + border-left-color: #f87171 !important; + background-color: #fef2f2 !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-admonition-caution { + border-left-color: #fb923c !important; + background-color: #fff7ed !important; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-markdown a[href]:not(.theme-admonition a):hover { + color: #b45309 !important; + text-decoration: underline; +} + +#__docusaurus:has([data-section-id="apepro"]) .theme-doc-markdown a[href]:not(.theme-admonition a):visited { + color: #b45309 !important; +} diff --git a/src/css/custom.css b/src/css/custom.css index 7031c92c..2ca1a762 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -35,10 +35,6 @@ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); */ } -.home { - background-color: #131c25; -} - @layer base { .stats :where(*) { margin: 0; @@ -81,7 +77,11 @@ .home .navbar { position: relative; box-shadow: none; - background-color: transparent; + background-color: #111A22; +} + +.navbar { + padding: 16px 16px; } .home .navbar__toggle { @@ -257,4 +257,20 @@ .hidden { display: none !important; - } \ No newline at end of file +} + +.responsive-video { + width: 100%; + height: auto; + max-width: 1200px; +} + +@media (max-width: 768px) { + .responsive-video { + max-width: 100%; + } +} + +.theme-doc-markdown.markdown { + max-width: 768px; +} diff --git a/src/css/navbar.css b/src/css/navbar.css index e4c15be6..eab09a85 100644 --- a/src/css/navbar.css +++ b/src/css/navbar.css @@ -16,6 +16,10 @@ text-decoration: none; } +.navbar__title.mobile-hidden { + color: black; +} + .navbar__brand:hover { color: black; } @@ -26,7 +30,7 @@ .navbar__item.navbar__link.navbar__link--active { margin-right: 16px; - font-weight: 900; + font-weight: 00; color: black !important; } @@ -44,6 +48,8 @@ .navbar__toggle { margin-left: auto; } + + } @media (min-width: 996px) { @@ -68,11 +74,11 @@ @media (prefers-color-scheme: light) { .navbar__item.navbar__link { @apply text-sm font-semibold text-[#304256]/40 hover:text-[#304256] hover:no-underline; - } + } .navbar__item.navbar__link.navbar__link--active { @apply text-[#304256]; - } + } .navbar__title { color: #19232d; @@ -95,4 +101,118 @@ .navbar__items--right .navbar__item { display: block; padding: 0; -} \ No newline at end of file +} + +.dropdown--hoverable { + position: relative; +} + +.navbar__item.dropdown .navbar__link:not([href]) { + font-size: 0.875rem; + line-height: 1.25rem; + font-weight: 600; + color: rgb(48 66 86 / 0.4); + position: relative; +} + +.dropdown--hoverable .dropdown__menu { + opacity: 0; + pointer-events: none; + position: absolute; + top: 100%; + left: 0; + width: 280px; + background: white; + border: 1px solid var(--ifm-color-emphasis-200); + border-radius: var(--ifm-border-radius); + box-shadow: var(--ifm-dropdown-shadow); + transition: opacity 0.2s ease-in-out; +} + +.dropdown--hoverable:hover .dropdown__menu { + opacity: 1; + pointer-events: auto; +} + +.dropdown__link { + display: block; + padding: 0.75rem 2rem; + color: rgb(48 66 86 / 0.4); + text-decoration: none; + height: 48px; + line-height: 24px; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + +.dropdown__link:hover { + color: black; + font-weight: 900; + background: none; +} + +.dropdown__link--active:hover { + color: black; + font-weight: 900; + background-color: ghostwhite; +} + +.dropdown__link.dropdown__link--active { + color: black; + font-weight: 900; + background-color: ghostwhite; +} + +.navbar__link-wrapper { + display: flex; + align-items: center; + font-size: 0.875rem; + line-height: 1.25rem; + font-weight: 600; + color: rgb(48 66 86 / 0.4); + position: relative; +} + +.navbar__link-wrapper .navbar__link { + color: rgb(48 66 86 / 0.4); + font-weight: 600; + padding-right: 1.5rem; /* Make room for dropdown trigger */ +} + +.navbar__link:hover, .navbar__link--active { + color: black !important; + font-weight: 900 !important; +} + +.dropdown__trigger { + position: absolute; + right: 0.5rem; + width: 0.75rem; + height: 0.75rem; + pointer-events: none; /* This ensures hover works properly */ +} + +.dropdown__trigger::after { + content: '▾'; + position: absolute; + top: 50%; + right: 0; + transform: translateY(-50%); +} + +/* Mobile navbar sidebar menu styles */ +.menu__list--nested .menu__link { + font-size: 1rem; + margin-left: 2rem; +} + +.menu__list--nested .menu__link--active { + font-weight: 900; + color: black; +} + +.menu__link--active { + font-weight: 900; + color: black; +} diff --git a/src/css/searchbar.css b/src/css/searchbar.css new file mode 100644 index 00000000..1619b580 --- /dev/null +++ b/src/css/searchbar.css @@ -0,0 +1,194 @@ +.homeSearchContainer .DocSearch-Button { + width: 80% !important; + height: 60px !important; + border-radius: 9999px !important; + background: rgba(199, 242, 132, 0.05) !important; + border: 4px solid rgba(170, 235, 66, 0.4) !important; + transition: all 0.2s ease !important; + margin: 0 auto !important; +} + +.homeSearchContainer .DocSearch-Button:active, +.homeSearchContainer .DocSearch-Button:focus, +.homeSearchContainer .DocSearch-Button:hover { + background: rgba(199, 242, 132, 0.1) !important; + border: 4px solid rgba(170, 235, 66, 1) !important; + box-shadow: none !important; +} + +.homeSearchContainer .DocSearch-Button-Placeholder { + color: rgba(199, 242, 132, 0.6) !important; + font-size: 16px !important; +} + +.homeSearchContainer .DocSearch-Button-Keys { + font-size: 16px !important; + margin-right: 0.5rem; +} + +.DocSearch-Button-Key, +.DocSearch-Commands-Key { + background: rgba(199, 242, 132, 0.1) !important; + border: 1px solid rgba(199, 242, 132, 0.2) !important; + border-radius: 4px !important; + box-shadow: none !important; + color: rgba(199, 242, 132, 0.6) !important; + font-size: 12px !important; + padding: 2px 6px !important; + margin: 0.2rem !important; + height: auto !important; + width: auto !important; + min-width: auto !important; +} + +.DocSearch-Search-Icon { + color: rgba(199, 242, 132, 0.6) !important; + width: 16px !important; + height: 16px !important; + margin-left: 1rem; +} + +.DocSearch-Modal { + background: #131C25 !important; + border-radius: 16px !important; + box-shadow: none !important; +} + +.DocSearch-Form { + background: rgba(199, 242, 132, 0.05) !important; + box-shadow: none !important; +} + +.DocSearch-Input { + color: white !important; + font-size: 16px !important; +} + +.DocSearch-Hit-source { + padding: 8px 16px 8px 16px !important; + color: rgba(199, 242, 132, 0.9) !important; + font-size: 16px !important; + font-weight: 600 !important; + background: #131C25 !important; +} + +.DocSearch-Hit[aria-selected=false] a { + background-color: rgba(199, 242, 132, 0.05) !important; + box-shadow: none !important; + color: black !important; +} + +.DocSearch-Hit[aria-selected=true] a { + background-color: #1A3742 !important; + box-shadow: none !important; +} + +.DocSearch-Hit-title { + color: white !important; +} + +.DocSearch-Hit-title mark { + color: rgba(199, 242, 132, 1) !important; + background: none !important; + text-decoration: underline; + text-decoration-color: rgba(199, 242, 132, 0.4); +} + +.DocSearch-Hit-path mark { + color: rgba(199, 242, 132, 0.6) !important; +} + +.DocSearch-Hit-icon { + color: rgba(199, 242, 132, 0.6) !important; +} + +.DocSearch-Hit-action { + color: rgba(199, 242, 132, 0.4) !important; +} + +.DocSearch-Hit-Tree { + color: rgba(199, 242, 132, 0.4) !important; +} + +.DocSearch-Footer { + background: #131C25 !important; + border-radius: 0 0 16px 16px !important; +} + +.DocSearch-Dropdown { + scrollbar-color: rgba(199, 242, 132, 0.4) rgba(199, 242, 132, 0) !important; + margin-top: 0.5rem; +} + +/* Hide cancel button by default */ +.DocSearch-Cancel { + display: none !important; +} + +.DocSearch-Reset { + color: rgba(255, 255, 255, 0.5) !important; +} + +/* Show cancel button only on mobile screens */ +@media (max-width: 768px) { + .DocSearch-Cancel { + font-size: 14px !important; + color: rgba(199, 242, 132, 0.6) !important; + position: relative !important; + height: 20px !important; + margin-top: 1rem !important; + display: flex !important; + align-items: center !important; + background: none !important; + border: none !important; + cursor: pointer !important; + transition: color 0.2s ease !important; + } + + .DocSearch-Cancel:hover { + color: rgba(199, 242, 132, 1) !important; + } + + .DocSearch-Cancel::before, + .DocSearch-Cancel::after { + display: none !important; + } +} + +/* navbar search */ +.navbarSearchContainer .DocSearch-Button { + width: 36px !important; + height: 36px !important; + padding: 0 !important; + border-radius: 50% !important; + background: rgba(199, 242, 132, 0.05) !important; + border: 1px solid #85CB15 !important; + transition: all 0.2s ease !important; + display: flex !important; + align-items: center !important; + justify-content: center !important; + box-shadow: none !important; +} + +.navbarSearchContainer .DocSearch-Button-Placeholder, +.navbarSearchContainer .DocSearch-Button-Keys { + display: none !important; +} + +.navbarSearchContainer .DocSearch-Search-Icon { + margin: 0 !important; + width: 16px !important; + height: 16px !important; + color: #85CB15 !important; + stroke-width: 2px !important; +} + +/* Hover state for both button and icon */ +.navbarSearchContainer .DocSearch-Button:hover { + background: rgba(199, 242, 132, 0.1) !important; + border-color: rgba(170, 235, 66, 1) !important; +} + +.navbarSearchContainer .DocSearch-Button:hover .DocSearch-Search-Icon { + color: rgba(170, 235, 66, 1) !important; +} \ No newline at end of file diff --git a/src/css/sidebar.css b/src/css/sidebar.css index a592efc2..a51517be 100644 --- a/src/css/sidebar.css +++ b/src/css/sidebar.css @@ -33,7 +33,19 @@ .theme-doc-sidebar-menu .menu__list-item-collapsible .menu__link { color: black !important; font-weight: 700 !important; + background: none !important; +} + +.theme-doc-sidebar-menu .menu__list-item-collapsible:hover { + color: black !important; + font-weight: 700 !important; + background: none !important; +} +.theme-doc-sidebar-menu .menu__link:hover { + background: none !important; + color: rgb(0, 180, 90); + font-weight: 700 !important; } .sidebar-line-break { @@ -43,4 +55,13 @@ :root { --doc-sidebar-width: 280px !important -} \ No newline at end of file +} + +.sidebar-reach-out-link { + color: var(--ifm-menu-color); + margin-left: 0.75rem; +} + +.sidebar-subcategory > .menu__list-item-collapsible > .menu__link { + font-weight: 400 !important; +} diff --git a/src/links/links.json b/src/links/links.json new file mode 100644 index 00000000..8f979c73 --- /dev/null +++ b/src/links/links.json @@ -0,0 +1,104 @@ +{ + "instant": [ + { + "text": "Quickstart", + "link": "/guides/spot/instant/0-quickstart" + }, + { + "text": "How swap works", + "link": "/guides/spot/instant/1-how-swap-works" + }, + { + "text": "Interface", + "link": "/guides/spot/instant/2-interface" + }, + { + "text": "Security", + "link": "/guides/spot/instant/3-security" + }, + { + "text": "Faq", + "link": "/guides/spot/instant/4-faq" + }, + { + "text": "How to swap", + "link": "/guides/spot/instant/100-how-to-swap" + }, + { + "text": "How to swap safely", + "link": "/guides/spot/instant/102-how-to-swap-safely" + }, + { + "text": "How to configure swap settings", + "link": "/guides/spot/instant/103-how-to-configure-swap-settings" + }, + { + "text": "How to get your token on jupiter", + "link": "/guides/spot/instant/104-how-to-get-your-token-on-jupiter" + } + ], + "trigger": [ + { + "text": "Quickstart", + "link": "/guides/spot/trigger/0-quickstart" + }, + { + "text": "How trigger order works", + "link": "/guides/spot/trigger/1-how-trigger-order-works" + }, + { + "text": "Interface", + "link": "/guides/spot/trigger/2-interface" + }, + { + "text": "Faq", + "link": "/guides/spot/trigger/4-faq" + }, + { + "text": "How to create trigger order", + "link": "/guides/spot/trigger/100-how-to-create-trigger-order" + }, + { + "text": "How to manage trigger orders", + "link": "/guides/spot/trigger/101-how-to-manage-trigger-orders" + } + ], + "recurring": [ + { + "text": "Quickstart", + "link": "/guides/spot/recurring/0-quickstart" + }, + { + "text": "How recurring order works", + "link": "/guides/spot/recurring/1-how-recurring-order-works" + }, + { + "text": "Interface", + "link": "/guides/spot/recurring/2-interface" + }, + { + "text": "Security", + "link": "/guides/spot/recurring/3-security" + }, + { + "text": "Faq", + "link": "/guides/spot/recurring/5-faq" + }, + { + "text": "How to create recurring order", + "link": "/guides/spot/recurring/100-how-to-create-recurring-order" + }, + { + "text": "How to manage recurring order", + "link": "/guides/spot/recurring/101-how-to-manage-recurring-order" + }, + { + "text": "How to use recurring order price range", + "link": "/guides/spot/recurring/102-how-to-use-recurring-order-price-range" + }, + { + "text": "How to optimize recurring order", + "link": "/guides/spot/recurring/103-how-to-optimize-recurring-order" + } + ] +} \ No newline at end of file diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 148cfb4c..d6fdb326 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -5,383 +5,155 @@ import Layout from "@theme/Layout"; import { TweetCardProps } from "react-tweet-card"; import BrowserOnly from "@docusaurus/BrowserOnly"; import { cn } from "../utils"; +import SearchBar from '@theme/SearchBar'; +import styles from '../components/JupiterSearch.module.css'; +import { PRODUCT_CARDS } from '../constant'; -const JupiterTopics = () => { +const JupiterSearch = () => { return ( -
    -
    - Quick Start -
    - -
    - {/* - Welcome to Solana - */} - - - Jup Research - - - Governance - - {/* - J.U.P Governance - */} - {/* - Ecosystem Token List - */} +
    +
    +
    ); }; -const JupiterProducts = () => { +const JupiterExplore = () => { return ( -
    -
    - Jupiter Products -
    -
    -
    - - - - - - - -
    - +
    +
    +
    +
    +

    Product

    +

    + Best crypto products. +

    +

    + Trade seamlessly with the best tools from spot to meme to leveraged products. +

    -
    - + - - +
    +
    +

    Development

    +

    + Build world class applications. +

    +

    + Tap into our infrastructure to build your own bots, products and more. +

    - - +
    +
    +

    Discovery

    +

    + Best community in crypto. +

    +

    + Join the Catdets to learn more about Jupiverse, Solana and the future ahead! +

    - + + Jup.com +
    ); }; -const ChevronRight = ({ width = 14, height = 14 }) => { - return ( - - - - ); -}; - -// const JupiterProjects = () => { +// const JupiterDevelopers = () => { // return ( //
    -//
    -// Projects +//
    +// Developers //
    -//
    +// @@ -389,363 +161,605 @@ const ChevronRight = ({ width = 14, height = 14 }) => { // ); // }; -const JupiterDevelopers = () => { +const JupiterDirectory = () => { return ( -
    -
    - Developers -
    - -
    - - v6 Swap API - - - - Payments API - - - {/* - Limit Orders API - - */} - - Jupiter Terminal - - - - DCA with SDK - - - - Referral Program - - +
    +
    + {PRODUCT_CARDS.map((card, index) => ( +
    +

    {card.title}

    +
    + {card.links.map((link, linkIndex) => ( + + {link.text} + + ))} +
    +
    + ))}
    ); }; - - -const JupiterJupAcronym = () => { +const JupiterCommunity = () => { return ( -
    -
    - {"J.U.P"} -
    -
    - - What is J.U.P - - - - What is J.U.P. (video) - + ); }; -const JupiterCredits = () => { - return ( -
    -
    - The Best On-Chain Exchange -
    +// const JupiterProducts = () => { +// return ( +//
    +//
    +// Directory +//
    +//
    +//
    +// -
    -
    - -
    - -
    -
    - Jeremy Allaire (@jerallaire) -
    -
    - 5:20 PM · Nov 15, 2023 -
    -
    -
    -
    -
    - I am super impressed with -
    -     - @JupiterExchange - - on - - @solana - - - . Truly excellent UX and features. An example of maturation in - a range of infrastructure -- wallets, usdc on solana liquidity - and availability, and product execution. - -
    -
    - -
    +//
    +// +//
    +// +//
    +// +//
    +// -
    - -
    - -
    -
    - Topo Gigio (@TopoGigio_sol) -
    -
    - 10:36 PM · Dec 21, 2023 -
    -
    -
    -
    -
    - Did you know?: - - @JupiterExchange - +//
    +// +//
    +// +// -
    - {" "} - has a bridge feature? Where it will compare rates and find you - the most efficient path to $SOL Jupiter, for me, is the single - most important app on $SOL -
    - It is our Grand Central Station. -
    - Love at first swap -
    - GM -
    -
    -
    - -
    +// +//
    +//
    +//
    +// ); +// }; -
    - -
    - -
    -
    - Abbas (@abbassshaikh42) -
    -
    - 4:28 PM · Dec 16, 2023 -
    -
    -
    -
    -
    - - Tell me this isn't a gorgeous fucking product by{" "} - - - @JupiterExchange - -

    - This would previously require me to use a slow, redacted CEX - that requires KYC and requires me to handover custody of my - assets. -

    -

    - The performant chain thesis is simple: When your base layer - does not require weeks and months of development efforts - purely directed towards gas/fee optimizations, you allow your - builders to innovate and focus purely on the product & they - make the magic happen -

    -
    -
    - -
    -
    -
    - ); -}; +// const ChevronRight = ({ width = 14, height = 14 }) => { +// return ( +// +// +// +// ); +// }; + +// const JupiterJupAcronym = () => { +// return ( +// +// ); +// }; + +// const JupiterCredits = () => { +// return ( +//
    +//
    +// The Best On-Chain Exchange +//
    + +//
    +//
    +// +//
    +// +//
    +//
    +// Jeremy Allaire (@jerallaire) +//
    +//
    +// 5:20 PM · Nov 15, 2023 +//
    +//
    +//
    +//
    +//
    +// I am super impressed with +//
    +//     +// @JupiterExchange +// +// on +// +// @solana +// +// +// . Truly excellent UX and features. An example of maturation in +// a range of infrastructure -- wallets, usdc on solana liquidity +// and availability, and product execution. +// +//
    +//
    +// +//
    + +//
    +// +//
    +// +//
    +//
    +// Topo Gigio (@TopoGigio_sol) +//
    +//
    +// 10:36 PM · Dec 21, 2023 +//
    +//
    +//
    +//
    +//
    +// Did you know?: +// +// @JupiterExchange +// + +//
    +// {" "} +// has a bridge feature? Where it will compare rates and find you +// the most efficient path to $SOL Jupiter, for me, is the single +// most important app on $SOL +//
    +// It is our Grand Central Station. +//
    +// Love at first swap +//
    +// GM +//
    +//
    +//
    +// +//
    + +//
    +// +//
    +// +//
    +//
    +// Abbas (@abbassshaikh42) +//
    +//
    +// 4:28 PM · Dec 16, 2023 +//
    +//
    +//
    +//
    +//
    +// +// Tell me this isn't a gorgeous fucking product by{" "} +// +// +// @JupiterExchange +// +//

    +// This would previously require me to use a slow, redacted CEX +// that requires KYC and requires me to handover custody of my +// assets. +//

    +//

    +// The performant chain thesis is simple: When your base layer +// does not require weeks and months of development efforts +// purely directed towards gas/fee optimizations, you allow your +// builders to innovate and focus purely on the product & they +// make the magic happen +//

    +//
    +//
    +// +//
    +//
    +//
    +// ); +// }; const Content = () => { return ( -
    +
    -
    -
    +
    +
    - Jupiter Space Station + Getting Started on Jupiter
    -
    - Welcome to the space station — home for catdets curious about Jupiter +
    + Home for Catdets curious about Jupiter
    +
    - - - -
    - -
    -
    -
    - -
    -
    - -
    + +
    +

    Browse by product

    - -
    -
    - -
    -
    - + +
    +

    We'd love to hear from you!

    +
    ); diff --git a/src/theme/Layout/index.js b/src/theme/Layout/index.js new file mode 100644 index 00000000..33ed34c1 --- /dev/null +++ b/src/theme/Layout/index.js @@ -0,0 +1,15 @@ +import React from 'react'; +import Layout from '@theme-original/Layout'; +import { useLocation } from '@docusaurus/router'; +import '../../../src/css/apepro.css'; + +export default function LayoutWrapper(props) { + const location = useLocation(); + const isApePro = location.pathname.includes('/apepro'); + + return ( +
    + +
    + ); +} \ No newline at end of file diff --git a/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx b/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx index e26e1500..29754681 100644 --- a/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx +++ b/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx @@ -21,13 +21,55 @@ export default function NavbarMobilePrimaryMenu(): JSX.Element { return (
      - {navbarItems.map((item, i) => ( -
    • - - {item.label} - -
      • - ))} + {navbarItems.map((item) => { + if (item.items) { + const isActive = location.pathname.startsWith(item.to) || + item.items.some(subItem => location.pathname.startsWith(subItem.to)); + + return ( +
    • + + {item.label} + + +
      • + ); + } + + return ( +
    • + + {item.label} + +
      • + ); + })}
    ); } diff --git a/src/theme/Navbar/index.tsx b/src/theme/Navbar/index.tsx index 682d4766..8edf96c3 100644 --- a/src/theme/Navbar/index.tsx +++ b/src/theme/Navbar/index.tsx @@ -4,10 +4,12 @@ import NavbarLayout from '@theme/Navbar/Layout'; import { useLocation } from '@docusaurus/router'; import clsx from 'clsx'; import MobileSidebarToggle from '@theme/Navbar/MobileSidebar/Toggle'; +import SearchBar from '@theme/SearchBar'; import { navbarConfigs } from '../../constant'; function CustomNavbarContent() { const location = useLocation(); + const isHomePage = location.pathname === '/'; // Determine which navbar config to use based on the current path const navbarItems = Object.keys(navbarConfigs).reduce((acc, path) => { @@ -20,25 +22,74 @@ function CustomNavbarContent() { }, []); return ( -
    - {navbarItems.length > 0 ? ( - navbarItems.map((item) => ( - - {item.label} - - )) - ) : ( - No items to display // Fallback message - )} -
    + <> +
    + {navbarItems.length > 0 ? ( + navbarItems.map((item) => { + if (item.items) { + // Render a dropdown + return ( + + ); + } + + // Render a standard link + return ( + + {item.label} + + ); + }) + ) : ( + No items to display // Fallback message + )} +
    +
    + {!isHomePage && ( +
    + +
    + )} +
    + ); } diff --git a/static/apepro/apepro-logo.svg b/static/apepro/apepro-logo.svg new file mode 100644 index 00000000..e95121e9 --- /dev/null +++ b/static/apepro/apepro-logo.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/static/apepro/apepro-mobile.mp4 b/static/apepro/apepro-mobile.mp4 new file mode 100644 index 00000000..17ff02d1 Binary files /dev/null and b/static/apepro/apepro-mobile.mp4 differ diff --git a/static/apepro/buy-sell-modal.png b/static/apepro/buy-sell-modal.png new file mode 100644 index 00000000..60aa7df8 Binary files /dev/null and b/static/apepro/buy-sell-modal.png differ diff --git a/static/apepro/deposit.png b/static/apepro/deposit.png new file mode 100644 index 00000000..8d329deb Binary files /dev/null and b/static/apepro/deposit.png differ diff --git a/static/apepro/explore.png b/static/apepro/explore.png new file mode 100644 index 00000000..fa52d296 Binary files /dev/null and b/static/apepro/explore.png differ diff --git a/static/apepro/hunt-gems.png b/static/apepro/hunt-gems.png new file mode 100644 index 00000000..5ad804e1 Binary files /dev/null and b/static/apepro/hunt-gems.png differ diff --git a/static/apepro/leaderboard.png b/static/apepro/leaderboard.png new file mode 100644 index 00000000..07013f9e Binary files /dev/null and b/static/apepro/leaderboard.png differ diff --git a/static/apepro/limit-order-explainer.png b/static/apepro/limit-order-explainer.png new file mode 100644 index 00000000..1a2754b4 Binary files /dev/null and b/static/apepro/limit-order-explainer.png differ diff --git a/static/apepro/limit-order.png b/static/apepro/limit-order.png new file mode 100644 index 00000000..f9961e42 Binary files /dev/null and b/static/apepro/limit-order.png differ diff --git a/static/apepro/login.png b/static/apepro/login.png new file mode 100644 index 00000000..914c3046 Binary files /dev/null and b/static/apepro/login.png differ diff --git a/static/apepro/portfolio.png b/static/apepro/portfolio.png new file mode 100644 index 00000000..f60de99c Binary files /dev/null and b/static/apepro/portfolio.png differ diff --git a/static/apepro/quick-buy.png b/static/apepro/quick-buy.png new file mode 100644 index 00000000..801079c5 Binary files /dev/null and b/static/apepro/quick-buy.png differ diff --git a/static/apepro/referral.png b/static/apepro/referral.png new file mode 100644 index 00000000..ab8e8c2b Binary files /dev/null and b/static/apepro/referral.png differ diff --git a/static/apepro/search.png b/static/apepro/search.png new file mode 100644 index 00000000..6db27d6f Binary files /dev/null and b/static/apepro/search.png differ diff --git a/static/apepro/share.png b/static/apepro/share.png new file mode 100644 index 00000000..debeaacf Binary files /dev/null and b/static/apepro/share.png differ diff --git a/static/apepro/token-profile.png b/static/apepro/token-profile.png new file mode 100644 index 00000000..01ed9ba6 Binary files /dev/null and b/static/apepro/token-profile.png differ diff --git a/static/apepro/trade-settings.png b/static/apepro/trade-settings.png new file mode 100644 index 00000000..ac30f29f Binary files /dev/null and b/static/apepro/trade-settings.png differ diff --git a/static/apepro/withdraw.png b/static/apepro/withdraw.png new file mode 100644 index 00000000..26bd7df8 Binary files /dev/null and b/static/apepro/withdraw.png differ diff --git a/static/jupsol/jupsol.png b/static/jupsol/jupsol.png new file mode 100644 index 00000000..003ea5e5 Binary files /dev/null and b/static/jupsol/jupsol.png differ diff --git a/static/lock/lock-walkthrough.mp4 b/static/lock/lock-walkthrough.mp4 new file mode 100644 index 00000000..03e1281b Binary files /dev/null and b/static/lock/lock-walkthrough.mp4 differ diff --git a/static/onboard/onramp.png b/static/onboard/onramp.png new file mode 100644 index 00000000..7ab1885f Binary files /dev/null and b/static/onboard/onramp.png differ diff --git a/static/perps/dove-oracle.png b/static/perps/dove-oracle.png new file mode 100644 index 00000000..79d98529 Binary files /dev/null and b/static/perps/dove-oracle.png differ diff --git a/static/perps/dual-slope-borrow-fee.png b/static/perps/dual-slope-borrow-fee.png new file mode 100644 index 00000000..cfbb58a3 Binary files /dev/null and b/static/perps/dual-slope-borrow-fee.png differ diff --git a/static/perps/hourly-borrow-fee.png b/static/perps/hourly-borrow-fee.png new file mode 100644 index 00000000..431d9d46 Binary files /dev/null and b/static/perps/hourly-borrow-fee.png differ diff --git a/static/perps/jlp-economics-aum-losses.png b/static/perps/jlp-economics-aum-losses.png new file mode 100644 index 00000000..200938ed Binary files /dev/null and b/static/perps/jlp-economics-aum-losses.png differ diff --git a/static/perps/jlp-economics-aum-profits.png b/static/perps/jlp-economics-aum-profits.png new file mode 100644 index 00000000..c6ba9070 Binary files /dev/null and b/static/perps/jlp-economics-aum-profits.png differ diff --git a/static/perps/jlp-economics-aum-stable.png b/static/perps/jlp-economics-aum-stable.png new file mode 100644 index 00000000..dd1953ea Binary files /dev/null and b/static/perps/jlp-economics-aum-stable.png differ diff --git a/static/perps/jlp-economics-global-short-positions-unrealised-pnl.png b/static/perps/jlp-economics-global-short-positions-unrealised-pnl.png new file mode 100644 index 00000000..59f4dd68 Binary files /dev/null and b/static/perps/jlp-economics-global-short-positions-unrealised-pnl.png differ diff --git a/static/perps/jlp-economics-guaranteed-usd.png b/static/perps/jlp-economics-guaranteed-usd.png new file mode 100644 index 00000000..d45d0dba Binary files /dev/null and b/static/perps/jlp-economics-guaranteed-usd.png differ diff --git a/static/perps/jlp-economics-market-price.png b/static/perps/jlp-economics-market-price.png new file mode 100644 index 00000000..ec556ff1 Binary files /dev/null and b/static/perps/jlp-economics-market-price.png differ diff --git a/static/perps/jlp-economics-nav.png b/static/perps/jlp-economics-nav.png new file mode 100644 index 00000000..c111f2eb Binary files /dev/null and b/static/perps/jlp-economics-nav.png differ diff --git a/static/perps/jlp-economics-total-aum.png b/static/perps/jlp-economics-total-aum.png new file mode 100644 index 00000000..18aa2a23 Binary files /dev/null and b/static/perps/jlp-economics-total-aum.png differ diff --git a/static/perps/jlp-economics-tvl-aum-limit.png b/static/perps/jlp-economics-tvl-aum-limit.png new file mode 100644 index 00000000..95978db6 Binary files /dev/null and b/static/perps/jlp-economics-tvl-aum-limit.png differ diff --git a/static/perps/jlp-economics-virtual-price.png b/static/perps/jlp-economics-virtual-price.png new file mode 100644 index 00000000..f63e2cb7 Binary files /dev/null and b/static/perps/jlp-economics-virtual-price.png differ diff --git a/static/perps/jlp-long-scenarios.png b/static/perps/jlp-long-scenarios.png new file mode 100644 index 00000000..61fd2068 Binary files /dev/null and b/static/perps/jlp-long-scenarios.png differ diff --git a/static/perps/jlp-revenue.png b/static/perps/jlp-revenue.png new file mode 100644 index 00000000..c72e872e Binary files /dev/null and b/static/perps/jlp-revenue.png differ diff --git a/static/perps/jlp-share.png b/static/perps/jlp-share.png new file mode 100644 index 00000000..0ceee742 Binary files /dev/null and b/static/perps/jlp-share.png differ diff --git a/static/perps/jlp-short-scenarios.png b/static/perps/jlp-short-scenarios.png new file mode 100644 index 00000000..70473c8c Binary files /dev/null and b/static/perps/jlp-short-scenarios.png differ diff --git a/static/perps/jlp-target-weight-balancing.jpg b/static/perps/jlp-target-weight-balancing.jpg new file mode 100644 index 00000000..409d92de Binary files /dev/null and b/static/perps/jlp-target-weight-balancing.jpg differ diff --git a/static/perps/jlp-weightage.png b/static/perps/jlp-weightage.png new file mode 100644 index 00000000..af1c7c7b Binary files /dev/null and b/static/perps/jlp-weightage.png differ diff --git a/static/perps/keeper.png b/static/perps/keeper.png new file mode 100644 index 00000000..aa8edf1c Binary files /dev/null and b/static/perps/keeper.png differ diff --git a/static/perps/long-formula.png b/static/perps/long-formula.png new file mode 100644 index 00000000..5ccf7c41 Binary files /dev/null and b/static/perps/long-formula.png differ diff --git a/static/perps/price-impact-fee-formula.png b/static/perps/price-impact-fee-formula.png new file mode 100644 index 00000000..f8b5f63f Binary files /dev/null and b/static/perps/price-impact-fee-formula.png differ diff --git a/static/perps/price-impact-fee-graph.png b/static/perps/price-impact-fee-graph.png new file mode 100644 index 00000000..cf80ae6d Binary files /dev/null and b/static/perps/price-impact-fee-graph.png differ diff --git a/static/perps/short-formula.png b/static/perps/short-formula.png new file mode 100644 index 00000000..ea5b692c Binary files /dev/null and b/static/perps/short-formula.png differ diff --git a/static/perps/trade-close-position-confirm.png b/static/perps/trade-close-position-confirm.png new file mode 100644 index 00000000..2307eeaa Binary files /dev/null and b/static/perps/trade-close-position-confirm.png differ diff --git a/static/perps/trade-close-position-size.png b/static/perps/trade-close-position-size.png new file mode 100644 index 00000000..c4fc0e48 Binary files /dev/null and b/static/perps/trade-close-position-size.png differ diff --git a/static/perps/trade-close-position-token.png b/static/perps/trade-close-position-token.png new file mode 100644 index 00000000..06240bfc Binary files /dev/null and b/static/perps/trade-close-position-token.png differ diff --git a/static/perps/trade-close-position.png b/static/perps/trade-close-position.png new file mode 100644 index 00000000..93a1f6f5 Binary files /dev/null and b/static/perps/trade-close-position.png differ diff --git a/static/perps/trade-connect-wallet.png b/static/perps/trade-connect-wallet.png new file mode 100644 index 00000000..cbd9dffb Binary files /dev/null and b/static/perps/trade-connect-wallet.png differ diff --git a/static/perps/trade-input-token-selector.png b/static/perps/trade-input-token-selector.png new file mode 100644 index 00000000..1ca5596d Binary files /dev/null and b/static/perps/trade-input-token-selector.png differ diff --git a/static/perps/trade-leverage-slider.png b/static/perps/trade-leverage-slider.png new file mode 100644 index 00000000..a287af18 Binary files /dev/null and b/static/perps/trade-leverage-slider.png differ diff --git a/static/perps/trade-long-short-selector.png b/static/perps/trade-long-short-selector.png new file mode 100644 index 00000000..0ee6fcf1 Binary files /dev/null and b/static/perps/trade-long-short-selector.png differ diff --git a/static/perps/trade-manage-collateral.png b/static/perps/trade-manage-collateral.png new file mode 100644 index 00000000..3a936181 Binary files /dev/null and b/static/perps/trade-manage-collateral.png differ diff --git a/static/perps/trade-manage-tp-sl-valid-prices.png b/static/perps/trade-manage-tp-sl-valid-prices.png new file mode 100644 index 00000000..038a8507 Binary files /dev/null and b/static/perps/trade-manage-tp-sl-valid-prices.png differ diff --git a/static/perps/trade-manage-tp-sl.png b/static/perps/trade-manage-tp-sl.png new file mode 100644 index 00000000..4a94f31f Binary files /dev/null and b/static/perps/trade-manage-tp-sl.png differ diff --git a/static/perps/trade-perp-token-selector.png b/static/perps/trade-perp-token-selector.png new file mode 100644 index 00000000..8a8f7f3c Binary files /dev/null and b/static/perps/trade-perp-token-selector.png differ diff --git a/static/perps/trade-position-details.png b/static/perps/trade-position-details.png new file mode 100644 index 00000000..dd7e9191 Binary files /dev/null and b/static/perps/trade-position-details.png differ diff --git a/static/perps/trade-review-position.png b/static/perps/trade-review-position.png new file mode 100644 index 00000000..b8f132ca Binary files /dev/null and b/static/perps/trade-review-position.png differ diff --git a/static/perps/trade-submit-position.png b/static/perps/trade-submit-position.png new file mode 100644 index 00000000..b329187a Binary files /dev/null and b/static/perps/trade-submit-position.png differ diff --git a/static/spot/dca/dca-100-1.png b/static/spot/dca/dca-100-1.png new file mode 100644 index 00000000..33fc858d Binary files /dev/null and b/static/spot/dca/dca-100-1.png differ diff --git a/static/spot/dca/dca-100-2.png b/static/spot/dca/dca-100-2.png new file mode 100644 index 00000000..7dd6d9c8 Binary files /dev/null and b/static/spot/dca/dca-100-2.png differ diff --git a/static/spot/dca/dca-100-3.png b/static/spot/dca/dca-100-3.png new file mode 100644 index 00000000..6fe80506 Binary files /dev/null and b/static/spot/dca/dca-100-3.png differ diff --git a/static/spot/dca/dca-100-4.png b/static/spot/dca/dca-100-4.png new file mode 100644 index 00000000..3a7ee913 Binary files /dev/null and b/static/spot/dca/dca-100-4.png differ diff --git a/static/spot/dca/dca-100-5.png b/static/spot/dca/dca-100-5.png new file mode 100644 index 00000000..1289e1a3 Binary files /dev/null and b/static/spot/dca/dca-100-5.png differ diff --git a/static/spot/dca/dca-100-6.png b/static/spot/dca/dca-100-6.png new file mode 100644 index 00000000..3822c01a Binary files /dev/null and b/static/spot/dca/dca-100-6.png differ diff --git a/static/spot/dca/dca-101-1.png b/static/spot/dca/dca-101-1.png new file mode 100644 index 00000000..f4fe1461 Binary files /dev/null and b/static/spot/dca/dca-101-1.png differ diff --git a/static/spot/dca/dca-101-2.png b/static/spot/dca/dca-101-2.png new file mode 100644 index 00000000..c02f9c41 Binary files /dev/null and b/static/spot/dca/dca-101-2.png differ diff --git a/static/spot/dca/dca-102-1.png b/static/spot/dca/dca-102-1.png new file mode 100644 index 00000000..00253d44 Binary files /dev/null and b/static/spot/dca/dca-102-1.png differ diff --git a/static/spot/dca/dca-2-1.png b/static/spot/dca/dca-2-1.png new file mode 100644 index 00000000..bc439463 Binary files /dev/null and b/static/spot/dca/dca-2-1.png differ diff --git a/static/spot/dca/dca-2-2.png b/static/spot/dca/dca-2-2.png new file mode 100644 index 00000000..44fe57f5 Binary files /dev/null and b/static/spot/dca/dca-2-2.png differ diff --git a/static/spot/dca/dca-2-3.png b/static/spot/dca/dca-2-3.png new file mode 100644 index 00000000..621d1774 Binary files /dev/null and b/static/spot/dca/dca-2-3.png differ diff --git a/static/spot/limit-order/limit-order-active.png b/static/spot/limit-order/limit-order-active.png new file mode 100644 index 00000000..90a333b0 Binary files /dev/null and b/static/spot/limit-order/limit-order-active.png differ diff --git a/static/spot/limit-order/limit-order-connect.png b/static/spot/limit-order/limit-order-connect.png new file mode 100644 index 00000000..1a34470a Binary files /dev/null and b/static/spot/limit-order/limit-order-connect.png differ diff --git a/static/spot/limit-order/limit-order-education-video.mp4 b/static/spot/limit-order/limit-order-education-video.mp4 new file mode 100644 index 00000000..26decf2c Binary files /dev/null and b/static/spot/limit-order/limit-order-education-video.mp4 differ diff --git a/static/spot/limit-order/limit-order-form-setup.png b/static/spot/limit-order/limit-order-form-setup.png new file mode 100644 index 00000000..3fd35641 Binary files /dev/null and b/static/spot/limit-order/limit-order-form-setup.png differ diff --git a/static/spot/limit-order/limit-order-form.png b/static/spot/limit-order/limit-order-form.png new file mode 100644 index 00000000..6e6d9727 Binary files /dev/null and b/static/spot/limit-order/limit-order-form.png differ diff --git a/static/spot/limit-order/limit-order-history.png b/static/spot/limit-order/limit-order-history.png new file mode 100644 index 00000000..6aa0c905 Binary files /dev/null and b/static/spot/limit-order/limit-order-history.png differ diff --git a/static/spot/limit-order/limit-order-manage-active.png b/static/spot/limit-order/limit-order-manage-active.png new file mode 100644 index 00000000..3475b8d2 Binary files /dev/null and b/static/spot/limit-order/limit-order-manage-active.png differ diff --git a/static/spot/limit-order/limit-order-manage-history.png b/static/spot/limit-order/limit-order-manage-history.png new file mode 100644 index 00000000..2f802749 Binary files /dev/null and b/static/spot/limit-order/limit-order-manage-history.png differ diff --git a/static/spot/limit-order/limit-order-stop-loss.png b/static/spot/limit-order/limit-order-stop-loss.png new file mode 100644 index 00000000..eae79d64 Binary files /dev/null and b/static/spot/limit-order/limit-order-stop-loss.png differ diff --git a/static/spot/limit-order/limit-order-summary.png b/static/spot/limit-order/limit-order-summary.png new file mode 100644 index 00000000..fb8b7c47 Binary files /dev/null and b/static/spot/limit-order/limit-order-summary.png differ diff --git a/static/spot/limit-order/limit-order-tokens.png b/static/spot/limit-order/limit-order-tokens.png new file mode 100644 index 00000000..59625755 Binary files /dev/null and b/static/spot/limit-order/limit-order-tokens.png differ diff --git a/static/spot/limit-order/limit-order-transactions.png b/static/spot/limit-order/limit-order-transactions.png new file mode 100644 index 00000000..4d1c1f9e Binary files /dev/null and b/static/spot/limit-order/limit-order-transactions.png differ diff --git a/static/spot/swap/Metis.png b/static/spot/swap/Metis.png new file mode 100644 index 00000000..9d9ab97d Binary files /dev/null and b/static/spot/swap/Metis.png differ diff --git a/static/spot/swap/Overview.png b/static/spot/swap/Overview.png new file mode 100644 index 00000000..5762432f Binary files /dev/null and b/static/spot/swap/Overview.png differ diff --git a/static/spot/swap/price-impact-criteria.jpg b/static/spot/swap/price-impact-criteria.jpg new file mode 100644 index 00000000..478bd199 Binary files /dev/null and b/static/spot/swap/price-impact-criteria.jpg differ