@dydxprotocol/v4-client-js 1.2.0 → 1.3.1

package/build/node_modules/@dydxprotocol/v4-proto/src/codegen/dydxprotocol/indexer/events/events.d.ts

@@ -389,11 +389,13 @@ export interface SubaccountUpdateEventV1SDKType {
  * stateful order.
  */
 export interface StatefulOrderEventV1 {
+    /** @deprecated */
     orderPlace?: StatefulOrderEventV1_StatefulOrderPlacementV1;
     orderRemoval?: StatefulOrderEventV1_StatefulOrderRemovalV1;
     conditionalOrderPlacement?: StatefulOrderEventV1_ConditionalOrderPlacementV1;
     conditionalOrderTriggered?: StatefulOrderEventV1_ConditionalOrderTriggeredV1;
     longTermOrderPlacement?: StatefulOrderEventV1_LongTermOrderPlacementV1;
+    orderReplacement?: StatefulOrderEventV1_LongTermOrderReplacementV1;
 }
 /**
  * StatefulOrderEvent message contains information about a change to a stateful
@@ -402,17 +404,25 @@ export interface StatefulOrderEventV1 {
  * stateful order.
  */
 export interface StatefulOrderEventV1SDKType {
+    /** @deprecated */
     order_place?: StatefulOrderEventV1_StatefulOrderPlacementV1SDKType;
     order_removal?: StatefulOrderEventV1_StatefulOrderRemovalV1SDKType;
     conditional_order_placement?: StatefulOrderEventV1_ConditionalOrderPlacementV1SDKType;
     conditional_order_triggered?: StatefulOrderEventV1_ConditionalOrderTriggeredV1SDKType;
     long_term_order_placement?: StatefulOrderEventV1_LongTermOrderPlacementV1SDKType;
+    order_replacement?: StatefulOrderEventV1_LongTermOrderReplacementV1SDKType;
 }
-/** A stateful order placement contains an order. */
+/**
+ * A stateful order placement contains an order.
+ * Deprecated in favor of LongTermOrderPlacementV1.
+ */
 export interface StatefulOrderEventV1_StatefulOrderPlacementV1 {
     order?: IndexerOrder;
 }
-/** A stateful order placement contains an order. */
+/**
+ * A stateful order placement contains an order.
+ * Deprecated in favor of LongTermOrderPlacementV1.
+ */
 export interface StatefulOrderEventV1_StatefulOrderPlacementV1SDKType {
     order?: IndexerOrderSDKType;
 }
@@ -468,6 +478,17 @@ export interface StatefulOrderEventV1_LongTermOrderPlacementV1 {
 export interface StatefulOrderEventV1_LongTermOrderPlacementV1SDKType {
     order?: IndexerOrderSDKType;
 }
+/** A long term order replacement contains an old order ID and the new order. */
+export interface StatefulOrderEventV1_LongTermOrderReplacementV1 {
+    /** vault replaces orders with a different order ID */
+    oldOrderId?: IndexerOrderId;
+    order?: IndexerOrder;
+}
+/** A long term order replacement contains an old order ID and the new order. */
+export interface StatefulOrderEventV1_LongTermOrderReplacementV1SDKType {
+    old_order_id?: IndexerOrderIdSDKType;
+    order?: IndexerOrderSDKType;
+}
 /**
  * AssetCreateEventV1 message contains all the information about an new Asset on
  * the dYdX chain.
@@ -511,7 +532,10 @@ export interface AssetCreateEventV1SDKType {
 /**
  * PerpetualMarketCreateEventV1 message contains all the information about a
  * new Perpetual Market on the dYdX chain.
+ * Deprecated. See PerpetualMarketCreateEventV2 for the most up to date message
+ * for the event to create a new Perpetual Market.
  */
+/** @deprecated */
 export interface PerpetualMarketCreateEventV1 {
     /**
      * Unique Perpetual id.
@@ -567,13 +591,14 @@ export interface PerpetualMarketCreateEventV1 {
      * Defined in perpetuals.perpetual
      */
     liquidityTier: number;
-    /** Market type of the perpetual. */
-    marketType: PerpetualMarketType;
 }
 /**
  * PerpetualMarketCreateEventV1 message contains all the information about a
  * new Perpetual Market on the dYdX chain.
+ * Deprecated. See PerpetualMarketCreateEventV2 for the most up to date message
+ * for the event to create a new Perpetual Market.
  */
+/** @deprecated */
 export interface PerpetualMarketCreateEventV1SDKType {
     id: number;
     clob_pair_id: number;
@@ -585,6 +610,84 @@ export interface PerpetualMarketCreateEventV1SDKType {
     subticks_per_tick: number;
     step_base_quantums: Long;
     liquidity_tier: number;
+}
+/**
+ * PerpetualMarketCreateEventV2 message contains all the information about a
+ * new Perpetual Market on the dYdX chain.
+ */
+export interface PerpetualMarketCreateEventV2 {
+    /**
+     * Unique Perpetual id.
+     * Defined in perpetuals.perpetual
+     */
+    id: number;
+    /**
+     * Unique clob pair Id associated with this perpetual market
+     * Defined in clob.clob_pair
+     */
+    clobPairId: number;
+    /**
+     * The name of the `Perpetual` (e.g. `BTC-USD`).
+     * Defined in perpetuals.perpetual
+     */
+    ticker: string;
+    /**
+     * Unique id of market param associated with this perpetual market.
+     * Defined in perpetuals.perpetual
+     */
+    marketId: number;
+    /** Status of the CLOB */
+    status: ClobPairStatus;
+    /**
+     * `10^Exponent` gives the number of QuoteQuantums traded per BaseQuantum
+     * per Subtick.
+     * Defined in clob.clob_pair
+     */
+    quantumConversionExponent: number;
+    /**
+     * The exponent for converting an atomic amount (`size = 1`)
+     * to a full coin. For example, if `AtomicResolution = -8`
+     * then a `PerpetualPosition` with `size = 1e8` is equivalent to
+     * a position size of one full coin.
+     * Defined in perpetuals.perpetual
+     */
+    atomicResolution: number;
+    /**
+     * Defines the tick size of the orderbook by defining how many subticks
+     * are in one tick. That is, the subticks of any valid order must be a
+     * multiple of this value. Generally this value should start `>= 100`to
+     * allow room for decreasing it.
+     * Defined in clob.clob_pair
+     */
+    subticksPerTick: number;
+    /**
+     * Minimum increment in the size of orders on the CLOB, in base quantums.
+     * Defined in clob.clob_pair
+     */
+    stepBaseQuantums: Long;
+    /**
+     * The liquidity_tier that this perpetual is associated with.
+     * Defined in perpetuals.perpetual
+     */
+    liquidityTier: number;
+    /** Market type of the perpetual. */
+    marketType: PerpetualMarketType;
+}
+/**
+ * PerpetualMarketCreateEventV2 message contains all the information about a
+ * new Perpetual Market on the dYdX chain.
+ */
+export interface PerpetualMarketCreateEventV2SDKType {
+    id: number;
+    clob_pair_id: number;
+    ticker: string;
+    market_id: number;
+    status: ClobPairStatus;
+    quantum_conversion_exponent: number;
+    atomic_resolution: number;
+    subticks_per_tick: number;
+    step_base_quantums: Long;
+    liquidity_tier: number;
     market_type: PerpetualMarketType;
 }
 /**
@@ -752,6 +855,76 @@ export interface AddressTradingRewardSDKType {
     owner: string;
     denom_amount: Uint8Array;
 }
+/** OpenInterestUpdateEventV1 is used for open interest update events */
+export interface OpenInterestUpdateEventV1 {
+    /** The list of all open interest updates in the block. */
+    openInterestUpdates: OpenInterestUpdate[];
+}
+/** OpenInterestUpdateEventV1 is used for open interest update events */
+export interface OpenInterestUpdateEventV1SDKType {
+    open_interest_updates: OpenInterestUpdateSDKType[];
+}
+/** OpenInterestUpdate contains a single open interest update for a perpetual */
+export interface OpenInterestUpdate {
+    /** The ID of the perpetual market. */
+    perpetualId: number;
+    /** The new open interest value for the perpetual market. */
+    openInterest: Uint8Array;
+}
+/** OpenInterestUpdate contains a single open interest update for a perpetual */
+export interface OpenInterestUpdateSDKType {
+    perpetual_id: number;
+    open_interest: Uint8Array;
+}
+/**
+ * LiquidationEventV2 message contains all the information needed to update
+ * the liquidity tiers. It contains all the fields from V1 along with the
+ * open interest caps.
+ */
+export interface LiquidityTierUpsertEventV2 {
+    /** Unique id. */
+    id: number;
+    /** The name of the tier purely for mnemonic purposes, e.g. "Gold". */
+    name: string;
+    /**
+     * The margin fraction needed to open a position.
+     * In parts-per-million.
+     */
+    initialMarginPpm: number;
+    /**
+     * The fraction of the initial-margin that the maintenance-margin is,
+     * e.g. 50%. In parts-per-million.
+     */
+    maintenanceFractionPpm: number;
+    /**
+     * The maximum position size at which the margin requirements are
+     * not increased over the default values. Above this position size,
+     * the margin requirements increase at a rate of sqrt(size).
+     *
+     * Deprecated since v3.x.
+     */
+    /** @deprecated */
+    basePositionNotional: Long;
+    /** Lower cap of open interest in quote quantums. optional */
+    openInterestLowerCap: Long;
+    /** Upper cap of open interest in quote quantums. */
+    openInterestUpperCap: Long;
+}
+/**
+ * LiquidationEventV2 message contains all the information needed to update
+ * the liquidity tiers. It contains all the fields from V1 along with the
+ * open interest caps.
+ */
+export interface LiquidityTierUpsertEventV2SDKType {
+    id: number;
+    name: string;
+    initial_margin_ppm: number;
+    maintenance_fraction_ppm: number;
+    /** @deprecated */
+    base_position_notional: Long;
+    open_interest_lower_cap: Long;
+    open_interest_upper_cap: Long;
+}
 export declare const FundingUpdateV1: {
     encode(message: FundingUpdateV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): FundingUpdateV1;
@@ -847,6 +1020,11 @@ export declare const StatefulOrderEventV1_LongTermOrderPlacementV1: {
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_LongTermOrderPlacementV1;
     fromPartial(object: DeepPartial<StatefulOrderEventV1_LongTermOrderPlacementV1>): StatefulOrderEventV1_LongTermOrderPlacementV1;
 };
+export declare const StatefulOrderEventV1_LongTermOrderReplacementV1: {
+    encode(message: StatefulOrderEventV1_LongTermOrderReplacementV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_LongTermOrderReplacementV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1_LongTermOrderReplacementV1>): StatefulOrderEventV1_LongTermOrderReplacementV1;
+};
 export declare const AssetCreateEventV1: {
     encode(message: AssetCreateEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): AssetCreateEventV1;
@@ -857,6 +1035,11 @@ export declare const PerpetualMarketCreateEventV1: {
     decode(input: _m0.Reader | Uint8Array, length?: number): PerpetualMarketCreateEventV1;
     fromPartial(object: DeepPartial<PerpetualMarketCreateEventV1>): PerpetualMarketCreateEventV1;
 };
+export declare const PerpetualMarketCreateEventV2: {
+    encode(message: PerpetualMarketCreateEventV2, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PerpetualMarketCreateEventV2;
+    fromPartial(object: DeepPartial<PerpetualMarketCreateEventV2>): PerpetualMarketCreateEventV2;
+};
 export declare const LiquidityTierUpsertEventV1: {
     encode(message: LiquidityTierUpsertEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): LiquidityTierUpsertEventV1;
@@ -882,3 +1065,18 @@ export declare const AddressTradingReward: {
     decode(input: _m0.Reader | Uint8Array, length?: number): AddressTradingReward;
     fromPartial(object: DeepPartial<AddressTradingReward>): AddressTradingReward;
 };
+export declare const OpenInterestUpdateEventV1: {
+    encode(message: OpenInterestUpdateEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): OpenInterestUpdateEventV1;
+    fromPartial(object: DeepPartial<OpenInterestUpdateEventV1>): OpenInterestUpdateEventV1;
+};
+export declare const OpenInterestUpdate: {
+    encode(message: OpenInterestUpdate, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): OpenInterestUpdate;
+    fromPartial(object: DeepPartial<OpenInterestUpdate>): OpenInterestUpdate;
+};
+export declare const LiquidityTierUpsertEventV2: {
+    encode(message: LiquidityTierUpsertEventV2, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): LiquidityTierUpsertEventV2;
+    fromPartial(object: DeepPartial<LiquidityTierUpsertEventV2>): LiquidityTierUpsertEventV2;
+};