HV-1973 - Bitcoin address validator #1343

jyoshiriro · 2024-04-13T03:00:24Z

Bitcoin address validator.

More translations are still missing. Only english and portuguese have been provided so far.

See https://hibernate.atlassian.net/browse/HV-1973.

marko-bekhta

Hey,

thanks for submitting the pull request with the new constraint. This looks interesting.
I've added some suggestions inline. Please also take a look at this post https://in.relation.to/2018/01/04/adding-new-constraint-to-engine/ to see about the additional parts that should be added for a constraint.

engine/src/main/java/org/hibernate/validator/constraints/BitcoinAddress.java

marko-bekhta · 2024-04-15T12:57:23Z

engine/src/main/java/org/hibernate/validator/constraints/BitcoinAddressType.java

+ */
+package org.hibernate.validator.constraints;
+
+public enum BitcoinAddressType {


I'd suggest moving this enum into constraint itself, see how it is done for ISBN:

hibernate-validator/engine/src/main/java/org/hibernate/validator/constraints/ISBN.java

Lines 74 to 77 in 729cd01

enum Type {

ISBN_10,

ISBN_13,

ANY

I did almost that... When you have a chance to take a look please :)

marko-bekhta · 2024-04-15T12:58:20Z

engine/src/main/java/org/hibernate/validator/constraints/BitcoinAddressType.java

+	ANY("Bitcoin", null),
+	P2PKH("Legacy (P2PKH)", "^(1)[a-zA-HJ-NP-Z0-9]{25,61}$"),
+	P2SH("Nested SegWit (P2SH)", "^(3)[a-zA-HJ-NP-Z0-9]{33}$"),
+	BECH32("Native SegWit (Bech32)", "^(bc1)[a-zA-HJ-NP-Z0-9]{39,59}$"),
+	P2WSH("SegWit variant of P2SH (P2WSH)", "^(bc1q)[a-zA-HJ-NP-Z0-9]{58}$"),
+	P2WPKH("SegWit variant of P2PKH (P2WPKH)", "^(bc1q)[a-zA-HJ-NP-Z0-9]{38}$"),
+	P2TR("Taproot (P2TR)", "^(bc1p)[a-zA-HJ-NP-Z0-9]{58}$");
+
+	private final String description;
+	private final String regex;
+
+	BitcoinAddressType(String description, String regex) {
+		this.description = description;
+		this.regex = regex;
+	}
+
+	public String getDescription() {
+		return description;
+	}
+
+	public String getRegex() {
+		return regex;
+	}
+
+	@Override
+	public String toString() {
+		return this.description;
+	}


and move all the implementation details into the ConstraintValidator implementation itself.

I did almost that... When you have a chance to take a look please :)

marko-bekhta · 2024-04-15T13:04:07Z

...n/java/org/hibernate/validator/internal/constraintvalidators/bv/BitcoinAddressValidator.java

+		}
+
+		for ( BitcoinAddressType type : this.addressType ) {
+			Pattern pattern = Pattern.compile( type.getRegex() );


Let's have the patterns pre-compiled.

Done! When you have a chance to take a look please :)

marko-bekhta · 2024-04-15T13:22:10Z

...n/java/org/hibernate/validator/internal/constraintvalidators/bv/BitcoinAddressValidator.java

+		BitcoinAddressType[] types = bitcoinAddress.value();
+
+		this.singleType = ( types.length == 1 );
+
+		if ( Arrays.stream( types ).anyMatch( type -> type == BitcoinAddressType.ANY ) ) {
+			this.typesDescription = BitcoinAddressType.ANY.getDescription();
+			this.addressType.addAll(
+				Arrays.stream( BitcoinAddressType.values() )
+						.filter( type -> type != BitcoinAddressType.ANY )
+						.collect( Collectors.toList() ) );
+			return;
+		}
+
+		Collections.addAll( this.addressType, types );
+		this.typesDescription = this.addressType.stream()
+								.map( BitcoinAddressType::getDescription )
+								.collect( Collectors.joining( "; " ) );


once the impl details are moved out of the enum here you could still keep them in the enum and maybe also have this prebuilt? e.g.:

public enum BitcoinAddressConstraint { P2PKH("Legacy (P2PKH)", "^(1)[a-zA-HJ-NP-Z0-9]{25,61}$"), P2SH("Nested SegWit (P2SH)", "^(3)[a-zA-HJ-NP-Z0-9]{33}$"), BECH32("Native SegWit (Bech32)", "^(bc1)[a-zA-HJ-NP-Z0-9]{39,59}$"), P2WSH("SegWit variant of P2SH (P2WSH)", "^(bc1q)[a-zA-HJ-NP-Z0-9]{58}$"), P2WPKH("SegWit variant of P2PKH (P2WPKH)", "^(bc1q)[a-zA-HJ-NP-Z0-9]{38}$"), P2TR("Taproot (P2TR)", "^(bc1p)[a-zA-HJ-NP-Z0-9]{58}$"); BitcoinAddressConstraint(String description, String pattern) { this.pattern = Pattern.compile( pattern ); } private static final EnumMap<BitcoinAddress.Type, Collection<BitcoinAddressConstraint>> constraints; static { constraints = new EnumMap<>( BitcoinAddress.Type.class ); constraints.put( BitcoinAddress.Type.ANY, Arrays.asList( BitcoinAddressConstraint.values() ) ); constraints.put( BitcoinAddress.Type.P2PKH, Collections.singleton( P2PKH ) ); constraints.put( BitcoinAddress.Type.P2SH, Collections.singleton( P2SH ) ); constraints.put( BitcoinAddress.Type.BECH32, Collections.singleton( BECH32 ) ); constraints.put( BitcoinAddress.Type.P2WSH, Collections.singleton( P2WSH ) ); constraints.put( BitcoinAddress.Type.P2WPKH, Collections.singleton( P2WPKH ) ); constraints.put( BitcoinAddress.Type.P2TR, Collections.singleton( P2TR ) ); } ... }

and then in the initialize:

public void initialize(BitcoinAddress bitcoinAddress) { Set<BitcoinAddressConstraint> constraints = new HashSet<>(); for ( BitcoinAddress.Type type : bitcoinAddress.value() ) { constraints.addAll( BitcoinAddressConstraint.constraints.get( type ) ); } this.singleType = constraints.size() == 1; }

I did almost that... When you have a chance to take a look please :)

marko-bekhta · 2024-04-15T13:25:39Z

engine/src/main/java/org/hibernate/validator/constraints/BitcoinAddressType.java

+	P2PKH("Legacy (P2PKH)", "^(1)[a-zA-HJ-NP-Z0-9]{25,61}$"),
+	P2SH("Nested SegWit (P2SH)", "^(3)[a-zA-HJ-NP-Z0-9]{33}$"),
+	BECH32("Native SegWit (Bech32)", "^(bc1)[a-zA-HJ-NP-Z0-9]{39,59}$"),
+	P2WSH("SegWit variant of P2SH (P2WSH)", "^(bc1q)[a-zA-HJ-NP-Z0-9]{58}$"),
+	P2WPKH("SegWit variant of P2PKH (P2WPKH)", "^(bc1q)[a-zA-HJ-NP-Z0-9]{38}$"),
+	P2TR("Taproot (P2TR)", "^(bc1p)[a-zA-HJ-NP-Z0-9]{58}$");


BTW I see that this description is used in the validation message. But as they use regular words they may need to be translated as well... So I'd suggest exploring an option of placing the description in the translation file as well and then let EL do the string interpolation.

Done. When you have a chance to take a look please :)

Co-authored-by: Marko Bekhta <marko-bekhta@users.noreply.github.com>

hibernate-github-bot · 2024-04-15T14:38:00Z

Thanks for your pull request!

This pull request does not follow the contribution rules. Could you have a look?

❌ All commit messages should start with a JIRA issue key matching pattern HV-\d+
↳ Offending commits: [404f529]

› This message was automatically generated.

jyoshiriro · 2024-04-15T22:35:37Z

Hey,

thanks for submitting the pull request with the new constraint. This looks interesting. I've added some suggestions inline. Please also take a look at this post https://in.relation.to/2018/01/04/adding-new-constraint-to-engine/ to see about the additional parts that should be added for a constraint.

I believe I fixed everything that was missing :)

jyoshiriro added 3 commits April 12, 2024 23:23

HV-1973 - Bitcoin address validator (alpha version)

909723f

HV-1973 - Bitcoin address validator (alpha version)

73411f4

HV-1973 - Unit tests for invalid scenarios

0a4993b

marko-bekhta reviewed Apr 15, 2024

View reviewed changes

message() fixed

404f529

Co-authored-by: Marko Bekhta <marko-bekhta@users.noreply.github.com>

jyoshiriro added 15 commits April 15, 2024 17:16

HV-1973 - Validation file for BitcoinAddressValidator

e7d6234

HV-1973 - 'validatedBy' clean and main javadoc improved

59bc4ee

HV-1973 - BitcoinAddressType refactored - pre-compiled pattern

329599a

HV-1973 - BitcoinAddressValidator refactored

83783db

HV-1973 - Validation messages fixed

5ab28ef

HV-1973 - BitcoinValidatorTest refactored

83255e5

HV-1973 - BitcoinAddressValidator added to configuration

7c40599

HV-1973 - toLowerCase() fixed in BitcoinAddressValidator

0339faf

HV-1973 - BitcoinConstrainedTest added

56d84ce

HV-1973 - sintaxe issue fixed

2941e94

HV-1973 - programmatic definition added

47e3708

HV-1973 - Message key refactored

2f2ed7f

HV-1973 - tests refactored

df28c8d

HV-1973 - annotation processor support added

07f362d

HV-1973 - annotation processor support added

4c24a61

jyoshiriro added 4 commits April 15, 2024 19:45

HV-1973 - import issues fixed

f461881

HV-1973 - import issues fixed

50a2175

HV-1973 - @ISBN -> @bitcoinaddress

cac4ef0

HV-1973 - @ISBN -> @bitcoinaddress

73844e6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HV-1973 - Bitcoin address validator #1343

HV-1973 - Bitcoin address validator #1343

jyoshiriro commented Apr 13, 2024

marko-bekhta left a comment

marko-bekhta Apr 15, 2024

jyoshiriro Apr 15, 2024

marko-bekhta Apr 15, 2024

jyoshiriro Apr 15, 2024

marko-bekhta Apr 15, 2024

jyoshiriro Apr 15, 2024

marko-bekhta Apr 15, 2024

jyoshiriro Apr 15, 2024

marko-bekhta Apr 15, 2024

jyoshiriro Apr 15, 2024

hibernate-github-bot bot commented Apr 15, 2024 •

edited

jyoshiriro commented Apr 15, 2024

HV-1973 - Bitcoin address validator #1343

Are you sure you want to change the base?

HV-1973 - Bitcoin address validator #1343

Conversation

jyoshiriro commented Apr 13, 2024

marko-bekhta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hibernate-github-bot bot commented Apr 15, 2024 • edited

jyoshiriro commented Apr 15, 2024

hibernate-github-bot bot commented Apr 15, 2024 •

edited