feat: add simple address validity check #1303

leohhhn · 2023-10-26T16:14:56Z

Description

This PR adds a simple Valid() check to the Address type. It is there to prevent most human errors, and doesn't actually validate the math behind bech32 (for now) - it relies only on the length of the address.

Running gno test . will run the unit test for the Valid() function.
Closes: #1298

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

codecov · 2023-10-26T16:26:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7105d00) 47.93% compared to head (1fb7ab6) 47.89%.
Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1303      +/-   ##
==========================================
- Coverage   47.93%   47.89%   -0.05%     
==========================================
  Files         372      372              
  Lines       62990    62990              
==========================================
- Hits        30192    30166      -26     
- Misses      30341    30360      +19     
- Partials     2457     2464       +7

see 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

harry-hov

LGTM 💯

I just wonder if we can get rid of these in the same PR:

gno/examples/gno.land/p/demo/grc/grc20/util.gno

Lines 7 to 12 in 34d78b3

    
           func checkIsValidAddress(addr std.Address) error { 
        
           	if addr.String() == "" { 
        
           		return ErrInvalidAddress 
        
           	} 
        
           	return nil 
        
           }

gno/examples/gno.land/p/demo/grc/grc721/util.gno

Lines 9 to 14 in 34d78b3

    
           func isValidAddress(addr std.Address) error { 
        
           	if addr.String() == "" { 
        
           		return ErrInvalidAddress 
        
           	} 
        
           	return nil 
        
           }

gno/examples/gno.land/p/demo/grc/grc1155/util.gno

Lines 9 to 14 in 34d78b3

    
           func isValidAddress(addr std.Address) bool { 
        
           	if addr.String() == "" { 
        
           		return false 
        
           	} 
        
           	return true 
        
           }

zivkovicmilos

Looks good 💯

gnovm/stdlibs/std/crypto.gno

thehowl · 2023-10-27T20:00:58Z

go.mod

-	github.com/btcsuite/btcd v0.22.0-beta.0.20220111032746-97732e52810c
+	github.com/btcsuite/btcd v0.22.3
 	github.com/btcsuite/btcd/btcutil v1.0.0
-	github.com/btcsuite/btcutil v1.0.2
+	github.com/btcsuite/btcutil v1.0.3-0.20201208143702-a53e38424cce


Ehh, I'd say upgrading btcd/btcutil is something that should be done in another PR, especially considering #1064

I'd suggest reverting changes here + go.sum

It was accidental, sorry. Will revert them :)

Oops, my mistake. I attempted to fix the previous commit but didn't thoroughly check it.

Edit: nope, was introduced before my commit; I'll fix now.

Signed-off-by: moul <94029+moul@users.noreply.github.com>

## Description This PR adds a simple `Valid()` check to the Address type. It is there to prevent most human errors, and doesn't actually validate the math behind bech32 (for now) - it relies only on the length of the address. Running `gno test .` will run the unit test for the `Valid()` function. Closes: gnolang#1298 <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> --------- Signed-off-by: moul <94029+moul@users.noreply.github.com> Co-authored-by: moul <94029+moul@users.noreply.github.com>

add address validity check

49c1c87

leohhhn requested review from jaekwon, moul and a team as code owners October 26, 2023 16:14

github-actions bot assigned leohhhn Oct 26, 2023

github-actions bot added 🧾 package/realm Tag used for new Realms or Packages. 📦 🤖 gnovm Issues or PRs gnovm related labels Oct 26, 2023

remove unnecessary file

38c4a2d

github-actions bot removed the 🧾 package/realm Tag used for new Realms or Packages. label Oct 26, 2023

refactor

103bdd1

thehowl approved these changes Oct 26, 2023

View reviewed changes

leohhhn requested a review from zivkovicmilos October 26, 2023 17:07

harry-hov approved these changes Oct 26, 2023

View reviewed changes

zivkovicmilos approved these changes Oct 26, 2023

View reviewed changes

gnovm/stdlibs/std/crypto.gno Outdated Show resolved Hide resolved

leohhhn added 2 commits October 26, 2023 13:58

renamed to IsValid

0d5a31b

change spelling, change helpers in grc

3cdd46a

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Oct 26, 2023

leohhhn and others added 3 commits October 26, 2023 15:53

comment update

1ee3dac

added IsValid to stdshim

89901dd

Merge branch 'master' into feat/add-valid-address

fc44e7e

moul approved these changes Oct 27, 2023

View reviewed changes

thehowl reviewed Oct 27, 2023

View reviewed changes

chore: fixup

1fb7ab6

Signed-off-by: moul <94029+moul@users.noreply.github.com>

moul force-pushed the feat/add-valid-address branch from 1fc803d to 1fb7ab6 Compare October 28, 2023 21:19

moul merged commit 199cd29 into gnolang:master Oct 28, 2023
190 checks passed

leohhhn deleted the feat/add-valid-address branch March 20, 2024 09:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add simple address validity check #1303

feat: add simple address validity check #1303

leohhhn commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 26, 2023 •

edited

Loading

harry-hov left a comment

zivkovicmilos left a comment

thehowl Oct 27, 2023

leohhhn Oct 27, 2023

moul Oct 27, 2023 •

edited

Loading

	func checkIsValidAddress(addr std.Address) error {
	if addr.String() == "" {
	return ErrInvalidAddress
	}
	return nil
	}

	func isValidAddress(addr std.Address) error {
	if addr.String() == "" {
	return ErrInvalidAddress
	}
	return nil
	}

	func isValidAddress(addr std.Address) bool {
	if addr.String() == "" {
	return false
	}
	return true
	}

feat: add simple address validity check #1303

feat: add simple address validity check #1303

Conversation

leohhhn commented Oct 26, 2023 • edited Loading

Description

codecov bot commented Oct 26, 2023 • edited Loading

Codecov Report

harry-hov left a comment

Choose a reason for hiding this comment

zivkovicmilos left a comment

Choose a reason for hiding this comment

thehowl Oct 27, 2023

Choose a reason for hiding this comment

leohhhn Oct 27, 2023

Choose a reason for hiding this comment

moul Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

leohhhn commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 26, 2023 •

edited

Loading

moul Oct 27, 2023 •

edited

Loading