[Neo Core Fix] Check params at Calling Contract #3438

Jim8y · 2024-07-25T18:52:05Z

Description

Neo core does not check the type of vales being passed to the contract, and this can cause problems.

for example: neo-project/neo-devpack-dotnet#863

Fixes # #1891 neo-project/neo-devpack-dotnet#863

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

How Has This Been Tested?

Runtime_GetNotifications_Test
Check_BalanceOfTransferAndBurn

Test Configuration:

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

src/Neo/SmartContract/ApplicationEngine.cs

roman-khimov · 2024-07-25T20:03:53Z

Wait, wait, wait a minute! As much as I love this change you can't just roll it out with the nearest hardfork. Remember all the pain of #2810. We need to:

pre-announce it
make adjustments to compilers if needed
add some checks/logs to the node for developers to be aware
wait for them to update their contracts and have ~0 warnings in logs for current blocks
schedule the update

lock9 · 2024-07-26T02:26:50Z

Will this affect calls between contracts?

Jim8y · 2024-07-26T02:54:38Z

Wait, wait, wait a minute! As much as I love this change you can't just roll it out with the nearest hardfork. Remember all the pain of #2810. We need to:

pre-announce it

make adjustments to compilers if needed

add some checks/logs to the node for developers to be aware

wait for them to update their contracts and have ~0 warnings in logs for current blocks

schedule the update

Exactly, this pr is marked as blocked, so will not be merged without careful review and discussion.

Jim8y · 2024-07-26T02:55:52Z

Will this affect calls between contracts?

Yes, it will. That is why this pr may only take effect to contracts that are depolyed or updated after the next hardfork,,,,,, will be discussed.

shargon

It's hard to know if this will break some contracts, because we can alter the type in some operations and the opcodes are compatible with multiple types..

AnnaShaleva · 2024-08-07T17:23:01Z

src/Neo/SmartContract/ApplicationEngine.Runtime.cs

@@ -449,6 +449,7 @@ protected internal Signer[] GetCurrentSigners()
        private static bool CheckItemType(StackItem item, ContractParameterType type)
        {
            StackItemType aType = item.Type;
+            if (aType == StackItemType.Any) return true;


I don't think it's correct for VM-compatible SC types, because for example, if you require stackitem to be Boolean, then Any just doesn't match this requirement.

I see what you mean, will update.

AnnaShaleva · 2024-08-07T17:31:08Z

src/Neo/SmartContract/ApplicationEngine.cs

@@ -319,7 +319,11 @@ private ExecutionContext CallContractInternal(ContractState contract, ContractMe
            state.CallingContext = currentContext;

            for (int i = args.Count - 1; i >= 0; i--)
+            {
+                if (!CheckItemType(args[i], method.Parameters[i].Type))
+                    throw new InvalidOperationException($"The type of the argument `{args[i]}` does not match the formal parameter.");


It may be too harsh for mainnet contracts (even if enabled with hardfrok), this change may break some of them and even prevent them from update. What do you think about using the same approach as it was done for SC Events parameters check (#2810 (comment)): in next release we firstly enable a warning log in case of parameters mismatch, and then in the subsequent release we convert the log to an exception.

It may be too harsh for mainnet contracts (even if enabled with hardfrok), this change may break some of them and even prevent them from update. What do you think about using the same approach as it was done for SC Events parameters check (#2810 (comment)): in next release we firstly enable a warning log in case of parameters mismatch, and then in the subsequent release we convert the log to an exception.

We have discussed this in the last meeting, check will only happen for newly deployed or updated contracts, this pr will be updated.

…eo-project#3449) * Part-1 `Neo.IO` - move * Part-2 * Added `BigInteger` to `Neo.Extensions` * Found more `BigInteger` * Added `ByteArray` to `Neo.Extensions` * Added `DateTime` Extensions to `Neo.Extensions` * Added `HashSetExtensions`, `HashSetExtensions2`, `IpAddressExtensions`, `AssemblyExtensions`, `StringExtensdions` Deleted `Helper.cs` file * Added `ICollection`, `Memory`, `String`, `Unsafe` extensions * Adding `using` * dotnet format * Added more Extensions * Move some methods * Added Tests * Added `tests` from `Part-2` * Added `tests` for `PART-4` * Added `tests` for `PART-5` * Added the `Part` 7 * `PART-8` * `PART-9` * `PART-10` * Revert some changes --------- Co-authored-by: Shargon <[email protected]>

* [Add] Get Accounts and Balances for GasToken * Removed `BalanceOf` extension * Added null check * Changed `Seek` to `Find` for `DataCache` --------- Co-authored-by: Jimmy <[email protected]>

* Update to correct version of `dotnet` for devcontainer * Add comment --------- Co-authored-by: Jimmy <[email protected]> Co-authored-by: NGD Admin <[email protected]>

)

Co-authored-by: NGD Admin <[email protected]>

…3626) * fix: UInt160.TryParse when source has whitespaces * Update tests/Neo.UnitTests/UT_UInt160.cs --------- Co-authored-by: Shargon <[email protected]> Co-authored-by: Jimmy <[email protected]>

* feature: add missed unit-tests for LogStorageStore * feature: add missed unit-tests for LogStorageStore --------- Co-authored-by: Jimmy <[email protected]> Co-authored-by: NGD Admin <[email protected]>

* fix issue 3629 * update test * format * add debug for rpcexception * Update src/Plugins/RpcServer/RpcException.cs --------- Co-authored-by: nan01ab <[email protected]>

# Conflicts: # tests/Neo.UnitTests/SmartContract/Native/UT_NeoToken.cs

shargon

Is not rebased? I see changes from other PRs

Jim8y · 2024-12-19T10:56:39Z

Is not rebased? I see changes from other PRs

I am tring to fix, but still have no clue, changed that are already merged into the base branch still showing here, i tried reset, rebase, merge,,, none of them work

Jim8y added 4 commits July 24, 2024 00:55

check param when calling contracts

f26303a

check tests

ad33527

try fix

c01ac8f

revert change to UT

9f394f3

Jim8y added Waiting for Review Blocked This issue can't be worked at the moment Waiting-Hardfork labels Jul 25, 2024

Jim8y requested review from cschuchardt88 and shargon July 25, 2024 18:53

Jim8y added 3 commits July 26, 2024 02:53

Merge branch 'master' into check-params

01ed4dc

revert debug

bb6692b

revert change

5aa0d30

Jim8y commented Jul 25, 2024

View reviewed changes

src/Neo/SmartContract/ApplicationEngine.cs Outdated Show resolved Hide resolved

Update src/Neo/SmartContract/ApplicationEngine.cs

df39d45

Merge branch 'master' into check-params

9ced170

shargon reviewed Jul 27, 2024

View reviewed changes

Jim8y mentioned this pull request Aug 7, 2024

Add hardfork HF_Echidna #3454

Draft

11 tasks

Jim8y changed the base branch from master to HF_Echidna August 7, 2024 16:29

Jim8y added Hardfork and removed Waiting-Hardfork labels Aug 7, 2024

AnnaShaleva reviewed Aug 7, 2024

View reviewed changes

cschuchardt88 and others added 5 commits December 12, 2024 00:48

[Add] Get Accounts and Balances for GasToken (neo-project#3614)

c531917

* [Add] Get Accounts and Balances for GasToken * Removed `BalanceOf` extension * Added null check * Changed `Seek` to `Find` for `DataCache` --------- Co-authored-by: Jimmy <[email protected]>

[Fixed] Dotnet version for DevContainer (neo-project#3620)

e0edd98

* Update to correct version of `dotnet` for devcontainer * Add comment --------- Co-authored-by: Jimmy <[email protected]> Co-authored-by: NGD Admin <[email protected]>

fix: move unit-tests of DataCache to corresponding dir (neo-project#3625

3669912

)

fix: remove the only compiler warning (neo-project#3623)

692cfbb

Co-authored-by: NGD Admin <[email protected]>

nan01ab and others added 20 commits December 16, 2024 20:32

[Fix]: UInt160.TryParse when source has whitespaces (neo-project#…

71aac33

…3626) * fix: UInt160.TryParse when source has whitespaces * Update tests/Neo.UnitTests/UT_UInt160.cs --------- Co-authored-by: Shargon <[email protected]> Co-authored-by: Jimmy <[email protected]>

[Add]: add missing unit-tests for LogStorageStore (neo-project#3624)

d749eaf

* feature: add missed unit-tests for LogStorageStore * feature: add missed unit-tests for LogStorageStore --------- Co-authored-by: Jimmy <[email protected]> Co-authored-by: NGD Admin <[email protected]>

Merge branch 'master' into check-params

4c052ff

Merge branch 'HF_Echidna' into check-params

707dbd4

Merge branch 'master' into HF_Echidna

c086661

[Plugin RpcServer] fix issue 3629 (neo-project#3630)

61de3a4

* fix issue 3629 * update test * format * add debug for rpcexception * Update src/Plugins/RpcServer/RpcException.cs --------- Co-authored-by: nan01ab <[email protected]>

Merge branch 'master' into HF_Echidna

0f1507f

check param when calling contracts

9e183fc

# Conflicts: # tests/Neo.UnitTests/SmartContract/Native/UT_NeoToken.cs

check tests

4d1c6bd

try fix

8da7163

revert debug

3bb2012

revert change

8a9bbc5

Update src/Neo/SmartContract/ApplicationEngine.cs

6b25105

Merge branch 'check-params' of github.com:Jim8y/neo into check-params

c13c9d6

try fix

120f7d3

revert debug

5e53ee4

revert change

9c0770e

Merge branch 'check-params' of github.com:Jim8y/neo into check-params

32507a9

reset

6ff0356

Merge branch 'check-params' of github.com:Jim8y/neo into check-params

f83e4f3

shargon reviewed Dec 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Neo Core Fix] Check params at Calling Contract #3438

[Neo Core Fix] Check params at Calling Contract #3438

Jim8y commented Jul 25, 2024 •

edited

Loading

roman-khimov commented Jul 25, 2024

lock9 commented Jul 26, 2024

Jim8y commented Jul 26, 2024

Jim8y commented Jul 26, 2024

shargon left a comment

AnnaShaleva Aug 7, 2024

Jim8y Aug 8, 2024

AnnaShaleva Aug 7, 2024 •

edited

Loading

Jim8y Aug 8, 2024

shargon left a comment

Jim8y commented Dec 19, 2024

[Neo Core Fix] Check params at Calling Contract #3438

Are you sure you want to change the base?

[Neo Core Fix] Check params at Calling Contract #3438

Conversation

Jim8y commented Jul 25, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

roman-khimov commented Jul 25, 2024

lock9 commented Jul 26, 2024

Jim8y commented Jul 26, 2024

Jim8y commented Jul 26, 2024

shargon left a comment

Choose a reason for hiding this comment

AnnaShaleva Aug 7, 2024

Choose a reason for hiding this comment

Jim8y Aug 8, 2024

Choose a reason for hiding this comment

AnnaShaleva Aug 7, 2024 • edited Loading

Choose a reason for hiding this comment

Jim8y Aug 8, 2024

Choose a reason for hiding this comment

shargon left a comment

Choose a reason for hiding this comment

Jim8y commented Dec 19, 2024

Jim8y commented Jul 25, 2024 •

edited

Loading

AnnaShaleva Aug 7, 2024 •

edited

Loading