You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1d88111
Browse filesBrowse the repository at this point in the historyBrowse files
Enables your token to be used as a quote asset for trading pairs. **Dependency:** Requires specific trading fee share value (see Step 6 above). See: [Permissionless Spot Quote Assets](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
126
+
Enables your token to be used as a quote asset for trading pairs.
127
+
128
+
> ⚠️ **Important**: Review the complete [Quote Assets (Fee Tokens)](https://github.com/LayerZero-Labs/devtools/tree/main/packages/hyperliquid-composer/HYPERLIQUID.README.md#quote-assets-fee-tokens) section in the main documentation for:
129
+
> - Mainnet requirements (technical and liquidity)
130
+
> - Testnet requirements (50 HYPE stake + active order book)
131
+
> - Order book maintenance for `HYPE/YOUR_ASSET` pair
This step enables the token to be used as a quote asset for trading pairs. This allows other tokens to form trading pairs against your token (e.g., TOKEN/YOUR_TOKEN instead of only YOUR_TOKEN/USDC).
525
533
526
-
> ⚠️ **Requirements**:
527
-
>
528
-
> - Requires specific trading fee share value (see Step 6/7 above)
529
-
> - Review all requirements at: [Permissionless Spot Quote Assets](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
530
-
> - Contact the Hyperliquid team for the most up-to-date information
534
+
> ⚠️ **Important**: Review the complete [Quote Assets (Fee Tokens)](../../packages/hyperliquid-composer/HYPERLIQUID.README.md#quote-assets-fee-tokens) section in the main documentation for detailed requirements, including:
535
+
> - Mainnet: Complete technical and liquidity requirements
536
+
> - Testnet: Simplified requirements (50 HYPE stake + active order book)
537
+
> - Order book maintenance for `HYPE/YOUR_ASSET` pair after enablement
531
538
>
532
539
> 📝 **Note**: This can be executed after the trading fee share is set and even after deployment and linking are complete.
- Trading fee share must be set (see Step 6/7 above)
551
+
-**Testnet**: 50 HYPE staked + active BUY and SELL limit orders on your token's order book
552
+
-**Mainnet**: All requirements per [Hyperliquid's documentation](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
553
+
554
+
**After Execution:**
555
+
- A `HYPE/YOUR_ASSET` trading pair is automatically created
556
+
- You must maintain order book requirements for the new `HYPE/ASSET` pair
557
+
- Verify quote asset status with the `is-quote-asset` command
This step enables the token to be used as an aligned quote asset for trading pairs. Aligned quote tokens have special properties and requirements different from regular quote tokens.
Copy file name to clipboardExpand all lines: packages/hyperliquid-composer/HYPERLIQUID.README.md
+74-4Lines changed: 74 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -159,6 +159,65 @@ This creates the asset bridge precompile `0x2000...abcd` (where `abcd` is the `c
159
159
>
160
160
> ⚠️ **Setup Guidance**: CoreDecimals - EVMDecimals must be within [-2,18] is a requirement for the hyperliquid protocol
161
161
162
+
## Quote Assets (Fee Tokens)
163
+
164
+
A **quote asset** (or fee token) is a token that can be used as the quote currency in trading pairs on HyperCore. When a token becomes a quote asset, Hyperliquid automatically creates a `HYPE/QUOTE_ASSET` spot market. Thus every quote asset for a `HYPE` spot market is a quote asset.
165
+
166
+
It is permissionless to deploy spot markets for OTHER tokens as well.
167
+
168
+
### Requirements Overview
169
+
170
+
**Mainnet:**
171
+
- Follow the complete requirements outlined in [Hyperliquid's Permissionless Spot Quote Assets documentation](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
172
+
- Requires specific trading fee share configuration
173
+
- Additional technical and liquidity requirements apply
174
+
- Contact the Hyperliquid team for the most up-to-date requirements
175
+
176
+
**Testnet (lighter requirements):**
177
+
The requirements are more relaxed to facilitate testing:
178
+
1.**Stake 50 HYPE tokens** (refer to [Hyperliquid's Permissionless Spot Quote Assets documentation](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets) for more details)
179
+
2.**Create active limit orders** on both sides of your token's order book:
180
+
- Place at least one BUY limit order
181
+
- Place at least one SELL limit order
182
+
- Orders must be active before executing the `enable-quote-token` command
183
+
- You can place these orders via the [Hyperliquid Explorer](https://app.hyperliquid.xyz/)
184
+
185
+
Example order book requirement:
186
+
```
187
+
Price Size Total
188
+
1.0015 1,000.00 1,000.00 <- Active SELL order
189
+
-------- Spread: 0.0025 (0.250%) --------
190
+
0.9990 1,000.00 1,000.00 <- Active BUY order
191
+
```
192
+
193
+
3. After executing `enable-quote-token`:
194
+
- A `HYPE/YOUR_ASSET` trading pair is automatically created
195
+
- You must then maintain order book requirements for the `HYPE/YOUR_ASSET` pair (not required for testnet)
196
+
- Follow Hyperliquid's documentation for maintaining the `HYPE/ASSET` order book
If you're deploying a quote asset token (or plan to make it one):
216
+
-**Use `MyHyperLiquidComposer_FeeToken`** - This composer variant provides automatic user activation using the token itself as the fee token
217
+
- Regular composers (`MyHyperliquidComposer`, `FeeAbstraction`, `Recoverable`) will work but require users to have HYPE for gas fees
218
+
219
+
The deployment scripts automatically check if your token is a quote asset and guide you to use the appropriate composer type.
220
+
162
221
## The Asset Bridge
163
222
164
223
Transactions can be sent to the asset bridge address `0x2000...abcd` (where `abcd` is the `coreIndexId` of the HIP-1 in hex) to send tokens between HyperEVM and HyperCore. This bridge is formed after the token linking step, until then the bridge does not exist.
This step enables the token to be used as a quote asset for trading pairs. This allows other tokens to form trading pairs against your token (e.g., TOKEN/YOUR_TOKEN instead of only YOUR_TOKEN/USDC).
840
899
841
-
> ⚠️ **Requirements**:
842
-
> -Requires specific trading fee share value (see Step 6/7 above)
843
-
> -Review all requirements at: [Permissionless Spot Quote Assets](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
844
-
> -Contact the Hyperliquid team for the most up-to-date information
900
+
> ⚠️ **Important**: Review the complete [Quote Assets (Fee Tokens)](#quote-assets-fee-tokens) section above for detailed requirements, including:
901
+
> -Mainnet: Complete technical and liquidity requirements
902
+
> -Testnet: Simplified requirements (50 HYPE stake + active order book)
903
+
> -Order book maintenance for `HYPE/YOUR_ASSET` pair after enablement
845
904
>
846
905
> 📝 **Note**: This can be executed after the trading fee share is set and even after deployment and linking are complete.
- Trading fee share must be set (see Step 6/7 above)
917
+
-**Testnet**: 50 HYPE staked + active BUY and SELL limit orders on your token's order book
918
+
-**Mainnet**: All requirements per [Hyperliquid's documentation](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
919
+
920
+
**After Execution:**
921
+
- A `HYPE/YOUR_ASSET` trading pair is automatically created
922
+
- You must maintain order book requirements for the new `HYPE/ASSET` pair
923
+
- Verify quote asset status with the `is-quote-asset` command
This step enables the token to be used as an aligned quote asset for trading pairs. Aligned quote tokens have special properties and requirements different from regular quote tokens.
Enables your token to be used as a quote asset for trading pairs. **Dependency:** Requires specific trading fee share value (see Step 6 above). See: [Permissionless Spot Quote Assets](https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/permissionless-spot-quote-assets)
134
+
Enables your token to be used as a quote asset for trading pairs.
0 commit comments