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
Next Next commit
add more updates and format
ttl33 committed Oct 24, 2023
commit 8d9556355ec167f483b86f5226c3f6251a0ef1c3
24 changes: 12 additions & 12 deletions proto/dydxprotocol/indexer/events/events.proto
Original file line number Diff line number Diff line change
@@ -63,7 +63,7 @@ message FundingEventV1 {
}

// MarketEvent message contains all the information about a market event on
// the V4 chain.
// the dYdX chain.
message MarketEventV1 {
// market id.
uint32 market_id = 1;
@@ -77,7 +77,7 @@ message MarketEventV1 {
}

// MarketPriceUpdateEvent message contains all the information about a price
// update on the V4 chain.
// update on the dYdX chain.
message MarketPriceUpdateEventV1 {
// price_with_exponent. Multiply by 10 ^ Exponent to get the human readable
// price in dollars. For example if `Exponent == -5` then a `exponent_price`
@@ -95,7 +95,7 @@ message MarketBaseEventV1 {
}

// MarketCreateEvent message contains all the information about a new market on
// the V4 chain.
// the dYdX chain.
message MarketCreateEventV1 {
MarketBaseEventV1 base = 1;
// Static value. The exponent of the price.
@@ -106,7 +106,7 @@ message MarketCreateEventV1 {
}

// MarketModifyEvent message contains all the information about a market update
// on the V4 chain
// on the dYdX chain
message MarketModifyEventV1 { MarketBaseEventV1 base = 1; }

// SourceOfFunds is the source of funds in a transfer event.
@@ -120,7 +120,7 @@ message SourceOfFunds {
}
}
// 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.
message TransferEventV1 {
@@ -142,7 +142,7 @@ message TransferEventV1 {
}

// 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.
message OrderFillEventV1 {
dydxprotocol.indexer.protocol.v1.IndexerOrder maker_order = 1
@@ -189,7 +189,7 @@ message LiquidationOrderV1 {
}

// 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
@@ -253,7 +253,7 @@ message StatefulOrderEventV1 {
}

// AssetCreateEventV1 message contains all the information about an new Asset on
// the v4 chain.
// the dYdX chain.
message AssetCreateEventV1 {
// Unique, sequentially-generated.
uint32 id = 1;
@@ -279,7 +279,7 @@ message AssetCreateEventV1 {
}

// PerpetualMarketCreateEventV1 message contains all the information about a
// new Perpetual Market on the v4 chain.
// new Perpetual Market on the dYdX chain.
message PerpetualMarketCreateEventV1 {
// Unique Perpetual id.
// Defined in perpetuals.perpetual
@@ -329,7 +329,7 @@ message PerpetualMarketCreateEventV1 {
}

// 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.
message LiquidityTierUpsertEventV1 {
// Unique id.
uint32 id = 1;
@@ -352,7 +352,7 @@ message LiquidityTierUpsertEventV1 {
}

// UpdateClobPairEventV1 message contains all the information about an update to
// a clob pair on the v4 chain.
// a clob pair on the dYdX chain.
message UpdateClobPairEventV1 {
// Unique clob pair Id associated with this perpetual market
// Defined in clob.clob_pair
@@ -379,7 +379,7 @@ message UpdateClobPairEventV1 {
}

// UpdatePerpetualEventV1 message contains all the information about an update
// to a perpetual on the v4 chain.
// to a perpetual on the dYdX chain.
message UpdatePerpetualEventV1 {
// Unique Perpetual id.
// Defined in perpetuals.perpetual
2 changes: 1 addition & 1 deletion proto/dydxprotocol/indexer/indexer_manager/event.proto
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ message IndexerEventsStoreValue {
}

// 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.
message IndexerTendermintEvent {
reserved 2;
Original file line number Diff line number Diff line change
@@ -20,16 +20,16 @@ message OrderPlaceV1 {
// Default value, this is invalid and unused.
ORDER_PLACEMENT_STATUS_UNSPECIFIED = 0;
// 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;
// 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
// 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.
@@ -50,18 +50,18 @@ message OrderRemoveV1 {
// Default value, this is invalid and unused.
ORDER_REMOVAL_STATUS_UNSPECIFIED = 0;
// 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;
// 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
// 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.
8 changes: 4 additions & 4 deletions proto/dydxprotocol/indexer/protocol/v1/clob.proto
Original file line number Diff line number Diff line change
@@ -6,10 +6,10 @@ import "gogoproto/gogo.proto";

option go_package = "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1";

// Initial copy of protos from dYdX chain application state protos for the clob module
// for use to send Indexer specific messages. Do not make any breaking changes
// to these protos, a new version should be created if a breaking change is
// needed.
// Initial copy of protos from dYdX chain application state protos for the clob
// module for use to send Indexer specific messages. Do not make any breaking
// changes to these protos, a new version should be created if a breaking change
// is needed.

// IndexerOrderId refers to a single order belonging to a Subaccount.
message IndexerOrderId {
8 changes: 4 additions & 4 deletions proto/dydxprotocol/indexer/protocol/v1/subaccount.proto
Original file line number Diff line number Diff line change
@@ -6,10 +6,10 @@ import "gogoproto/gogo.proto";

option go_package = "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1";

// Initial copy of protos from dYdX chain application state protos for the subaccount
// module for use to send Indexer specific messages. Do not make any breaking
// changes to these protos, a new version should be created if a breaking change
// is needed.
// Initial copy of protos from dYdX chain application state protos for the
// subaccount module for use to send Indexer specific messages. Do not make any
// breaking changes to these protos, a new version should be created if a
// breaking change is needed.

// IndexerSubaccountId defines a unique identifier for a Subaccount.
message IndexerSubaccountId {
2 changes: 1 addition & 1 deletion proto/dydxprotocol/indexer/redis/redis_order.proto
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ import "dydxprotocol/indexer/protocol/v1/clob.proto";

// 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.
message RedisOrder {
// uuid of the Order generated by the Indexer based on the `OrderId`.
string id = 1;