-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into add-secp256k1-recovery
- Loading branch information
Showing
10 changed files
with
170 additions
and
45 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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,93 @@ | ||
| package crypto | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/aptos-labs/aptos-go-sdk/internal/util" | ||
| ) | ||
|
|
||
| // PrivateKeyVariant represents the type of private key | ||
| type PrivateKeyVariant string | ||
|
|
||
| const ( | ||
| PrivateKeyVariantEd25519 PrivateKeyVariant = "ed25519" | ||
| PrivateKeyVariantSecp256k1 PrivateKeyVariant = "secp256k1" | ||
| ) | ||
|
|
||
| // AIP80Prefixes contains the AIP-80 compliant prefixes for each private key type | ||
| var AIP80Prefixes = map[PrivateKeyVariant]string{ | ||
| PrivateKeyVariantEd25519: "ed25519-priv-", | ||
| PrivateKeyVariantSecp256k1: "secp256k1-priv-", | ||
| } | ||
|
|
||
| // FormatPrivateKey formats a hex input to an AIP-80 compliant string | ||
| func FormatPrivateKey(privateKey any, keyType PrivateKeyVariant) (formattedString string, err error) { | ||
| aip80Prefix := AIP80Prefixes[keyType] | ||
|
|
||
| var hexStr string | ||
| switch v := privateKey.(type) { | ||
| case string: | ||
| // Remove the prefix if it exists | ||
| if strings.HasPrefix(v, aip80Prefix) { | ||
| parts := strings.Split(v, "-") | ||
| v = parts[2] | ||
| } | ||
|
|
||
| // If it's already a string, just ensure it's properly formatted | ||
| var strBytes, err = util.ParseHex(v) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| // Reformat to have 0x prefix | ||
| hexStr = util.BytesToHex(strBytes) | ||
| case []byte: | ||
| hexStr = util.BytesToHex(v) | ||
| default: | ||
| return "", fmt.Errorf("unsupported private key type: must be string or []byte") | ||
| } | ||
|
|
||
| return fmt.Sprintf("%s%s", aip80Prefix, hexStr), nil | ||
| } | ||
|
|
||
| // ParseHexInput parses a hex input that may be bytes, hex string, or an AIP-80 compliant string to bytes. | ||
| // | ||
| // You may optionally pass in a boolean to strictly enforce AIP-80 compliance. | ||
| func ParsePrivateKey(value any, keyType PrivateKeyVariant, strict ...bool) (bytes []byte, err error) { | ||
| aip80Prefix := AIP80Prefixes[keyType] | ||
|
|
||
| // Get the first boolean if it exists, otherwise nil | ||
| var strictness *bool = nil | ||
| if len(strict) > 1 { | ||
| return nil, fmt.Errorf("strictness must be a single boolean") | ||
| } else if len(strict) == 1 { | ||
| strictness = &strict[0] | ||
| } | ||
|
|
||
| switch v := value.(type) { | ||
| case string: | ||
| if (strictness == nil || !*strictness) && !strings.HasPrefix(v, aip80Prefix) { | ||
| bytes, err := util.ParseHex(v) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // If strictness is not explicitly false, warn about non-AIP-80 compliance | ||
| if strictness == nil { | ||
| fmt.Printf("[Aptos SDK] It is recommended that private keys are AIP-80 compliant (https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-80.md). You can fix the private key by formatting it with crypto.FormatPrivateKey") | ||
| } | ||
|
|
||
| return bytes, nil | ||
| } else if strings.HasPrefix(v, aip80Prefix) { | ||
| // Parse for AIP-80 compliant String input | ||
| parts := strings.Split(v, "-") | ||
| return util.ParseHex(parts[2]) | ||
| } | ||
| return nil, fmt.Errorf("invalid hex string input while parsing private key. Must be AIP-80 compliant string") | ||
| case []byte: | ||
| return v, nil | ||
| default: | ||
| return nil, fmt.Errorf("unsupported private key type: must be string or []byte") | ||
| } | ||
| } |
This file contains 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 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 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.