Skip to content

[Optimization]: add exception message to ArgumentException#3862

Merged
shargon merged 2 commits intoneo-project:masterfrom
Wi1l-B0t:style.add-info-to-ArugmentException
Apr 1, 2025
Merged

[Optimization]: add exception message to ArgumentException#3862
shargon merged 2 commits intoneo-project:masterfrom
Wi1l-B0t:style.add-info-to-ArugmentException

Conversation

@Wi1l-B0t
Copy link
Contributor

@Wi1l-B0t Wi1l-B0t commented Apr 1, 2025

Description

Add message when throw new ArgumentException

Type of change

  • Optimization (the change is only an optimization)
  • Style (the change is only a code style for better maintenance or standard purpose)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@Wi1l-B0t Wi1l-B0t changed the title [Optimization ]: add exception message to ArgumentException [Optimization]: add exception message to ArgumentException Apr 1, 2025
@Wi1l-B0t Wi1l-B0t force-pushed the style.add-info-to-ArugmentException branch from 467e025 to c18716b Compare April 1, 2025 01:42
@Jim8y Jim8y requested review from Copilot and shargon April 1, 2025 02:28
Copilot AI reviewed Apr 1, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves exception handling by replacing generic ArgumentExceptions with more descriptive messages for better clarity and debugging. Key changes include:

  • Adding detailed exception messages to various methods across tests and production code.
  • Refactoring null-checks by using ArgumentNullException.ThrowIfNull with parameter names.
  • Improving code formatting and inline exception messages for consistency and readability.

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/Neo.UnitTests/Ledger/UT_PoolItem.cs Added descriptive exception message on size mismatch.
tests/Neo.UnitTests/Cryptography/UT_MerkleTree.cs Renamed parameter and replaced null-check with ThrowIfNull.
src/Plugins/TokensTracker/Trackers/TokenTransferKey.cs Updated null-checks to use ThrowIfNull with parameter names.
src/Plugins/TokensTracker/Trackers/NEP-17/Nep17BalanceKey.cs Refactored ctor and argument-checks for clarity.
src/Plugins/TokensTracker/Trackers/NEP-11/Nep11BalanceKey.cs Replaced generic null-check with parameter specific checks.
src/Plugins/SQLiteWallet/SQLiteWallet.cs Enhanced exception messages with parameter details.
src/Neo/Wallets/Helper.cs Added detailed exception message for XOR length mismatch.
src/Neo/SmartContract/Native/OracleContract.cs Improved formatting and enhanced exception message clarity in Request method.
src/Neo/SmartContract/Native/ContractManagement.cs Added descriptive exception messages when both parameters are null and on update limits.
src/Neo/SmartContract/ContractParameter.cs Provided a clear error message for unsupported ContractParameterType.
src/Neo/SmartContract/ApplicationEngine.Crypto.cs Detailed exception messages for CheckMultisig parameter checks.
src/Neo.ConsoleService/CommandToken.cs Exception messages refined to indicate unmatched quote/space.

Jim8y
Jim8y previously approved these changes Apr 1, 2025
View reviewed changes
Update src/Neo/SmartContract/ApplicationEngine.Crypto.cs
c827598 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@shargon shargon merged commit 064fb92 into neo-project:master Apr 1, 2025
6 of 7 checks passed
@Wi1l-B0t Wi1l-B0t deleted the style.add-info-to-ArugmentException branch April 4, 2025 10:01
Jim8y added a commit to Jim8y/neo that referenced this pull request Apr 9, 2025
@Jim8y
Merge branch 'master' into opcode-bench-files
5a4c994 
* master: (163 commits)
  [style] Added some var styles (neo-project#3867)
  [`fix`] stop syncing on block 1465790 (neo-project#3888)
  Optimize block deserialization (neo-project#3879)
  Avoid double `ToArray` on `OnInvMessageReceived` (neo-project#3875)
  style: format long lines (neo-project#3884)
  optimize: return GetFileNameWithoutExtension(Path) if name is not set (neo-project#3883)
  Fix possible null exception (neo-project#3880)
  Remove linkedList (neo-project#3873)
  Optimize Uint160 and Uint256 constructor (neo-project#3872)
  Release the resources (neo-project#3868)
  [Clean] Remove `IRawReadOnlyStore` (neo-project#3869)
  move non-plugins out of plugins (neo-project#3863)
  feature: set name when create wallet (neo-project#3866)
  Native: swap Policy's `[get/set]AttributeFee` implementations (neo-project#3859)
  Fix: concurrent conflict in Cache.CopyTo (neo-project#3860)
  Fix: add default key parameter in help cmd (neo-project#3865)
  [Plugin UT] add more rpcserver UTs (neo-project#3864)
  config: upgrade NeoFS chains protocol configuration (neo-project#3858)
  [`Optimization`]: add exception message to `ArgumentException` (neo-project#3862)
  Native: unify arguments naming of CryptoLib's `verifyWith*` methods (neo-project#3855)
  ...

# Conflicts:
#	benchmarks/Neo.VM.Benchmarks/OpCode/Arrays/OpCode.ReverseN.cs
#	benchmarks/Neo.VM.Benchmarks/Program.cs
#	src/Neo/Neo.csproj
#	src/Neo/ProtocolSettings.cs
#	src/Neo/SmartContract/ApplicationEngine.cs
#	src/Neo/SmartContract/Native/NeoToken.cs
#	src/Neo/SmartContract/Native/RoleManagement.cs
#	tests/Neo.UnitTests/SmartContract/Manifest/UT_ContractManifest.cs
#	tests/Neo.UnitTests/SmartContract/Manifest/UT_ContractPermission.cs
#	tests/Neo.UnitTests/SmartContract/Native/UT_NativeContract.cs
#	tests/Neo.UnitTests/SmartContract/Native/UT_NeoToken.cs
#	tests/Neo.UnitTests/UT_ProtocolSettings.cs
#	tests/Neo.VM.Tests/UT_ReferenceCounter.cs
cschuchardt88 pushed a commit to cschuchardt88/neo that referenced this pull request Jun 8, 2025
@Wi1l-B0t @cschuchardt88
[Optimization]: add exception message to ArgumentException (neo-p…
1f53a32 
…roject#3862)

* Style: add exception message to ArgumentException

* Update src/Neo/SmartContract/ApplicationEngine.Crypto.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Jimmy <jinghui@wayne.edu>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@shargon shargon shargon approved these changes

@Jim8y Jim8y Jim8y approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Wi1l-B0t @shargon @Jim8y