|
| 1 | +package initialization |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "fmt" |
| 6 | + "os" |
| 7 | + "path/filepath" |
| 8 | + |
| 9 | + "github.com/natefinch/atomic" |
| 10 | + "go.uber.org/zap" |
| 11 | + |
| 12 | + "github.com/spacemeshos/post/config" |
| 13 | + "github.com/spacemeshos/post/oracle" |
| 14 | + "github.com/spacemeshos/post/shared" |
| 15 | +) |
| 16 | + |
| 17 | +var migrateData map[int]func(dir string, logger *zap.Logger) (err error) |
| 18 | + |
| 19 | +func init() { |
| 20 | + migrateData = make(map[int]func(dir string, logger *zap.Logger) (err error)) |
| 21 | + migrateData[0] = migrateV0 |
| 22 | +} |
| 23 | + |
| 24 | +type MetadataVersion struct { |
| 25 | + Version int `json:",omitempty"` |
| 26 | +} |
| 27 | + |
| 28 | +// MigratePoST migrates the PoST metadata file to the latest version. |
| 29 | +func MigratePoST(dir string, logger *zap.Logger) (err error) { |
| 30 | + logger.Info("checking PoST for migrations") |
| 31 | + |
| 32 | + filename := filepath.Join(dir, MetadataFileName) |
| 33 | + file, err := os.Open(filename) |
| 34 | + switch { |
| 35 | + case os.IsNotExist(err): |
| 36 | + return ErrStateMetadataFileMissing |
| 37 | + case err != nil: |
| 38 | + return fmt.Errorf("could not open metadata file: %w", err) |
| 39 | + } |
| 40 | + defer file.Close() |
| 41 | + |
| 42 | + version := MetadataVersion{} |
| 43 | + if err := json.NewDecoder(file).Decode(&version); err != nil { |
| 44 | + return fmt.Errorf("failed to determine metadata version: %w", err) |
| 45 | + } |
| 46 | + |
| 47 | + if version.Version == len(migrateData) { |
| 48 | + logger.Info("PoST is up to date, no migration needed") |
| 49 | + return nil |
| 50 | + } |
| 51 | + |
| 52 | + if version.Version > len(migrateData) { |
| 53 | + return fmt.Errorf("PoST metadata version %d is newer than the latest supported version %d", version.Version, len(migrateData)) |
| 54 | + } |
| 55 | + |
| 56 | + logger.Info("determined PoST version", zap.Int("version", version.Version)) |
| 57 | + |
| 58 | + for v := version.Version; v < len(migrateData); v++ { |
| 59 | + if err := migrateData[v](dir, logger); err != nil { |
| 60 | + return fmt.Errorf("failed to migrate metadata from version %d to version %d: %w", v, v+1, err) |
| 61 | + } |
| 62 | + |
| 63 | + logger.Info("migrated PoST successfully to version", zap.Int("version", v+1)) |
| 64 | + } |
| 65 | + |
| 66 | + logger.Info("PoST migration process finished successfully") |
| 67 | + return nil |
| 68 | +} |
| 69 | + |
| 70 | +type postMetadataV0 struct { |
| 71 | + NodeId []byte |
| 72 | + CommitmentAtxId []byte |
| 73 | + |
| 74 | + LabelsPerUnit uint64 |
| 75 | + NumUnits uint32 |
| 76 | + MaxFileSize uint64 |
| 77 | + Nonce *uint64 `json:",omitempty"` |
| 78 | + NonceValue shared.NonceValue `json:",omitempty"` |
| 79 | + LastPosition *uint64 `json:",omitempty"` |
| 80 | +} |
| 81 | + |
| 82 | +// migrateV0 upgrades PoST from version 0 to version 1. |
| 83 | +// |
| 84 | +// - add version field to postdata_metadata.json (missing in version 0) |
| 85 | +// - add NonceValue field to postdata_metadata.json if missing (was introduced before migrations, not every PoST version 0 metadata file has it) |
| 86 | +// - re-encode NodeId and CommitmentAtxId as hex strings. |
| 87 | +// - add Scrypt field to postdata_metadata.json (missing in version 0), assume default mainnet values. |
| 88 | +func migrateV0(dir string, logger *zap.Logger) (err error) { |
| 89 | + filename := filepath.Join(dir, MetadataFileName) |
| 90 | + file, err := os.Open(filename) |
| 91 | + switch { |
| 92 | + case os.IsNotExist(err): |
| 93 | + return ErrStateMetadataFileMissing |
| 94 | + case err != nil: |
| 95 | + return fmt.Errorf("could not read metadata file: %w", err) |
| 96 | + } |
| 97 | + defer file.Close() |
| 98 | + |
| 99 | + old := postMetadataV0{} |
| 100 | + if err := json.NewDecoder(file).Decode(&old); err != nil { |
| 101 | + return fmt.Errorf("failed to determine metadata version: %w", err) |
| 102 | + } |
| 103 | + |
| 104 | + var nodeID shared.NodeID |
| 105 | + if len(old.NodeId) != 32 { |
| 106 | + return fmt.Errorf("invalid node ID length: %d", len(old.NodeId)) |
| 107 | + } |
| 108 | + copy(nodeID[:], old.NodeId) |
| 109 | + |
| 110 | + var commitmentAtxID shared.ATXID |
| 111 | + if len(old.CommitmentAtxId) != 32 { |
| 112 | + return fmt.Errorf("invalid commitment ATX ID length: %d", len(old.CommitmentAtxId)) |
| 113 | + } |
| 114 | + copy(commitmentAtxID[:], old.CommitmentAtxId) |
| 115 | + |
| 116 | + new := shared.PostMetadata{ |
| 117 | + Version: 1, |
| 118 | + |
| 119 | + NodeId: nodeID, |
| 120 | + CommitmentAtxId: commitmentAtxID, |
| 121 | + |
| 122 | + LabelsPerUnit: old.LabelsPerUnit, |
| 123 | + NumUnits: old.NumUnits, |
| 124 | + MaxFileSize: old.MaxFileSize, |
| 125 | + Scrypt: config.DefaultLabelParams(), // we don't know the scrypt params, but on mainnet they are the default ones |
| 126 | + |
| 127 | + Nonce: old.Nonce, |
| 128 | + NonceValue: old.NonceValue, |
| 129 | + LastPosition: old.LastPosition, |
| 130 | + } |
| 131 | + |
| 132 | + if new.Nonce != nil && new.NonceValue == nil { |
| 133 | + // there is a nonce in the metadata but no nonce value |
| 134 | + commitment := oracle.CommitmentBytes(new.NodeId[:], new.CommitmentAtxId[:]) |
| 135 | + cpuProviderID := CPUProviderID() |
| 136 | + |
| 137 | + wo, err := oracle.New( |
| 138 | + oracle.WithProviderID(&cpuProviderID), |
| 139 | + oracle.WithCommitment(commitment), |
| 140 | + oracle.WithVRFDifficulty(make([]byte, 32)), // we are not looking for it, so set difficulty to 0 |
| 141 | + oracle.WithScryptParams(new.Scrypt), |
| 142 | + oracle.WithLogger(logger), |
| 143 | + ) |
| 144 | + if err != nil { |
| 145 | + return fmt.Errorf("failed to create oracle: %w", err) |
| 146 | + } |
| 147 | + |
| 148 | + result, err := wo.Position(*new.Nonce) |
| 149 | + if err != nil { |
| 150 | + return fmt.Errorf("failed to compute nonce value: %w", err) |
| 151 | + } |
| 152 | + copy(new.NonceValue, result.Output) |
| 153 | + } |
| 154 | + |
| 155 | + tmp, err := os.Create(fmt.Sprintf("%s.tmp", filename)) |
| 156 | + if err != nil { |
| 157 | + return fmt.Errorf("create temporary file %s: %w", tmp.Name(), err) |
| 158 | + } |
| 159 | + defer tmp.Close() |
| 160 | + |
| 161 | + if err := json.NewEncoder(tmp).Encode(new); err != nil { |
| 162 | + return fmt.Errorf("failed to encode metadata during migration: %w", err) |
| 163 | + } |
| 164 | + |
| 165 | + if err := tmp.Close(); err != nil { |
| 166 | + return fmt.Errorf("failed to close tmp file %s: %w", tmp.Name(), err) |
| 167 | + } |
| 168 | + |
| 169 | + if err := atomic.ReplaceFile(tmp.Name(), filename); err != nil { |
| 170 | + return fmt.Errorf("save file from %s, %s: %w", tmp.Name(), filename, err) |
| 171 | + } |
| 172 | + |
| 173 | + return nil |
| 174 | +} |
0 commit comments