Skip to content

feat: add upgrades.json file as canonical source of upgrade info#184

Merged
BigLep merged 1 commit into
filecoin-project:masterfrom
rvagg:rvagg/upgrades.json
Oct 28, 2024
Merged

feat: add upgrades.json file as canonical source of upgrade info#184
BigLep merged 1 commit into
filecoin-project:masterfrom
rvagg:rvagg/upgrades.json

Conversation

@rvagg

@rvagg rvagg commented Oct 24, 2024

Copy link
Copy Markdown
Member
  • Add upgrades.json to the root of the repo with all of the upgrade information in it, including epochs, dates and actors CIDs for mainnet and calibrationnet. This can be consumed programatically and be used tasks such as informing users that upgrades are pending. Suggested by @magik6k.
  • Add an _upgrades.js executable in the Network Upgrades directory that will generate the README.md in that directory from the upgrades.json data.

In the process a few minor inconsistencies were fixed up, including one FIP reference that pointed to a pull request.

Compare rendered versions side by side for accuracy:

As per docs inside _upgrades.js, here's some quirks about the data that may be relevant to consumers:

// Some quirks about the upgrades.json file:
// - If the activation.mainnet.epoch field is null, it means the epoch is TBD.
// - If the activation.mainnet.epoch field is null but the activation.mainnet.time field is not null,
//   it means the epoch is TBD but the date and time have been proposed.
// - builtin-actors began at version 8, so we don't link to the actors repo for upgrades before that.

In addition, an upgrade with an actors version >8 without actors CIDs means that it hasn't been tagged.

/cc @rjan90 @BigLep

@BigLep BigLep self-requested a review October 24, 2024 21:32

@BigLep BigLep left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@rvagg : this is awesome. I don't see any downsides with this. Assuming @rjan90 is on board, we'll update the steps in https://docs.google.com/document/d/1KKJj2COb0vIqAQh-4F7fflJjxiTgGrU9oT9B461nsgg/edit#heading=h.xh3e4jwq08cp once this gets approved/merged.

@BigLep

BigLep commented Oct 28, 2024

Copy link
Copy Markdown
Member

Seeing how the access to this repo is outdated (screenshot below), and @rjan90 gave a thumbs up, and I think risks here are minimal, I'm going to merge this...
image

@BigLep BigLep merged commit 03bdbc9 into filecoin-project:master Oct 28, 2024
@BigLep

BigLep commented Oct 28, 2024

Copy link
Copy Markdown
Member

I also updated the network upgrade template to account for this: https://docs.google.com/document/d/1KKJj2COb0vIqAQh-4F7fflJjxiTgGrU9oT9B461nsgg/edit#heading=h.8csw9xq9zwiy

@rvagg rvagg deleted the rvagg/upgrades.json branch October 28, 2024 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants