V1.0.0 and TODO

[nktkas]

Way to V1.0.0

• Do everything from TODO
• 2 months without breaking changes in the SDK (exception update hyperliquid api methods)

TODO

• NodeJS v20+ support
• Implement helper functions for Tick and lot size (format px/sz)
• Implement helper functions for Asset IDs (parse data from meta / spotMeta)
• Implement CLI commands (npx @nktkas/hyperliquid [options])
• Decide what to do about API argument coverage in tests (see fix(info/userFunding): update input argument types to make startTime optional #103 (comment))

[nanthandev12]

Hey,
have you considered adding a symbol conversion helper similar to what nomeida's SDK does? It could simplify mapping between asset IDs and market symbols.

[nktkas]

Hey, have you considered adding a symbol conversion helper similar to what nomeida's SDK does? It could simplify mapping between asset IDs and market symbols.

Hey @nanthandev12
I planned to add helper functions for mapping market symbols to asset IDs.
Something like this:

const id = getAssetId("BTC", "perp" | "spot");
await exchClient.order({
  orders: [{
    a: id,
    b: true,
    p: "30000",
    s: "0.1",
    r: false,
    t: {
      limit: {
        tif: "Gtc",
      },
    },
  }],
  grouping: "na",
});

[nanthandev12]

Hey, have you considered adding a symbol conversion helper similar to what nomeida's SDK does? It could simplify mapping between asset IDs and market symbols.

Hey @nanthandev12 I planned to add helper functions for mapping market symbols to asset IDs. Something like this:

const id = getAssetId("BTC", "perp" | "spot");
await exchClient.order({
orders: [{
a: id,
b: true,
p: "30000",
s: "0.1",
r: false,
t: {
limit: {
tif: "Gtc",
},
},
}],
grouping: "na",
});

I actually implemented something similar .
I also included size decimals, which can be used for price and size formatters.

https://github.com/nanthandev12/hyperliquid/blob/main/src/utils/symbolConverter.ts

other than hitting rate limit on testnet due to 50+ perpdexs , it works well

Do you have any suggestions or preferred approach ?

[nktkas]

Do you have any suggestions or preferred approach ?

This code is quite good, but in the context of adding it to the SDK, there are a few changes I would make:

• create an instance using the async static method instead of new SymbolConverter() > await instance.initialize() (to make initialisation easier)

• pass transport instead of isTestnet (to make the code more flexible)

• make dex support optional, accept during class initialization: an array of dex names OR a boolean flag (default false) for the full dex list (rate limit issue should be handled at the transport layer)

• make Spot in getAssetId and getSzDecimals via base + quote names, instead of market id (this is more convenient)

• rename fetchAssetMaps() to reload() (this is a simpler name in the context of SymbolConverter)

Would you mind creating a PR to solve all these issues there?

[nanthandev12]

This code is quite good, but in the context of adding it to the SDK, there are a few changes I would make:

• create an instance using the async static method instead of new SymbolConverter() > await instance.initialize() (to make initialisation easier)
• pass transport instead of isTestnet (to make the code more flexible)
• make dex support optional, accept during class initialization: an array of dex names OR a boolean flag (default false) for the full dex list (rate limit issue should be handled at the transport layer)
• make Spot in getAssetId and getSzDecimals via base + quote names, instead of market id (this is more convenient)
• rename fetchAssetMaps() to reload() (this is a simpler name in the context of SymbolConverter)

Would you mind creating a PR to solve all these issues there?

Will do 👍

[nanthandev12]

Created a PR
let me know if you’d like any changes

[nanthandev12]

Hey @nktkas,
what do you think about adding a function like getSpotPairId that takes a base/quote and returns the name from universe.
It could be useful for info requests and subscriptions.

[nktkas]

Hey @nktkas, what do you think about adding a function like getSpotPairId that takes a base/quote and returns the name from universe. It could be useful for info requests and subscriptions.

Good idea. It will be clearer than assetId - 10000.

[nova1000k]

Hello,
First of all, I’d like to thank you for the work you’ve done. Your SDK is extremely helpful. I was wondering whether it would be possible to add the IsFrontend option to the exchange client, which would allow for near-instant WebSocket updates after an order is placed or an action is performed in general.

Thank you very much.