@rabby-wallet/hyperliquid-sdk 1.0.6 → 1.0.7-alpha.0

package/dist/client/info-client.d.ts

@@ -1,4 +1,4 @@
-import type { Meta, AssetCtx, ClearinghouseState, UserFills, CandleSnapshot, AllMids, ExtraAgent, OpenOrder, FeeResponse, UserNonFundingLedgerUpdates, UserHistoricalOrders } from '../types';
+import type { Meta, AssetCtx, ClearinghouseState, UserFills, CandleSnapshot, AllMids, ExtraAgent, OpenOrder, FeeResponse, UserNonFundingLedgerUpdates, UserHistoricalOrders, ReferralResponse } from '../types';
 export interface InfoClientConfig {
     isTestnet?: boolean;
     timeout?: number;
@@ -31,8 +31,8 @@ export declare class InfoClient {
      */
     getUserFills(address?: string, aggregateByTime?: boolean): Promise<UserFills>;
     /**
-   * Get user's fill and cancel and other all orders history
-   */
+     * Get user's fill and cancel and other all orders history
+     */
     getUserHistoricalOrders(address?: string, startTime?: number, endTime?: number): Promise<UserHistoricalOrders[]>;
     /**
      * Get candlestick data snapshot
@@ -49,6 +49,10 @@ export declare class InfoClient {
     getUserRole(address?: string): Promise<{
         role: 'user' | 'agent' | 'vault' | 'subAccount' | 'missing';
     }>;
+    /**
+     * Get referral
+     */
+    getReferral(address?: string): Promise<ReferralResponse>;
     /**
      * Get user fees information
      */

package/dist/client/info-client.js

@@ -129,8 +129,8 @@ class InfoClient {
         });
     }
     /**
-   * Get user's fill and cancel and other all orders history
-   */
+     * Get user's fill and cancel and other all orders history
+     */
     getUserHistoricalOrders(address, startTime, endTime) {
         return __awaiter(this, void 0, void 0, function* () {
             const user = address || this.masterAddress;
@@ -151,7 +151,7 @@ class InfoClient {
      */
     candleSnapshot(coin, interval, startTime, endTime) {
         return __awaiter(this, void 0, void 0, function* () {
-            // if no time range is specified, default to 24 hours ago 
+            // if no time range is specified, default to 24 hours ago
             const now = Date.now();
             return this.httpClient.info({
                 type: constants_1.InfoType.CANDLES_SNAPSHOT,
@@ -196,6 +196,22 @@ class InfoClient {
             return res;
         });
     }
+    /**
+     * Get referral
+     */
+    getReferral(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const user = address || this.masterAddress;
+            if (!user) {
+                throw new Error('user address is empty');
+            }
+            const res = yield this.httpClient.info({
+                type: constants_1.InfoType.REFERRAL,
+                user,
+            });
+            return res;
+        });
+    }
     /**
      * Get user fees information
      */

package/dist/types/constants.d.ts

@@ -46,7 +46,8 @@ export declare enum InfoType {
     MAX_BUILDER_FEE = "maxBuilderFee",
     USER_FEES = "userFees",
     USER_ROLE = "userRole",
-    EXTRA_AGENTS = "extraAgents"
+    EXTRA_AGENTS = "extraAgents",
+    REFERRAL = "referral"
 }
 export declare enum OrderType {
     LIMIT = "limit",
@@ -58,7 +59,7 @@ export declare enum OrderType {
 }
 export declare enum TimeInForce {
     GTC = "Gtc",// Good Till Cancel
-    IOC = "Ioc",// Immediate or Cancel  
+    IOC = "Ioc",// Immediate or Cancel
     ALO = "Alo"
 }
 export declare const CHAIN_IDS: {

package/dist/types/constants.js

@@ -55,6 +55,7 @@ var InfoType;
     InfoType["USER_FEES"] = "userFees";
     InfoType["USER_ROLE"] = "userRole";
     InfoType["EXTRA_AGENTS"] = "extraAgents";
+    InfoType["REFERRAL"] = "referral";
 })(InfoType || (exports.InfoType = InfoType = {}));
 // Order types
 var OrderType;

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { SymbolConversion } from "../client/symbolConversion";
+import { SymbolConversion } from '../client/symbolConversion';
 export type Tif = 'Alo' | 'Ioc' | 'Gtc';
 export type TriggerType = 'tp' | 'sl';
 export type Side = 'A' | 'B';
@@ -43,8 +43,8 @@ export interface OpenOrder {
     triggerPx: string;
     isPositionTpsl: boolean;
     reduceOnly: boolean;
-    orderType: "Take Profit Market" | "Stop Market";
-    origSz: "0.0";
+    orderType: 'Take Profit Market' | 'Stop Market';
+    origSz: '0.0';
     tif: null;
 }
 export interface OrderRequest {
@@ -409,3 +409,36 @@ export interface SendApproveParams {
     nonce: number;
     signature: string;
 }
+export interface ReferralResponse {
+    referredBy: {
+        referrer: string;
+        code: string;
+    };
+    cumVlm: string;
+    unclaimedRewards: string;
+    claimedRewards: string;
+    builderRewards: string;
+    tokenToState: [
+        number,
+        {
+            cumVlm: string;
+            unclaimedRewards: string;
+            claimedRewards: string;
+            builderRewards: string;
+        }
+    ];
+    referrerState: {
+        stage: string;
+        data: {
+            code: string;
+            referralStates: {
+                cumVlm: string;
+                cumRewardedFeesSinceReferred: string;
+                cumFeesRewardedToReferrer: string;
+                timeJoined: number;
+                user: string;
+            }[];
+        };
+    };
+    rewardHistory: any[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/hyperliquid-sdk",
-  "version": "1.0.6",
+  "version": "1.0.7-alpha.0",
   "description": "Simplified Hyperliquid Perpetuals Trading SDK for Frontend Applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",