Skip to content

Commit

Permalink
Renamed methods to follow Get convention
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrz1836
mrz1836 committed Oct 6, 2020
1 parent 8046f05 commit 7e33d7c
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 47 deletions.
20 changes: 10 additions & 10 deletions address.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,21 +89,21 @@ func ValidA58(a58 []byte) (bool, error) {
return a.EmbeddedChecksum() == a.ComputeChecksum(), nil
}

// AddressFromPrivateKey takes a private key string and returns a Bitcoin address
func AddressFromPrivateKey(privateKey string) (string, error) {
// GetAddressFromPrivateKey takes a private key string and returns a Bitcoin address
func GetAddressFromPrivateKey(privateKey string) (string, error) {
rawKey, err := PrivateKeyFromString(privateKey)
if err != nil {
return "", err
}
var address *bsvutil.LegacyAddressPubKeyHash
if address, err = AddressFromPubKey(rawKey.PubKey()); err != nil {
if address, err = GetAddressFromPubKey(rawKey.PubKey()); err != nil {
return "", err
}
return address.EncodeAddress(), nil
}

// AddressFromPubKey gets a bsvutil.LegacyAddressPubKeyHash from a bsvec.PublicKey
func AddressFromPubKey(publicKey *bsvec.PublicKey) (*bsvutil.LegacyAddressPubKeyHash, error) {
// GetAddressFromPubKey gets a bsvutil.LegacyAddressPubKeyHash from a bsvec.PublicKey
func GetAddressFromPubKey(publicKey *bsvec.PublicKey) (*bsvutil.LegacyAddressPubKeyHash, error) {
if publicKey == nil {
return nil, fmt.Errorf("publicKey cannot be nil")
} else if publicKey.X == nil {
Expand All @@ -112,17 +112,17 @@ func AddressFromPubKey(publicKey *bsvec.PublicKey) (*bsvutil.LegacyAddressPubKey
return bsvutil.NewLegacyAddressPubKeyHash(bsvutil.Hash160(publicKey.SerializeCompressed()), &chaincfg.MainNetParams)
}

// AddressFromPubKeyString is a convenience function to use a hex string pubKey
func AddressFromPubKeyString(pubKey string) (*bsvutil.LegacyAddressPubKeyHash, error) {
// GetAddressFromPubKeyString is a convenience function to use a hex string pubKey
func GetAddressFromPubKeyString(pubKey string) (*bsvutil.LegacyAddressPubKeyHash, error) {
rawPubKey, err := PubKeyFromString(pubKey)
if err != nil {
return nil, err
}
return AddressFromPubKey(rawPubKey)
return GetAddressFromPubKey(rawPubKey)
}

// AddressFromScript will take an output script and extract a standard bitcoin address
func AddressFromScript(script string) (string, error) {
// GetAddressFromScript will take an output script and extract a standard bitcoin address
func GetAddressFromScript(script string) (string, error) {

// No script?
if len(script) == 0 {
Expand Down
72 changes: 36 additions & 36 deletions address_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ func BenchmarkValidA58(b *testing.B) {
}
}

// TestAddressFromPrivateKey will test the method AddressFromPrivateKey()
func TestAddressFromPrivateKey(t *testing.T) {
// TestGetAddressFromPrivateKey will test the method GetAddressFromPrivateKey()
func TestGetAddressFromPrivateKey(t *testing.T) {
t.Parallel()

// Create the list of tests
Expand All @@ -86,7 +86,7 @@ func TestAddressFromPrivateKey(t *testing.T) {

// Run tests
for _, test := range tests {
if address, err := AddressFromPrivateKey(test.input); err != nil && !test.expectedError {
if address, err := GetAddressFromPrivateKey(test.input); err != nil && !test.expectedError {
t.Errorf("%s Failed: [%s] inputted and error not expected but got: %s", t.Name(), test.input, err.Error())
} else if err == nil && test.expectedError {
t.Errorf("%s Failed: [%s] inputted and error was expected", t.Name(), test.input)
Expand All @@ -96,9 +96,9 @@ func TestAddressFromPrivateKey(t *testing.T) {
}
}

// ExampleAddressFromPrivateKey example using AddressFromPrivateKey()
func ExampleAddressFromPrivateKey() {
address, err := AddressFromPrivateKey("54035dd4c7dda99ac473905a3d82f7864322b49bab1ff441cc457183b9bd8abd")
// ExampleGetAddressFromPrivateKey example using GetAddressFromPrivateKey()
func ExampleGetAddressFromPrivateKey() {
address, err := GetAddressFromPrivateKey("54035dd4c7dda99ac473905a3d82f7864322b49bab1ff441cc457183b9bd8abd")
if err != nil {
fmt.Printf("error occurred: %s", err.Error())
return
Expand All @@ -107,11 +107,11 @@ func ExampleAddressFromPrivateKey() {
// Output:address found: 1DfGxKmgL3ETwUdNnXLBueEvNpjcDGcKgK
}

// BenchmarkAddressFromPrivateKey benchmarks the method AddressFromPrivateKey()
func BenchmarkAddressFromPrivateKey(b *testing.B) {
// BenchmarkGetAddressFromPrivateKey benchmarks the method GetAddressFromPrivateKey()
func BenchmarkGetAddressFromPrivateKey(b *testing.B) {
key, _ := CreatePrivateKeyString()
for i := 0; i < b.N; i++ {
_, _ = AddressFromPrivateKey(key)
_, _ = GetAddressFromPrivateKey(key)
}
}

Expand All @@ -124,8 +124,8 @@ func testGetPublicKeyFromPrivateKey(privateKey string) *bsvec.PublicKey {
return rawKey.PubKey()
}

// TestAddressFromPubKey will test the method AddressFromPubKey()
func TestAddressFromPubKey(t *testing.T) {
// TestGetAddressFromPubKey will test the method GetAddressFromPubKey()
func TestGetAddressFromPubKey(t *testing.T) {
t.Parallel()

// Create the list of tests
Expand All @@ -145,7 +145,7 @@ func TestAddressFromPubKey(t *testing.T) {

// Run tests
for _, test := range tests {
if rawKey, err := AddressFromPubKey(test.input); err != nil && !test.expectedError {
if rawKey, err := GetAddressFromPubKey(test.input); err != nil && !test.expectedError {
t.Errorf("%s Failed: [%v] inputted and error not expected but got: %s", t.Name(), test.input, err.Error())
} else if err == nil && test.expectedError {
t.Errorf("%s Failed: [%v] inputted and error was expected", t.Name(), test.input)
Expand All @@ -159,9 +159,9 @@ func TestAddressFromPubKey(t *testing.T) {
}
}

// ExampleAddressFromPubKey example using AddressFromPubKey()
func ExampleAddressFromPubKey() {
rawAddress, err := AddressFromPubKey(testGetPublicKeyFromPrivateKey("54035dd4c7dda99ac473905a3d82f7864322b49bab1ff441cc457183b9bd8abd"))
// ExampleGetAddressFromPubKey example using GetAddressFromPubKey()
func ExampleGetAddressFromPubKey() {
rawAddress, err := GetAddressFromPubKey(testGetPublicKeyFromPrivateKey("54035dd4c7dda99ac473905a3d82f7864322b49bab1ff441cc457183b9bd8abd"))
if err != nil {
fmt.Printf("error occurred: %s", err.Error())
return
Expand All @@ -170,16 +170,16 @@ func ExampleAddressFromPubKey() {
// Output:address found: 1DfGxKmgL3ETwUdNnXLBueEvNpjcDGcKgK
}

// BenchmarkAddressFromPubKey benchmarks the method AddressFromPubKey()
func BenchmarkAddressFromPubKey(b *testing.B) {
// BenchmarkGetAddressFromPubKey benchmarks the method GetAddressFromPubKey()
func BenchmarkGetAddressFromPubKey(b *testing.B) {
pubKey := testGetPublicKeyFromPrivateKey("54035dd4c7dda99ac473905a3d82f7864322b49bab1ff441cc457183b9bd8abd")
for i := 0; i < b.N; i++ {
_, _ = AddressFromPubKey(pubKey)
_, _ = GetAddressFromPubKey(pubKey)
}
}

// TestAddressFromScript will test the method AddressFromScript()
func TestAddressFromScript(t *testing.T) {
// TestGetAddressFromScript will test the method GetAddressFromScript()
func TestGetAddressFromScript(t *testing.T) {
t.Parallel()

// Create the list of tests
Expand All @@ -203,7 +203,7 @@ func TestAddressFromScript(t *testing.T) {

// Run tests
for _, test := range tests {
if address, err := AddressFromScript(test.inputScript); err != nil && !test.expectedError {
if address, err := GetAddressFromScript(test.inputScript); err != nil && !test.expectedError {
t.Errorf("%s Failed: [%v] inputted and error not expected but got: %s", t.Name(), test.inputScript, err.Error())
} else if err == nil && test.expectedError {
t.Errorf("%s Failed: [%v] inputted and error was expected", t.Name(), test.inputScript)
Expand All @@ -213,9 +213,9 @@ func TestAddressFromScript(t *testing.T) {
}
}

// ExampleAddressFromScript example using AddressFromScript()
func ExampleAddressFromScript() {
address, err := AddressFromScript("76a914b424110292f4ea2ac92beb9e83cf5e6f0fa2996388ac")
// ExampleGetAddressFromScript example using GetAddressFromScript()
func ExampleGetAddressFromScript() {
address, err := GetAddressFromScript("76a914b424110292f4ea2ac92beb9e83cf5e6f0fa2996388ac")
if err != nil {
fmt.Printf("error occurred: %s", err.Error())
return
Expand All @@ -224,15 +224,15 @@ func ExampleAddressFromScript() {
// Output:address found: 1HRVqUGDzpZSMVuNSZxJVaB9xjneEShfA7
}

// BenchmarkAddressFromScript benchmarks the method AddressFromScript()
func BenchmarkAddressFromScript(b *testing.B) {
// BenchmarkAddressFromScript benchmarks the method GetAddressFromScript()
func BenchmarkGetAddressFromScript(b *testing.B) {
for i := 0; i < b.N; i++ {
_, _ = AddressFromScript("76a914b424110292f4ea2ac92beb9e83cf5e6f0fa2996388ac")
_, _ = GetAddressFromScript("76a914b424110292f4ea2ac92beb9e83cf5e6f0fa2996388ac")
}
}

// TestAddressFromPubKeyString will test the method AddressFromPubKeyString()
func TestAddressFromPubKeyString(t *testing.T) {
// TestGetAddressFromPubKeyString will test the method GetAddressFromPubKeyString()
func TestGetAddressFromPubKeyString(t *testing.T) {
t.Parallel()

// Create the list of tests
Expand All @@ -250,7 +250,7 @@ func TestAddressFromPubKeyString(t *testing.T) {

// Run tests
for _, test := range tests {
if rawKey, err := AddressFromPubKeyString(test.input); err != nil && !test.expectedError {
if rawKey, err := GetAddressFromPubKeyString(test.input); err != nil && !test.expectedError {
t.Errorf("%s Failed: [%v] inputted and error not expected but got: %s", t.Name(), test.input, err.Error())
} else if err == nil && test.expectedError {
t.Errorf("%s Failed: [%v] inputted and error was expected", t.Name(), test.input)
Expand All @@ -264,9 +264,9 @@ func TestAddressFromPubKeyString(t *testing.T) {
}
}

// ExampleAddressFromPubKeyString example using AddressFromPubKeyString()
func ExampleAddressFromPubKeyString() {
rawAddress, err := AddressFromPubKeyString("03ce8a73eb5e4d45966d719ac3ceb431cd0ee203e6395357a167b9abebc4baeacf")
// ExampleGetAddressFromPubKeyString example using GetAddressFromPubKeyString()
func ExampleGetAddressFromPubKeyString() {
rawAddress, err := GetAddressFromPubKeyString("03ce8a73eb5e4d45966d719ac3ceb431cd0ee203e6395357a167b9abebc4baeacf")
if err != nil {
fmt.Printf("error occurred: %s", err.Error())
return
Expand All @@ -275,9 +275,9 @@ func ExampleAddressFromPubKeyString() {
// Output:address found: 17HeHWVDqDqexLJ31aG4qtVMoX8pKMGSuJ
}

// BenchmarkAddressFromPubKeyString benchmarks the method AddressFromPubKeyString()
func BenchmarkAddressFromPubKeyString(b *testing.B) {
// BenchmarkGetAddressFromPubKeyString benchmarks the method GetAddressFromPubKeyString()
func BenchmarkGetAddressFromPubKeyString(b *testing.B) {
for i := 0; i < b.N; i++ {
_, _ = AddressFromPubKeyString("03ce8a73eb5e4d45966d719ac3ceb431cd0ee203e6395357a167b9abebc4baeacf")
_, _ = GetAddressFromPubKeyString("03ce8a73eb5e4d45966d719ac3ceb431cd0ee203e6395357a167b9abebc4baeacf")
}
}
2 changes: 1 addition & 1 deletion examples/verify_signature/verify_signature.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ func main() {
message := "This is the example message"

// Get an address from private key
address, err := bitcoin.AddressFromPrivateKey(privateKey)
address, err := bitcoin.GetAddressFromPrivateKey(privateKey)
if err != nil {
log.Fatalf("error occurred: %s", err.Error())
}
Expand Down

0 comments on commit 7e33d7c

Please sign in to comment.