Normalize the flag names

Author: bbrtj

Changes

@@ -15,15 +15,16 @@ Revision history for Perl extension Bitcoin::Crypto.
 	- Bitcoin::Crypto::Transaction::Flags:
 		- added new_full method
 		- renamed strict_signatures flag to der_signatures
+		- renamed nulldummy flag to null_dummy
 		- added strict_sigantures method
 		- added signature_pushes_only flag
-		- added minimalif flag
+		- added minimal_if flag
 		- added compressed_pubkeys flag
 		- added strict_encoding flag
 		- added low_s_signatures flag
-		- added minimaldata flag
-		- added nullfail flag
-		- added cleanstack flag
+		- added minimal_data flag
+		- added null_fail flag
+		- added clean_stack flag
 		- added const_script flag
 		- added known_witness flag
 		- added illegal_upgradeable_nops flag

lib/Bitcoin/Crypto/Script/Opcode.pm

@@ -257,7 +257,7 @@ sub _OP_PUSHDATA
 		my ($runner, $bytes) = @_;
 
 		$runner->_invalid_script("push opcode for data is not minimal in $opcode_name")
-			if $runner->flags->minimaldata && !standard_push($opcode_name, $bytes);
+			if $runner->flags->minimal_data && !standard_push($opcode_name, $bytes);
 
 		push @{$runner->stack}, $bytes;
 		$class->_verify_stack($runner);
@@ -315,10 +315,10 @@ sub _OP_IF
 		$runner->_stack_error unless @$stack >= 1;
 		my $value = pop @$stack;
 
-		my $minimalif = $runner->is_tapscript
-			|| ($runner->has_transaction && $runner->transaction->is_segwit && $runner->flags->minimalif);
+		my $minimal_if = $runner->is_tapscript
+			|| ($runner->has_transaction && $runner->transaction->is_segwit && $runner->flags->minimal_if);
 
-		$value = $minimalif ? $runner->to_minimal_bool($value) : $runner->to_bool($value);
+		$value = $minimal_if ? $runner->to_minimal_bool($value) : $runner->to_bool($value);
 		$runner->_invalid_script('OP_IF argument is not minimal') unless defined $value;
 
 		$value = !$value if $inverted;
@@ -1076,7 +1076,7 @@ sub _OP_CHECKSIG
 		my $result = __checksig($runner, $sig, $hashtype, $raw_pubkey, $preimage);
 
 		$runner->_script_error('non-empty signature verification failed')
-			if !$result && $runner->flags->nullfail && $sig ne '';
+			if !$result && $runner->flags->null_fail && $sig ne '';
 
 		push @$stack, $runner->from_bool($result);
 	};
@@ -1127,7 +1127,7 @@ sub _OP_CHECKMULTISIG
 		$runner->_stack_error unless @$stack >= 1;
 		my $unused = pop @$stack;
 		$runner->_script_error('OP_CHECKMULTISIG dummy argument must be empty')
-			if $runner->flags->nulldummy && length $unused;
+			if $runner->flags->null_dummy && length $unused;
 
 		my $found = !!1;
 		my %digests;
@@ -1152,7 +1152,7 @@ sub _OP_CHECKMULTISIG
 		# last one was found correctly
 		my $result = $found && !@signatures_left;
 		$runner->_script_error('non-empty signature verification failed')
-			if !$result && $runner->flags->nullfail && notall { $_ eq '' } @signatures;
+			if !$result && $runner->flags->null_fail && notall { $_ eq '' } @signatures;
 
 		push @$stack, $runner->from_bool($result);
 	};

lib/Bitcoin/Crypto/Script/Runner.pm

@@ -130,7 +130,7 @@ sub to_int
 	}
 
 	die_no_trace 'number is not minimally encoded'
-		if ref $self && $self->flags->minimaldata && $bytes ne $self->from_int($value);
+		if ref $self && $self->flags->minimal_data && $bytes ne $self->from_int($value);
 
 	return $value;
 }
@@ -410,12 +410,12 @@ sub success
 	return !!0 if !$stack->[-1];
 	return !!0 if !$self->to_bool($stack->[-1]);
 
-	# NOTE: cleanstack rule does not check altstack, because altstack can only
+	# NOTE: clean_stack rule does not check altstack, because altstack can only
 	# be manipulated by the script itself, so there is no chance for witness
 	# malleability
 	if (@$stack > 1) {
 		my $segwit = $self->has_transaction && $self->transaction->is_native_segwit;
-		return !!0 if $segwit || $self->is_tapscript || $self->flags->cleanstack;
+		return !!0 if $segwit || $self->is_tapscript || $self->flags->clean_stack;
 	}
 
 	return !!1;
@@ -666,7 +666,7 @@ machines.
 =head3 from_bool
 
 These methods encode and decode booleans in format which is used on L</stack>.
-C<to_minimal_bool> variant is used to enforce MINIMALIF rule.
+C<to_minimal_bool> variant is used to enforce L<Bitcoin::Crypto::Transaction::Flags/minimal_if>.
 
 =head3 stack_serialized
 

lib/Bitcoin/Crypto/Transaction/Flags.pm

@@ -12,12 +12,6 @@ has param 'p2sh' => (
 	writer => 1,
 );
 
-has param 'signature_pushes_only' => (
-	coerce => Bool,
-	default => 1,
-	writer => 1,
-);
-
 # BIP65
 has param 'checklocktimeverify' => (
 	coerce => Bool,
@@ -47,7 +41,7 @@ has param 'segwit' => (
 );
 
 # BIP147
-has param 'nulldummy' => (
+has param 'null_dummy' => (
 	coerce => Bool,
 	default => 1,
 	writer => 1,
@@ -62,8 +56,14 @@ has param 'taproot' => (
 
 # optional standardness rules below
 
+has param 'signature_pushes_only' => (
+	coerce => Bool,
+	default => 0,
+	writer => 1,
+);
+
 # segwit only
-has param 'minimalif' => (
+has param 'minimal_if' => (
 	coerce => Bool,
 	default => 0,
 	writer => 1,
@@ -88,19 +88,19 @@ has param 'low_s_signatures' => (
 	writer => 1,
 );
 
-has param 'minimaldata' => (
+has param 'minimal_data' => (
 	coerce => Bool,
 	default => 0,
 	writer => 1,
 );
 
-has param 'nullfail' => (
+has param 'null_fail' => (
 	coerce => Bool,
 	default => 0,
 	writer => 1,
 );
 
-has param 'cleanstack' => (
+has param 'clean_stack' => (
 	coerce => Bool,
 	default => 0,
 	writer => 1,
@@ -130,12 +130,11 @@ sub new_empty
 
 	return $self->new(
 		p2sh => !!0,
-		signature_pushes_only => !!0,
 		checklocktimeverify => !!0,
 		der_signatures => !!0,
 		checksequenceverify => !!0,
 		segwit => !!0,
-		nulldummy => !!0,
+		null_dummy => !!0,
 		taproot => !!0,
 		%args,
 	);
@@ -146,13 +145,14 @@ sub new_full
 	my ($self, %args) = @_;
 
 	return $self->new(
-		minimalif => !!1,
+		signature_pushes_only => !!1,
+		minimal_if => !!1,
 		compressed_pubkeys => !!1,
 		strict_encoding => !!1,
 		low_s_signatures => !!1,
-		minimaldata => !!1,
-		nullfail => !!1,
-		cleanstack => !!1,
+		minimal_data => !!1,
+		null_fail => !!1,
+		clean_stack => !!1,
 		const_script => !!1,
 		known_witness => !!1,
 		illegal_upgradeable_nops => !!1,
@@ -185,7 +185,7 @@ Bitcoin::Crypto::Transaction::Flags - Consensus flags
 
 	# disable some flags (those not passed are active)
 	my $some_flags = Bitcoin::Crypto::Transaction::Flags->new(
-		strict_signatures => !!0,
+		der_signatures => !!0,
 	);
 
 	# use flags in transaction verification
@@ -197,85 +197,118 @@ This is a class that represents a set of consensus rules used in transaction
 verification and associated systems. Each attribute of this class represents a
 single rule.
 
-By default, all implemented consensus rules are active. As Bitcoin
-and this module progress, more rules may be added all enabled by default on
-arrival. Since Bitcoin is extended through softforks (implemented in a
+By default, all implemented consensus rules are active, and all implemented
+standardness rules are inactive when calling L</new>. As Bitcoin and this
+module progress, more rules may be added all enabled by default on arrival.
+Since Bitcoin is extended through softforks (implemented in a
 backward-compatible manner), this should rarely pose a problem with
 Bitcoin::Crypto code. If you want to be extra sure, see L</new_empty>.
 
 =head1 INTERFACE
 
-=head2 Attributes
+All the following flags are attributes available in the constructor of the
+object. They have writer methods named C<set_X>.
 
-=head3 p2sh
+=head2 Consensus flags
+
+All consensus flags are active by default.
 
-I<Available in the constructor>.
+=head3 p2sh
 
 Whether P2SH verification defined in
 L<BIP16|https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki> should
 be used.
 
-I<writer:> C<set_p2sh>
-
-=head3 strict_signatures
-
-I<Available in the constructor>.
+=head3 der_signatures
 
 Whether strict DER signature verification defined in
 L<BIP66|https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki> should
 be used.
 
-I<writer:> C<set_strict_signatures>
-
 =head3 checklocktimeverify
 
-I<Available in the constructor>.
-
 Whether C<OP_CHECKLOCKTIMEVERIFY> opcode defined in
 L<BIP65|https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki> should
 be used.
 
-I<writer:> C<set_checklocktimeverify>
-
 =head3 checksequenceverify
 
-I<Available in the constructor>.
-
 Whether C<OP_CHECKSEQUENCEVERIFY> opcode defined in
 L<BIP112|https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki> should
 be used.
 
-I<writer:> C<set_checksequenceverify>
+=head3 null_dummy
 
-=head3 nulldummy
-
-I<Available in the constructor>.
-
-Whether C<OP_CHECKMULTISIG> nulldummy verification defined in
+Whether C<OP_CHECKMULTISIG> null dummy verification defined in
 L<BIP147|https://github.com/bitcoin/bips/blob/master/bip-0147.mediawiki> should
 be used.
 
-I<writer:> C<set_nulldummy>
-
 =head3 segwit
 
-I<Available in the constructor>.
-
 Whether segwit-specific verification defined in
 L<BIP141|https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki> should
 be used.
 
-I<writer:> C<set_segwit>
-
 =head3 taproot
 
-I<Available in the constructor>.
-
 Whether taproot-specific verification defined in
 L<BIP341|https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki> should
 be used.
 
-I<writer:> C<set_taproot>
+=head2 Standardness flags
+
+All standardness flags are inactive by default.
+
+=head3 signature_pushes_only
+
+Disallows non-push opcodes in signature scripts of inputs for legacy non-P2SH
+transactions. Automatically active for P2SH.
+
+=head3 minimal_if
+
+Whether the argument to C<OP_IF> must be minimal (C<OP_1> or C<OP_0>). Only
+applicable to Segregated Witness scripts.
+
+=head3 compressed_pubkeys
+
+Whether public keys used is signature-checking scripts must be compressed. Only
+applicable to Segregated Witness scripts.
+
+=head3 strict_encoding
+
+Disallows non-strictly encoded DER signatures and public keys.
+
+=head3 low_s_signatures
+
+Disallows signatures encoded with low S.
+
+=head3 minimal_data
+
+When active, data pushed by push opcodes must be minimally encoded.
+
+=head3 null_fail
+
+Causes non-taproot signature-checking opcodes to stop script execution on
+failure, unless the signature is empty.
+
+=head3 clean_stack
+
+Requires script stack to have exactly one element at the end of execution to
+consider the execution successful.
+
+=head3 const_script
+
+Causes the script to fail if C<OP_CODESEPARATOR> or a signature is encoded in a
+pre-SegWit script.
+
+=head3 known_witness
+
+Causes the transaction verification to fail if unknown version of Segregated
+Witness program is encountered.
+
+=head3 illegal_upgradeable_nops
+
+Disallows the use of C<OP_NOPX> opcodes (but not C<OP_NOP>).
 
 =head2 Methods
 
@@ -284,7 +317,7 @@ I<writer:> C<set_taproot>
 	$object = $class->new(%args)
 
 This is a standard Moo constructor, which can be used to create the object. It
-takes arguments specified in L</Attributes>.
+takes arguments specified in L</Consensus flags> and L</Standardness flags>.
 
 Returns a class instance.
 
@@ -294,6 +327,20 @@ Returns a class instance.
 
 Same as L</new>, but assumes all flags unspecified in C<%args> are disabled.
 
+=head3 new_full
+
+	$object = $class->new_full(%args)
+
+Same as L</new>, but assumes all flags unspecified in C<%args> are enabled.
+
+=head3 strict_signatures
+
+	$bool = $object->strict_signatures()
+
+Return true if any one of L</strict_encoding>, L</der_signatures> or
+L</low_s_signatures> are enabled. Having either one of these flags in effect is
+the same as having L</der_signatures> enabled.
+
 =head1 SEE ALSO
 
 =over

lib/Bitcoin/Crypto/Transaction/Signer.pm

@@ -225,7 +225,7 @@ sub finalize_multisignature
 		'not on multisignature opcode'
 	) unless $self->_multisigop;
 
-	# add mandatory nulldummy element
+	# add mandatory null dummy element
 	$self->add_bytes('');
 	$self->_step_over_sigop;