Skip to content

Commit b9c6a9b

Browse files
authored
Update README with dYdX-specific instructions on our fork + rename, release publishing, and remaining work for deploying the forked sidecar (#9)
1 parent 8c0f340 commit b9c6a9b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,26 @@ We have an extensive suite of metrics available to validators and chain operator
9595

9696
* metrics relevant to the network's (that is running the instance of slinky) performance are [here](./service/metrics/README.md)
9797

98+
---
99+
100+
## dYdX Fork
101+
102+
### Slinky vs. Connect Rename
103+
104+
* Skip renamed their repo (and code refs) from Slinky --> Connect for branding purposes.
105+
* Unfortunately it is impossible to update V4 protocol to use the renamed version, as message names etc. were changed. This would cause downtime during the interval when validators have updated `v4-chain` to use the rename but have not yet updated sidecar (or vice-versa).
106+
* As a result, the dYdX fork of `skip-mev/connect` has chosen to roll back to the pre-rename state, `slinky`, as the base for future development (along with backporting any essential post-rename changes to functionality).
107+
108+
### Publishing a Release
109+
110+
To publish a new release of the `dydxprotocol/slinky` codebase, [follow the official Go docs for Publishing A Module.](https://go.dev/doc/modules/publishing)
111+
112+
### TODO: Sidecar Deploys
113+
114+
* The GitHub workflows in this repo can build + deploy new images of the Slinky sidecar (along with other images for E2E testing, local testing, etc.)
115+
* However, these workflows have not yet been updated for dYdX's use case. (Ex. ECR + GHCR URLs still point to Skip's accounts, still rely on Skip secrets, etc.)
116+
* This is not an urgent issue, unless the sidecar code itself is updated, or breaking changes are made to the format of the Market Map.
117+
* Note: Adding new fields to ex. the `metadata_json` string in Market Map, is not a breaking change (assuming these new fields are not required by the sidecar for price-fetching).
118+
* **Next Steps to enable deploys for dYdX's fork of sidecar:**
119+
* Update the URLs and secrets in `build-docker.yml` to deploy to dYdX's ECR / GHCR repos.
120+
* Update `v4-chain`'s `docker-compose.yml` to pull from dYdX's repos when building the `slinky0` (sidecar) image.

0 commit comments

Comments
 (0)