@madeinusmate/grvt-cli 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,462 @@
+import { z } from 'zod';
+
+declare const configSchema: z.ZodObject<{
+    env: z.ZodDefault<z.ZodEnum<["dev", "staging", "testnet", "prod"]>>;
+    apiKey: z.ZodOptional<z.ZodString>;
+    privateKey: z.ZodOptional<z.ZodString>;
+    subAccountId: z.ZodOptional<z.ZodString>;
+    accountId: z.ZodOptional<z.ZodString>;
+    cookie: z.ZodOptional<z.ZodString>;
+    outputDefaults: z.ZodDefault<z.ZodObject<{
+        output: z.ZodDefault<z.ZodEnum<["json", "ndjson", "table", "raw"]>>;
+        pretty: z.ZodDefault<z.ZodBoolean>;
+        silent: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        output: "json" | "ndjson" | "table" | "raw";
+        pretty: boolean;
+        silent: boolean;
+    }, {
+        output?: "json" | "ndjson" | "table" | "raw" | undefined;
+        pretty?: boolean | undefined;
+        silent?: boolean | undefined;
+    }>>;
+    http: z.ZodDefault<z.ZodObject<{
+        timeoutMs: z.ZodDefault<z.ZodNumber>;
+        retries: z.ZodDefault<z.ZodNumber>;
+        backoffMs: z.ZodDefault<z.ZodNumber>;
+        maxBackoffMs: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        timeoutMs: number;
+        retries: number;
+        backoffMs: number;
+        maxBackoffMs: number;
+    }, {
+        timeoutMs?: number | undefined;
+        retries?: number | undefined;
+        backoffMs?: number | undefined;
+        maxBackoffMs?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    env: "dev" | "staging" | "testnet" | "prod";
+    outputDefaults: {
+        output: "json" | "ndjson" | "table" | "raw";
+        pretty: boolean;
+        silent: boolean;
+    };
+    http: {
+        timeoutMs: number;
+        retries: number;
+        backoffMs: number;
+        maxBackoffMs: number;
+    };
+    apiKey?: string | undefined;
+    privateKey?: string | undefined;
+    subAccountId?: string | undefined;
+    accountId?: string | undefined;
+    cookie?: string | undefined;
+}, {
+    env?: "dev" | "staging" | "testnet" | "prod" | undefined;
+    apiKey?: string | undefined;
+    privateKey?: string | undefined;
+    subAccountId?: string | undefined;
+    accountId?: string | undefined;
+    cookie?: string | undefined;
+    outputDefaults?: {
+        output?: "json" | "ndjson" | "table" | "raw" | undefined;
+        pretty?: boolean | undefined;
+        silent?: boolean | undefined;
+    } | undefined;
+    http?: {
+        timeoutMs?: number | undefined;
+        retries?: number | undefined;
+        backoffMs?: number | undefined;
+        maxBackoffMs?: number | undefined;
+    } | undefined;
+}>;
+type GrvtConfig = z.infer<typeof configSchema>;
+
+declare const loadConfig: () => GrvtConfig;
+declare const saveConfig: (config: GrvtConfig) => void;
+
+type GrvtEnvironment = "dev" | "staging" | "testnet" | "prod";
+declare const ENDPOINTS: {
+    readonly auth: {
+        readonly login: "/auth/api_key/login";
+    };
+    readonly marketData: {
+        readonly instrument: "/full/v1/instrument";
+        readonly allInstruments: "/full/v1/all_instruments";
+        readonly instruments: "/full/v1/instruments";
+        readonly currency: "/full/v1/currency";
+        readonly marginRules: "/full/v1/margin_rules";
+        readonly mini: "/full/v1/mini";
+        readonly ticker: "/full/v1/ticker";
+        readonly tradeHistory: "/full/v1/trade_history";
+        readonly kline: "/full/v1/kline";
+        readonly funding: "/full/v1/funding";
+        readonly book: "/full/v1/book";
+    };
+    readonly trading: {
+        readonly createOrder: "/full/v1/create_order";
+        readonly cancelOrder: "/full/v1/cancel_order";
+        readonly cancelAllOrders: "/full/v1/cancel_all_orders";
+        readonly getOrder: "/full/v1/order";
+        readonly openOrders: "/full/v1/open_orders";
+        readonly orderHistory: "/full/v1/order_history";
+        readonly cancelOnDisconnect: "/full/v1/cancel_on_disconnect";
+        readonly fillHistory: "/full/v1/fill_history";
+        readonly positions: "/full/v1/positions";
+        readonly fundingPaymentHistory: "/full/v1/funding_payment_history";
+        readonly getAllInitialLeverage: "/full/v1/get_all_initial_leverage";
+        readonly setInitialLeverage: "/full/v1/set_initial_leverage";
+        readonly setDeriskMmRatio: "/full/v1/set_derisk_mm_ratio";
+    };
+    readonly account: {
+        readonly accountSummary: "/full/v1/account_summary";
+        readonly accountHistory: "/full/v1/account_history";
+        readonly fundingAccountSummary: "/full/v1/funding_account_summary";
+        readonly aggregatedAccountSummary: "/full/v1/aggregated_account_summary";
+    };
+    readonly funds: {
+        readonly depositHistory: "/full/v1/deposit_history";
+        readonly transfer: "/full/v1/transfer";
+        readonly transferHistory: "/full/v1/transfer_history";
+        readonly withdrawal: "/full/v1/withdrawal";
+        readonly withdrawalHistory: "/full/v1/withdrawal_history";
+    };
+};
+
+interface HttpClientOptions {
+    env: GrvtEnvironment;
+    cookie?: string;
+    accountId?: string;
+    timeoutMs?: number;
+    retries?: number;
+    backoffMs?: number;
+    maxBackoffMs?: number;
+}
+interface HttpClient {
+    post: <T>(baseType: "edge" | "marketData" | "trading", path: string, body?: unknown) => Promise<T>;
+}
+declare const createHttpClient: (options: HttpClientOptions) => HttpClient;
+
+interface LoginOptions {
+    apiKey: string;
+    env?: GrvtEnvironment;
+    privateKey?: string;
+}
+
+declare const login: (options: LoginOptions) => Promise<{
+    accountId: string;
+    env: GrvtEnvironment;
+}>;
+declare const logout: () => void;
+declare const verifySession: () => Promise<{
+    valid: boolean;
+    env: string;
+    accountId?: string;
+}>;
+
+type Kind = "PERPETUAL" | "FUTURE" | "CALL" | "PUT";
+type Currency = string;
+type TimeInForce = "GOOD_TILL_TIME" | "IMMEDIATE_OR_CANCEL" | "ALL_OR_NONE" | "FILL_OR_KILL";
+interface OrderLeg {
+    instrument: string;
+    size: string;
+    limit_price?: string;
+    is_buying_asset: boolean;
+}
+interface OrderMetadata {
+    client_order_id: string;
+    create_time?: string;
+}
+interface OrderSignature {
+    signer: string;
+    r: string;
+    s: string;
+    v: number;
+    expiration: string;
+    nonce: number;
+}
+interface SignedOrder {
+    sub_account_id: string;
+    is_market: boolean;
+    time_in_force: TimeInForce;
+    post_only: boolean;
+    reduce_only: boolean;
+    legs: OrderLeg[];
+    signature: OrderSignature;
+    metadata: OrderMetadata;
+}
+interface CancelOrderRequest {
+    sub_account_id: string;
+    order_id?: string;
+    client_order_id?: string;
+}
+interface CancelAllOrdersRequest {
+    sub_account_id: string;
+    instrument?: string;
+}
+interface GetOrderRequest {
+    sub_account_id: string;
+    order_id?: string;
+    client_order_id?: string;
+}
+interface GetOpenOrdersRequest {
+    sub_account_id: string;
+    kind?: Kind[];
+    base?: Currency[];
+    quote?: Currency[];
+}
+interface PaginatedRequest {
+    sub_account_id: string;
+    kind?: Kind[];
+    base?: Currency[];
+    quote?: Currency[];
+    start_time?: string;
+    end_time?: string;
+    limit?: number;
+    cursor?: string;
+}
+interface GetPositionsRequest {
+    sub_account_id: string;
+    kind?: Kind[];
+    base?: Currency[];
+    quote?: Currency[];
+}
+interface TransferRequest {
+    from_sub_account_id: string;
+    to_sub_account_id: string;
+    currency: string;
+    num_tokens: string;
+}
+interface WithdrawalRequest {
+    main_account_id: string;
+    from_sub_account_id: string;
+    to_eth_address: string;
+    currency: string;
+    num_tokens: string;
+}
+interface HistoryRequest {
+    start_time?: string;
+    end_time?: string;
+    limit?: number;
+    cursor?: string;
+}
+interface ApiResponse<T = unknown> {
+    result: T;
+    next?: string;
+}
+
+declare const createOrder: (client: HttpClient, order: SignedOrder) => Promise<unknown>;
+declare const cancelOrder: (client: HttpClient, params: CancelOrderRequest) => Promise<unknown>;
+declare const cancelAllOrders: (client: HttpClient, params: CancelAllOrdersRequest) => Promise<unknown>;
+declare const getOrder: (client: HttpClient, params: GetOrderRequest) => Promise<unknown>;
+declare const getOpenOrders: (client: HttpClient, params: GetOpenOrdersRequest) => Promise<unknown>;
+declare const getOrderHistory: (client: HttpClient, params: PaginatedRequest) => Promise<ApiResponse<unknown[]>>;
+
+declare const getFillHistory: (client: HttpClient, params: PaginatedRequest) => Promise<ApiResponse<unknown[]>>;
+
+declare const getPositions: (client: HttpClient, params: GetPositionsRequest) => Promise<unknown>;
+
+declare const getFundingPayments: (client: HttpClient, params: PaginatedRequest) => Promise<ApiResponse<unknown[]>>;
+
+declare const getFundingAccountSummary: (client: {
+    post: <T>(base: "edge" | "marketData" | "trading", path: string, body?: unknown) => Promise<T>;
+}) => Promise<unknown>;
+declare const getSubAccountSummary: (client: {
+    post: <T>(base: "edge" | "marketData" | "trading", path: string, body?: unknown) => Promise<T>;
+}, subAccountId: string) => Promise<unknown>;
+declare const getSubAccountHistory: (client: {
+    post: <T>(base: "edge" | "marketData" | "trading", path: string, body?: unknown) => Promise<T>;
+}, subAccountId: string) => Promise<unknown>;
+declare const getAccountHistory: (client: {
+    post: <T>(base: "edge" | "marketData" | "trading", path: string, body?: unknown) => Promise<T>;
+}, params: {
+    sub_account_id: string;
+    start_time?: string;
+    end_time?: string;
+    limit?: number;
+    cursor?: string;
+}) => Promise<ApiResponse<unknown[]>>;
+declare const getAggregatedAccountSummary: (client: {
+    post: <T>(base: "edge" | "marketData" | "trading", path: string, body?: unknown) => Promise<T>;
+}) => Promise<unknown>;
+
+declare const createDeposit: (_client: HttpClient, _params: unknown) => Promise<unknown>;
+declare const getDepositHistory: (client: HttpClient, params: HistoryRequest) => Promise<ApiResponse<unknown[]>>;
+
+declare const createTransfer: (client: HttpClient, params: TransferRequest) => Promise<unknown>;
+declare const getTransferHistory: (client: HttpClient, params: HistoryRequest) => Promise<ApiResponse<unknown[]>>;
+
+declare const createWithdrawal: (client: HttpClient, params: WithdrawalRequest) => Promise<unknown>;
+declare const getWithdrawalHistory: (client: HttpClient, params: HistoryRequest) => Promise<ApiResponse<unknown[]>>;
+
+type OutputFormat = "json" | "ndjson" | "table" | "raw";
+interface OutputOptions {
+    output: OutputFormat;
+    pretty?: boolean;
+    silent?: boolean;
+}
+
+interface PaginateOptions<T> {
+    fetchPage: (cursor?: string) => Promise<{
+        result: T[];
+        next?: string;
+    }>;
+    limit?: number;
+    cursor?: string;
+    all?: boolean;
+    outputOptions: OutputOptions;
+}
+declare const paginateCursor: <T>(options: PaginateOptions<T>) => Promise<T[]>;
+
+interface CurrencyDetail {
+    id: number;
+    symbol: string;
+    balance_decimals: number;
+    quantity_multiplier: string;
+}
+declare const getCurrencies: (env: GrvtEnvironment, cookie?: string, accountId?: string) => Promise<Record<string, CurrencyDetail>>;
+declare const getCurrencyId: (env: GrvtEnvironment, symbol: string, cookie?: string, accountId?: string) => Promise<number>;
+declare const getCurrencyDecimals: (env: GrvtEnvironment, symbol: string, cookie?: string, accountId?: string) => Promise<number>;
+
+interface TransferPayload {
+    fromAccount: string;
+    fromSubAccount: string;
+    toAccount: string;
+    toSubAccount: string;
+    tokenCurrency: number;
+    numTokens: string;
+    balanceDecimals: number;
+    expiration: string;
+    nonce: number;
+}
+declare const buildTransferTypedData: (payload: TransferPayload, env: GrvtEnvironment) => {
+    domain: {
+        readonly name: "GRVT Exchange";
+        readonly version: "0";
+        readonly chainId: bigint;
+    };
+    types: {
+        readonly Transfer: readonly [{
+            readonly name: "fromAccount";
+            readonly type: "address";
+        }, {
+            readonly name: "fromSubAccount";
+            readonly type: "uint64";
+        }, {
+            readonly name: "toAccount";
+            readonly type: "address";
+        }, {
+            readonly name: "toSubAccount";
+            readonly type: "uint64";
+        }, {
+            readonly name: "tokenCurrency";
+            readonly type: "uint8";
+        }, {
+            readonly name: "numTokens";
+            readonly type: "uint64";
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint32";
+        }, {
+            readonly name: "expiration";
+            readonly type: "int64";
+        }];
+    };
+    primaryType: "Transfer";
+    message: {
+        fromAccount: `0x${string}`;
+        fromSubAccount: bigint;
+        toAccount: `0x${string}`;
+        toSubAccount: bigint;
+        tokenCurrency: number;
+        numTokens: bigint;
+        nonce: number;
+        expiration: bigint;
+    };
+};
+interface WithdrawalPayload {
+    fromAccount: string;
+    toEthAddress: string;
+    tokenCurrency: number;
+    numTokens: string;
+    balanceDecimals: number;
+    expiration: string;
+    nonce: number;
+}
+declare const buildWithdrawalTypedData: (payload: WithdrawalPayload, env: GrvtEnvironment) => {
+    domain: {
+        readonly name: "GRVT Exchange";
+        readonly version: "0";
+        readonly chainId: bigint;
+    };
+    types: {
+        readonly Withdrawal: readonly [{
+            readonly name: "fromAccount";
+            readonly type: "address";
+        }, {
+            readonly name: "toEthAddress";
+            readonly type: "address";
+        }, {
+            readonly name: "tokenCurrency";
+            readonly type: "uint8";
+        }, {
+            readonly name: "numTokens";
+            readonly type: "uint64";
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint32";
+        }, {
+            readonly name: "expiration";
+            readonly type: "int64";
+        }];
+    };
+    primaryType: "Withdrawal";
+    message: {
+        fromAccount: `0x${string}`;
+        toEthAddress: `0x${string}`;
+        tokenCurrency: number;
+        numTokens: bigint;
+        nonce: number;
+        expiration: bigint;
+    };
+};
+interface DeriskPayload {
+    subAccountId: string;
+    ratio: string;
+    expiration: string;
+    nonce: number;
+}
+declare const buildDeriskTypedData: (payload: DeriskPayload, env: GrvtEnvironment) => {
+    domain: {
+        readonly name: "GRVT Exchange";
+        readonly version: "0";
+        readonly chainId: bigint;
+    };
+    types: {
+        readonly SetDeriskMMRatio: readonly [{
+            readonly name: "subAccountID";
+            readonly type: "uint64";
+        }, {
+            readonly name: "ratio";
+            readonly type: "uint64";
+        }, {
+            readonly name: "nonce";
+            readonly type: "uint32";
+        }, {
+            readonly name: "expiration";
+            readonly type: "int64";
+        }];
+    };
+    primaryType: "SetDeriskMMRatio";
+    message: {
+        subAccountID: bigint;
+        ratio: bigint;
+        nonce: number;
+        expiration: bigint;
+    };
+};
+
+export { ENDPOINTS, type GrvtConfig, type GrvtEnvironment, buildDeriskTypedData, buildTransferTypedData, buildWithdrawalTypedData, cancelAllOrders, cancelOrder, configSchema, createDeposit, createHttpClient, createOrder, createTransfer, createWithdrawal, getAccountHistory, getAggregatedAccountSummary, getCurrencies, getCurrencyDecimals, getCurrencyId, getDepositHistory, getFillHistory, getFundingAccountSummary, getFundingPayments, getOpenOrders, getOrder, getOrderHistory, getPositions, getSubAccountHistory, getSubAccountSummary, getTransferHistory, getWithdrawalHistory, loadConfig, login, logout, paginateCursor, saveConfig, verifySession };