fix: contract operations #685

JeneaVranceanu · 2022-11-26T14:12:26Z

Enable writeToChain function to send signed or unsigned transactions;
decodeReturnData from ABI.Element.Function returns ["_success": true] instead of nil if a function has no output (WARNING: subject to change)
Split decodeReturnData into decodeReturnData and decodeErrorResponse. decodeErrorResponse is able to decode results of revert and require Solidity calls.
Tests for decodeReturnData and decodeErrorResponse returning error information caused by revert or require.

JeneaVranceanu · 2022-11-26T14:25:26Z

Sources/Core/EthereumABI/ABIElements.swift

@@ -325,7 +325,7 @@ extension ABI.Element.Function {
            // set a flag to detect the request succeeded
        }

-        if returnArray.isEmpty {
+        if returnArray.isEmpty && !outputs.isEmpty {


While trying to understand what is the issue this line change fixes I understood that we do not have clear explanation for this function outputs.
It's not clear if this change won't just break someone's current use of this library. It's a weird edge case but someone could just be checking if returned data != nil. Thus, we shall clearly specify what to expect in each return case.
What I see so far with current change:

nil is returned if something has failed (big minus to us that we don't tell yet what the issue was; must be improved);

["_success": true] for cases when ABI.Element.Function has no return types specified;

["_success": true, ....] for cases when some return types have been specified and data successfully decoded.

pharms-eth gave an example here: #670 (comment)

I've almost prepared documentation for this function but had to unpack each path leading to return.
It looks like there could be some issues in the function itself when it comes to decoding the invocation of require statement in https://github.com/web3swift-team/web3swift/pull/685/files#diff-3c274f0e8aa4f7a52ab734f9d55c13954e03532655ed01e4ad51747d03fb10e4R304-R312
I'm not sure if it will correctly recognize when it's a result of invocation of empty require() or just 0 bytes returned from a function call.

I want to thoroughly debug and cover it with tests.

Sources/Core/EthereumABI/ABIElements.swift

JeneaVranceanu · 2022-11-29T09:22:02Z

Sources/Core/EthereumABI/ABIElements.swift

+    ///            - `data.count` is less than `outputs.count * 32`;
+    ///            - `outputs` defined and `data` is empty;
+    ///            - `data` represent reverted transaction
+    public func decodeReturnData(_ data: Data) -> [String: Any] {


What should we also consider here is the option to pass a list or a dictionary of ABI.Element.EthError.
The reason for that is the ability to use custom errors with revert, e.g. revert Unauthorized().
That list must be optional so that we don't force anyone to set it in order to decode data but as a result of having that list we can decode custom errors that were raised using revert because the first 4 bytes of the given data will match function selector of a custom error.

revert test cases:

revert() -> 0 bytes. We can only assume it was a result of `revert()` or `require(expression)` call. revert Unauthorized() -> 0x82b4290000000000000000000000000000000000000000000000000000000000 revert("Not enough Ether provided.") -> 08c379a0 0000000000000000000000000000000000000000000000000000000000000020 000000000000000000000000000000000000000000000000000000000000001a 4e6f7420656e6f7567682045746865722070726f76696465642e000000000000 revert Unauthorized("Reason") -> 973d02cb 0000000000000000000000000000000000000000000000000000000000000020 0000000000000000000000000000000000000000000000000000000000000006 526561736f6e0000000000000000000000000000000000000000000000000000

require test cases:

require(false) -> 0 bytes. We can only assume it was a result of `revert()` or `require(expression)` call. require(false, "Not enough Ether provided.") -> 08c379a0 0000000000000000000000000000000000000000000000000000000000000020 000000000000000000000000000000000000000000000000000000000000001a 4e6f7420656e6f7567682045746865722070726f76696465642e000000000000

require is unable to use custom errors so there's no third test case:

It is currently not possible to use custom errors in combination with require. Please use if (!condition) revert CustomError(); instead.

https://docs.soliditylang.org/en/v0.8.17/control-structures.html?highlight=require()#panic-via-assert-and-error-via-require

…on using `errorDeclaration` computed variable; tests added

Sources/Core/EthereumABI/ABIElements.swift

…Response

JeneaVranceanu · 2022-12-01T15:02:34Z

Sources/Core/EthereumABI/ABIParsing.swift

-        let name = self.name ?? ""
-        let parameterType = try ABITypeParser.parseTypeString(self.type)
-        return ABI.Element.EthError.Input(name: name, type: parameterType)
-    }


ABI.Element.EthError.Input was replaced with ABI.Element.InOut since these are two identical structures.
No need for func parseForError() throws -> ABI.Element.EthError.Input then.

JeneaVranceanu · 2022-12-01T15:03:41Z

Sources/web3swift/Operations/WriteOperation.swift

-        // MARK: Sending Data flow
-        return try await web3.eth.send(transaction)
+        guard let transactionData = transaction.encode(for: .transaction) else { throw Web3Error.dataError }
+        return try await web3.eth.send(raw: transactionData)
    }
 }


@janndriessen @yaroslavyaroslav Nothing to review here. This part was discussed in the previous PR.

JeneaVranceanu · 2022-12-01T15:04:09Z

Tests/web3swiftTests/localTests/AdvancedABIv2Tests.swift

@@ -25,7 +25,7 @@ class AdvancedABIv2Tests: LocalTestCase {
        deployTx.transaction.from = allAddresses[0]
        // MARK: Sending Data flow
        let policies = Policies(gasLimitPolicy: .manual(3000000))
-        let result = try await deployTx.writeToChain(password: "web3swift", policies: policies)
+        let result = try await deployTx.writeToChain(password: "web3swift", policies: policies, sendRaw: false)


Same with all , sendRaw: false updates - already discussed.

janndriessen

As always great work. 👍

LGTM! We just have to figure out if the failing remote tests are somehow related.

…ion called in a transaction

…web3

… instance!!"

JeneaVranceanu · 2022-12-08T21:25:25Z

@janndriessen Please re-approve.
Here is everything that has changed after your approval - b9ac465

janndriessen

🌟 ✅

JeneaVranceanu · 2022-12-09T21:18:08Z

@yaroslavyaroslav Your approval was dismissed after the #701 was merged. Please re-approve.

yaroslavyaroslav · 2022-12-10T09:51:06Z

@yaroslavyaroslav Your approval was dismissed after the #701 was merged. Please re-approve.

Done. Please merge it when you'll be ready.

pharms-eth and others added 12 commits November 26, 2022 16:08

fix bugs

eea9749

fix: documentation update

34e312a

fix: documentation update for func writeToChain

4207de8

update per feedback

ff05502

attempt test fix

6b69769

working on tests

713c63d

restore true

aaaabe7

amend tests

9fc1508

adjust helpers

13bac57

adjust test for deploy changes

2213fd0

fix another test for deploy changes

5e1dd2c

chore: default value of sendRaw for writeToChain is true

6247628

JeneaVranceanu commented Nov 26, 2022

View reviewed changes

janndriessen mentioned this pull request Nov 27, 2022

EthereumContractTest removed swiftLint errors and warnings #688

Merged

chore: decodeReturnData refactoring + documentation for it

aa32c36

JeneaVranceanu commented Nov 28, 2022

View reviewed changes

Sources/Core/EthereumABI/ABIElements.swift Outdated Show resolved Hide resolved

JeneaVranceanu commented Nov 29, 2022

View reviewed changes

JeneaVranceanu added 3 commits November 29, 2022 17:47

fix: first we try to decode data as a revert/require call

a5c56ea

chore: added trim extension function to String

3198752

fix: EthError uses InOut as type for inputs; produces error declarati…

f2cb4b9

…on using `errorDeclaration` computed variable; tests added

janndriessen reviewed Nov 29, 2022

View reviewed changes

Sources/Core/EthereumABI/ABIElements.swift Outdated Show resolved Hide resolved

JeneaVranceanu added 4 commits November 29, 2022 21:24

chore: test update - added array type to error arguments

6bc5100

chore: EthError has default empty inputs array

7257f59

feat: decodeReturnData is split into decodeReturnData and decodeError…

3151678

…Response

chore: tests for errors decode

8d2490b

JeneaVranceanu marked this pull request as ready for review December 1, 2022 14:58

JeneaVranceanu requested review from yaroslavyaroslav and janndriessen December 1, 2022 14:58

JeneaVranceanu self-assigned this Dec 1, 2022

JeneaVranceanu added the bug Something isn't working label Dec 1, 2022

JeneaVranceanu added the enhancement New feature or request label Dec 1, 2022

JeneaVranceanu commented Dec 1, 2022

View reviewed changes

janndriessen previously approved these changes Dec 1, 2022

View reviewed changes

JeneaVranceanu added 8 commits December 6, 2022 00:09

fix: return message from Web3Error.valueError

6a5ce15

fix: removed redundant spacing

b9ac465

feat: ContractProtocol - new function to search for ABI.Element.Funct…

60c9ca7

…ion called in a transaction

chore: added tests for dynamic types encoding

d08a2de

feat: mocking network responses

97ba8e9

chore: Web3.Eth + IEth refactoring

ff0778b

fix: added initializer for the Web3EthMock

29fff74

fix: changed type of web3.eth to IEth and removed it's dependency on …

e2b0f5d

…web3

JeneaVranceanu mentioned this pull request Dec 7, 2022

feat: remote tests mocking #701

Merged

JeneaVranceanu dismissed janndriessen’s stale review via b9ac465 December 7, 2022 15:34

yaroslavyaroslav previously approved these changes Dec 8, 2022

View reviewed changes

JeneaVranceanu added 2 commits December 8, 2022 18:11

chore: removed commented out case from SecurityToken test

bd2188a

chore: updated FIXME comments to "// FIXME: remove dependency on web3…

3707ca4

… instance!!"

Merge pull request #701 from JeneaVranceanu/feat/remote-tests-mocking

d036483

yaroslavyaroslav dismissed their stale review via d036483 December 9, 2022 09:56

JeneaVranceanu mentioned this pull request Dec 9, 2022

CI/CD Remote tests failing occasionally #649

Open

janndriessen approved these changes Dec 9, 2022

View reviewed changes

yaroslavyaroslav approved these changes Dec 10, 2022

View reviewed changes

JeneaVranceanu merged commit d7a1012 into develop Dec 10, 2022

JeneaVranceanu deleted the fix/contract-operations branch December 10, 2022 09:55

fix: contract operations #685

fix: contract operations #685

Uh oh!

Conversation

JeneaVranceanu commented Nov 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JeneaVranceanu Nov 26, 2022

Choose a reason for hiding this comment

Uh oh!

janndriessen Nov 26, 2022

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu Nov 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JeneaVranceanu Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu Nov 29, 2022

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu Nov 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JeneaVranceanu Dec 1, 2022

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu Dec 1, 2022

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu Dec 1, 2022

Choose a reason for hiding this comment

Uh oh!

janndriessen left a comment

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu commented Dec 8, 2022

Uh oh!

janndriessen left a comment

Choose a reason for hiding this comment

Uh oh!

JeneaVranceanu commented Dec 9, 2022

Uh oh!

yaroslavyaroslav commented Dec 10, 2022

Uh oh!

Uh oh!

JeneaVranceanu commented Nov 26, 2022 •

edited

Loading

JeneaVranceanu Nov 26, 2022 •

edited

Loading

JeneaVranceanu Nov 29, 2022 •

edited

Loading

JeneaVranceanu Nov 29, 2022 •

edited

Loading