Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(refactor): Update READMEs and comments to use dYdX Chain #689

Merged
merged 7 commits into from
Oct 24, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update indexer protos
ttl33 committed Oct 24, 2023
commit 2d6367b350741e30fbf6a880afb1f49842d81d4d
Original file line number Diff line number Diff line change
@@ -184,7 +184,7 @@ export interface FundingEventV1SDKType {
}
/**
* MarketEvent message contains all the information about a market event on
* the V4 chain.
* the dYdX chain.
*/

export interface MarketEventV1 {
@@ -196,7 +196,7 @@ export interface MarketEventV1 {
}
/**
* MarketEvent message contains all the information about a market event on
* the V4 chain.
* the dYdX chain.
*/

export interface MarketEventV1SDKType {
@@ -208,7 +208,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 {
@@ -221,7 +221,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 {
@@ -258,7 +258,7 @@ export interface MarketBaseEventV1SDKType {
}
/**
* MarketCreateEvent message contains all the information about a new market on
* the V4 chain.
* the dYdX chain.
*/

export interface MarketCreateEventV1 {
@@ -274,7 +274,7 @@ export interface MarketCreateEventV1 {
}
/**
* MarketCreateEvent message contains all the information about a new market on
* the V4 chain.
* the dYdX chain.
*/

export interface MarketCreateEventV1SDKType {
@@ -290,25 +290,25 @@ 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 {
/**
* MarketModifyEvent message contains all the information about a market update
* on the V4 chain
* on the dYdX chain
*/
base?: MarketBaseEventV1SDKType;
}
@@ -326,7 +326,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.
*/
@@ -357,7 +357,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.
*/
@@ -388,7 +388,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.
*/

@@ -417,7 +417,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.
*/

@@ -512,7 +512,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
@@ -526,7 +526,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
@@ -638,7 +638,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 {
@@ -672,7 +672,7 @@ export interface AssetCreateEventV1 {
}
/**
* AssetCreateEventV1 message contains all the information about an new Asset on
* the v4 chain.
* the dYdX chain.
*/

export interface AssetCreateEventV1SDKType {
@@ -706,7 +706,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 {
@@ -776,7 +776,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 {
@@ -846,7 +846,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 {
@@ -877,7 +877,7 @@ export interface LiquidityTierUpsertEventV1 {
}
/**
* 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 {
@@ -908,7 +908,7 @@ export interface LiquidityTierUpsertEventV1SDKType {
}
/**
* 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 {
@@ -945,7 +945,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 {
@@ -982,7 +982,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 {
@@ -1021,7 +1021,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 {
Original file line number Diff line number Diff line change
@@ -111,7 +111,7 @@ export interface IndexerEventsStoreValueSDKType {
}
/**
* IndexerTendermintEvent contains the base64 encoded event proto emitted from
* the V4 application as well as additional metadata to determine the ordering
* the dYdX application as well as additional metadata to determine the ordering
* of the event within the block and the subtype of the event.
*/

@@ -136,7 +136,7 @@ export interface IndexerTendermintEvent {
}
/**
* IndexerTendermintEvent contains the base64 encoded event proto emitted from
* the V4 application as well as additional metadata to determine the ordering
* the dYdX application as well as additional metadata to determine the ordering
* of the event within the block and the subtype of the event.
*/

Original file line number Diff line number Diff line change
@@ -13,19 +13,19 @@ export enum OrderPlaceV1_OrderPlacementStatus {

/**
* ORDER_PLACEMENT_STATUS_BEST_EFFORT_OPENED - A best effort opened order is one that has only been confirmed to be
* placed on the V4 node sending the off-chain update message.
* placed on the dYdX node sending the off-chain update message.
* The cases where this happens includes:
* - The V4 node places an order in it's in-memory orderbook during the
* - The dYdX node places an order in it's in-memory orderbook during the
* CheckTx flow.
* A best effort placed order may not have been placed on other V4
* nodes including other V4 validator nodes and may still be excluded in
* A best effort placed order may not have been placed on other dYdX
* nodes including other dYdX validator nodes and may still be excluded in
* future order matches.
*/
ORDER_PLACEMENT_STATUS_BEST_EFFORT_OPENED = 1,

/**
* ORDER_PLACEMENT_STATUS_OPENED - An opened order is one that is confirmed to be placed on all V4 nodes
* (discounting dishonest V4 nodes) and will be included in any future
* ORDER_PLACEMENT_STATUS_OPENED - An opened order is one that is confirmed to be placed on all dYdX nodes
* (discounting dishonest dYdX nodes) and will be included in any future
* order matches.
* This status is used internally by the indexer and will not be sent
* out by protocol.
@@ -44,19 +44,19 @@ export enum OrderPlaceV1_OrderPlacementStatusSDKType {

/**
* ORDER_PLACEMENT_STATUS_BEST_EFFORT_OPENED - A best effort opened order is one that has only been confirmed to be
* placed on the V4 node sending the off-chain update message.
* placed on the dYdX node sending the off-chain update message.
* The cases where this happens includes:
* - The V4 node places an order in it's in-memory orderbook during the
* - The dYdX node places an order in it's in-memory orderbook during the
* CheckTx flow.
* A best effort placed order may not have been placed on other V4
* nodes including other V4 validator nodes and may still be excluded in
* A best effort placed order may not have been placed on other dYdX
* nodes including other dYdX validator nodes and may still be excluded in
* future order matches.
*/
ORDER_PLACEMENT_STATUS_BEST_EFFORT_OPENED = 1,

/**
* ORDER_PLACEMENT_STATUS_OPENED - An opened order is one that is confirmed to be placed on all V4 nodes
* (discounting dishonest V4 nodes) and will be included in any future
* ORDER_PLACEMENT_STATUS_OPENED - An opened order is one that is confirmed to be placed on all dYdX nodes
* (discounting dishonest dYdX nodes) and will be included in any future
* order matches.
* This status is used internally by the indexer and will not be sent
* out by protocol.
@@ -111,21 +111,21 @@ export enum OrderRemoveV1_OrderRemovalStatus {

/**
* ORDER_REMOVAL_STATUS_BEST_EFFORT_CANCELED - A best effort canceled order is one that has only been confirmed to be
* removed on the V4 node sending the off-chain update message.
* removed on the dYdX node sending the off-chain update message.
* The cases where this happens includes:
* - the order was removed due to the V4 node receiving a CancelOrder
* - the order was removed due to the dYdX node receiving a CancelOrder
* transaction for the order.
* - the order was removed due to being undercollateralized during
* optimistic matching.
* A best effort canceled order may not have been removed on other V4
* nodes including other V4 validator nodes and may still be included in
* A best effort canceled order may not have been removed on other dYdX
* nodes including other dYdX validator nodes and may still be included in
* future order matches.
*/
ORDER_REMOVAL_STATUS_BEST_EFFORT_CANCELED = 1,

/**
* ORDER_REMOVAL_STATUS_CANCELED - A canceled order is one that is confirmed to be removed on all V4 nodes
* (discounting dishonest V4 nodes) and will not be included in any future
* ORDER_REMOVAL_STATUS_CANCELED - A canceled order is one that is confirmed to be removed on all dYdX nodes
* (discounting dishonest dYdX nodes) and will not be included in any future
* order matches.
* The cases where this happens includes:
* - the order is expired.
@@ -147,21 +147,21 @@ export enum OrderRemoveV1_OrderRemovalStatusSDKType {

/**
* ORDER_REMOVAL_STATUS_BEST_EFFORT_CANCELED - A best effort canceled order is one that has only been confirmed to be
* removed on the V4 node sending the off-chain update message.
* removed on the dYdX node sending the off-chain update message.
* The cases where this happens includes:
* - the order was removed due to the V4 node receiving a CancelOrder
* - the order was removed due to the dYdX node receiving a CancelOrder
* transaction for the order.
* - the order was removed due to being undercollateralized during
* optimistic matching.
* A best effort canceled order may not have been removed on other V4
* nodes including other V4 validator nodes and may still be included in
* A best effort canceled order may not have been removed on other dYdX
* nodes including other dYdX validator nodes and may still be included in
* future order matches.
*/
ORDER_REMOVAL_STATUS_BEST_EFFORT_CANCELED = 1,

/**
* ORDER_REMOVAL_STATUS_CANCELED - A canceled order is one that is confirmed to be removed on all V4 nodes
* (discounting dishonest V4 nodes) and will not be included in any future
* ORDER_REMOVAL_STATUS_CANCELED - A canceled order is one that is confirmed to be removed on all dYdX nodes
* (discounting dishonest dYdX nodes) and will not be included in any future
* order matches.
* The cases where this happens includes:
* - the order is expired.
Original file line number Diff line number Diff line change
@@ -72,7 +72,7 @@ export function redisOrder_TickerTypeToJSON(object: RedisOrder_TickerType): stri
/**
* RedisOrder is a proto for orders stored in Redis. This proto holds some
* human-readable values such as price, size and ticker as well as the original
* `Order` proto from the V4 application.
* `Order` proto from the dYdX application.
*/

export interface RedisOrder {
@@ -97,7 +97,7 @@ export interface RedisOrder {
/**
* RedisOrder is a proto for orders stored in Redis. This proto holds some
* human-readable values such as price, size and ticker as well as the original
* `Order` proto from the V4 application.
* `Order` proto from the dYdX application.
*/

export interface RedisOrderSDKType {