@basedone/core 0.1.6 → 0.1.10

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { SpotToken, PerpsMeta, PerpsAssetCtx, SpotMeta, ExchangeClient, SuccessResponse, InfoClient } from '@nktkas/hyperliquid';
+import { SpotToken, MarginTables, PerpsAssetCtx, SpotMeta, ExchangeClient, SuccessResponse, InfoClient } from '@nktkas/hyperliquid';
 import { Hex } from '@nktkas/hyperliquid/types';
 
 declare function encodeSlug(slug: string): bigint;
@@ -45,6 +45,7 @@ declare const CloidClientCode: {
     readonly Desktop: 7;
     readonly API: 8;
     readonly Stream: 9;
+    readonly Pal: 10;
 };
 type ClientCodeType = keyof typeof CloidClientCode;
 type CloidClientCodeId = (typeof CloidClientCode)[ClientCodeType];
@@ -82,17 +83,19 @@ declare const TARGET_APPROVED_MAX_BUILDER_FEE: number;
 declare const TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT = "0.1%";
 /**
  * Get the amount of builder fee to approve for
- * @param perpetualTradingFee - Perp fee in percentage
- * @param spotTradingFee - Spot fee in percentage
+ * @param perpetualTradingFee - Perp fee in percentage (0.025 means 0.025% perp fee)
+ * @param spotTradingFee - Spot fee in percentage (0.01 means 0.01% spot fee)
+ * @param feeDiscount - Discount fee in percentage (0.9 means 90% discount)
  * @returns {
  *   amount: number;  - The amount of builder fee to approve in 1/10 of a basis point
  *   percent: string;  - eg. String input to approve fee, "0.1%"
  * }
  */
-declare const getApprovalAmount: ({ customFeeEnabled, perpetualTradingFee, spotTradingFee, }: {
+declare const getApprovalAmount: ({ customFeeEnabled, perpetualTradingFee, spotTradingFee, feeDiscount, }: {
     customFeeEnabled: boolean;
     perpetualTradingFee?: number;
     spotTradingFee?: number;
+    feeDiscount?: number;
 }) => {
     approvalAmount: number;
     approvalPercent: `${string}%`;
@@ -236,6 +239,34 @@ declare function getNextTierInfo(pupTokenAmount: number, normalizedAirDropAmount
 declare const USDC_SPOT_TOKEN: SpotToken;
 declare const TESTNET_USDC_SPOT_TOKEN: SpotToken;
 
+interface PerpsMeta$1 {
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse$1[];
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: MarginTables;
+    /** Collateral token index. */
+    collateralToken?: number;
+}
+/** Trading universe parameters for perpetual assets. */
+interface PerpsUniverse$1 {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Name of the universe. */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Unique identifier for the margin requirements table. */
+    marginTableId: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+    /** Indicates if the universe is in growth mode, eligible for discounted fees */
+    growthMode?: "enabled";
+    /** Margin mode for the universe. */
+    marginMode?: "strictIsolated" | "noCross";
+}
+
 interface PerpDex {
     /** Short name of the perpetual dex. */
     name: string;
@@ -267,9 +298,10 @@ interface MarketInfo {
     dexDisplayName?: string;
     dexImageUrl?: string;
     dexCollateralTokenSymbol?: string;
+    growthMode: boolean;
 }
 interface DexInfo {
-    meta: PerpsMeta;
+    meta: PerpsMeta$1;
     assetContext: PerpsAssetCtx[];
     dexFullName: string;
     dexName: string;
@@ -279,7 +311,7 @@ interface DexInfo {
     imageUrl?: string;
     accountName?: string;
 }
-type ExtendedPerpsMeta = PerpsMeta & {
+type ExtendedPerpsMeta = PerpsMeta$1 & {
     collateralToken?: number;
 };
 /**
@@ -324,6 +356,7 @@ interface MetadataClientConfig {
  * - HIP-3: 100000 + perp_dex_index * 10000 + index_in_meta
  */
 declare const ROOT_DEX = "hyperliquid";
+/**@deprecated use react sdk instead */
 declare class MetadataClient {
     private infoClient;
     private config;
@@ -428,7 +461,7 @@ declare class MetadataClient {
      */
     getRawMetadata(): {
         spotMeta: SpotMeta | null;
-        perpsMeta: PerpsMeta | null;
+        perpsMeta: PerpsMeta$1 | null;
         perpDexs: (PerpDex | null)[];
         hip3DexsMeta: {
             [k: string]: DexInfo;
@@ -552,6 +585,8 @@ declare function getStaticCollateralTokenByDex(dex: string): string;
  * @returns The collateral token symbol for the given coin
  */
 declare function getStaticCollateralTokenSymbol(coin: string | undefined): string;
+declare const stableQuoteTokens: string[];
+declare function isStableQuoteToken(coin: string): boolean;
 /**
  * Get display market symbol for a given coin
  * @param coin - The coin symbol to get the display market symbol for eg. xyz:XYZ100
@@ -564,4 +599,40 @@ declare function getStaticCollateralTokenSymbol(coin: string | undefined): strin
 declare function getDisplayMarketSymbol(coin: string | undefined, showCollateralTokenSymbol?: boolean, collateralTokenSymbol?: string): string | undefined;
 declare function getDexFromCollateralTokenSymbol(collateralTokenSymbol: string): string | undefined;
 
-export { type AirdropAllocationData, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction };
+interface PerpsMeta {
+    collateralToken: number;
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse[];
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: MarginTables;
+}
+/** Metadata and context for perpetual assets. */
+type PerpsMetaAndAssetCtxs = [
+    /** Metadata for assets. */
+    PerpsMeta,
+    /** Context for each perpetual asset. */
+    PerpsAssetCtx[]
+];
+/** Trading universe parameters for perpetual assets. */
+interface PerpsUniverse {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Name of the universe. */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Unique identifier for the margin requirements table. */
+    marginTableId: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+    /** Indicates if the universe is in growth mode, eligible for discounted fees */
+    growthMode?: true;
+    /** Margin mode for the universe. */
+    marginMode?: "strictIsolated" | "noCross";
+}
+type AllPerpsMeta = PerpsMeta[];
+declare function getAllPerpsMeta(infoClient: InfoClient): Promise<AllPerpsMeta>;
+
+export { type AirdropAllocationData, type AllPerpsMeta, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PerpsMeta, type PerpsMetaAndAssetCtxs, type PerpsUniverse, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getAllPerpsMeta, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SpotToken, PerpsMeta, PerpsAssetCtx, SpotMeta, ExchangeClient, SuccessResponse, InfoClient } from '@nktkas/hyperliquid';
+import { SpotToken, MarginTables, PerpsAssetCtx, SpotMeta, ExchangeClient, SuccessResponse, InfoClient } from '@nktkas/hyperliquid';
 import { Hex } from '@nktkas/hyperliquid/types';
 
 declare function encodeSlug(slug: string): bigint;
@@ -45,6 +45,7 @@ declare const CloidClientCode: {
     readonly Desktop: 7;
     readonly API: 8;
     readonly Stream: 9;
+    readonly Pal: 10;
 };
 type ClientCodeType = keyof typeof CloidClientCode;
 type CloidClientCodeId = (typeof CloidClientCode)[ClientCodeType];
@@ -82,17 +83,19 @@ declare const TARGET_APPROVED_MAX_BUILDER_FEE: number;
 declare const TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT = "0.1%";
 /**
  * Get the amount of builder fee to approve for
- * @param perpetualTradingFee - Perp fee in percentage
- * @param spotTradingFee - Spot fee in percentage
+ * @param perpetualTradingFee - Perp fee in percentage (0.025 means 0.025% perp fee)
+ * @param spotTradingFee - Spot fee in percentage (0.01 means 0.01% spot fee)
+ * @param feeDiscount - Discount fee in percentage (0.9 means 90% discount)
  * @returns {
  *   amount: number;  - The amount of builder fee to approve in 1/10 of a basis point
  *   percent: string;  - eg. String input to approve fee, "0.1%"
  * }
  */
-declare const getApprovalAmount: ({ customFeeEnabled, perpetualTradingFee, spotTradingFee, }: {
+declare const getApprovalAmount: ({ customFeeEnabled, perpetualTradingFee, spotTradingFee, feeDiscount, }: {
     customFeeEnabled: boolean;
     perpetualTradingFee?: number;
     spotTradingFee?: number;
+    feeDiscount?: number;
 }) => {
     approvalAmount: number;
     approvalPercent: `${string}%`;
@@ -236,6 +239,34 @@ declare function getNextTierInfo(pupTokenAmount: number, normalizedAirDropAmount
 declare const USDC_SPOT_TOKEN: SpotToken;
 declare const TESTNET_USDC_SPOT_TOKEN: SpotToken;
 
+interface PerpsMeta$1 {
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse$1[];
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: MarginTables;
+    /** Collateral token index. */
+    collateralToken?: number;
+}
+/** Trading universe parameters for perpetual assets. */
+interface PerpsUniverse$1 {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Name of the universe. */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Unique identifier for the margin requirements table. */
+    marginTableId: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+    /** Indicates if the universe is in growth mode, eligible for discounted fees */
+    growthMode?: "enabled";
+    /** Margin mode for the universe. */
+    marginMode?: "strictIsolated" | "noCross";
+}
+
 interface PerpDex {
     /** Short name of the perpetual dex. */
     name: string;
@@ -267,9 +298,10 @@ interface MarketInfo {
     dexDisplayName?: string;
     dexImageUrl?: string;
     dexCollateralTokenSymbol?: string;
+    growthMode: boolean;
 }
 interface DexInfo {
-    meta: PerpsMeta;
+    meta: PerpsMeta$1;
     assetContext: PerpsAssetCtx[];
     dexFullName: string;
     dexName: string;
@@ -279,7 +311,7 @@ interface DexInfo {
     imageUrl?: string;
     accountName?: string;
 }
-type ExtendedPerpsMeta = PerpsMeta & {
+type ExtendedPerpsMeta = PerpsMeta$1 & {
     collateralToken?: number;
 };
 /**
@@ -324,6 +356,7 @@ interface MetadataClientConfig {
  * - HIP-3: 100000 + perp_dex_index * 10000 + index_in_meta
  */
 declare const ROOT_DEX = "hyperliquid";
+/**@deprecated use react sdk instead */
 declare class MetadataClient {
     private infoClient;
     private config;
@@ -428,7 +461,7 @@ declare class MetadataClient {
      */
     getRawMetadata(): {
         spotMeta: SpotMeta | null;
-        perpsMeta: PerpsMeta | null;
+        perpsMeta: PerpsMeta$1 | null;
         perpDexs: (PerpDex | null)[];
         hip3DexsMeta: {
             [k: string]: DexInfo;
@@ -552,6 +585,8 @@ declare function getStaticCollateralTokenByDex(dex: string): string;
  * @returns The collateral token symbol for the given coin
  */
 declare function getStaticCollateralTokenSymbol(coin: string | undefined): string;
+declare const stableQuoteTokens: string[];
+declare function isStableQuoteToken(coin: string): boolean;
 /**
  * Get display market symbol for a given coin
  * @param coin - The coin symbol to get the display market symbol for eg. xyz:XYZ100
@@ -564,4 +599,40 @@ declare function getStaticCollateralTokenSymbol(coin: string | undefined): strin
 declare function getDisplayMarketSymbol(coin: string | undefined, showCollateralTokenSymbol?: boolean, collateralTokenSymbol?: string): string | undefined;
 declare function getDexFromCollateralTokenSymbol(collateralTokenSymbol: string): string | undefined;
 
-export { type AirdropAllocationData, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction };
+interface PerpsMeta {
+    collateralToken: number;
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse[];
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: MarginTables;
+}
+/** Metadata and context for perpetual assets. */
+type PerpsMetaAndAssetCtxs = [
+    /** Metadata for assets. */
+    PerpsMeta,
+    /** Context for each perpetual asset. */
+    PerpsAssetCtx[]
+];
+/** Trading universe parameters for perpetual assets. */
+interface PerpsUniverse {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Name of the universe. */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Unique identifier for the margin requirements table. */
+    marginTableId: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+    /** Indicates if the universe is in growth mode, eligible for discounted fees */
+    growthMode?: true;
+    /** Margin mode for the universe. */
+    marginMode?: "strictIsolated" | "noCross";
+}
+type AllPerpsMeta = PerpsMeta[];
+declare function getAllPerpsMeta(infoClient: InfoClient): Promise<AllPerpsMeta>;
+
+export { type AirdropAllocationData, type AllPerpsMeta, CloidClientCode, type CloidClientCodeId, CloidClientCodeNameById, type CloidData, type DexInfo, type ExtendedPerpsMeta, type MarketInfo, MetadataClient, PUP_TOKEN_ADDRESS, PUP_TOKEN_THRESHOLDS, type PerpDex, type PerpsMeta, type PerpsMetaAndAssetCtxs, type PerpsUniverse, type PupEligibilityResult, ROOT_DEX, TARGET_APPROVED_MAX_BUILDER_FEE, TARGET_APPROVED_MAX_BUILDER_FEE_PERCENT, TESTNET_USDC_SPOT_TOKEN, type TokenInfo, USDC_SPOT_TOKEN, type UpheavalApiResponse, type UpheavalPosition, type UpheavalSnapshot, UserDexAbstractionTypes, type V3LPTokenInfo, WidgetType, WidgetTypeById, type WidgetTypeId, XP_BOOST_PERCENTAGES, buildCloid, calculateBoostPercentage, calculateTotalPupAmount, decodeSlug, enableHip3DexAbstractionWithAgent, encodeSlug, formatPriceAndSize, formatPriceForDisplay, formatPriceForOrder, formatSizeForDisplay, formatSizeForOrder, getAllPerpsMeta, getApprovalAmount, getClientCodeNameById, getCloid, getDexFromCollateralTokenSymbol, getDisplayMarketSymbol, getHip3Dex, getHip3DexAbstraction, getNextTierInfo, getPriceDecimals, getStaticCollateralTokenByDex, getStaticCollateralTokenSymbol, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isSpotSymbol, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };