From ab94eb052378f58c48fdf148591d5b5d8cf8b8e0 Mon Sep 17 00:00:00 2001 From: Taehoon Lee <19664986+ttl33@users.noreply.github.com> Date: Tue, 24 Oct 2023 10:29:27 -0400 Subject: [PATCH] v4 -> dYdX chain --- .github/workflows/protocol-lint.yml | 12 ++++++------ README.md | 14 +++++++------- indexer/packages/postgres/README.md | 2 +- indexer/packages/v4-protos/README.md | 4 ++-- proto/README.md | 4 ++-- proto/dydxprotocol/indexer/protocol/v1/clob.proto | 2 +- .../indexer/protocol/v1/subaccount.proto | 2 +- protocol/.gitleaks.toml | 2 +- v4-proto-js/README.md | 2 +- v4-proto-py/README.md | 2 +- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/workflows/protocol-lint.yml b/.github/workflows/protocol-lint.yml index 8a6cb46a9d..88c7d8ce5c 100644 --- 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 index 318e5c1903..72696a6ad2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-

v4 Chain

+

dYdX Chain

@@ -9,19 +9,19 @@
## 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 index 7f4b821d92..c4ddb21901 100644 --- 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 ` 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 index b145d830c8..4393e25ab2 100644 --- 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/proto/README.md b/proto/README.md index 0c40a24cce..12a0e128b5 100644 --- a/proto/README.md +++ b/proto/README.md @@ -1,6 +1,6 @@

-

v4 Proto

+

dYdX Chain Proto

@@ -8,7 +8,7 @@
-This directory defines all protos for `v4`. We follow the Cosmos-SDK convention of using a tool called +This directory defines all protos for `v4-chain`. We follow the Cosmos-SDK convention of using a tool called [buf](https://github.com/bufbuild/buf) to manage proto dependencies. You can think of `buf` as being like `npm` for protocol buffers. See the `buf` [documentation](https://docs.buf.build/how-to/iterate-on-modules#update-dependencies) for further details. diff --git a/proto/dydxprotocol/indexer/protocol/v1/clob.proto b/proto/dydxprotocol/indexer/protocol/v1/clob.proto index 1d749a432e..9861bd81a9 100644 --- a/proto/dydxprotocol/indexer/protocol/v1/clob.proto +++ b/proto/dydxprotocol/indexer/protocol/v1/clob.proto @@ -6,7 +6,7 @@ import "gogoproto/gogo.proto"; option go_package = "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1"; -// Initial copy of protos from V4 application state protos for the clob module +// 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. diff --git a/proto/dydxprotocol/indexer/protocol/v1/subaccount.proto b/proto/dydxprotocol/indexer/protocol/v1/subaccount.proto index 085f12d7fa..5e58c33c71 100644 --- a/proto/dydxprotocol/indexer/protocol/v1/subaccount.proto +++ b/proto/dydxprotocol/indexer/protocol/v1/subaccount.proto @@ -6,7 +6,7 @@ import "gogoproto/gogo.proto"; option go_package = "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1"; -// Initial copy of protos from V4 application state protos for the subaccount +// 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. diff --git a/protocol/.gitleaks.toml b/protocol/.gitleaks.toml index e03a378481..deb27f0719 100644 --- a/protocol/.gitleaks.toml +++ b/protocol/.gitleaks.toml @@ -1,5 +1,5 @@ # Title for the gitleaks configuration file. -title = "dYdX chain Gitleaks Settings" +title = "dYdX Chain Gitleaks Settings" [extend] # useDefault will extend the base configuration with the default gitleaks config: diff --git a/v4-proto-js/README.md b/v4-proto-js/README.md index 13c5e0c121..b0acdc0b71 100644 --- a/v4-proto-js/README.md +++ b/v4-proto-js/README.md @@ -11,4 +11,4 @@ -Generated Javascript package for v4 Chain protobufs. +Generated Javascript package for dYdX Chain protobufs. diff --git a/v4-proto-py/README.md b/v4-proto-py/README.md index 1d2c0edecd..940bf58088 100644 --- a/v4-proto-py/README.md +++ b/v4-proto-py/README.md @@ -11,4 +11,4 @@ -Generated Python package for v4 Chain protobufs. +Generated Python package for dYdX Chain protobufs.