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

* update readmes * v4 -> dYdX chain * add more updates and format * format * nit update * proto gen * update indexer protos
dydxprotocol · Oct 24, 2023 · 59fcb53 · 59fcb53
1 parent 6dd7647
commit 59fcb53
Show file tree

Hide file tree

Showing 23 changed files with 153 additions and 161 deletions.
diff --git a/.github/workflows/protocol-lint.yml b/.github/workflows/protocol-lint.yml
@@ -1,17 +1,17 @@
 name: Protocol Lint
 # Lint runs all linting jobs.
 
-on:  # yamllint disable-line rule:truthy
+on: # yamllint disable-line rule:truthy
   pull_request:
     paths:
-      - 'protocol/**'
+      - "protocol/**"
   push:
     branches:
       - main
-      - 'release/protocol/v0.[0-9]+.x'  # e.g. release/protocol/v0.1.x
-      - 'release/protocol/v[0-9]+.x'  # e.g. release/protocol/v1.x
+      - "release/protocol/v0.[0-9]+.x" # e.g. release/protocol/v0.1.x
+      - "release/protocol/v[0-9]+.x" # e.g. release/protocol/v1.x
     paths:
-      - 'protocol/**'
+      - "protocol/**"
 
 # Ensure only a single instance of this workflow is running, and cancel any that are in-progress
 # before this workflow instance starts
@@ -20,7 +20,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  # Validates that the YAML files in the V4 repository are formatted properly.
+  # Validates that the YAML files in the repository are formatted properly.
   # The `validate-yaml` job will pass without running if no YAML files have been modified.
   validate-yaml:
     runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p>
 
-<h1 align="center">v4 Chain</h1>
+<h1 align="center">dYdX Chain</h1>
 
 <div align="center">
   <a href='https://github.com/dydxprotocol/v4-chain/blob/main/LICENSE'>
@@ -9,19 +9,19 @@
 </div>
 
 ## audits/
-Audit reports for the v4 Chain.
+Audit reports for the dYdX Chain.
 
 ## indexer/
-The v4 Indexer is a set of microservices which provides a set of rich APIs and websocket channels for a dYdX v4 application.
+The dYdX Indexer is a set of microservices which provides a set of rich APIs and websocket channels for a dYdX Chain application.
 
 ## proto/
-This directory defines all protos for the v4 Chain.
+This directory defines all protos for the dYdX Chain.
 
 ## protocol/
-Sovereign Blockchain built using Cosmos SDK & CometBFT for v4 of the dYdX Protocol.
+Sovereign Blockchain built using Cosmos SDK & CometBFT for dYdX Chain Protocol.
 
 ## v4-proto-js/
-Generated Javascript package for v4 Chain protobufs.
+Generated Javascript package for dYdX Chain protobufs.
 
 ## v4-proto-py/
-Generated Python package for v4 Chain protobufs.
+Generated Python package for dYdX Chain protobufs.
diff --git a/indexer/packages/postgres/README.md b/indexer/packages/postgres/README.md
@@ -7,6 +7,6 @@ Add a knex migration by running `pnpm run migrate:make <create_fake_table>`
 
 Run the migration with `pnpm run migrate`
 
-In order to migrate in v4 dev and staging, you must redeploy and run bazooka.
+In order to migrate in dev and staging, you must redeploy and run bazooka.
 
 TODO(CORE-512): Add info/resources around bazooka. [Doc](https://www.notion.so/dydx/Engineering-Runbook-15064661da9643188ce33e341b68e7bb#cb2283d80ef14a51924f3bd1a538fd82).
diff --git a/indexer/packages/v4-protos/README.md b/indexer/packages/v4-protos/README.md
@@ -1,5 +1,5 @@
-# V4 protos
+# dYdX Chain protos
 
-Package containing generated Typescript modules for V4 proto definitions.
+Package containing generated Typescript modules for dYdX Chain proto definitions.
 
 Protos can be found in `proto/` [here](https://github.com/dydxprotocol/v4-chain/tree/main/proto).
diff --git a/indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/events/events.ts b/indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/events/events.ts
@@ -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 {

diff --git a/indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/indexer_manager/event.ts b/indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/indexer_manager/event.ts
@@ -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.
  */