Skip to content

Commit

Permalink
Update actors_version_checklist.md (#271)
Browse files Browse the repository at this point in the history
Update actors_version_checklist.md to reference Go-State-Types Checklist in Lotus repository
  • Loading branch information
rjan90 authored Jun 13, 2024
1 parent 6568009 commit b0f5faa
Showing 1 changed file with 1 addition and 12 deletions.
13 changes: 1 addition & 12 deletions actors_version_checklist.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
### Actor version integration checklist

- [ ] Copy `go-state-types/builtin/vX` to `go-state-types/builtin/v(X+1)`
- [ ] Change all references to `vX` in the new files to `v(X+1)`
- [ ] Add new network version to `network/version.go`
- [ ] Add new actors version to `actors/version.go`[^1]
- [ ] Add the new version to the `gen` step of the makefile`[^2]
- [ ] run `make gen`

[^1]:
#### Steps:
1. **Add a new constant**: Add a new constant in the list of versions. The new constant's name should follow the existing naming convention - i.e., `VersionXX+1 Version = XX+1`, where XX+1 is the new version number.
2. **Update `VersionForNetwork` function**: In `version.go`, there's a function called `VersionForNetwork` that accepts a network version and returns the corresponding actor version. Add a new case line for the network version that corresponds to the new actor version you're adding - i.e, `network.Version(XX+1): return Version(XX+1), nil`
[^2]: Add `$(GO_BIN) run ./builtin/v(XX+1)/gen/gen.go`
For detailed steps on integrating a new actor version, please refer to the [Go-State-Types Checklist in the Lotus repository](https://github.com/filecoin-project/lotus/blob/master/documentation/misc/Building_a_network_skeleton.md#go-state-types-checklist).

0 comments on commit b0f5faa

Please sign in to comment.