@typus/typus-sdk 1.2.70 → 1.2.71

package/lib/utils/typus_perp/position/structs.d.ts

@@ -0,0 +1,588 @@
+import * as reified from "../../_framework/reified";
+import { Option } from "../../_dependencies/source/0x1/option/structs";
+import { TypeName } from "../../_dependencies/source/0x1/type-name/structs";
+import { UID } from "../../_dependencies/source/0x2/object/structs";
+import { PhantomReified, Reified, StructClass, ToField, ToTypeStr, Vector } from "../../_framework/reified";
+import { FieldsWithTypes } from "../../_framework/util";
+import { Symbol } from "../symbol/structs";
+import { SuiClient, SuiParsedData } from "@mysten/sui.js/client";
+export declare function isOrderFilledEvent(type: string): boolean;
+export interface OrderFilledEventFields {
+    user: ToField<"address">;
+    collateralToken: ToField<TypeName>;
+    symbol: ToField<Symbol>;
+    orderId: ToField<"u64">;
+    linkedPositionId: ToField<Option<"u64">>;
+    newPositionId: ToField<Option<"u64">>;
+    filledSize: ToField<"u64">;
+    filledPrice: ToField<"u64">;
+    positionSide: ToField<"bool">;
+    positionSize: ToField<"u64">;
+    positionAveragePrice: ToField<"u64">;
+    u64Padding: ToField<Vector<"u64">>;
+}
+export type OrderFilledEventReified = Reified<OrderFilledEvent, OrderFilledEventFields>;
+export declare class OrderFilledEvent implements StructClass {
+    static readonly $typeName = "0x0::position::OrderFilledEvent";
+    static readonly $numTypeParams = 0;
+    readonly $typeName = "0x0::position::OrderFilledEvent";
+    readonly $fullTypeName: "0x0::position::OrderFilledEvent";
+    readonly $typeArgs: [];
+    readonly user: ToField<"address">;
+    readonly collateralToken: ToField<TypeName>;
+    readonly symbol: ToField<Symbol>;
+    readonly orderId: ToField<"u64">;
+    readonly linkedPositionId: ToField<Option<"u64">>;
+    readonly newPositionId: ToField<Option<"u64">>;
+    readonly filledSize: ToField<"u64">;
+    readonly filledPrice: ToField<"u64">;
+    readonly positionSide: ToField<"bool">;
+    readonly positionSize: ToField<"u64">;
+    readonly positionAveragePrice: ToField<"u64">;
+    readonly u64Padding: ToField<Vector<"u64">>;
+    private constructor();
+    static reified(): OrderFilledEventReified;
+    static get r(): reified.StructClassReified<OrderFilledEvent, OrderFilledEventFields>;
+    static phantom(): PhantomReified<ToTypeStr<OrderFilledEvent>>;
+    static get p(): reified.PhantomReified<"0x0::position::OrderFilledEvent">;
+    static get bcs(): import("@mysten/bcs").BcsType<{
+        user: string;
+        collateral_token: {
+            name: {
+                bytes: number[];
+            };
+        };
+        symbol: {
+            base_token: {
+                name: {
+                    bytes: number[];
+                };
+            };
+            quote_token: {
+                name: {
+                    bytes: number[];
+                };
+            };
+        };
+        order_id: string;
+        linked_position_id: {
+            vec: any[];
+        };
+        new_position_id: {
+            vec: any[];
+        };
+        filled_size: string;
+        filled_price: string;
+        position_side: boolean;
+        position_size: string;
+        position_average_price: string;
+        u64_padding: string[];
+    }, {
+        user: string;
+        collateral_token: {
+            name: {
+                bytes: Iterable<number> & {
+                    length: number;
+                };
+            };
+        };
+        symbol: {
+            base_token: {
+                name: {
+                    bytes: Iterable<number> & {
+                        length: number;
+                    };
+                };
+            };
+            quote_token: {
+                name: {
+                    bytes: Iterable<number> & {
+                        length: number;
+                    };
+                };
+            };
+        };
+        order_id: string | number | bigint;
+        linked_position_id: {
+            vec: Iterable<any> & {
+                length: number;
+            };
+        };
+        new_position_id: {
+            vec: Iterable<any> & {
+                length: number;
+            };
+        };
+        filled_size: string | number | bigint;
+        filled_price: string | number | bigint;
+        position_side: boolean;
+        position_size: string | number | bigint;
+        position_average_price: string | number | bigint;
+        u64_padding: Iterable<string | number | bigint> & {
+            length: number;
+        };
+    }>;
+    static fromFields(fields: Record<string, any>): OrderFilledEvent;
+    static fromFieldsWithTypes(item: FieldsWithTypes): OrderFilledEvent;
+    static fromBcs(data: Uint8Array): OrderFilledEvent;
+    toJSONField(): {
+        user: string;
+        collateralToken: {
+            name: string;
+        };
+        symbol: {
+            baseToken: {
+                name: string;
+            };
+            quoteToken: {
+                name: string;
+            };
+        };
+        orderId: string;
+        linkedPositionId: string | null;
+        newPositionId: string | null;
+        filledSize: string;
+        filledPrice: string;
+        positionSide: boolean;
+        positionSize: string;
+        positionAveragePrice: string;
+        u64Padding: string[];
+    };
+    toJSON(): {
+        user: string;
+        collateralToken: {
+            name: string;
+        };
+        symbol: {
+            baseToken: {
+                name: string;
+            };
+            quoteToken: {
+                name: string;
+            };
+        };
+        orderId: string;
+        linkedPositionId: string | null;
+        newPositionId: string | null;
+        filledSize: string;
+        filledPrice: string;
+        positionSide: boolean;
+        positionSize: string;
+        positionAveragePrice: string;
+        u64Padding: string[];
+        $typeName: string;
+        $typeArgs: [];
+    };
+    static fromJSONField(field: any): OrderFilledEvent;
+    static fromJSON(json: Record<string, any>): OrderFilledEvent;
+    static fromSuiParsedData(content: SuiParsedData): OrderFilledEvent;
+    static fetch(client: SuiClient, id: string): Promise<OrderFilledEvent>;
+}
+export declare function isPosition(type: string): boolean;
+export interface PositionFields {
+    id: ToField<UID>;
+    createTsMs: ToField<"u64">;
+    positionId: ToField<"u64">;
+    user: ToField<"address">;
+    isLong: ToField<"bool">;
+    size: ToField<"u64">;
+    sizeDecimal: ToField<"u64">;
+    collateralToken: ToField<TypeName>;
+    collateralTokenDecimal: ToField<"u64">;
+    symbol: ToField<Symbol>;
+    collateralAmount: ToField<"u64">;
+    reserveAmount: ToField<"u64">;
+    averagePrice: ToField<"u64">;
+    entryFundingIndex: ToField<"u64">;
+    realizedHasProfit: ToField<"bool">;
+    unrealizedCost: ToField<"u64">;
+    unrealizedRebate: ToField<"u64">;
+    u64Padding: ToField<Vector<"u64">>;
+}
+export type PositionReified = Reified<Position, PositionFields>;
+export declare class Position implements StructClass {
+    static readonly $typeName = "0x0::position::Position";
+    static readonly $numTypeParams = 0;
+    readonly $typeName = "0x0::position::Position";
+    readonly $fullTypeName: "0x0::position::Position";
+    readonly $typeArgs: [];
+    readonly id: ToField<UID>;
+    readonly createTsMs: ToField<"u64">;
+    readonly positionId: ToField<"u64">;
+    readonly user: ToField<"address">;
+    readonly isLong: ToField<"bool">;
+    readonly size: ToField<"u64">;
+    readonly sizeDecimal: ToField<"u64">;
+    readonly collateralToken: ToField<TypeName>;
+    readonly collateralTokenDecimal: ToField<"u64">;
+    readonly symbol: ToField<Symbol>;
+    readonly collateralAmount: ToField<"u64">;
+    readonly reserveAmount: ToField<"u64">;
+    readonly averagePrice: ToField<"u64">;
+    readonly entryFundingIndex: ToField<"u64">;
+    readonly realizedHasProfit: ToField<"bool">;
+    readonly unrealizedCost: ToField<"u64">;
+    readonly unrealizedRebate: ToField<"u64">;
+    readonly u64Padding: ToField<Vector<"u64">>;
+    private constructor();
+    static reified(): PositionReified;
+    static get r(): reified.StructClassReified<Position, PositionFields>;
+    static phantom(): PhantomReified<ToTypeStr<Position>>;
+    static get p(): reified.PhantomReified<"0x0::position::Position">;
+    static get bcs(): import("@mysten/bcs").BcsType<{
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        create_ts_ms: string;
+        position_id: string;
+        user: string;
+        is_long: boolean;
+        size: string;
+        size_decimal: string;
+        collateral_token: {
+            name: {
+                bytes: number[];
+            };
+        };
+        collateral_token_decimal: string;
+        symbol: {
+            base_token: {
+                name: {
+                    bytes: number[];
+                };
+            };
+            quote_token: {
+                name: {
+                    bytes: number[];
+                };
+            };
+        };
+        collateral_amount: string;
+        reserve_amount: string;
+        average_price: string;
+        entry_funding_index: string;
+        realized_has_profit: boolean;
+        unrealized_cost: string;
+        unrealized_rebate: string;
+        u64_padding: string[];
+    }, {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        create_ts_ms: string | number | bigint;
+        position_id: string | number | bigint;
+        user: string;
+        is_long: boolean;
+        size: string | number | bigint;
+        size_decimal: string | number | bigint;
+        collateral_token: {
+            name: {
+                bytes: Iterable<number> & {
+                    length: number;
+                };
+            };
+        };
+        collateral_token_decimal: string | number | bigint;
+        symbol: {
+            base_token: {
+                name: {
+                    bytes: Iterable<number> & {
+                        length: number;
+                    };
+                };
+            };
+            quote_token: {
+                name: {
+                    bytes: Iterable<number> & {
+                        length: number;
+                    };
+                };
+            };
+        };
+        collateral_amount: string | number | bigint;
+        reserve_amount: string | number | bigint;
+        average_price: string | number | bigint;
+        entry_funding_index: string | number | bigint;
+        realized_has_profit: boolean;
+        unrealized_cost: string | number | bigint;
+        unrealized_rebate: string | number | bigint;
+        u64_padding: Iterable<string | number | bigint> & {
+            length: number;
+        };
+    }>;
+    static fromFields(fields: Record<string, any>): Position;
+    static fromFieldsWithTypes(item: FieldsWithTypes): Position;
+    static fromBcs(data: Uint8Array): Position;
+    toJSONField(): {
+        id: string;
+        createTsMs: string;
+        positionId: string;
+        user: string;
+        isLong: boolean;
+        size: string;
+        sizeDecimal: string;
+        collateralToken: {
+            name: string;
+        };
+        collateralTokenDecimal: string;
+        symbol: {
+            baseToken: {
+                name: string;
+            };
+            quoteToken: {
+                name: string;
+            };
+        };
+        collateralAmount: string;
+        reserveAmount: string;
+        averagePrice: string;
+        entryFundingIndex: string;
+        realizedHasProfit: boolean;
+        unrealizedCost: string;
+        unrealizedRebate: string;
+        u64Padding: string[];
+    };
+    toJSON(): {
+        id: string;
+        createTsMs: string;
+        positionId: string;
+        user: string;
+        isLong: boolean;
+        size: string;
+        sizeDecimal: string;
+        collateralToken: {
+            name: string;
+        };
+        collateralTokenDecimal: string;
+        symbol: {
+            baseToken: {
+                name: string;
+            };
+            quoteToken: {
+                name: string;
+            };
+        };
+        collateralAmount: string;
+        reserveAmount: string;
+        averagePrice: string;
+        entryFundingIndex: string;
+        realizedHasProfit: boolean;
+        unrealizedCost: string;
+        unrealizedRebate: string;
+        u64Padding: string[];
+        $typeName: string;
+        $typeArgs: [];
+    };
+    static fromJSONField(field: any): Position;
+    static fromJSON(json: Record<string, any>): Position;
+    static fromSuiParsedData(content: SuiParsedData): Position;
+    static fetch(client: SuiClient, id: string): Promise<Position>;
+}
+export declare function isTradingOrder(type: string): boolean;
+export interface TradingOrderFields {
+    id: ToField<UID>;
+    createTsMs: ToField<"u64">;
+    orderId: ToField<"u64">;
+    linkedPositionId: ToField<Option<"u64">>;
+    user: ToField<"address">;
+    collateralToken: ToField<TypeName>;
+    collateralTokenDecimal: ToField<"u64">;
+    symbol: ToField<Symbol>;
+    leveragePct: ToField<"u64">;
+    reduceOnly: ToField<"bool">;
+    isLong: ToField<"bool">;
+    isStopOrder: ToField<"bool">;
+    size: ToField<"u64">;
+    sizeDecimal: ToField<"u64">;
+    triggerPrice: ToField<"u64">;
+    oraclePriceWhenPlacing: ToField<"u64">;
+    u64Padding: ToField<Vector<"u64">>;
+}
+export type TradingOrderReified = Reified<TradingOrder, TradingOrderFields>;
+export declare class TradingOrder implements StructClass {
+    static readonly $typeName = "0x0::position::TradingOrder";
+    static readonly $numTypeParams = 0;
+    readonly $typeName = "0x0::position::TradingOrder";
+    readonly $fullTypeName: "0x0::position::TradingOrder";
+    readonly $typeArgs: [];
+    readonly id: ToField<UID>;
+    readonly createTsMs: ToField<"u64">;
+    readonly orderId: ToField<"u64">;
+    readonly linkedPositionId: ToField<Option<"u64">>;
+    readonly user: ToField<"address">;
+    readonly collateralToken: ToField<TypeName>;
+    readonly collateralTokenDecimal: ToField<"u64">;
+    readonly symbol: ToField<Symbol>;
+    readonly leveragePct: ToField<"u64">;
+    readonly reduceOnly: ToField<"bool">;
+    readonly isLong: ToField<"bool">;
+    readonly isStopOrder: ToField<"bool">;
+    readonly size: ToField<"u64">;
+    readonly sizeDecimal: ToField<"u64">;
+    readonly triggerPrice: ToField<"u64">;
+    readonly oraclePriceWhenPlacing: ToField<"u64">;
+    readonly u64Padding: ToField<Vector<"u64">>;
+    private constructor();
+    static reified(): TradingOrderReified;
+    static get r(): reified.StructClassReified<TradingOrder, TradingOrderFields>;
+    static phantom(): PhantomReified<ToTypeStr<TradingOrder>>;
+    static get p(): reified.PhantomReified<"0x0::position::TradingOrder">;
+    static get bcs(): import("@mysten/bcs").BcsType<{
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        create_ts_ms: string;
+        order_id: string;
+        linked_position_id: {
+            vec: any[];
+        };
+        user: string;
+        collateral_token: {
+            name: {
+                bytes: number[];
+            };
+        };
+        collateral_token_decimal: string;
+        symbol: {
+            base_token: {
+                name: {
+                    bytes: number[];
+                };
+            };
+            quote_token: {
+                name: {
+                    bytes: number[];
+                };
+            };
+        };
+        leverage_pct: string;
+        reduce_only: boolean;
+        is_long: boolean;
+        is_stop_order: boolean;
+        size: string;
+        size_decimal: string;
+        trigger_price: string;
+        oracle_price_when_placing: string;
+        u64_padding: string[];
+    }, {
+        id: {
+            id: {
+                bytes: string;
+            };
+        };
+        create_ts_ms: string | number | bigint;
+        order_id: string | number | bigint;
+        linked_position_id: {
+            vec: Iterable<any> & {
+                length: number;
+            };
+        };
+        user: string;
+        collateral_token: {
+            name: {
+                bytes: Iterable<number> & {
+                    length: number;
+                };
+            };
+        };
+        collateral_token_decimal: string | number | bigint;
+        symbol: {
+            base_token: {
+                name: {
+                    bytes: Iterable<number> & {
+                        length: number;
+                    };
+                };
+            };
+            quote_token: {
+                name: {
+                    bytes: Iterable<number> & {
+                        length: number;
+                    };
+                };
+            };
+        };
+        leverage_pct: string | number | bigint;
+        reduce_only: boolean;
+        is_long: boolean;
+        is_stop_order: boolean;
+        size: string | number | bigint;
+        size_decimal: string | number | bigint;
+        trigger_price: string | number | bigint;
+        oracle_price_when_placing: string | number | bigint;
+        u64_padding: Iterable<string | number | bigint> & {
+            length: number;
+        };
+    }>;
+    static fromFields(fields: Record<string, any>): TradingOrder;
+    static fromFieldsWithTypes(item: FieldsWithTypes): TradingOrder;
+    static fromBcs(data: Uint8Array): TradingOrder;
+    toJSONField(): {
+        id: string;
+        createTsMs: string;
+        orderId: string;
+        linkedPositionId: string | null;
+        user: string;
+        collateralToken: {
+            name: string;
+        };
+        collateralTokenDecimal: string;
+        symbol: {
+            baseToken: {
+                name: string;
+            };
+            quoteToken: {
+                name: string;
+            };
+        };
+        leveragePct: string;
+        reduceOnly: boolean;
+        isLong: boolean;
+        isStopOrder: boolean;
+        size: string;
+        sizeDecimal: string;
+        triggerPrice: string;
+        oraclePriceWhenPlacing: string;
+        u64Padding: string[];
+    };
+    toJSON(): {
+        id: string;
+        createTsMs: string;
+        orderId: string;
+        linkedPositionId: string | null;
+        user: string;
+        collateralToken: {
+            name: string;
+        };
+        collateralTokenDecimal: string;
+        symbol: {
+            baseToken: {
+                name: string;
+            };
+            quoteToken: {
+                name: string;
+            };
+        };
+        leveragePct: string;
+        reduceOnly: boolean;
+        isLong: boolean;
+        isStopOrder: boolean;
+        size: string;
+        sizeDecimal: string;
+        triggerPrice: string;
+        oraclePriceWhenPlacing: string;
+        u64Padding: string[];
+        $typeName: string;
+        $typeArgs: [];
+    };
+    static fromJSONField(field: any): TradingOrder;
+    static fromJSON(json: Record<string, any>): TradingOrder;
+    static fromSuiParsedData(content: SuiParsedData): TradingOrder;
+    static fetch(client: SuiClient, id: string): Promise<TradingOrder>;
+}