Skip to content

Commit

Permalink
v4 -> dYdX chain
Browse files Browse the repository at this point in the history
  • Loading branch information
ttl33 committed Oct 24, 2023
1 parent 3efede3 commit ab94eb0
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 23 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/protocol-lint.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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'>
Expand All @@ -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.
2 changes: 1 addition & 1 deletion indexer/packages/postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions indexer/packages/v4-protos/README.md
Original file line number Diff line number Diff line change
@@ -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).
4 changes: 2 additions & 2 deletions proto/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p>

<h1 align="center">v4 Proto</h1>
<h1 align="center">dYdX Chain Proto</h1>

<div align="center">
<a href="https://github.com/dydxprotocol/v4-chain/actions/workflows/proto.yml?query=branch%3Amain" style="text-decoration:none;">
<img src="https://github.com/dydxprotocol/v4-chain/actions/workflows/proto.yml/badge.svg?branch=main" />
</a>
</div>

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.
2 changes: 1 addition & 1 deletion proto/dydxprotocol/indexer/protocol/v1/clob.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion proto/dydxprotocol/indexer/protocol/v1/subaccount.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion protocol/.gitleaks.toml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion v4-proto-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
</a>
</div>

Generated Javascript package for v4 Chain protobufs.
Generated Javascript package for dYdX Chain protobufs.
2 changes: 1 addition & 1 deletion v4-proto-py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
</a>
</div>

Generated Python package for v4 Chain protobufs.
Generated Python package for dYdX Chain protobufs.

0 comments on commit ab94eb0

Please sign in to comment.