# Introduction
Nemo Protocol is a decentralized finance application. We enable users to trade and manage yield positions. We also provide innovative solutions for maximizing returns and managing risks in the yield market.
Learn more about the technical details [Getting Started](/tutorial/getting-started)
# Glossary
**Yield-bearing Token -** Any token that could generate yields. For example sSUI / sUSDC sUSDT on Scallop, vSUI on Volo.
**Underlying Asset / Underlying Token** - A underlying asset /token is the token that the yield-bearing token represents. For example the underlying asset for sSUI is SUI deposited in Scallop; and the underlying asset for vSUI is the SUI staked in Volo.
**Underlying Yield / Underlying APY -** The current yield / APY of the underlying token. The underlying APY of sSUI is 5% means that currently the APY for depositing SUI in Scallop is 5%.
**Maturity -** On Nemo, every PT / YT has a manually set date. So far, only the Nemo team are allowed to create a pool and set the date, which is called maturity. Setting a maturity is to determine a specific date, which helps PT / YT obtain a reasonable pricing from the market.
**PT (Principal Token) -** PT represents the principal component of a yield bearing token. 1 PT gives the right to redeem 1 underlying asset UPON maturity.
**YT (Yield Token) -** YT represents the yield component of a yield bearing token. 1 YT gives the right to continually receiving the yield of 1 underlying asset UNTIL maturity.
**Fixed APY (PT APY)-** The APY that is guaranteed of buying and holding PT upon maturity.
**Leveraged APY (YT APY)-** APY for buying and holding YT until maturity, **assuming** the average future APY is same as the current underlying APY.
# Getting Started
In DeFi world, we often encounter yields that are high or low. These yields fluctuate within a certain range, thereby affecting our earnings.
For example, if you deposited SUI into Scallop in April 2024, the APY was around 20% at that time. While in July 2024, the APY was around 7.5%.
Nemo is here to help you amplify your earnings.
# Yield Tokenization
In traditional DeFi protocol, if you deposits 100 USDC then you will get around 98 sUSDC/ tUSDC/vUSDC as your proof of deposits.
## DeFi Basics
For example if you deposit 100 SUI into Scallop you may get 97 sSUI (more or less), and after 3 months, you could choose to redeem these sSUI to get back your **100 SUI** (principle) and **1.5 SUI & 2 SCA** (yield).
## Yield Tokenization
In Nemo, the staked SUI position can be split into 2 separate parts: PT & YT.
* PT represents the principal component of the staked SUI, it gives you the right to redeem 100 SUI after 3 months.
* YT represents the yield component of the staked SUI, it gives you the right to receive yield continuously during the 3 months.
In the case above, 3 months is called **maturity**. You can learn more terminologies [here](/general/glossary).
# PT
## Definition
**PT (Principal Token) -** PT represents the principal component of a yield bearing token. 1 PT gives the right to redeem 1 underlying asset UPON maturity.
## Pricing
PT's price is always cheaper than the underlying asset, it's because PT doesn't include the yield of underlying asset. Besides, PT's price is determined by markets supply and demand.
For example,
* if 1 SUI = $1
* 1 PT sSUI is always cheaper than $1, it could be $0.98 when market demand is high and $0.92 when market demand is relatively low.
## Fixed Yield
Buying and holding PT offers a **fixed yield**. Because upon maturity, 1 PT is able to redeem 1 underlying token.
For instance, Alice purchases 100 PT sUSDC at $0.9 each, totaling $90. After a one-year maturity period, Alice can redeem these 100 USDC, which have appreciated to a total value of $100.
The effective annual percentage yield (APY) from buying and holding PT for one year is calculated as ($100 - $90) / $90 = **11.11%**. This yield is referred to as the **Fixed Yield**, given its fixed nature.
## Selling PT Earlier
If you purchase PT that matures after 1 year, you are allowed to sell the PT before maturity. Doing so can lock in profits or enhance capital efficiency.
Alice purchases 100 PT sUSDC at $0.9 each, totaling $90. After 180 days, Alice sells the 100 PT sUSDC for $0.94 each due to increased market demand nearing maturity, amounting to $94. The net profit from this trade is $4, resulting in an APY of 9.01%.
## PT Trade Opportunity
Because buying and holding PT profits a fixed yield, it is a good investment target for locking in yields and avoiding fluctuations in APY.
### PT trade in practice
There's a pool on Nemo looks like this:
* sUSDC, maturity 365 days
* Underlying APY 8% - means that currently holding the underlying asset can yield an APY of 8%. Learn more [glossary](/general/glossary).
* PT sUSDC = $0.93
* Fixed APY = 7.78% - If you purchase 1 PT sUSDC for $0.93, after one year you can redeem 1 USDC, resulting in a net profit of $0.07. This calculates to a fixed yield APY of 7.78%.
Although the underlying APY of 8% is slightly higher than the fixed yield of 7.78%, you predict that future average APY may decrease to 5% due to market fluctuations. Therefore, buying and holding PT to lock in 7.78% is a good strategy.
{% hint style="info" %}
To sum up, when you anticipate a decrease in the underlying APY in the future, buying and holding PT allows you to lock in the fixed yield APY, which as known as shorting APY.
{% endhint %}
# YT
## Definition
**YT (Yield Token) -** YT represents the yield component of a yield bearing token. 1 YT gives the right to continually receiving the yield of 1 underlying asset UNTIL maturity.
## Pricing
YT's price is also determined by market supply and demand.
For example,
* If 1 SUI = $1, the current underlying APY is 5%, maturity in 365 days.
* Therefore, the fair price for 1 YT sSUI should be around $0.05, because currently, 1 YT sSUI can receive approximately $0.05 worth of yield from staked sSUI within one year.
## Long Yield / Leveraged Yield
The yield of buying and holding YT is called **Long Yield**, since it essentially bets on the increase of the underlying yield, as known as YT APY.
For example, Bob buys 100 YT sUSDC at a price of $0.05, totaling $5. Over a one-year maturity period, Bob continuously receives yields from 100 staked USDC, totaling $5.5.
The actual APY from buying and holding YT for one year is ($5.5 - $5) / $5 = 10%, known as the YT APY.
## YT Trade Opportunity
Because when APY rises, YT can help you increase your earnings even more, it's a good time to buy YT when you predict that the future underlying APY will be higher than it is now.
### YT trade in practice
There's a pool on Nemo looks like this:
* sUSDC, maturity 365 days
* Underlying APY 5% - means that currently holding the underlying asset can yield an APY of 5%. Learn more [glossary](/general/glossary).
* PT sUSDC = $0.96, Fixed APY = 4.17%
* YT sUSDC = $0.04, Long yield APY = 25%
Based on the above market information, 2 different traders have adopted varying trading strategies:
* Alice buys 40 USDC, spending $40
* Bob buys 1000 YT sUSDC, spending $40
Scenarios
Alice
Bob
If the average underlying APY remains at 5% within the 1-year maturity.
Net Profits: $2
APY: 5%
Net Profits: $10
APY: 25%
If the average of underlying APY increase to 6.5% in the next year
Net Profits: $2.6
APY: 6.5%
Net Profits: $25
APY: 62.5%
If the future APY drops to 3.5%.
Net Profits: $1.4
APY: 3.5%
Net Profits: $-5
APY: -12.5%
{% hint style="info" %}
The calculation of YT's actual profits and APY goes:
* Profits: *Total yield received - total cost of buying YT*
* Actual YT APY: *(Total yield received - total cost of buying YT) / total cost of buying YT*
{% endhint %}
In the example above, we can see that the greater the profits, the greater the accompanying risks. Therefore, the key to YT trading depends on the future fluctuation of underlying APY.
# Yield Trading Strategy
As we are aware, the yield market constantly fluctuates, including both Fixed Yield and Leveraged Yield. Based on market conditions, you can opt to switch between PT and YT positions to maximize your APY earnings.
## Yield Trade in Practice
For example, on 1st Jan, 2024, there's a pool on Nemo looks like this
Through observation and understanding of the market, Alice thinks that the average underlying APY in the following period will be 5.5%, which is higher than the current 5%. So she chooses to purchase 10,000 YT at a cost of $460.
During these 120 days, with an average underlying APY of 5.1%, Alice received a total of $167.67 in yield. Alongside the value of all her YTs at $380, her total assets amounted to $547.67. The trading profit from the previous transaction was $546.67 - $460 = $86.67, yielding an APY of 57%!
Then, Alice sensed the onset of a bear market (typically characterized by a decline in APY). Anticipating that the underlying APY would drop below 5% in the upcoming period, she decided to sell all her YT and purchase PT to secure the current 5.26% yield. Therefore, she bought 569.3 PT sSUI with all her $547.67.
Alice holds 569.3 PT for another 120 days, and then the market looks like this:
Sure enough, the underlying APY dropped to 4.5%. However, since all of Alice's assets were PT and the price of PT rose to $0.985, her total assets were $560.76. Therefore, the previous transaction brought her a profit of $13.09 up to now, and its APY was 7.27%!
{% hint style="info" %}
After these two trades, Alice made a total of $100.76 in 240 days. Converted to APY, it was 33.31%!
{% endhint %}
Alice was very satisfied, cleared all her positions, and waited for the next entry opportunity.
## Conclusion
In summary, yield trading is a highly effective strategy for capturing additional profits regardless of whether the APY market is bullish or bearish.
* **If you anticipate a decrease in APY, Buy PT / Sell YT = Short APY.**
* **If you expect APY to rise, Sell PT / Buy YT = Long APY.**
Lastly, always remember that every trade involves risks alongside opportunities. If you prefer lower risk, trading PT may be suitable for you. If you are a risk-taker, then trading YT might be more appealing.
# Fees
Two types of fees will be charged on the Nemo Protocol, both of which will be distributed to NEMO token stakers. Details on the distribution will be coming soon.
## PT Swap Fees
Similar to other AMM-based DeFi projects, Nemo will have different fees for different pools. What makes Nemo's fee structure more reasonable is that the fees decrease as the maturity date approaches. Since shorter maturity times mean lower yields, Nemo's fees will also decrease accordingly. The specific fees can be viewed in the Swap section of the app.
## YT Swap Fees
**In Nemo's AMM, purchasing YT is executed as a flash swap (where the fee is typically multiple times higher than a standard PT swap). For example:**
Suppose you use **1 USDC** to buy **10 YT sUSDC**. The process works as follows:
1. **Borrow 9 USDC** from the Nemo Pool.
2. Combine it with your **1 USDC** to mint **10 PT + 10 YT**.
3. Sell the **10 PT** back into the pool.
4. Keep the **10 YT** as the output.
Thus, in this example, **the swap fee for YT equals the fee incurred when selling the 10 PT back to the pool.**
## YT yield Fees
Nemo collects 5% of all YT yields as a protocol fee.
# Liquidity Provider(LP)
### Introduction
As a Liquidity Provider (LP), you play a crucial role in Nemo ecosystem by supplying liquidity to the protocol. This document provides essential details about being an LP, including the benefits, requirements, and processes involved.
### What is a Liquidity Provider?
A Liquidity Provider is an individual or entity that supplies assets to a liquidity pool, enabling users to trade seamlessly within the Nemo Protocol ecosystem. By providing liquidity, you help maintain market stability and enhance the trading experience for all users.
Nemo's LP consists of the underlying asset and its corresponding PT token, for example sSUI-PT sSUI. There are two modes for adding liquidity:
* Single-Coin: In this mode, users add liquidity using only the underlying asset. For example, by using sSUI. Nemo will assist users by converting a portion of the underlying asset into PT according to the pool's ratio and complete the provision.
* Multi-Coin: In this mode, users add liquidity using both the underlying asset and PT. For example, using sSUI and PT sSUI. During this process, Nemo will not perform any swaps.
### Why to be a LP?
As an LP of Nemo, there are multiple benefits:
#### **Yield rewards**
The yield for Nemo LPs comes from various sources, typically consisting of the following components:
* Underlying Yield: the yield generated by underlying assets, eg. sSUI.
* Fixed Yield: the fixed yield from PT.
* Swap Fee
* $NEMO Incentives
#### **No impermanent loss (IL)**
Unlike traditional AMM models, there may be short-term price fluctuations in Nemo, but at the maturity, **there is no IL**, the technical breakdown is as below:
At maturity, the PT can be exchanged for the underlying asset (as detailed in [the definition of PT](/tutorial/pt)). Therefore, the LP composed of PT and the underlying asset will both become the underlying asset at maturity.
* For example, a sUSDC pool composed of PT sUSDC & sUSDC. At maturity, these will both be claimed as USDC.
Although LPs may still experience value loss due to price fluctuations in the short term(before maturity), there will be no issue of impermanent loss at maturity. In other words, the longer LPs stay in the pool, the better the performance of their asset appreciation will be.
#### **No lock-up period**
As a Nemo LP, you can withdraw at any time. While as recommended, there might be slight value loss in short term, so it's always recommended to hold LP positions longer to maturity which will maximize your capital efficiency.
# Add Liquidity
**Steps for adding liquidity**
1. **Connect Your Wallet**
* Open the Nemo Protocol app and connect your preferred Web3 wallet (e.g., Sui Wallet.
* Ensure you have sufficient funds in your wallet for the tokens you want to deposit.
2. **Navigate to the "Pool" Section**
* Click on the **"Pool"** or **"Liquidity"** tab in the main menu.
3. **Select the Token**
* Choose the token you want to provide liquidity for (e.g., SUI/sSUI).
* Enter the amount and then Nemo will calculate the output automatically.
{% hint style="info" %}
When adding liquidity with the underlying token (eg. SUI), a portion of SUI will be swapped into PT to form a pair and deposited into the pool. However, when adding a large amount of liquidity, excessive slippage from the swap may cause the system to automatically switch to an alternative method: using part of the SUI to mint PT and YT, then combining PT + SUI to provide liquidity. The remaining YT will be returned to the user.
{% endhint %}
4. **Approve & Receive LP NFT**
* Click **"Approve"** to grant the protocol permission to access your tokens (requires a wallet confirmation).
* After approval, click **"Add Liquidity"** and confirm the transaction in your wallet.
* Once the transaction is confirmed, you’ll receive **LP (Liquidity Provider) NFT** representing your share of the pool.
# Remove Liquidity
**Steps for removing liquidity**
1. **Go to the "Portfolio" Section**
* Open the **"LP"** tab where your active positions are displayed.
2. **Click the "Remove" button**
* Find the liquidity pool you want to withdraw from and click **"Remove Liquidity"**.
3. **Choose Withdrawal Amount**
* Enter the amount of LP Tokens you want to remove.
* The interface will show the equivalent amounts of tokens you’ll receive.
{% hint style="info" %}
When removing liquidity, the amount returned to the user is determined based on the current ratio of PT and yield-bearing assets in the liquidity pool. For example: Removing **100 LP** might return **10 sSUI + 12 PT**.
The returned **PT** can be:
* Sold on the **Market**,
* Redeemed [**here**](https://www.nemoprotocol.com/#/mint/redeem) 1:1 with **YT**, or
* Held until maturity for redemption.
{% endhint %}
4. **Confirm Removal**
* Click **"Remove Liquidity"** and approve the transaction in your wallet.
# LP FAQ
1. **What is Nemo LP?**\
Liquidity Provider (LP): A role that provides liquidity for traders exchanging PT and YT on Nemo, earning income such as transaction fees.
2. **How to provide liquidity?**\
The liquidity pool consists of yield-bearing assets and PT. You can add liquidity using either the underlying asset or the yield-bearing asset. For example, in the sSUI - PT sSUI pool, you can use either SUI or sSUI. Click [here](/tutorial/liquidity-provider-lp/add-liquidity) for details.
3. **What are the benefits of being an LP?**
* Underlying APY & PT APY: Since the LP is composed of yield-bearing assets and PT, you will benefit from the underlying APY of the yield-bearing assets and the APY of PT.
* Fee: LPs receive transaction fees from swaps.
* Nemo Points: LPs earn Nemo Points.
* Incentives: LPs receive additional incentives from Nemo or other protocols.
4. **What is the specific workflow when adding liquidity?**\
Taking sSUI as an example: Since the pool consists of PT sSUI and sSUI, when adding liquidity using SUI, Nemo will first convert SUI into sSUI through Scallop. Then, a portion of the sSUI will be swapped/minted into PT, and the remaining sSUI will be paired with it to form the liquidity pair added to the pool.
5. **Why do I receive YT when adding liquidity?**\
When adding liquidity, a portion of the yield-bearing assets needs to be swapped into PT. If there is insufficient liquidity in the pool and not enough PT is available, the second mode of adding liquidity will be used: the yield-bearing assets are minted into PT and YT, and then the PT is paired with the yield-bearing assets to form the LP.
6. **Why is there no Impermanent Loss (IL) for Nemo LPs?**\
Since the PT and yield-bearing assets in the LP are backed by the same underlying asset, there is no impermanent loss.
7. **How to remove liquidity?**\
When removing liquidity, a portion of the PT will be transferred to your portfolio. If the PT has matured, you can directly claim the matured PT. If it has not yet matured, you can either sell the PT in the market or recombine it 1:1 with YT to convert it back into the yield-bearing asset.
# Nemo Points
Nemo Protocol highly values its early supporters, and rewards LP, PT& YT holders, and traders, with Nemo Points. These points will serve as a proof of engagement for future airdrops.
### **Eligibility**
Nemo will periodically adjust eligibility criteria to establish more sustainable and protocol-friendly reward mechanisms. Normally, these three roles are eligible to earn Nemo Points (specific point allocations will be displayed in the App).
* **LP Holders**: Liquidity providers (LPs) who supply assets to the Nemo Protocol will earn Nemo Points based on the amount and duration of liquidity provided.
* **PT and YT Holders**: Holders of Principal Tokens (PT) and Yield Tokens (YT) are eligible for Nemo Points according to the amount of tokens held and the holding period.
* **Traders**: Active traders on the Nemo Protocol will receive Nemo Points based on trading volume and activity level.
### **Distribution Frequency**
Nemo Points will be distributed every **24 hours** to eligible participants based on their activities within the protocol during that period.
### **Calculation Method**
At this stage, Nemo Points are rewarded to Nemo's LPs, but in the future, they may also be distributed to PT and YT holders or users who have conducted transactions within Nemo, depending on the protocol's development needs.
The exact number of points awarded may fluctuate periodically to ensure the health of the protocol. You can find more details on the distribution page.
### **Points Usage**
Nemo Points can’t be traded or sold. They are **non-transferable** and are intended to serve as an indicator of contribution to the protocol. These points will be a key qualification for **future airdrops** and additional rewards as the protocol grows.
### **Expiration**
Nemo Points do not expire, but they can only be redeemed for specific future rewards, such as airdrops, within certain windows announced by the protocol.
# Introduction
Nemo Vaults are automated yield strategy vaults built on the Nemo Protocol.\
You can think of them as a tireless, expert on-chain fund manager. Users do not need to have complex DeFi knowledge or perform frequent manual operations. Simply deposit a supported asset (such as a Momentum LP token) into the corresponding vault, and the vault will automatically execute a series of optimized strategies, such as auto-compounding and dynamic rebalancing, designed to capture maximized compound returns for your assets.
Nemo Protocol plans to offer two types of vaults to meet the risk preferences and asset needs of different users.
* LP Vaults This is the current core product of Nemo Vaults. Users can deposit LP tokens from third-party DEXs (e.g., suiUSDT-USDC LP on Momentum). The vault will then execute auto-compounding and dynamic rebalancing strategies around these LP positions.
* Single Token Vaults (Coming Soon) These vaults will allow users to deposit single assets directly (e.g., SUI, USDC, suiUSDT). The vault will deploy these funds into optimal, risk-managed external protocols (such as Lending Protocols, CDP Protocols, etc.) to generate yield and perform auto-compounding.
# Core Advantages
Compared to manually providing liquidity on a DEX, Nemo Vaults offer the following core advantages:
* One-Click, Effortless Management Users only need to perform two actions: "Deposit" and "Withdraw." All the tedious tasks like harvesting rewards, selling them, and reinvesting are handled automatically by the vault, saving you valuable time and effort.
* Auto-Compounding for Snowballing Returns The vault automatically reinvests farming rewards and trading fees into your principal at an optimal frequency. This creates a "compounding interest" effect, leading to a much higher Annual Percentage Yield (APY) than manual operations.
* Smart Dynamic Rebalancing for Enhanced Capital Efficiency For LP Vaults based on a Concentrated Liquidity DEX (CLMM), even minor price changes can render a liquidity position inactive. Nemo Vaults' core strategy automatically monitors the market price and dynamically adjusts the liquidity range, ensuring your capital is always working in the most active and profitable range to maximize your capital efficiency.
* Aggregated Transactions for Gas Savings The vault aggregates rewards from multiple users and performs a single compounding transaction. All participants share the gas fees that they would otherwise have to bear individually. This advantage is particularly significant in strategies that require frequent transactions.
# How it works
### I. How it works
Nemo Vaults aims to be a one-stop, intelligent yield solution on the SUI network, enabling every user to easily participate in and benefit from complex concentrated liquidity market making (CLMM) strategies.
#### **The Lifecycle of Your Deposit**
Your funds within Nemo Vaults undergo a continuous, automated cycle of "earning yield → optimizing position." The entire process can be broken down into three core phases:
#### Phase 1: Seamless Deposit & LP Creation
This is the starting point of your interaction with Nemo Vaults.
1. **User Deposit:** You do not need to hold complex LP tokens in advance. With our built-in "Zap In" feature, you can directly deposit a single asset from the trading pair (e.g., depositing only USDC or only suiUSDT).
2. **Automated LP Creation:** Upon receiving your deposit, Nemo Vaults' smart contracts automatically handle all subsequent steps. They calculate the current optimal asset ratio, swap a portion of your deposited single asset for the other asset on the underlying DEX (Momentum), and then combine both to create a concentrated liquidity LP position on your behalf.
3. **Position Management:** Once the LP is successfully created, its management is fully handed over to Nemo Vaults' strategy contract. In return, you receive `nevLPToken`, which represents your share in the vault. The value of this `nevLPToken` continuously increases as the assets within the vault appreciate.
#### Phase 2: The Automated Yield Compounding Loop
This is the core loop where the Vaults continuously generate passive income for you while your position is In Range.
1. **Profit Generation:** Your LP position on Momentum begins to earn two core types of yield:
* Trading Fees: Fees paid by traders executing swaps within the liquidity pool.
* Farming Incentives: (If applicable) Additional token rewards provided by Momentum or other project partners to incentivize liquidity.
2. **Automatically Harvest:** The Nemo Vault constantly monitors the rewards accumulated by your position. Once the earnings reach an optimal threshold (considering both the amount of rewards and the on-chain Gas costs), a bot automatically triggers a `harvest` operation.
3. **Auto-compounding:** All harvested rewards (fees and incentive tokens) are automatically swapped in the market for the two base assets required by the LP. They are then reinvested into your original liquidity position, thereby increasing your principal.
This "Generate → Harvest → Compound" cycle runs continuously and automatically, allowing your earnings to grow exponentially through compounding. This is the fundamental reason for the constantly increasing value of your `nevLPToken`.
#### Phase 3: The Intelligent Rebalancing Engine
This is where the core value of Nemo Vaults lies—the intelligent engine that handles situations when the price moves Out of Range.
1. **Real-time Monitoring:** The vault's strategy monitors the real-time market price 24/7, comparing it against the narrow price range set for your current LP position.
2. **Rebalancing Triggered:** When market volatility causes the price to move outside your position's range, it stops earning trading fees. This event immediately triggers Nemo's "Intelligent Position Adjustment System."
3. **Intelligent Evaluation:** The system activates instantly. Instead of simply moving the position back to the current price, it calculates a new, more optimal price range by analyzing a series of complex market indicators (e.g., recent price volatility, trading volume, market depth, etc.).
4. **Executing Rebalance:** Once the new optimal range is determined, the Nemo Vaults contract automatically executes a series of on-chain operations:
* Withdraws your entire liquidity position from Momentum.
* Swaps a portion of the two withdrawn assets to match the center point of the new price range.
* Re-establishes your LP position within the new optimal price range.
5. **Resuming Work:** After the rebalance is complete, your position is active and "In Range" again, seamlessly transitioning back to the automated yield compounding loop in Phase 2 to continue earning yield for you.
### II. Nemo Vaults User Guide
#### Step 1: Explore and Select a Vault
First, visit the official Nemo protocol website and click on the \[Vaults] tab in the top navigation bar to go to the vaults overview page.\
Here, you will see:
* Vaults List: All available vaults are clearly displayed in a card format.
* Key Information at a Glance:
* Asset Type: E.g., `suiUSDT-USDC`, which tells you what kind of assets this vault manages.
* APY (Annual Percentage Yield): An estimated, dynamic annual rate of return, a key metric for evaluating a vault's attractiveness.
* TVL (Total Value Locked): Shows how much capital is currently working within this vault.
* Source Protocol: Tells you which DEX the vault's underlying liquidity is built on, e.g., Momentum.
➡️ Your action: Browse the list and, based on the assets you hold and your APY preference, click on the vault card that interests you to proceed to the next step.
#### Step 2: Depositing Funds
After clicking, you will be taken to the vault's details and transaction page. This is where you perform all core operations.
**2.1 Understand the Details Page** Before depositing, you can take a moment to review the detailed information:
* Core Metrics: The top of the page displays the vault's total TVL, real-time APY, your personal position value (Your Position), and your cumulative earnings (Your Earnings).
* LP Breakdown: Shows the current value ratio of the two tokens within the vault.
* Strategy Overview: Briefly introduces the vault's automated strategy.
* Historical Charts: The charts at the bottom of the page allow you to view historical APY trends.
**2.2 Start Depositing** On the right side of the page, find the \[Deposit] module. We offer two convenient deposit modes:
**Mode 1: Single-Asset Deposit (Zap In) - Recommended for Beginners** This is the simplest and most recommended method. You don't need to acquire both tokens yourself; Nemo handles everything for you automatically.
* Ensure the toggle is set to \[Zap In] mode.
* Click the asset dropdown menu to select the single asset you wish to deposit (e.g., SUI or xSUI).
* Enter the amount you want to deposit in the input box, or click the Max button to input the entire balance.
* Review Information: The system will automatically estimate the amount of `nevLP` tokens you will receive. `nevLP` is your share certificate in this vault and is very important.
* Click the green \[✅ Deposit] button.
* Confirm the transaction in the wallet pop-up.
**Mode 2: Dual-Asset Deposit (Manual)** - **For Advanced Users** If you already have both tokens in the appropriate ratio in your wallet, you can use this mode.
* Switch the toggle to \[Manual] mode.
* Enter the amounts for both tokens you wish to deposit.
* The subsequent steps are the same: review the information, click the button, and confirm the transaction.
#### Step 3: View and Manage Your Position
Want to see how your vault is performing? Click on \[My portfolio] in the top navigation bar.\
On your portfolio page, switch to the \[Vault Positions] tab.
* **Core Data:** Here, you can see the total value of your positions across all vaults (Vaults Positions).
* **Position List**: The list clearly displays each vault position you hold, including:
* LP Amount: The number of share tokens (`nevLP Token`) you hold and their USD value.
* Your Earnings: The cumulative profit this position has generated for you.
* APY: The current real-time APY of the vault.
* **History:** At the bottom of the page, the “Latest transactions” module records all your deposit and withdrawal history and provides links to the on-chain explorer, ensuring every operation is verifiable.
#### Step 4: Withdrawing Funds
When you need to withdraw your funds, the process is just as simple:
1. Return to the specific vault's details page.
2. Select the \[Withdraw] tab.
3. Enter the amount of `nevLP` shares you wish to withdraw.
4. Choose a withdrawal method:
* **Zap Out** (Single-asset withdrawal): You can choose to have your LP shares directly converted into any specified single asset (like USDC) and returned to your wallet. It's very convenient.
* **Manual** (Dual-asset withdrawal): You can also choose to withdraw your LP shares as the two underlying tokens according to their current ratio.
5. Click the \[Withdraw] button and confirm in your wallet.
#### Step 5: Advanced Play - Unlock Higher Yields!
Remember the `nevLP Token` you received after depositing? It is itself a yield-bearing asset that is constantly appreciating in value. Now, you can take it to Nemo's Yield Trading Market to unlock a higher level of compounded returns!\
Here, you can:
* Split Your Yield: Split your `nevLP` token into a Principal Token (PT) and a Yield Token (YT) to lock in profits early or leverage your returns.
* Provide Liquidity: Provide liquidity for PT/YT trading to earn additional trading fees and liquidity incentives.
# Fee
To support the sustainable development of the protocol and cover operational and development costs, Nemo Vaults charge a small fee. We adhere to a principle of full transparency:
|
We only take a 15% fee from the profits you generate. If a vault does not generate positive returns, no fee is charged.
|
# Risk Disclosure
Vaults are not without risk. We strongly recommend that you fully understand the following potential risks before investing:
* Smart Contract Risk: Although the Nemo Protocol's code has been audited by professional security firms, no smart contract can be 100% guaranteed to be free of vulnerabilities. Bugs or exploits in the contracts could lead to a loss of funds.
* Impermanent Loss Risk: This is an inherent risk of providing liquidity to concentrated liquidity pools. Even though our strategies aim to mitigate it through dynamic rebalancing, impermanent loss can still occur during periods of high market volatility and may exceed the trading fees you earn, resulting in a decrease in the total value of your position.
* Upstream Protocol Risk: Our Vaults are built on top of third-party DEXs. If these underlying DEX protocols experience security vulnerabilities, are exploited, or cease operations, it will directly impact the security of the assets in Nemo Vaults.
# FAQs
**Q: What do I receive when I withdraw from a Vault?**
A: You will receive the same type of asset you deposited, but the quantity will have changed. Specifically, you will receive your initial LP tokens (or the equivalent underlying assets), plus all the compounded earnings that have been added to your principal.
\
**Q: How often does the vault harvest rewards and rebalance its position?**
A: There is no fixed schedule. The vault's strategy is dynamic; it determines the optimal time to act based on market conditions, gas fees, and the amount of accumulated rewards. The goal is to maximize returns after costs, so this could happen several times a day or just once a day.
**Q: Is the APY displayed for Vaults fixed? Why does it keep changing?**
A: The APY is dynamic and not guaranteed. It is an estimated value based on historical performance (including trading fees and farming rewards) and calculated with compounding. APY fluctuates in real-time due to changes in market trading volume, token prices, and liquidity mining rewards. Past APY is not indicative of future returns.
**Q: Why has the total value of my vault position decreased?**
A: This could be due to a few reasons:
1. Impermanent Loss (IL): This is the most common reason. When the relative price of the two tokens in the pool changes significantly, the value of your LP position might be lower than if you had simply held the two tokens separately.
2. Decreased Yield: If market activity is low, the income from trading fees and farming rewards may decrease, potentially failing to offset the impermanent loss.
**Q: Are Nemo Vaults non-custodial? Can the Nemo team access my funds?**
A: Yes, Nemo Vaults are fully non-custodial. Your assets are managed by publicly verifiable smart contract code. The Nemo team cannot unilaterally move, freeze, or access your funds. You always maintain ultimate control over your funds and can initiate a withdrawal at any time according to the contract rules.
**Q: I'm from a project team. How can we partner with Nemo to launch an official vault?**
A: We warmly welcome partnerships with outstanding projects in the Sui ecosystem! Please contact our business development team through our official Discord or Twitter. We can discuss creating dedicated vaults for your project's token or LP, potentially even with additional Sui incentives.
# Background and Introduction
### 1. Background
Over the past year, the Sui ecosystem has experienced explosive growth. To incentivize early users, major protocols have launched their own points systems, such as:
* Momentum's BRICKS points
* ZO's ZO points
* Volo's volo points
* ...and many more from other projects.
These points serve as direct credentials for future airdrop expectations, representing immense potential wealth. Users diligently "farm" these points through activities like staking, lending, and trading. However, a significant problem has emerged: while invaluable, these points are locked within each protocol's account. They cannot be traded, transferred, or priced. No matter how many points you accumulate, it remains a form of "paper wealth." Your capital is heavily engaged, yet its liquidity cannot be unlocked until the airdrop is actually realized. This is the "golden handcuff" of the Sui ecosystem's points meta.
### 2. The Nemo Points Market Mechanism
Nemo Points Market is the premier marketplace for airdrop farming on Sui, transforming points into a powerful tool that can be traded, leveraged, and used to generate excess returns. In short, the Nemo Points Market is a marketplace built around PT and YT.\
Nemo's core magic lies in its ability to unbundle the points from any yield-bearing asset (e.g., BRICKS from Momentum's xSUI). We achieve this through our exclusive PT/YT tokenization technology, creating two brand-new tokens:
1. Asset Wrapping: When you deposit a yield-bearing asset that generates points (e.g., xSUI, which earns Momentum BRICKS points) into Nemo.
2. Points Unbundling: Nemo acts like a sophisticated financial magician, separating the asset's two core rights:
* Principal Ownership: This is minted into PT (Principal Token). It acts like a fixed-term deposit certificate, guaranteeing that you can redeem your principal 1:1 at expiry.
* All Future Yield + Points: This is minted into YT (Yield Token). It's like a grand prize lottery ticket that contains all future rewards. Whoever holds YT owns 100% of all future yield and points generated by the underlying asset until expiry.
3. Points Trading: The trading of these rights happens seamlessly within the Points Market.
# Feature Advantages
| **User Need** | **Nemo's Solution** |
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
Locked Capital & Unrealized Airdrop Value
|
Unlock Your Capital: Sell YT to get your yield upfront. Your principal, now in the form of PT, can still be used elsewhere in DeFi.
|
|
Slow Points Accumulation & Whale Domination
|
Points Leverage: Buy YT to maximize your points accumulation efficiency with minimal capital, breaking the barrier to entry.
Diversified Yields: Become an LP to simultaneously earn trading fees, base points, and platform incentives.
|
# Points Strategies
In simple terms, there are three main strategies you can employ in the Points Market:
**Role 1: The Fixed-Yield Seeker (Alice)**
* Your Goal: "I'm tired of the uncertainty of future airdrops. I just want to convert these intangible 'points' into real, high returns that I can get my hands on right now!"
* Your Strategy: Sell Points, Lock In Profits
* By depositing your yield-bearing asset and immediately selling the resulting YT, you are essentially selling a pre-packaged bundle of all future points and interest.
* Because "Points Hunters" in the market are willing to pay a premium for this potential, you receive an exceptionally high Fixed APY (Annual Percentage Yield), far exceeding what's available elsewhere.
**Role 2: The Points Hunter (Bob)**
* Your Goal: "I strongly believe this project's airdrop will be massive! I want to use the minimum possible cost to get the maximum points exposure and achieve exponential gains!"
* Your Strategy: Leverage-Buy Points for Alpha Returns
* You don't need a large amount of principal capital. Simply purchase YT directly from the Nemo marketplace.
* This allows you to use a very low cost (the price of YT) to acquire all the points generated by an equivalent amount of principal, automatically achieving 3x, 5x, or even higher points leverage. This is the most capital-efficient way to accumulate points in the entire market.
**Role 3: The Balanced LP Provider (Carly)**
* Your Goal: "I want to earn a steady yield, but I don't want to completely miss out on points opportunities. Is there a way to get the best of both worlds?"
* Your Strategy: Provide Liquidity to Earn Diversified Yields
* You can provide liquidity (LP) to one of Nemo's PT/SY pools (e.g., PT-xSUI / xSUI).
* By becoming an LP, you can earn three types of returns simultaneously:
* 1\. LP Trading Fees: A share of all trades that occur in that trading pair.
* 2\. Base Points Earnings: The SY portion of your LP (e.g., xSUI) continues to accrue the project's base points on a 1:1 basis.
* 3\. Nemo's Extra Incentives: Additional token rewards that may be offered by the Nemo platform or the project partner.
# Disclaimer & Risks
Nemo Protocol, as a technically neutral DeFi platform, has the core responsibility of providing stable and efficient PT/YT unbundling and trading functions. We ensure the accurate accumulation of "Points" for users according to the rules provided by our project partners via our SDK.\
We can only guarantee that your points records on the Nemo platform are accurate.\
However, the "Airdrop" itself—including whether an airdrop will occur, when it will occur, the specific quantity, and the distribution rules (e.g., Sybil attack detection, address activity requirements, etc.)—is determined solely by the partner project. Nemo cannot control or guarantee the final airdrop actions of any project.\
Please conduct your own thorough research (DYOR) on partner projects before participating. Your investment decisions should be based on your own judgment and risk tolerance.\
Before participating, you must understand and evaluate the following risks:
* Smart Contract Risk: All DeFi protocols carry the theoretical risk of code exploits.
* Underlying Asset Risk: The asset you use (e.g., LSTs) may have its own risks, such as de-pegging.
* YT Speculation Risk: You may lose money if the cost of purchasing YT is higher than the final value of the airdrop you receive.
{% hint style="info" %} Notice: When calculating YT positions for issuing points, the net YT position is used in the computation. Net YT Position = Amount(YT) - Amount(PT). This prevents dilution of YT holders' rewards through minting operations.
{% endhint %}
# Points Market Q\&A
Q1: Why can I get such a high fixed yield?
A: This excess return is essentially a "points premium" paid to you by YT buyers. They are willing to pay a premium now for a chance at a potentially large future reward. By holding PT (effectively selling YT), you convert this uncertain opportunity into a guaranteed, high yield.
Q2: How are points calculated? Do I get a points boost?
A: Yes! Project partners typically offer a points Boost (multiplier) to Nemo's YT holders. For example, if a project offers a 3x Boost, holding 1 unit of YT will earn you 3 times the points of directly holding 1 unit of the underlying asset. The specific multiplier is clearly displayed on each asset pool's page.
Q3: What does the expiry date for PT and YT mean?
A: The expiry date is a pre-set date for each pool. On this date, PT can be redeemed 1:1 for the principal asset, and the right of YT to generate yield and points terminates. You should always check the expiry date before transacting.
Q4: Why does YT provide points "leverage" or a "boost"?
A: Because the price of YT is significantly lower than the price of the underlying asset it represents. For example, one xSUI might be worth $100, while YT-xSUI might only cost $5. By spending $5, you acquire all the points generated by $100 worth of xSUI, effectively achieving 20x points efficiency. Any additional Boost from the partner (e.g., 3x) further amplifies this effect.
Q5: What if I want to exit my position early?
A: Of course! Nemo is a fully open market.
* PT Holders: You can sell your PT on the "Trade" market at any time before expiry to regain liquidity.
* YT Holders: You can sell your YT on the market at any time.
* LP Providers: You can remove your liquidity and reclaim your two tokens at any time.
# Introduction
The Nemo Referral System is a mechanism designed to drive protocol growth through network effects. It is more than a mere invitation tool; it is a powerful engine for you and your friends to synergistically accelerate points accumulation and share in the upside of the protocol's growth. Here, your influence is directly converted into tangible Points rewards.
The core mission of this mechanism is to:
* **Incentivize Evangelism:** To transform the individual influence of community members into quantifiable and sustainable economic returns.
* **Amplify Network Expansion:** To achieve exponential growth in the user network and protocol TVL through a transparent, programmatic, tiered reward system.
* **Empower Core Contributors:** To provide a permissionless and sustainable framework for KOLs, active communities, and power users to collaborate and promote the protocol.
**Best Practices: Building a High-Quality Network of Organic Users**\
We strongly advise and encourage all participants to invite organic users rather than programmatic or non-genuine accounts. This is not only crucial for maintaining the long-term health of the Nemo ecosystem but also for maximizing your own long-term benefits.
### Why Invite Organic Users?
* Higher Lifetime Value (LTV): Genuine users engage deeply with the protocol through actions like providing long-term liquidity and participating in governance. Their sustained points generation leads to more stable and enduring referral rewards for you.
* Ecosystem Symbiosis: Inviting real, active users is the best way to inject vitality into the Nemo protocol. The prosperity of the protocol ultimately reflects in the rewards for every contributor. To support this, the Nemo protocol backend will deploy a series of risk control models to monitor anomalous activities.
# Core Mechanics
### 1. Attribution & Relationship Binding
The protocol employs a strict attribution logic to ensure the accuracy of referral relationships
* Attribution Methods: A new user can establish a relationship with a referrer by clicking a referral link or by manually entering a referral code.
* Definition of a Valid Referral: A referral relationship is confirmed as "valid" and immutably recorded by the system when the referred user connects their wallet AND for the first time, accrues protocol points through a designated core action (at the current stage, this is "providing liquidity").
* Immutability of Relationships: Once a referral relationship is successfully bound, it is immutable. A user address can only have one direct, first-level referrer.
### 2.Reward Structure
The protocol utilizes a two-tiered reward structure. All rewards are incremental incentives at the protocol level and will not dilute the earnings of the referred users.
* L1 Reward (Level 1): Referrers will receive 10% of the daily points generated by their directly referred users (Level 1 Invitees) as a reward.
* L2 Reward (Level 2): Referrers will receive 2.5% of the daily points generated by their indirectly referred users (Level 2 Invitees) as a reward.
### 3.Disclaimers
* Disclaimer on Points Calculation Rules: Nemo Protocol reserves the right to adjust the rules for points calculation, reward percentages, or event terms when necessary (e.g., to prevent malicious exploits, fix potential vulnerabilities, or ensure system fairness). All calculations and rules are subject to the latest official version published by Nemo, and the protocol reserves the right of final interpretation.
# FAQs
Q1: Where do the excess returns from referral rewards come from?
A: They originate from the protocol's growth budget. These excess returns can be considered the "Customer Acquisition Cost (CAC)" that the protocol pays to acquire high-quality users and expand its network. By participating in the referral program, you are, in effect, capturing the value supported by this market growth expectation.
Q2: Can the Points Boost mechanism and referral rewards be stacked?
A: Yes. For example, if your referred user (Bob) receives a 3x Points Boost by purchasing YT and generates 3,000 points in a day, your L1 reward will be calculated based on this boosted amount (i.e., 3,000 \* 10% = 300 points). The Boost mechanism amplifies the base points, which in turn amplifies your referral reward.
Q3: How is a "Valid Referral" defined for reward calculation to begin?
A: When a new address binds a relationship through your referral link/code and successfully accrues their first protocol points through a designated action like providing liquidity, they are flagged by the system as a "Valid Referral." All their subsequent points generation will be included in your referral reward calculations.
Q4: If I exit my positions, what happens to my referral relationships and accrued rewards?
A: Your referral network relationship is permanent. Even if you withdraw all your liquidity, you will continue to receive daily referral points as long as the network you built remains active. Your previously accrued rewards will not be affected.
Q5: How does the protocol prevent cheating or bot-driven referrals?
A: In addition to advising users to invite organic users, the Nemo protocol backend will deploy a series of risk control models to monitor anomalous activities.
# Audits
Yield Trading Audits By Movebit:
Vaults Audits By Movebit:
# Official Links
Website -
X -
Telegram -
Discord -
# Press Kit
You can find high quality Nemo logos below:
{% embed url="" %}
For further inquiries regarding integration and collaboration, please contact us via email at [admin@nemoprotocol.com](mailto:undefined) or follow us on X: [https://x.com/nemoprotocol](https://x.com/nemoprotocol.com)
# SDK
## Nemo Protocol SDK Documentation
### Table of Contents
1. [Overview](#overview)
2. [Installation](#installation)
3. [Core Features](#core-features)
4. [API Reference](#api-reference)
5. [Type Definitions](#type-definitions)
***
### Overview
The Nemo Protocol SDK provides core functionality for querying user positions, calculating market values, and managing yield distributions in the Nemo Protocol.
#### Key Features
* **Position Query**: Query all positions for any Sui address
* **Holder Statistics**: Get PT, YT, LP holder counts and position quantities
* **Market Value Calculation**: Calculate current market values in SUI or underlying assets
* **Yield Management**: Query and claim available yield
* **Pool Information**: Get comprehensive pool statistics and market data
***
### Installation
#### Package Installation
```bash
npm install @nemoprotocol/contract-sdk
# or
yarn add @nemoprotocol/contract-sdk
# or
pnpm add @nemoprotocol/contract-sdk
```
#### Environment Configuration
```bash
# Build-time configuration
API_BASE_URL=https://api.nemoprotocol.com npm run build
# Development configuration (.env file)
API_BASE_URL=https://api.nemoprotocol.com
```
#### SDK Initialization
```typescript
import { PositionQuery, PoolQuery } from '@nemoprotocol/contract-sdk'
const positionQuery = new PositionQuery({
network: 'mainnet', // or 'testnet', 'devnet', 'localnet'
rpcUrl: 'https://sui-mainnet.mystenlabs.com' // optional
})
const poolQuery = new PoolQuery()
```
***
### Core Features
#### 1. Position Query
Query all positions for a specific Sui address in the Nemo protocol.
**LP Position Query**
```typescript
const lpPositions = await positionQuery.queryLpPositions({
address: '0x...', // user address
positionTypes: [
'0x...::market::LpPosition<0x...::coin::SUI>',
'0x...::market::LpPosition<0x...::coin::USDC>'
],
maturity: '2024-12-31', // optional filter
marketStateId: '0x...' // optional filter
})
// Response format:
// [
// {
// id: { id: '0x...' },
// name: 'LP-SUI-2024-12-31',
// expiry: '2024-12-31',
// lpAmount: '1000000000',
// description: 'LP position for SUI',
// marketStateId: '0x...'
// }
// ]
```
**PY Position Query**
```typescript
const pyPositions = await positionQuery.queryPyPositions({
address: '0x...', // user address
positionTypes: [
'0x...::py_state::PyState<0x...::coin::SUI>',
'0x...::py_state::PyState<0x...::coin::USDC>'
],
maturity: '2024-12-31', // optional filter
pyStateId: '0x...' // optional filter
})
// Response format:
// [
// {
// id: '0x...',
// maturity: '2024-12-31',
// ptBalance: '500000000',
// ytBalance: '300000000',
// pyStateId: '0x...'
// }
// ]
```
#### 2. Holder Statistics
Get users holding different asset types (PT, YT, LP) and their position quantities.
**PT/YT Holder Count**
```typescript
const holdersCount = await positionQuery.queryPyPositionHoldersCount({
positionTypes: [
'0x...::py_state::PyState<0x...::coin::SUI>',
'0x...::py_state::PyState<0x...::coin::USDC>'
],
maturity: '2024-12-31',
pyStateId: '0x...',
pageSize: 50 // optional
})
console.log('PT Holders:', holdersCount.ptHolders)
console.log('YT Holders:', holdersCount.ytHolders)
console.log('Total Holders:', holdersCount.totalHolders)
console.log('Holders by Type:', holdersCount.holdersByType)
console.log('Total Positions:', holdersCount.totalPositions)
```
**LP Holder Count**
```typescript
const lpHoldersCount = await positionQuery.queryLpPositionHoldersCount({
positionTypes: [
'0x...::market::LpPosition<0x...::coin::SUI>',
'0x...::market::LpPosition<0x...::coin::USDC>'
],
maturity: '2024-12-31',
marketStateId: '0x...',
pageSize: 50 // optional
})
console.log('LP Holders:', lpHoldersCount.totalHolders)
console.log('Holders by Type:', lpHoldersCount.holdersByType)
console.log('Total Positions:', lpHoldersCount.totalPositions)
```
#### 3. Market Value Calculation
Calculate and display current market values of user positions (priced in SUI or underlying assets).
**Yield Query**
```typescript
const yieldResult = await positionQuery.queryYield({
address: '0x...',
ytBalance: '1000000000',
pyPositions: [
{
id: '0x...',
maturity: '2024-12-31',
ptBalance: '500000000',
ytBalance: '300000000',
pyStateId: '0x...'
}
],
receivingType: 'sy', // or 'underlying'
config: {
nemoContractId: '0x...',
version: '1.0.0',
coinType: '0x...::coin::SUI',
pyStateId: '0x...',
syCoinType: '0x...::sy_coin::SyCoin<0x...::coin::SUI>',
yieldFactoryConfigId: '0x...',
marketStateId: '0x...',
underlyingCoinType: '0x...::coin::SUI',
underlyingProtocol: 'Scallop',
priceOracleConfigId: '0x...',
oraclePackageId: '0x...',
oracleTicket: '0x...',
oracleVoucherPackageId: '0x...'
}
})
console.log('Output Value:', yieldResult.outputValue)
console.log('Output Amount:', yieldResult.outputAmount)
```
#### 4. Yield Claiming
**⚠️ Note: This feature is currently missing from the SDK**
Query and display available yield that users can claim in the NEMO protocol.
```typescript
// TODO: Implement yield claiming functionality
async function queryClaimableYield(address: string) {
// This functionality needs to be implemented
throw new Error('Yield claiming not yet implemented')
}
```
#### 5. Pool Information
Query basic information and statistics for different pools.
**Pool Query**
```typescript
const pools = await poolQuery.queryPools()
// Response format:
// [
// {
// id: '0x...',
// tvl: '1000000000000',
// tvlRateChange: '5.2',
// coinLogo: 'https://...',
// maturity: '2024-12-31',
// startTime: '2024-01-01',
// coinName: 'SUI',
// coinType: '0x...::coin::SUI',
// ptTokenType: '0x...::pt_coin::PtCoin<0x...::coin::SUI>',
// nemoContractId: '0x...',
// boost: '1.5',
// provider: 'Scallop',
// providerLogo: 'https://...',
// cap: '10000000000000',
// marketStateId: '0x...',
// syCoinType: '0x...::sy_coin::SyCoin<0x...::coin::SUI>',
// underlyingCoinType: '0x...::coin::SUI',
// providerMarket: '0x...',
// providerVersion: '1.0.0',
// priceOracleConfigId: '0x...',
// decimal: '9',
// underlyingApy: '8.5',
// coinPrice: '1.2',
// underlyingPrice: '1.2',
// pyStateId: '0x...',
// syStateId: '0x...',
// conversionRate: '1.0',
// marketFactoryConfigId: '0x...',
// swapFeeForLpHolder: '0.003',
// underlyingCoinName: 'SUI',
// underlyingCoinLogo: 'https://...',
// version: '1.0.0',
// perPoints: '1000000',
// oraclePackageId: '0x...',
// oracleTicket: '0x...',
// oracleVoucherPackageId: '0x...',
// yieldTokenType: '0x...::yt_coin::YtCoin<0x...::coin::SUI>',
// tokenRegistryState: '0x...',
// ptPrice: '0.95',
// ptTvl: '500000000000',
// syTvl: '500000000000',
// marketState: {
// marketCap: '1000000000000',
// totalSy: '500000000000',
// lpSupply: '1000000000000',
// totalPt: '500000000000',
// rewardMetrics: [...]
// },
// scaledPtApy: '12.5',
// scaledUnderlyingApy: '8.5',
// feeApy: '2.0',
// sevenAvgUnderlyingApy: '8.2',
// sevenAvgUnderlyingApyRateChange: '0.3',
// ytPrice: '0.15',
// lpPrice: '1.0',
// ytTokenLogo: 'https://...',
// ptTokenLogo: 'https://...',
// lpTokenLogo: 'https://...',
// ytReward: '150000000',
// underlyingProtocol: 'Scallop',
// yieldFactoryConfigId: '0x...',
// pyPositionTypeList: ['0x...::py_state::PyState<0x...::coin::SUI>'],
// marketPositionTypeList: ['0x...::market::LpPosition<0x...::coin::SUI>'],
// lpPriceRateChange: '2.1',
// ptPriceRateChange: '-1.5',
// ytPriceRateChange: '5.2',
// incentiveApy: '3.0',
// incentives: [...],
// poolApy: '15.5',
// tradeStatus: 'active'
// }
// ]
```
***
### API Reference
#### PositionQuery Class
**Constructor**
```typescript
new PositionQuery(config: PositionQueryConfig)
```
**Parameters:**
* `config.network`: Network type ('mainnet' | 'testnet' | 'devnet' | 'localnet')
* `config.rpcUrl`: Custom RPC URL (optional)
**Methods**
**queryLpPositions()**
```typescript
async queryLpPositions(options: {
address: string;
positionTypes: string[];
maturity?: string;
marketStateId?: string;
}): Promise
```
**queryPyPositions()**
```typescript
async queryPyPositions(options: {
address: string;
positionTypes: string[];
maturity?: string;
pyStateId?: string;
}): Promise
```
**queryPyPositionHoldersCount()**
```typescript
async queryPyPositionHoldersCount(options: {
positionTypes: string[];
maturity?: string;
pyStateId?: string;
pageSize?: number;
}): Promise<{
ptHolders: number;
ytHolders: number;
totalHolders: number;
holdersByType: Record;
totalPositions: number;
}>
```
**queryLpPositionHoldersCount()**
```typescript
async queryLpPositionHoldersCount(options: {
positionTypes: string[];
maturity?: string;
marketStateId?: string;
pageSize?: number;
}): Promise<{
totalHolders: number;
holdersByType: Record;
totalPositions: number;
}>
```
**queryYield()**
```typescript
async queryYield(params: QueryYieldParams): Promise<{
outputValue: string;
outputAmount: string;
}>
```
#### PoolQuery Class
**Constructor**
```typescript
new PoolQuery()
```
**Methods**
**queryPools()**
```typescript
async queryPools(): Promise
```
***
### Type Definitions
#### PositionQueryConfig
```typescript
interface PositionQueryConfig {
network?: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
rpcUrl?: string;
}
```
#### LpPosition
```typescript
interface LpPosition {
id: { id: string };
name: string;
expiry: string;
lpAmount: string;
description: string;
marketStateId: string;
}
```
#### PyPosition
```typescript
interface PyPosition {
id: string;
maturity: string;
ptBalance: string;
ytBalance: string;
pyStateId: string;
}
```
#### PortfolioItem
```typescript
interface PortfolioItem {
id: string;
tvl: string;
tvlRateChange: string;
coinLogo: string;
maturity: string;
startTime: string;
coinName: string;
coinType: string;
ptTokenType: string;
nemoContractId: string;
boost: string;
provider: string;
providerLogo: string;
cap: string;
marketStateId: string;
syCoinType: string;
underlyingCoinType: string;
providerMarket: string;
providerVersion: string;
priceOracleConfigId: string;
decimal: string;
underlyingApy: string;
coinPrice: string;
underlyingPrice: string;
pyStateId: string;
syStateId: string;
conversionRate: string;
marketFactoryConfigId: string;
swapFeeForLpHolder: string;
underlyingCoinName: string;
underlyingCoinLogo: string;
version: string;
perPoints: string;
oraclePackageId: string;
oracleTicket: string;
oracleVoucherPackageId: string;
yieldTokenType: string;
tokenRegistryState: string;
ptPrice: string;
ptTvl: string;
syTvl: string;
marketState: MarketState;
scaledPtApy: string;
scaledUnderlyingApy: string;
feeApy: string;
sevenAvgUnderlyingApy: string;
sevenAvgUnderlyingApyRateChange: string;
ytPrice: string;
lpPrice: string;
ytTokenLogo: string;
ptTokenLogo: string;
lpTokenLogo: string;
ytReward: string;
underlyingProtocol: string;
yieldFactoryConfigId: string;
pyPositionTypeList: string[];
marketPositionTypeList: string[];
lpPriceRateChange: string;
ptPriceRateChange: string;
ytPriceRateChange: string;
incentiveApy: string;
incentives: Incentive[];
poolApy: string;
tradeStatus: string;
}
```
***
**Document Version**: 1.0
**Last Updated**: \[Date]
# Terms of Use
#### Welcome to Nemo! These Terms of Use ("Terms") constitute a legally binding agreement between you ("you," "your," or "user") and the developers and contributors to the Nemo Protocol ("we," "us," or "our") governing your access to and use of the Nemo Protocol interface (the "Interface"), the underlying smart contracts (the "Protocol"), and any related services.
#### By accessing, connecting your wallet to, or using the Interface, you acknowledge that you have read, understood, and agree to be bound by these Terms in their entirety. If you do not agree, you must not access or use the Interface or the Protocol.
1\. The Nemo Protocol\
Nemo is a decentralized, non-custodial financial protocol built on the Sui blockchain. The Protocol allows users to interact with smart contracts to, among other things:
* Split yield-bearing assets into Principal Tokens (PT) and Yield Tokens (YT).
* Provide liquidity and engage with automated yield strategies in Liquidity Provider (LP) Vaults ("Nemo Vaults").
The Protocol is autonomous code deployed on the Sui blockchain. We, as developers of the Interface, do not control the Protocol, have custody over your funds, or have the ability to reverse any transactions. All transactions are processed on the Sui network and are final and irreversible.\
2\. Eligibility and Geographic Restrictions\
To be eligible to use the Interface, you must be at least 18 years of age (or the age of legal majority in your jurisdiction) and have the full right, power, and authority to enter into and comply with these Terms.\
You represent and warrant that you are not: (a) A citizen, resident, or located in the United States of America (including its territories), the United Kingdom (for certain derivative products), Canada, or any jurisdiction where your use of the Protocol would be illegal or otherwise violate any applicable law. (b) A citizen or resident of a jurisdiction subject to comprehensive economic sanctions by the United Nations, the U.S. Office of Foreign Assets Control (OFAC), or other relevant authorities, including, but not limited to, Cuba, Iran, North Korea, Syria, the Crimea, Donetsk, or Luhansk regions of Ukraine. (c) A person or entity listed on any sanctions list, such as the UN Security Council Sanctions List or the OFAC Specially Designated Nationals (SDN) List.\
We reserve the right to restrict access to the Interface from any jurisdiction at any time, with or without notice.\
3\. Assumption of Risk\
Your use of the Nemo Protocol is entirely at your own risk. By using the Protocol, you expressly acknowledge and accept the following risks:
* No Financial Advice: All information provided on the Interface is for informational purposes only and should not be construed as financial, investment, legal, or tax advice. You are solely responsible for your financial decisions and outcomes.
* Market Risk & Volatility: The value of cryptographic assets is extremely volatile. Prices can fluctuate dramatically in a short period. You may lose the entire value of your assets.
* Smart Contract Risk: The Nemo Protocol is composed of complex smart contracts. While these contracts may have undergone third-party audits \[You should link to your audit reports here], audits do not eliminate all risks. A bug, vulnerability, or exploit could result in the total and permanent loss of your funds.
* Impermanent Loss (IL): When providing liquidity to Concentrated Liquidity Market Maker (CLMM) pools, such as those used by Nemo Vaults, you are exposed to Impermanent Loss. This loss occurs when the price of the assets in the pool changes compared to holding them in your wallet. Aggressive, narrow-range strategies may significantly amplify IL.
* Vault Strategy Risk: Nemo Vaults employ automated rebalancing strategies to maximize yield. These strategies carry inherent risks, including:
* * Rebalancing Costs: Frequent rebalancing incurs transaction fees and slippage, which can erode profits or even lead to a net loss, especially in volatile markets.
* Strategy Failure: A strategy may underperform or fail under certain market conditions, leading to financial loss. Past performance and displayed APYs are not guarantees of future results.
* Protocol & Yield Risk: APY (Annual Percentage Yield) figures displayed are variable, dynamic, and not guaranteed. They are based on historical data and can change rapidly due to market conditions, trading volume, and changes in underlying reward programs.
* Non-Custodial Responsibility: You are solely responsible for the security of your private keys and wallet. Loss of access to your wallet will result in the permanent loss of your funds. Nemo developers never have custody or control over your assets.
* Regulatory Uncertainty: The regulatory landscape for DeFi and digital assets is evolving. Future regulations may restrict or prohibit the use of the Nemo Protocol and could impact the value of your assets.
* Sui Network Risk: The Protocol relies on the underlying Sui blockchain. Any failure, fork, or malfunction of the Sui network could negatively impact the Protocol and your assets.
4\. Fees\
Transactions on the Nemo Protocol require the payment of transaction fees ("Gas") to the Sui network. Furthermore, certain products or vaults on Nemo may be subject to protocol fees (e.g., performance fees on yield generated). All fees will be disclosed to you through the Interface before you confirm a transaction.\
5\. No Warranties & "AS-IS"\
THE INTERFACE AND THE NEMO PROTOCOL ARE PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS. TO THE FULLEST EXTENT PERMITTED BY LAW, WE DISCLAIM ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. WE DO NOT GUARANTEE THAT THE INTERFACE OR PROTOCOL WILL BE SECURE, ERROR-FREE, OR UNINTERRUPTED.\
6\. Limitation of Liability\
IN NO EVENT SHALL NEMO, ITS DEVELOPERS, CONTRIBUTORS, OR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, PUNITIVE, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF PROFITS, DATA, USE, GOODWILL, OR OTHER INTANGIBLE LOSSES, ARISING OUT OF OR IN ANY WAY CONNECTED WITH:
* YOUR USE OF OR INABILITY TO USE THE INTERFACE OR PROTOCOL;
* ANY LOSSES RESULTING FROM SMART CONTRACT VULNERABILITIES, HACKS, OR EXPLOITS;
* ANY LOSSES DUE TO MARKET VOLATILITY, IMPERMANENT LOSS, OR STRATEGY PERFORMANCE;
* ANY ACTION OR INACTION YOU TAKE BASED ON INFORMATION FOUND ON THE INTERFACE.
YOU ACKNOWLEDGE AND AGREE THAT YOU ARE USING THE PROTOCOL AT YOUR OWN SOLE RISK AND ARE RESPONSIBLE FOR YOUR OWN PROFITS AND LOSSES.\
7\. Prohibited Activities\
You agree not to engage in any of the following activities:
* Violating any applicable laws or regulations.
* Using the Protocol for any illegal purpose, including money laundering or terrorist financing.
* Attempting to compromise the integrity of the Protocol, including hacking, introducing viruses, or deploying malicious code.
* Engaging in any form of market manipulation.
8\. Amendments\
We may amend these Terms at any time by posting the revised version on the Interface. The "Last Revised" date at the top of these Terms will indicate when the latest changes were made. Your continued use of the Interface after any changes constitutes your acceptance of the new Terms.\
9\. Entire Agreement\
These Terms constitute the entire agreement between you and us regarding your use of the Nemo Protocol and supersede all prior agreements and understandings.
# Tokenomics
Coming soon.