@basedone/core 0.1.5 → 0.1.8

package/dist/index.d.mts

@@ -84,15 +84,17 @@ 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 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}%`;
@@ -471,6 +473,18 @@ declare const formatPriceForOrder: ({ px, szDecimals, isSpot, }: {
     szDecimals: number;
     isSpot: boolean;
 }) => number;
+/**
+ * Formats price for order placement following Hyperliquid rules
+ * - Rounded to priceDecimals of the asset
+ * @param px - The price to format
+ * @param priceDecimals - Price decimals for the asset
+ * @returns Formatted price as number (rounded to priceDecimals if exceeds)
+ */
+declare const formatPriceForDisplay: ({ px, szDecimals, isSpot, }: {
+    px: number;
+    szDecimals: number;
+    isSpot: boolean;
+}) => string;
 /**
  * Formats size for order placement following Hyperliquid rules
  * - Rounded to szDecimals of the asset
@@ -482,6 +496,17 @@ declare const formatSizeForOrder: ({ sz, szDecimals, }: {
     sz: number;
     szDecimals: number;
 }) => number;
+/**
+ * Formats size for order placement following Hyperliquid rules
+ * - Rounded to szDecimals of the asset
+ * @param sz - The size to format
+ * @param szDecimals - Size decimals for the asset
+ * @returns Formatted size as number (rounded down to szDecimals if exceeds)
+ */
+declare const formatSizeForDisplay: ({ sz, szDecimals, }: {
+    sz: number;
+    szDecimals: number;
+}) => string;
 /**
  * Get minimum price decimals for tick size calculations
  * Uses the same logic as internal price formatting
@@ -498,7 +523,7 @@ declare const formatSizeForOrder: ({ sz, szDecimals, }: {
  */
 declare function getPriceDecimals(price: number, szDecimals: number, isSpot: boolean): number;
 
-declare function isHip3Symbol(symbol: string): boolean;
+declare function isHip3Symbol(symbol: string | undefined): boolean;
 declare function getHip3Dex(symbol: string): string | null;
 /**
  * Enable HIP-3 DEX abstraction with the current agent wallet
@@ -521,5 +546,26 @@ declare const UserDexAbstractionTypes: {
  */
 declare function setHip3DexAbstraction(client: ExchangeClient, enabled: boolean, user: string): Promise<SuccessResponse>;
 declare function getHip3DexAbstraction(client: InfoClient, user: string): Promise<boolean | null>;
+declare const isSpotSymbol: (coin: string | undefined) => boolean;
+declare function getStaticCollateralTokenByDex(dex: string): string;
+/**
+ * Get static collateral token symbol for a given coin
+ * @param coin - The coin symbol to get the collateral token symbol for eg. xyz:XYZ100
+ * @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
+ * @param showCollateralTokenSymbol - Whether to show the collateral token symbol. Default is true.
+ * @returns
+ * HIP-3 symbol: The display market symbol for the given coin eg. XYZ100-USDC, BTC-USDE, etc.
+ * If showCollateralTokenSymbol is false, returns the symbol without the collateral token symbol. eg. rrrrr:BTC -> BTC, hyena:BTC -> BTC
+ * Spot symbol: returns the coin argument itself
+ */
+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, formatPriceForOrder, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getHip3Dex, getHip3DexAbstraction, getNextTierInfo, getPriceDecimals, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction };
+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, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };

package/dist/index.d.ts

@@ -84,15 +84,17 @@ 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 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}%`;
@@ -471,6 +473,18 @@ declare const formatPriceForOrder: ({ px, szDecimals, isSpot, }: {
     szDecimals: number;
     isSpot: boolean;
 }) => number;
+/**
+ * Formats price for order placement following Hyperliquid rules
+ * - Rounded to priceDecimals of the asset
+ * @param px - The price to format
+ * @param priceDecimals - Price decimals for the asset
+ * @returns Formatted price as number (rounded to priceDecimals if exceeds)
+ */
+declare const formatPriceForDisplay: ({ px, szDecimals, isSpot, }: {
+    px: number;
+    szDecimals: number;
+    isSpot: boolean;
+}) => string;
 /**
  * Formats size for order placement following Hyperliquid rules
  * - Rounded to szDecimals of the asset
@@ -482,6 +496,17 @@ declare const formatSizeForOrder: ({ sz, szDecimals, }: {
     sz: number;
     szDecimals: number;
 }) => number;
+/**
+ * Formats size for order placement following Hyperliquid rules
+ * - Rounded to szDecimals of the asset
+ * @param sz - The size to format
+ * @param szDecimals - Size decimals for the asset
+ * @returns Formatted size as number (rounded down to szDecimals if exceeds)
+ */
+declare const formatSizeForDisplay: ({ sz, szDecimals, }: {
+    sz: number;
+    szDecimals: number;
+}) => string;
 /**
  * Get minimum price decimals for tick size calculations
  * Uses the same logic as internal price formatting
@@ -498,7 +523,7 @@ declare const formatSizeForOrder: ({ sz, szDecimals, }: {
  */
 declare function getPriceDecimals(price: number, szDecimals: number, isSpot: boolean): number;
 
-declare function isHip3Symbol(symbol: string): boolean;
+declare function isHip3Symbol(symbol: string | undefined): boolean;
 declare function getHip3Dex(symbol: string): string | null;
 /**
  * Enable HIP-3 DEX abstraction with the current agent wallet
@@ -521,5 +546,26 @@ declare const UserDexAbstractionTypes: {
  */
 declare function setHip3DexAbstraction(client: ExchangeClient, enabled: boolean, user: string): Promise<SuccessResponse>;
 declare function getHip3DexAbstraction(client: InfoClient, user: string): Promise<boolean | null>;
+declare const isSpotSymbol: (coin: string | undefined) => boolean;
+declare function getStaticCollateralTokenByDex(dex: string): string;
+/**
+ * Get static collateral token symbol for a given coin
+ * @param coin - The coin symbol to get the collateral token symbol for eg. xyz:XYZ100
+ * @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
+ * @param showCollateralTokenSymbol - Whether to show the collateral token symbol. Default is true.
+ * @returns
+ * HIP-3 symbol: The display market symbol for the given coin eg. XYZ100-USDC, BTC-USDE, etc.
+ * If showCollateralTokenSymbol is false, returns the symbol without the collateral token symbol. eg. rrrrr:BTC -> BTC, hyena:BTC -> BTC
+ * Spot symbol: returns the coin argument itself
+ */
+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, formatPriceForOrder, formatSizeForOrder, getApprovalAmount, getClientCodeNameById, getCloid, getHip3Dex, getHip3DexAbstraction, getNextTierInfo, getPriceDecimals, getWidgetTypeById, isBasedCloid, isClientCode, isHip3Symbol, isMiniAppCloid, isMiniAppTriggeredCloid, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction };
+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, isStableQuoteToken, isTenantCloid, isTrackingIdCloid, isWidgetType, normaliseSlug, normaliseTrackingId, normalizeAirdropAmount, parseCloid, setHip3DexAbstraction, stableQuoteTokens };