pooltogether / contract-list-schema Goto Github PK

Contracts follow individual semver versioning with no direct link to what parent global version was used during deployment.

For example, when deploying a new PrizeTierHistory the version will go from 1.1.0 to 1.2.0.

But as of right now, there is no way of knowing if PrizeTierHistoryv1.2.0 is used in Global.v1.1.0/v1.2.0/v.1.3.0/v1.4.0.

While not a problem at the moment because generally contracts are updated in succession and contracts are deprecated, so we can generally assume the latest ones are compatible with the latest major version.

But if we start deploying that we still need to support (even though they might be deprecated) it would be nice to future proof reverse lookups, so it's possible to find all child contracts used in (for example v1.4.0) and ensure the proper contracts are being used instead of optimistically determining the correct pairing of contracts.

The easiest solution (discussed with @dylandesrosier) could be to add an additional field to the Contract definition that tracks the major version during deployment.

Example

{
  chainId: 1,
  address: 0x000.000,
  deployVersion: 1.4.0,
  version: {
     "major":1,
     "minor":1,
     "patch":0
  }
}