@dydxprotocol/v4-client-js 1.0.11 → 1.0.12

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

@@ -92,7 +92,7 @@ export interface FundingEventV1SDKType {
 }
 /**
  * MarketEvent message contains all the information about a market event on
- * the V4 chain.
+ * the dYdX chain.
  */
 export interface MarketEventV1 {
     /** market id. */
@@ -103,7 +103,7 @@ export interface MarketEventV1 {
 }
 /**
  * MarketEvent message contains all the information about a market event on
- * the V4 chain.
+ * the dYdX chain.
  */
 export interface MarketEventV1SDKType {
     market_id: number;
@@ -113,7 +113,7 @@ export interface MarketEventV1SDKType {
 }
 /**
  * MarketPriceUpdateEvent message contains all the information about a price
- * update on the V4 chain.
+ * update on the dYdX chain.
  */
 export interface MarketPriceUpdateEventV1 {
     /**
@@ -125,7 +125,7 @@ export interface MarketPriceUpdateEventV1 {
 }
 /**
  * MarketPriceUpdateEvent message contains all the information about a price
- * update on the V4 chain.
+ * update on the dYdX chain.
  */
 export interface MarketPriceUpdateEventV1SDKType {
     price_with_exponent: Long;
@@ -147,7 +147,7 @@ export interface MarketBaseEventV1SDKType {
 }
 /**
  * MarketCreateEvent message contains all the information about a new market on
- * the V4 chain.
+ * the dYdX chain.
  */
 export interface MarketCreateEventV1 {
     base?: MarketBaseEventV1;
@@ -161,7 +161,7 @@ export interface MarketCreateEventV1 {
 }
 /**
  * MarketCreateEvent message contains all the information about a new market on
- * the V4 chain.
+ * the dYdX chain.
  */
 export interface MarketCreateEventV1SDKType {
     base?: MarketBaseEventV1SDKType;
@@ -169,18 +169,18 @@ export interface MarketCreateEventV1SDKType {
 }
 /**
  * MarketModifyEvent message contains all the information about a market update
- * on the V4 chain
+ * on the dYdX chain
  */
 export interface MarketModifyEventV1 {
     /**
      * MarketModifyEvent message contains all the information about a market update
-     * on the V4 chain
+     * on the dYdX chain
      */
     base?: MarketBaseEventV1;
 }
 /**
  * MarketModifyEvent message contains all the information about a market update
- * on the V4 chain
+ * on the dYdX chain
  */
 export interface MarketModifyEventV1SDKType {
     base?: MarketBaseEventV1SDKType;
@@ -197,7 +197,7 @@ export interface SourceOfFundsSDKType {
 }
 /**
  * TransferEvent message contains all the information about a transfer,
- * deposit-to-subaccount, or withdraw-from-subaccount on the V4 chain.
+ * deposit-to-subaccount, or withdraw-from-subaccount on the dYdX chain.
  * When a subaccount is involved, a SubaccountUpdateEvent message will
  * be produced with the updated asset positions.
  */
@@ -223,7 +223,7 @@ export interface TransferEventV1 {
 }
 /**
  * TransferEvent message contains all the information about a transfer,
- * deposit-to-subaccount, or withdraw-from-subaccount on the V4 chain.
+ * deposit-to-subaccount, or withdraw-from-subaccount on the dYdX chain.
  * When a subaccount is involved, a SubaccountUpdateEvent message will
  * be produced with the updated asset positions.
  */
@@ -237,7 +237,7 @@ export interface TransferEventV1SDKType {
 }
 /**
  * OrderFillEvent message contains all the information from an order match in
- * the V4 chain. This includes the maker/taker orders that matched and the
+ * the dYdX chain. This includes the maker/taker orders that matched and the
  * amount filled.
  */
 export interface OrderFillEventV1 {
@@ -260,7 +260,7 @@ export interface OrderFillEventV1 {
 }
 /**
  * OrderFillEvent message contains all the information from an order match in
- * the V4 chain. This includes the maker/taker orders that matched and the
+ * the dYdX chain. This includes the maker/taker orders that matched and the
  * amount filled.
  */
 export interface OrderFillEventV1SDKType {
@@ -273,6 +273,49 @@ export interface OrderFillEventV1SDKType {
     total_filled_maker: Long;
     total_filled_taker: Long;
 }
+/**
+ * DeleveragingEvent message contains all the information for a deleveraging
+ * on the dYdX chain. This includes the liquidated/offsetting subaccounts and
+ * the amount filled.
+ */
+export interface DeleveragingEventV1 {
+    /** ID of the subaccount that was liquidated. */
+    liquidated?: IndexerSubaccountId;
+    /** ID of the subaccount that was used to offset the position. */
+    offsetting?: IndexerSubaccountId;
+    /** The ID of the perpetual that was liquidated. */
+    perpetualId: number;
+    /**
+     * The amount filled between the liquidated and offsetting position, in
+     * base quantums.
+     */
+    fillAmount: Long;
+    /** Fill price of deleveraging event, in USDC quote quantums. */
+    price: Long;
+    /** `true` if liquidating a short position, `false` otherwise. */
+    isBuy: boolean;
+    /**
+     * `true` if the deleveraging event is for final settlement, indicating
+     * the match occurred at the oracle price rather than bankruptcy price.
+     * When this flag is `false`, the fill price is the bankruptcy price
+     * of the liquidated subaccount.
+     */
+    isFinalSettlement: boolean;
+}
+/**
+ * DeleveragingEvent message contains all the information for a deleveraging
+ * on the dYdX chain. This includes the liquidated/offsetting subaccounts and
+ * the amount filled.
+ */
+export interface DeleveragingEventV1SDKType {
+    liquidated?: IndexerSubaccountIdSDKType;
+    offsetting?: IndexerSubaccountIdSDKType;
+    perpetual_id: number;
+    fill_amount: Long;
+    price: Long;
+    is_buy: boolean;
+    is_final_settlement: boolean;
+}
 /**
  * LiquidationOrder represents the liquidation taker order to be included in a
  * liquidation order fill event.
@@ -314,7 +357,7 @@ export interface LiquidationOrderV1SDKType {
 }
 /**
  * SubaccountUpdateEvent message contains information about an update to a
- * subaccount in the V4 chain. This includes the list of updated perpetual
+ * subaccount in the dYdX chain. This includes the list of updated perpetual
  * and asset positions for the subaccount.
  * Note: This event message will contain all the updates to a subaccount
  * at the end of a block which is why multiple asset/perpetual position
@@ -327,7 +370,7 @@ export interface SubaccountUpdateEventV1 {
 }
 /**
  * SubaccountUpdateEvent message contains information about an update to a
- * subaccount in the V4 chain. This includes the list of updated perpetual
+ * subaccount in the dYdX chain. This includes the list of updated perpetual
  * and asset positions for the subaccount.
  * Note: This event message will contain all the updates to a subaccount
  * at the end of a block which is why multiple asset/perpetual position
@@ -426,7 +469,7 @@ export interface StatefulOrderEventV1_LongTermOrderPlacementV1SDKType {
 }
 /**
  * AssetCreateEventV1 message contains all the information about an new Asset on
- * the v4 chain.
+ * the dYdX chain.
  */
 export interface AssetCreateEventV1 {
     /** Unique, sequentially-generated. */
@@ -455,7 +498,7 @@ export interface AssetCreateEventV1 {
 }
 /**
  * AssetCreateEventV1 message contains all the information about an new Asset on
- * the v4 chain.
+ * the dYdX chain.
  */
 export interface AssetCreateEventV1SDKType {
     id: number;
@@ -466,7 +509,7 @@ export interface AssetCreateEventV1SDKType {
 }
 /**
  * PerpetualMarketCreateEventV1 message contains all the information about a
- * new Perpetual Market on the v4 chain.
+ * new Perpetual Market on the dYdX chain.
  */
 export interface PerpetualMarketCreateEventV1 {
     /**
@@ -526,7 +569,7 @@ export interface PerpetualMarketCreateEventV1 {
 }
 /**
  * PerpetualMarketCreateEventV1 message contains all the information about a
- * new Perpetual Market on the v4 chain.
+ * new Perpetual Market on the dYdX chain.
  */
 export interface PerpetualMarketCreateEventV1SDKType {
     id: number;
@@ -542,7 +585,7 @@ export interface PerpetualMarketCreateEventV1SDKType {
 }
 /**
  * LiquidityTierUpsertEventV1 message contains all the information to
- * create/update a Liquidity Tier on the v4 chain.
+ * create/update a Liquidity Tier on the dYdX chain.
  */
 export interface LiquidityTierUpsertEventV1 {
     /** Unique id. */
@@ -563,23 +606,27 @@ export interface LiquidityTierUpsertEventV1 {
      * 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;
 }
 /**
  * LiquidityTierUpsertEventV1 message contains all the information to
- * create/update a Liquidity Tier on the v4 chain.
+ * create/update a Liquidity Tier on the dYdX chain.
  */
 export interface LiquidityTierUpsertEventV1SDKType {
     id: number;
     name: string;
     initial_margin_ppm: number;
     maintenance_fraction_ppm: number;
+    /** @deprecated */
     base_position_notional: Long;
 }
 /**
  * UpdateClobPairEventV1 message contains all the information about an update to
- * a clob pair on the v4 chain.
+ * a clob pair on the dYdX chain.
  */
 export interface UpdateClobPairEventV1 {
     /**
@@ -611,7 +658,7 @@ export interface UpdateClobPairEventV1 {
 }
 /**
  * UpdateClobPairEventV1 message contains all the information about an update to
- * a clob pair on the v4 chain.
+ * a clob pair on the dYdX chain.
  */
 export interface UpdateClobPairEventV1SDKType {
     clob_pair_id: number;
@@ -622,7 +669,7 @@ export interface UpdateClobPairEventV1SDKType {
 }
 /**
  * UpdatePerpetualEventV1 message contains all the information about an update
- * to a perpetual on the v4 chain.
+ * to a perpetual on the dYdX chain.
  */
 export interface UpdatePerpetualEventV1 {
     /**
@@ -656,7 +703,7 @@ export interface UpdatePerpetualEventV1 {
 }
 /**
  * UpdatePerpetualEventV1 message contains all the information about an update
- * to a perpetual on the v4 chain.
+ * to a perpetual on the dYdX chain.
  */
 export interface UpdatePerpetualEventV1SDKType {
     id: number;
@@ -665,6 +712,42 @@ export interface UpdatePerpetualEventV1SDKType {
     atomic_resolution: number;
     liquidity_tier: number;
 }
+/**
+ * TradingRewardsEventV1 is communicates all trading rewards for all accounts
+ * that receive trade rewards in the block.
+ */
+export interface TradingRewardsEventV1 {
+    /** The list of all trading rewards in the block. */
+    tradingRewards: AddressTradingReward[];
+}
+/**
+ * TradingRewardsEventV1 is communicates all trading rewards for all accounts
+ * that receive trade rewards in the block.
+ */
+export interface TradingRewardsEventV1SDKType {
+    trading_rewards: AddressTradingRewardSDKType[];
+}
+/**
+ * AddressTradingReward contains info on an instance of an address receiving a
+ * reward
+ */
+export interface AddressTradingReward {
+    /** The address of the wallet that will receive the trading reward. */
+    owner: string;
+    /**
+     * The amount of trading rewards earned by the address above in denoms. 1e18
+     * denoms is equivalent to a single coin.
+     */
+    denomAmount: Uint8Array;
+}
+/**
+ * AddressTradingReward contains info on an instance of an address receiving a
+ * reward
+ */
+export interface AddressTradingRewardSDKType {
+    owner: string;
+    denom_amount: Uint8Array;
+}
 export declare const FundingUpdateV1: {
     encode(message: FundingUpdateV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): FundingUpdateV1;
@@ -715,6 +798,11 @@ export declare const OrderFillEventV1: {
     decode(input: _m0.Reader | Uint8Array, length?: number): OrderFillEventV1;
     fromPartial(object: DeepPartial<OrderFillEventV1>): OrderFillEventV1;
 };
+export declare const DeleveragingEventV1: {
+    encode(message: DeleveragingEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): DeleveragingEventV1;
+    fromPartial(object: DeepPartial<DeleveragingEventV1>): DeleveragingEventV1;
+};
 export declare const LiquidationOrderV1: {
     encode(message: LiquidationOrderV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): LiquidationOrderV1;
@@ -780,3 +868,13 @@ export declare const UpdatePerpetualEventV1: {
     decode(input: _m0.Reader | Uint8Array, length?: number): UpdatePerpetualEventV1;
     fromPartial(object: DeepPartial<UpdatePerpetualEventV1>): UpdatePerpetualEventV1;
 };
+export declare const TradingRewardsEventV1: {
+    encode(message: TradingRewardsEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): TradingRewardsEventV1;
+    fromPartial(object: DeepPartial<TradingRewardsEventV1>): TradingRewardsEventV1;
+};
+export declare const AddressTradingReward: {
+    encode(message: AddressTradingReward, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): AddressTradingReward;
+    fromPartial(object: DeepPartial<AddressTradingReward>): AddressTradingReward;
+};