search

dydxprotocol / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:
https://cosmos.network/
Other
10 stars 10 forks source link

readme

dYdX Fork of CosmosSDK

This is a lightweight fork of CosmosSDK. The current version of the forked code resides on the default branch.

Making Changes to the Fork

  1. Open a PR against the current default branch (i.e. dydx-fork-v0.50.3).
  2. Get approval, and merge. DO NOT SQUASH AND MERGE. PLEASE REBASE AND MERGE
  3. After merging, update the v4 repository's go.mod, and go.sum files with your merged $COMMIT_HASH.
  4. (In dydxprotocol/v4) go mod edit -replace github.com/cosmos/cosmos-sdk=github.com/dydxprotocol/cosmos-sdk@$COMMIT_HASH
  5. (In dydxprotocol/v4) go mod tidy
  6. (In dydxprotocol/v4) update package references in mocks/Makefile. See here for an example.
  7. Open a PR in dydxprotocol/v4 to bump the version of the fork.

Fork maintenance

We'd like to keep the main branch up to date with cosmos/cosmos-sdk. You can utilize GitHub's sync fork button to accomplish this. ⚠️ Please only use this on the main branch, not on the fork branches as it will discard our commits.⚠️

Before these steps, please set the upstream remote to be the cosmos/cosmos-sdk repo. If you use http auth, you will have to switch the upstream url to be http. git remote add upstream git@github.com:cosmos/cosmos-sdk.git

Note that this doesn't pull in upstream tags, so in order to do this follow these steps:

  1. git fetch upstream
  2. git push --tags

Updating CosmosSDK to new versions

When a new version of CosmosSDK is published, we may want to adopt the changes in our fork. This process can be somewhat tedious, but below are the recommended steps to accomplish this.

  1. Ensure the main branch and all tags are up to date by following the steps above in "Fork maintenance".
  2. Create a new branch off the desired CosmosSDK commit using tags. git checkout -b dydx-fork-$VERSION <CosmosSDK repo's tag name>. The new branch should be named something like dydx-fork-$VERSION where $VERSION is the version of CosmosSDK being forked (should match the CosmosSDK repo's tag name). i.e. dydx-fork-v0.50.3.
  3. Push the new branch (i.e dydx-fork-v0.50.3).
  4. Off of this new branch, create a new branch. (i.e totoro/dydxCommits)
  5. Cherry-pick each dydx-created commit from the current default branch, in order, on to the new dydx-fork-$VERSION branch (note: you may want to consider creating multiple PRs for this process if there are difficulties or merge conflicts). For example, git cherry-pick <commit hash>. You can verify the first commit by seeing the most recent commit sha for the $VERSION (i.e v0.50.3) tag on the cosmos/cosmos-sdk repo, and taking the next commit from that sha.
  6. The dYdX fork uses an optimized version of runTx for handling ABCI CheckTx messages. Ensure that the logic within runCheckTxConcurrently stays up to date with the runTx counterpart by diffing baseapp.go#runTx current version against the new version copying over relevant changes to baseapp.go#runCheckTxConcurrently.
  7. Open a PR to merge the second branch (totoro/dydxCommits) into the first (dydx-fork-v0.50.3). Get approval, and merge. DO NOT SQUASH AND MERGE. PLEASE REBASE AND MERGE
  8. Update dydxprotocol/v4 by following the steps in "Making Changes to the fork" above.
  9. Set dydx-fork-$VERSION as the default branch in this repository.

Note that the github CI workflows need permissioning. If they fail with a permissioning error, i.e Resource not accessible through integration, a Github admin will need to whitelist the workflow.

Cosmos SDK

banner

License: Apache-2.0 Go Reference Go report card Code Coverage SonarCloud Analysis
Discord Imported by Sims Lint Satus

The Cosmos SDK is a framework for building blockchain applications. CometBFT (BFT Consensus) and the Cosmos SDK are written in the Go programming language. Cosmos SDK is used to build Gaia, the implementation of the Cosmos Hub.

WARNING: The Cosmos SDK has mostly stabilized, but we are still making some breaking changes.

Note: We advise to always use the latest maintained Go version for building Cosmos SDK applications.

Quick Start

To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK High-Level Intro.

If you want to get started quickly and learn how to build on top of Cosmos SDK, visit Cosmos SDK Tutorials. You can also fork the tutorial's repository to get started building your own Cosmos SDK application.

For more information, see the Cosmos SDK Documentation.

Contributing

See CONTRIBUTING.md for details on how to contribute and participate in our dev calls. If you want to follow the updates or learn more about the latest design then join our Discord.

Tools and Frameworks

The Cosmos ecosystem is vast. Awesome Cosmos is a community-curated list of notable frameworks, modules and tools.

Cosmos Hub Mainnet

The Cosmos Hub application, gaia, has its own cosmos/gaia repository. Go there to join the Cosmos Hub mainnet and more.

Inter-Blockchain Communication (IBC)

The IBC module for the Cosmos SDK has its own cosmos/ibc-go repository. Go there to build and integrate with the IBC module.

Disambiguation

This Cosmos SDK project is not related to the React-Cosmos project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here.