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

Conversation

ttl33
Copy link
Contributor

@ttl33 ttl33 commented Oct 24, 2023

Changelist

  • Update READMEs and comments to use dYdX Chain instead of v4

Test Plan

N/A

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 24, 2023

Walkthrough

The changes primarily involve renaming and rebranding the project from "V4 Chain" to "dYdX Chain". This includes updates to package names, comments, documentation, and workflow configurations. The logic and functionality of the code remain unchanged.

Changes

File(s) Summary
.github/workflows/protocol-lint.yml Updated paths and branches for the linting job triggers.
README.md, indexer/packages/postgres/README.md, indexer/packages/v4-protos/README.md, proto/README.md, protocol/README.md, v4-proto-js/README.md, v4-proto-py/README.md Rebranded the project from "V4 Chain" to "dYdX Chain". Updated project names, directory names, package names, and documentation links.
proto/dydxprotocol/indexer/protocol/v1/clob.proto, proto/dydxprotocol/indexer/protocol/v1/subaccount.proto, proto/dydxprotocol/indexer/events/events.proto, proto/dydxprotocol/indexer/indexer_manager/event.proto, proto/dydxprotocol/indexer/off_chain_updates/off_chain_updates.proto, proto/dydxprotocol/indexer/redis/redis_order.proto Updated comments and package names to reflect the rebranding.
protocol/.gitleaks.toml Updated the title of the gitleaks configuration file to reflect the rebranding.
v4-proto-py/setup.py Updated the description of the project to reflect the rebranding.
indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/events/events.ts, indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/indexer_manager/event.ts, indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/off_chain_updates/off_chain_updates.ts, indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/redis/redis_order.ts Updated interface names, variable names, and comments to reflect the rebranding.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between cba238d and ab94eb0.
Files selected for processing (11)
  • .github/workflows/protocol-lint.yml (2 hunks)
  • README.md (2 hunks)
  • indexer/packages/postgres/README.md (1 hunks)
  • indexer/packages/v4-protos/README.md (1 hunks)
  • proto/README.md (1 hunks)
  • proto/dydxprotocol/indexer/protocol/v1/clob.proto (1 hunks)
  • proto/dydxprotocol/indexer/protocol/v1/subaccount.proto (1 hunks)
  • protocol/.gitleaks.toml (1 hunks)
  • protocol/README.md (6 hunks)
  • v4-proto-js/README.md (1 hunks)
  • v4-proto-py/README.md (1 hunks)
Files skipped from review due to trivial changes (11)
  • .github/workflows/protocol-lint.yml
  • README.md
  • indexer/packages/postgres/README.md
  • indexer/packages/v4-protos/README.md
  • proto/README.md
  • proto/dydxprotocol/indexer/protocol/v1/clob.proto
  • proto/dydxprotocol/indexer/protocol/v1/subaccount.proto
  • protocol/.gitleaks.toml
  • protocol/README.md
  • v4-proto-js/README.md
  • v4-proto-py/README.md

@@ -178,23 +178,6 @@ dasel put string -f "$CONFIG_FOLDER"/config.toml '.consensus.timeout_propose' '6
dasel put string -f "$CONFIG_FOLDER"/config.toml '.consensus.timeout_commit' '60s'
```

## Bootstrapping a new module
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we no longer use ignite

### Pricefeed Daemon

The Pricefeed Daemon is responsible for ingesting prices from 3rd party exchanges like Binance and sending these prices to the application where they are then used by the Prices module. The Pricefeed daemon is started by default when the application starts.

The path to the configuration file used for querying exchanges is dictated by the flag `pricefeed-exchange-config-file`. The default configuration file is located within `v4` at the path `daemons/configs/default_pricefeed_exchange_config.go`. The file utilizes a template that is populated from `daemons/pricefeed/client/constants/static_exchange_startup_config.go`. The first exchange within the default configuration file additionally has inline comments explaining what each field is for.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we got rid of this as part of this PR

@ttl33 ttl33 changed the title Update READMEs and comments to use dYdX Chain (refactor) Update READMEs and comments to use dYdX Chain Oct 24, 2023
@ttl33 ttl33 changed the title (refactor) Update READMEs and comments to use dYdX Chain (refactor): Update READMEs and comments to use dYdX Chain Oct 24, 2023
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between ab94eb0 and 8d95563.
Files selected for processing (6)
  • proto/dydxprotocol/indexer/events/events.proto (12 hunks)
  • proto/dydxprotocol/indexer/indexer_manager/event.proto (1 hunks)
  • proto/dydxprotocol/indexer/off_chain_updates/off_chain_updates.proto (2 hunks)
  • proto/dydxprotocol/indexer/protocol/v1/clob.proto (1 hunks)
  • proto/dydxprotocol/indexer/protocol/v1/subaccount.proto (1 hunks)
  • proto/dydxprotocol/indexer/redis/redis_order.proto (1 hunks)
Files skipped from review due to trivial changes (6)
  • proto/dydxprotocol/indexer/events/events.proto
  • proto/dydxprotocol/indexer/indexer_manager/event.proto
  • proto/dydxprotocol/indexer/off_chain_updates/off_chain_updates.proto
  • proto/dydxprotocol/indexer/protocol/v1/clob.proto
  • proto/dydxprotocol/indexer/protocol/v1/subaccount.proto
  • proto/dydxprotocol/indexer/redis/redis_order.proto

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8d95563 and 66fbd89.
Files selected for processing (2)
  • proto/dydxprotocol/indexer/protocol/v1/clob.proto (1 hunks)
  • proto/dydxprotocol/indexer/protocol/v1/subaccount.proto (1 hunks)
Files skipped from review due to trivial changes (2)
  • proto/dydxprotocol/indexer/protocol/v1/clob.proto
  • proto/dydxprotocol/indexer/protocol/v1/subaccount.proto

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 66fbd89 and 147d0cf.
Files selected for processing (1)
  • v4-proto-py/setup.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • v4-proto-py/setup.py

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 147d0cf and 2d6367b.
Files ignored due to filter (3)
  • protocol/indexer/events/events.pb.go
  • protocol/indexer/indexer_manager/event.pb.go
  • protocol/indexer/off_chain_updates/off_chain_updates.pb.go
Files selected for processing (4)
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/events/events.ts (23 hunks)
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/indexer_manager/event.ts (2 hunks)
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/off_chain_updates/off_chain_updates.ts (4 hunks)
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/redis/redis_order.ts (2 hunks)
Files skipped from review due to trivial changes (4)
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/events/events.ts
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/indexer_manager/event.ts
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/off_chain_updates/off_chain_updates.ts
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/indexer/redis/redis_order.ts

@ttl33 ttl33 merged commit 59fcb53 into main Oct 24, 2023
@ttl33 ttl33 deleted the tl/readme-updates branch October 24, 2023 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants