@dydxprotocol/v4-client-js 0.33.1 → 0.34.0

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

@@ -1,9 +1,9 @@
 /// <reference types="long" />
 import { IndexerSubaccountId, IndexerSubaccountIdSDKType, IndexerPerpetualPosition, IndexerPerpetualPositionSDKType, IndexerAssetPosition, IndexerAssetPositionSDKType } from "../protocol/v1/subaccount";
-import { IndexerOrder, IndexerOrderSDKType, IndexerOrderId, IndexerOrderIdSDKType } from "../protocol/v1/clob";
+import { IndexerOrder, IndexerOrderSDKType, IndexerOrderId, IndexerOrderIdSDKType, ClobPairStatus } from "../protocol/v1/clob";
 import { OrderRemovalReason } from "../shared/removal_reason";
 import * as _m0 from "protobufjs/minimal";
-import { Long } from "../../../helpers";
+import { DeepPartial, Long } from "../../../helpers";
 /** Type is the type for funding values. */
 export declare enum FundingEventV1_Type {
     /** TYPE_UNSPECIFIED - Unspecified type. */
@@ -424,129 +424,359 @@ export interface StatefulOrderEventV1_LongTermOrderPlacementV1 {
 export interface StatefulOrderEventV1_LongTermOrderPlacementV1SDKType {
     order?: IndexerOrderSDKType;
 }
+/**
+ * AssetCreateEventV1 message contains all the information about an new Asset on
+ * the v4 chain.
+ */
+export interface AssetCreateEventV1 {
+    /** Unique, sequentially-generated. */
+    id: number;
+    /**
+     * The human readable symbol of the `Asset` (e.g. `USDC`, `ATOM`).
+     * Must be uppercase, unique and correspond to the canonical symbol of the
+     * full coin.
+     */
+    symbol: string;
+    /** `true` if this `Asset` has a valid `MarketId` value. */
+    hasMarket: boolean;
+    /**
+     * The `Id` of the `Market` associated with this `Asset`. It acts as the
+     * oracle price for the purposes of calculating collateral
+     * and margin requirements.
+     */
+    marketId: number;
+    /**
+     * The exponent for converting an atomic amount (1 'quantum')
+     * to a full coin. For example, if `atomic_resolution = -8`
+     * then an `asset_position` with `base_quantums = 1e8` is equivalent to
+     * a position size of one full coin.
+     */
+    atomicResolution: number;
+}
+/**
+ * AssetCreateEventV1 message contains all the information about an new Asset on
+ * the v4 chain.
+ */
+export interface AssetCreateEventV1SDKType {
+    id: number;
+    symbol: string;
+    has_market: boolean;
+    market_id: number;
+    atomic_resolution: number;
+}
+/**
+ * PerpetualMarketCreateEventV1 message contains all the information about a
+ * new Perpetual Market on the v4 chain.
+ */
+export interface PerpetualMarketCreateEventV1 {
+    /**
+     * 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;
+}
+/**
+ * PerpetualMarketCreateEventV1 message contains all the information about a
+ * new Perpetual Market on the v4 chain.
+ */
+export interface PerpetualMarketCreateEventV1SDKType {
+    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;
+}
+/**
+ * LiquidityTierUpsertEventV1 message contains all the information to
+ * create/update a Liquidity Tier on the v4 chain.
+ */
+export interface LiquidityTierUpsertEventV1 {
+    /** 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).
+     */
+    basePositionNotional: Long;
+}
+/**
+ * LiquidityTierUpsertEventV1 message contains all the information to
+ * create/update a Liquidity Tier on the v4 chain.
+ */
+export interface LiquidityTierUpsertEventV1SDKType {
+    id: number;
+    name: string;
+    initial_margin_ppm: number;
+    maintenance_fraction_ppm: number;
+    base_position_notional: Long;
+}
+/**
+ * UpdateClobPairEventV1 message contains all the information about an update to
+ * a clob pair on the v4 chain.
+ */
+export interface UpdateClobPairEventV1 {
+    /**
+     * Unique clob pair Id associated with this perpetual market
+     * Defined in clob.clob_pair
+     */
+    clobPairId: 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;
+    /**
+     * 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;
+}
+/**
+ * UpdateClobPairEventV1 message contains all the information about an update to
+ * a clob pair on the v4 chain.
+ */
+export interface UpdateClobPairEventV1SDKType {
+    clob_pair_id: number;
+    status: ClobPairStatus;
+    quantum_conversion_exponent: number;
+    subticks_per_tick: number;
+    step_base_quantums: Long;
+}
+/**
+ * UpdatePerpetualEventV1 message contains all the information about an update
+ * to a perpetual on the v4 chain.
+ */
+export interface UpdatePerpetualEventV1 {
+    /**
+     * Unique Perpetual id.
+     * Defined in perpetuals.perpetual
+     */
+    id: 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;
+    /**
+     * 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;
+    /**
+     * The liquidity_tier that this perpetual is associated with.
+     * Defined in perpetuals.perpetual
+     */
+    liquidityTier: number;
+}
+/**
+ * UpdatePerpetualEventV1 message contains all the information about an update
+ * to a perpetual on the v4 chain.
+ */
+export interface UpdatePerpetualEventV1SDKType {
+    id: number;
+    ticker: string;
+    market_id: number;
+    atomic_resolution: number;
+    liquidity_tier: number;
+}
 export declare const FundingUpdateV1: {
     encode(message: FundingUpdateV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): FundingUpdateV1;
-    fromJSON(object: any): FundingUpdateV1;
-    toJSON(message: FundingUpdateV1): unknown;
-    fromPartial(object: Partial<FundingUpdateV1>): FundingUpdateV1;
+    fromPartial(object: DeepPartial<FundingUpdateV1>): FundingUpdateV1;
 };
 export declare const FundingEventV1: {
     encode(message: FundingEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): FundingEventV1;
-    fromJSON(object: any): FundingEventV1;
-    toJSON(message: FundingEventV1): unknown;
-    fromPartial(object: Partial<FundingEventV1>): FundingEventV1;
+    fromPartial(object: DeepPartial<FundingEventV1>): FundingEventV1;
 };
 export declare const MarketEventV1: {
     encode(message: MarketEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): MarketEventV1;
-    fromJSON(object: any): MarketEventV1;
-    toJSON(message: MarketEventV1): unknown;
-    fromPartial(object: Partial<MarketEventV1>): MarketEventV1;
+    fromPartial(object: DeepPartial<MarketEventV1>): MarketEventV1;
 };
 export declare const MarketPriceUpdateEventV1: {
     encode(message: MarketPriceUpdateEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): MarketPriceUpdateEventV1;
-    fromJSON(object: any): MarketPriceUpdateEventV1;
-    toJSON(message: MarketPriceUpdateEventV1): unknown;
-    fromPartial(object: Partial<MarketPriceUpdateEventV1>): MarketPriceUpdateEventV1;
+    fromPartial(object: DeepPartial<MarketPriceUpdateEventV1>): MarketPriceUpdateEventV1;
 };
 export declare const MarketBaseEventV1: {
     encode(message: MarketBaseEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): MarketBaseEventV1;
-    fromJSON(object: any): MarketBaseEventV1;
-    toJSON(message: MarketBaseEventV1): unknown;
-    fromPartial(object: Partial<MarketBaseEventV1>): MarketBaseEventV1;
+    fromPartial(object: DeepPartial<MarketBaseEventV1>): MarketBaseEventV1;
 };
 export declare const MarketCreateEventV1: {
     encode(message: MarketCreateEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): MarketCreateEventV1;
-    fromJSON(object: any): MarketCreateEventV1;
-    toJSON(message: MarketCreateEventV1): unknown;
-    fromPartial(object: Partial<MarketCreateEventV1>): MarketCreateEventV1;
+    fromPartial(object: DeepPartial<MarketCreateEventV1>): MarketCreateEventV1;
 };
 export declare const MarketModifyEventV1: {
     encode(message: MarketModifyEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): MarketModifyEventV1;
-    fromJSON(object: any): MarketModifyEventV1;
-    toJSON(message: MarketModifyEventV1): unknown;
-    fromPartial(object: Partial<MarketModifyEventV1>): MarketModifyEventV1;
+    fromPartial(object: DeepPartial<MarketModifyEventV1>): MarketModifyEventV1;
 };
 export declare const SourceOfFunds: {
     encode(message: SourceOfFunds, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): SourceOfFunds;
-    fromJSON(object: any): SourceOfFunds;
-    toJSON(message: SourceOfFunds): unknown;
-    fromPartial(object: Partial<SourceOfFunds>): SourceOfFunds;
+    fromPartial(object: DeepPartial<SourceOfFunds>): SourceOfFunds;
 };
 export declare const TransferEventV1: {
     encode(message: TransferEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): TransferEventV1;
-    fromJSON(object: any): TransferEventV1;
-    toJSON(message: TransferEventV1): unknown;
-    fromPartial(object: Partial<TransferEventV1>): TransferEventV1;
+    fromPartial(object: DeepPartial<TransferEventV1>): TransferEventV1;
 };
 export declare const OrderFillEventV1: {
     encode(message: OrderFillEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): OrderFillEventV1;
-    fromJSON(object: any): OrderFillEventV1;
-    toJSON(message: OrderFillEventV1): unknown;
-    fromPartial(object: Partial<OrderFillEventV1>): OrderFillEventV1;
+    fromPartial(object: DeepPartial<OrderFillEventV1>): OrderFillEventV1;
 };
 export declare const LiquidationOrderV1: {
     encode(message: LiquidationOrderV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): LiquidationOrderV1;
-    fromJSON(object: any): LiquidationOrderV1;
-    toJSON(message: LiquidationOrderV1): unknown;
-    fromPartial(object: Partial<LiquidationOrderV1>): LiquidationOrderV1;
+    fromPartial(object: DeepPartial<LiquidationOrderV1>): LiquidationOrderV1;
 };
 export declare const SubaccountUpdateEventV1: {
     encode(message: SubaccountUpdateEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): SubaccountUpdateEventV1;
-    fromJSON(object: any): SubaccountUpdateEventV1;
-    toJSON(message: SubaccountUpdateEventV1): unknown;
-    fromPartial(object: Partial<SubaccountUpdateEventV1>): SubaccountUpdateEventV1;
+    fromPartial(object: DeepPartial<SubaccountUpdateEventV1>): SubaccountUpdateEventV1;
 };
 export declare const StatefulOrderEventV1: {
     encode(message: StatefulOrderEventV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1;
-    fromJSON(object: any): StatefulOrderEventV1;
-    toJSON(message: StatefulOrderEventV1): unknown;
-    fromPartial(object: Partial<StatefulOrderEventV1>): StatefulOrderEventV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1>): StatefulOrderEventV1;
 };
 export declare const StatefulOrderEventV1_StatefulOrderPlacementV1: {
     encode(message: StatefulOrderEventV1_StatefulOrderPlacementV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_StatefulOrderPlacementV1;
-    fromJSON(object: any): StatefulOrderEventV1_StatefulOrderPlacementV1;
-    toJSON(message: StatefulOrderEventV1_StatefulOrderPlacementV1): unknown;
-    fromPartial(object: Partial<StatefulOrderEventV1_StatefulOrderPlacementV1>): StatefulOrderEventV1_StatefulOrderPlacementV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1_StatefulOrderPlacementV1>): StatefulOrderEventV1_StatefulOrderPlacementV1;
 };
 export declare const StatefulOrderEventV1_StatefulOrderRemovalV1: {
     encode(message: StatefulOrderEventV1_StatefulOrderRemovalV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_StatefulOrderRemovalV1;
-    fromJSON(object: any): StatefulOrderEventV1_StatefulOrderRemovalV1;
-    toJSON(message: StatefulOrderEventV1_StatefulOrderRemovalV1): unknown;
-    fromPartial(object: Partial<StatefulOrderEventV1_StatefulOrderRemovalV1>): StatefulOrderEventV1_StatefulOrderRemovalV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1_StatefulOrderRemovalV1>): StatefulOrderEventV1_StatefulOrderRemovalV1;
 };
 export declare const StatefulOrderEventV1_ConditionalOrderPlacementV1: {
     encode(message: StatefulOrderEventV1_ConditionalOrderPlacementV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_ConditionalOrderPlacementV1;
-    fromJSON(object: any): StatefulOrderEventV1_ConditionalOrderPlacementV1;
-    toJSON(message: StatefulOrderEventV1_ConditionalOrderPlacementV1): unknown;
-    fromPartial(object: Partial<StatefulOrderEventV1_ConditionalOrderPlacementV1>): StatefulOrderEventV1_ConditionalOrderPlacementV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1_ConditionalOrderPlacementV1>): StatefulOrderEventV1_ConditionalOrderPlacementV1;
 };
 export declare const StatefulOrderEventV1_ConditionalOrderTriggeredV1: {
     encode(message: StatefulOrderEventV1_ConditionalOrderTriggeredV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_ConditionalOrderTriggeredV1;
-    fromJSON(object: any): StatefulOrderEventV1_ConditionalOrderTriggeredV1;
-    toJSON(message: StatefulOrderEventV1_ConditionalOrderTriggeredV1): unknown;
-    fromPartial(object: Partial<StatefulOrderEventV1_ConditionalOrderTriggeredV1>): StatefulOrderEventV1_ConditionalOrderTriggeredV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1_ConditionalOrderTriggeredV1>): StatefulOrderEventV1_ConditionalOrderTriggeredV1;
 };
 export declare const StatefulOrderEventV1_LongTermOrderPlacementV1: {
     encode(message: StatefulOrderEventV1_LongTermOrderPlacementV1, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): StatefulOrderEventV1_LongTermOrderPlacementV1;
-    fromJSON(object: any): StatefulOrderEventV1_LongTermOrderPlacementV1;
-    toJSON(message: StatefulOrderEventV1_LongTermOrderPlacementV1): unknown;
-    fromPartial(object: Partial<StatefulOrderEventV1_LongTermOrderPlacementV1>): StatefulOrderEventV1_LongTermOrderPlacementV1;
+    fromPartial(object: DeepPartial<StatefulOrderEventV1_LongTermOrderPlacementV1>): StatefulOrderEventV1_LongTermOrderPlacementV1;
+};
+export declare const AssetCreateEventV1: {
+    encode(message: AssetCreateEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): AssetCreateEventV1;
+    fromPartial(object: DeepPartial<AssetCreateEventV1>): AssetCreateEventV1;
+};
+export declare const PerpetualMarketCreateEventV1: {
+    encode(message: PerpetualMarketCreateEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PerpetualMarketCreateEventV1;
+    fromPartial(object: DeepPartial<PerpetualMarketCreateEventV1>): PerpetualMarketCreateEventV1;
+};
+export declare const LiquidityTierUpsertEventV1: {
+    encode(message: LiquidityTierUpsertEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): LiquidityTierUpsertEventV1;
+    fromPartial(object: DeepPartial<LiquidityTierUpsertEventV1>): LiquidityTierUpsertEventV1;
+};
+export declare const UpdateClobPairEventV1: {
+    encode(message: UpdateClobPairEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): UpdateClobPairEventV1;
+    fromPartial(object: DeepPartial<UpdateClobPairEventV1>): UpdateClobPairEventV1;
+};
+export declare const UpdatePerpetualEventV1: {
+    encode(message: UpdatePerpetualEventV1, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): UpdatePerpetualEventV1;
+    fromPartial(object: DeepPartial<UpdatePerpetualEventV1>): UpdatePerpetualEventV1;
 };