support more flexible manipulation of participation keys #96
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| // Copyright (C) 2019 Algorand, Inc. | ||
| // This file is part of go-algorand | ||
| // | ||
| // go-algorand is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as | ||
| // published by the Free Software Foundation, either version 3 of the | ||
| // License, or (at your option) any later version. | ||
| // | ||
| // go-algorand is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with go-algorand. If not, see <https://www.gnu.org/licenses/>. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "encoding/base64" | ||
| "fmt" | ||
| "math" | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/algorand/go-algorand/data/account" | ||
| "github.com/algorand/go-algorand/data/basics" | ||
| "github.com/algorand/go-algorand/util/db" | ||
| ) | ||
|
|
||
| var partKeyfile string | ||
| var partFirstRound uint64 | ||
| var partLastRound uint64 | ||
| var partKeyDilution uint64 | ||
| var partParent string | ||
|
|
||
| var partCmd = &cobra.Command{ | ||
| Use: "part", | ||
| Short: "Manage participation keys", | ||
| Args: cobra.NoArgs, | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| // If no arguments passed, we should fallback to help | ||
| cmd.HelpFunc()(cmd, args) | ||
| }, | ||
| } | ||
|
|
||
| var partGenerateCmd = &cobra.Command{ | ||
| Use: "generate", | ||
| Short: "Generate participation key", | ||
| Args: cobra.NoArgs, | ||
| Run: func(cmd *cobra.Command, _ []string) { | ||
| if partLastRound < partFirstRound { | ||
| fmt.Fprintf(os.Stderr, "Last round %d < first round %d\n", partLastRound, partFirstRound) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| if partKeyDilution == 0 { | ||
| partKeyDilution = 1 + uint64(math.Sqrt(float64(partLastRound-partFirstRound))) | ||
| } | ||
|
|
||
| var err error | ||
| var parent basics.Address | ||
| if partParent != "" { | ||
| parent, err = basics.UnmarshalChecksumAddress(partParent) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot parse parent address %s: %v\n", partParent, err) | ||
| os.Exit(1) | ||
| } | ||
| } | ||
|
|
||
| partdb, err := db.MakeErasableAccessor(partKeyfile) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot open partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| partkey, err := account.FillDBWithParticipationKeys(partdb, parent, basics.Round(partFirstRound), basics.Round(partLastRound), partKeyDilution) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot generate partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| printPartkey(partkey) | ||
| }, | ||
| } | ||
|
|
||
| var partInfoCmd = &cobra.Command{ | ||
| Use: "info", | ||
| Short: "Print participation key information", | ||
| Args: cobra.NoArgs, | ||
| Run: func(cmd *cobra.Command, _ []string) { | ||
| partdb, err := db.MakeErasableAccessor(partKeyfile) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot open partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| partkey, err := account.RestoreParticipation(partdb) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot load partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| printPartkey(partkey) | ||
| }, | ||
| } | ||
|
|
||
| var partReparentCmd = &cobra.Command{ | ||
| Use: "reparent", | ||
| Short: "Change parent address of participation key", | ||
| Args: cobra.NoArgs, | ||
| Run: func(cmd *cobra.Command, _ []string) { | ||
| parent, err := basics.UnmarshalChecksumAddress(partParent) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot parse parent address %s: %v\n", partParent, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| partdb, err := db.MakeErasableAccessor(partKeyfile) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot open partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| partkey, err := account.RestoreParticipation(partdb) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot load partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| partkey.Parent = parent | ||
| err = partkey.PersistNewParent() | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "Cannot persist partkey database %s: %v\n", partKeyfile, err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| printPartkey(partkey) | ||
| }, | ||
| } | ||
|
|
||
| func printPartkey(partkey account.Participation) { | ||
| fmt.Printf("Parent address: %s\n", partkey.Parent.GetChecksumAddress().String()) | ||
| fmt.Printf("VRF public key: %s\n", base64.StdEncoding.EncodeToString(partkey.VRF.PK[:])) | ||
| fmt.Printf("Voting public key: %s\n", base64.StdEncoding.EncodeToString(partkey.Voting.OneTimeSignatureVerifier[:])) | ||
| fmt.Printf("First round: %d\n", partkey.FirstValid) | ||
| fmt.Printf("Last round: %d\n", partkey.LastValid) | ||
| fmt.Printf("Key dilution: %d\n", partkey.KeyDilution) | ||
| fmt.Printf("First batch: %d\n", partkey.Voting.FirstBatch) | ||
| fmt.Printf("First offset: %d\n", partkey.Voting.FirstOffset) | ||
| } | ||
|
|
||
| func init() { | ||
| partCmd.AddCommand(partGenerateCmd) | ||
| partCmd.AddCommand(partInfoCmd) | ||
| partCmd.AddCommand(partReparentCmd) | ||
|
|
||
| partGenerateCmd.Flags().StringVarP(&partKeyfile, "keyfile", "", "", "Participation key filename") | ||
| partGenerateCmd.Flags().Uint64VarP(&partFirstRound, "first", "", 0, "First round for participation key") | ||
| partGenerateCmd.Flags().Uint64VarP(&partLastRound, "last", "", 0, "Last round for participation key") | ||
| partGenerateCmd.Flags().Uint64VarP(&partKeyDilution, "dilution", "", 0, "Key dilution (default to sqrt of validity window)") | ||
| partGenerateCmd.Flags().StringVarP(&partParent, "parent", "", "", "Address of parent account") | ||
| partGenerateCmd.MarkFlagRequired("first") | ||
| partGenerateCmd.MarkFlagRequired("last") | ||
| partGenerateCmd.MarkFlagRequired("keyfile") | ||
|
|
||
| partInfoCmd.Flags().StringVarP(&partKeyfile, "keyfile", "", "", "Participation key filename") | ||
| partInfoCmd.MarkFlagRequired("keyfile") | ||
|
|
||
| partReparentCmd.Flags().StringVarP(&partKeyfile, "keyfile", "", "", "Participation key filename") | ||
| partReparentCmd.Flags().StringVarP(&partParent, "parent", "", "", "Address of parent account") | ||
| partReparentCmd.MarkFlagRequired("keyfile") | ||
| partReparentCmd.MarkFlagRequired("parent") | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than breaking the assignment and persistence, can we change PersistNewParent() to ReplaceParent(parent)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was going for that originally, but for historical reasons, all current methods on
account.Participationare by value rather than by pointer. So,ReplaceParent()would not have any apparent effect on the caller's partkey object (in particular, the subsequentprintPartkey()would print the old parent), even though it could write the new parent to the partkey db.. Modifying the parent in-place seemed cleaner than having a mix of by-value and by-pointer methods onaccount.Participation, and changing all of them to by-pointer seemed unnecessarily involved.