Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(drive): remove duplicated withdrawal amount validation #2191

Merged
merged 4 commits into from
Oct 3, 2024
Merged

refactor(drive): remove duplicated withdrawal amount validation #2191

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
178dfa4
chore(drive): remove duplicated withdrawal amount validation
shumkov Oct 1, 2024
31d4b13
refactor: remove unused imports
shumkov Oct 1, 2024
5ed5ea9
test: verify p2sh and p2pkh outputs
shumkov Oct 1, 2024
3624b46
revert: grammar fix
shumkov Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...ensus/basic/identity/invalid_identity_credit_withdrawal_transition_output_script_error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ impl InvalidIdentityCreditWithdrawalTransitionOutputScriptError {
}

pub fn output_script(&self) -> CoreScript {
// TODO: We shouldn't clone in getter 🤦
shumkov marked this conversation as resolved.
Show resolved Hide resolved
self.output_script.clone()
shumkov marked this conversation as resolved.
Show resolved Hide resolved
}
}
Expand Down
103 changes: 98 additions & 5 deletions ...alidation/state_transition/state_transitions/identity_credit_withdrawal/balance/v0/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ use dpp::state_transition::identity_credit_withdrawal_transition::accessors::Ide
use dpp::state_transition::identity_credit_withdrawal_transition::IdentityCreditWithdrawalTransition;

use crate::error::execution::ExecutionError;
use crate::execution::types::execution_operation::ValidationOperation;
use crate::execution::types::state_transition_execution_context::{
StateTransitionExecutionContext, StateTransitionExecutionContextMethodsV0,
};
use dpp::validation::SimpleConsensusValidationResult;
use dpp::version::PlatformVersion;

Expand All @@ -34,7 +30,11 @@ impl IdentityCreditTransferTransitionBalanceValidationV0 for IdentityCreditWithd
"expected to have a balance on identity for credit withdrawal transition",
)))?;

if balance < self.amount().checked_add(platform_version.fee_version.state_transition_min_fees.credit_withdrawal).ok_or(Error::Execution(ExecutionError::Overflow("overflow when adding amount and min_leftover_credits_before_processing in identity credit withdrawal")))? {
let amount_and_fees = self.amount()
.checked_add(platform_version.fee_version.state_transition_min_fees.credit_withdrawal)
.ok_or_else(|| Error::Execution(ExecutionError::Overflow("overflow when adding amount and min_leftover_credits_before_processing in identity credit withdrawal")))?;

if balance < amount_and_fees {
return Ok(SimpleConsensusValidationResult::new_with_error(
IdentityInsufficientBalanceError::new(self.identity_id(), balance, self.amount())
.into(),
Expand All @@ -44,3 +44,96 @@ impl IdentityCreditTransferTransitionBalanceValidationV0 for IdentityCreditWithd
Ok(SimpleConsensusValidationResult::new())
}
}

#[cfg(test)]
mod tests {
use super::*;

use assert_matches::assert_matches;
use dpp::consensus::state::state_error::StateError;
use dpp::consensus::ConsensusError;
use dpp::prelude::Identifier;
use dpp::state_transition::identity_credit_withdrawal_transition::v0::IdentityCreditWithdrawalTransitionV0;
use platform_version::version::v1::PLATFORM_V1;

mod validate_advanced_minimum_balance_pre_check_v0 {
use super::*;

#[test]
fn should_return_invalid_result_if_balance_is_less_than_amount_and_fees() {
let balance = 100;

let amount = 200;

let identity = PartialIdentity {
id: Identifier::random(),
loaded_public_keys: Default::default(),
balance: Some(balance),
revision: None,
not_found_public_keys: Default::default(),
};

let transaction =
IdentityCreditWithdrawalTransition::V0(IdentityCreditWithdrawalTransitionV0 {
identity_id: identity.id,
amount,
core_fee_per_byte: 0,
pooling: Default::default(),
output_script: Default::default(),
nonce: 0,
user_fee_increase: 0,
signature_public_key_id: 0,
signature: Default::default(),
});

let platform_version = &PLATFORM_V1;

let result = transaction
.validate_advanced_minimum_balance_pre_check_v0(&identity, platform_version)
.expect("failed to validate minimum balance");

assert_matches!(
result.errors.as_slice(),
[ConsensusError::StateError(
StateError::IdentityInsufficientBalanceError(err)
)] if err.balance() == balance && err.required_balance() == amount && err.identity_id() == &identity.id
);
}

#[test]
fn should_return_valid_result() {
let balance = 200000000000;

let amount = 100;

let identity = PartialIdentity {
id: Identifier::random(),
loaded_public_keys: Default::default(),
balance: Some(balance),
revision: None,
not_found_public_keys: Default::default(),
};

let transaction =
IdentityCreditWithdrawalTransition::V0(IdentityCreditWithdrawalTransitionV0 {
identity_id: Default::default(),
amount,
core_fee_per_byte: 0,
pooling: Default::default(),
output_script: Default::default(),
nonce: 0,
user_fee_increase: 0,
signature_public_key_id: 0,
signature: Default::default(),
});

let platform_version = &PLATFORM_V1;

let result = transaction
.validate_advanced_minimum_balance_pre_check_v0(&identity, platform_version)
.expect("failed to validate minimum balance");

assert_matches!(result.errors.as_slice(), []);
}
}
}
25 changes: 1 addition & 24 deletions .../validation/state_transition/state_transitions/identity_credit_withdrawal/state/v0/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
use crate::rpc::core::CoreRPCLike;
use dpp::block::block_info::BlockInfo;

use dpp::consensus::signature::IdentityNotFoundError;

Check warning on line 6 in packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_credit_withdrawal/state/v0/mod.rs

View workflow job for this annotation

GitHub Actions / Rust packages (drive-abci) / Linting

unused import: `dpp::consensus::signature::IdentityNotFoundError` 

warning: unused import: `dpp::consensus::signature::IdentityNotFoundError`
 --> packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_credit_withdrawal/state/v0/mod.rs:6:5
  |
6 | use dpp::consensus::signature::IdentityNotFoundError;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default
use dpp::consensus::state::identity::IdentityInsufficientBalanceError;

Check warning on line 7 in packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_credit_withdrawal/state/v0/mod.rs

View workflow job for this annotation

GitHub Actions / Rust packages (drive-abci) / Linting

unused import: `dpp::consensus::state::identity::IdentityInsufficientBalanceError` 

warning: unused import: `dpp::consensus::state::identity::IdentityInsufficientBalanceError`
 --> packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_credit_withdrawal/state/v0/mod.rs:7:5
  |
7 | use dpp::consensus::state::identity::IdentityInsufficientBalanceError;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
use dpp::prelude::ConsensusValidationResult;
use dpp::state_transition::identity_credit_withdrawal_transition::accessors::IdentityCreditWithdrawalTransitionAccessorsV0;
use dpp::state_transition::identity_credit_withdrawal_transition::IdentityCreditWithdrawalTransition;
Expand Down Expand Up @@ -49,29 +49,6 @@
tx: TransactionArg,
platform_version: &PlatformVersion,
) -> Result<ConsensusValidationResult<StateTransitionAction>, Error> {
let maybe_existing_identity_balance = platform.drive.fetch_identity_balance(
self.identity_id().to_buffer(),
tx,
platform_version,
)?;

let Some(existing_identity_balance) = maybe_existing_identity_balance else {
return Ok(ConsensusValidationResult::new_with_error(
IdentityNotFoundError::new(self.identity_id()).into(),
));
};

if existing_identity_balance < self.amount() {
return Ok(ConsensusValidationResult::new_with_error(
IdentityInsufficientBalanceError::new(
self.identity_id(),
existing_identity_balance,
self.amount(),
)
.into(),
));
}

self.transform_into_action_v0(
platform,
block_info,
Expand All @@ -91,7 +68,7 @@
) -> Result<ConsensusValidationResult<StateTransitionAction>, Error> {
let consensus_validation_result =
IdentityCreditWithdrawalTransitionAction::try_from_identity_credit_withdrawal(
&platform.drive,
platform.drive,
QuantumExplorer marked this conversation as resolved.
Show resolved Hide resolved
tx,
self,
block_info,
Expand Down
Loading
Loading