Skip to content

Commit cc5081c

Browse files
author
shankar
committed
docs: explain limited ux
Signed-off-by: shankar <shankar@layerzero.org>
1 parent e858adb commit cc5081c

2 files changed

Lines changed: 11 additions & 10 deletions

File tree

packages/hyperliquid-composer/src/operations/spotDeploy.ts

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -203,20 +203,23 @@ export async function setNoHyperliquidity(
203203
if (!state) {
204204
// Token is already deployed - check for pending spot pairs in spotMetaAndAssetCtxs
205205
logger.info(
206-
`No in progress deployment state found for token ${tokenIndex}. Checking for pending spot pairs...`
206+
`No in progress deployment state found for token ${tokenIndex}. Checking for pending spot pairs network-wide...`
207207
)
208208

209-
const pendingSpots = await getPendingSpotPairs(isTestnet, tokenIndex, logLevel)
209+
const pendingSpots = await getPendingSpotPairs(isTestnet, logLevel)
210210

211211
if (pendingSpots.length === 0) {
212-
logger.error(
213-
`No pending spot pairs found for token ${tokenIndex}. The token is fully deployed with no pending pairs.`
214-
)
212+
logger.error(`No pending spot pairs found network-wide.`)
215213
logger.info(`Tip: If you know the spot index, use --spot-index <id> to directly specify it.`)
216214
process.exit(1)
217215
}
218216

219-
logger.info(`Found ${pendingSpots.length} pending spot pair(s):`)
217+
logger.warn(
218+
`WARNING: The API does not provide token composition for pending spots. ` +
219+
`The following are ALL pending spots network-wide, not filtered by token ${tokenIndex}.`
220+
)
221+
logger.warn(`Use --spot-index <id> to directly specify your spot if you know it from register-spot output.`)
222+
logger.info(`Found ${pendingSpots.length} pending spot pair(s) network-wide:`)
220223
pendingSpots.forEach((spot) => {
221224
logger.info(` - ${spot.coin} (spot index: ${spot.spotIndex}, markPx: ${spot.markPx})`)
222225
})

packages/hyperliquid-composer/src/operations/spotMeta.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,18 +179,16 @@ export async function getExistingQuoteTokens(
179179
* Gets pending spot pairs that exist in spotMetaAndAssetCtxs but NOT in the universe.
180180
* These are spots that have been registered via registerSpot but not yet finalized.
181181
*
182-
* Note: The Hyperliquid API does not provide token composition info for pending spots,
182+
* IMPORTANT: The Hyperliquid API does not provide token composition info for pending spots,
183183
* so this function returns ALL pending spots network-wide, not filtered by token.
184184
* Users should use the --spot-index flag to directly specify which spot to finalize.
185185
*
186186
* @param isTestnet Whether to query testnet or mainnet
187-
* @param _tokenIndex Unused - API doesn't support filtering pending spots by token
188187
* @param logLevel Logging level for the client
189-
* @returns Array of pending spot indices and their details
188+
* @returns Array of pending spot indices and their details (network-wide, not token-specific)
190189
*/
191190
export async function getPendingSpotPairs(
192191
isTestnet: boolean,
193-
_tokenIndex: number,
194192
logLevel: string
195193
): Promise<Array<{ spotIndex: number; coin: string; markPx: string }>> {
196194
const hyperliquidClient = new HyperliquidClient(isTestnet, logLevel)

0 commit comments

Comments
 (0)