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.

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

fix: include the reason when the redistribution contract call fails #4358

Merged
merged 1 commit into from
Sep 29, 2023

Conversation

mrekucci
Copy link
Contributor

@mrekucci mrekucci commented Sep 29, 2023

Checklist

  • I have read the coding guide.
  • My change requires a documentation update, and I have done it.
  • I have added tests to cover my changes.
  • I have filled out the description and linked the related issues.

Description

Indicate the reason for the unsuccessful call of the redistribution contract.

@mrekucci mrekucci force-pushed the redistribution-add-revert-reason branch 2 times, most recently from 3f71e2a to 8c6d160 Compare September 29, 2023 11:36
@mrekucci mrekucci requested a review from janos September 29, 2023 11:36
@mrekucci mrekucci force-pushed the redistribution-add-revert-reason branch from 8c6d160 to beb5631 Compare September 29, 2023 11:39
@@ -191,7 +191,7 @@ func (c *contract) sendAndWait(ctx context.Context, request *transaction.TxReque
}

if receipt.Status == 0 {
return txHash, transaction.ErrTransactionReverted
return txHash, c.txService.UnwrapRevertReason(ctx, request, transaction.ErrTransactionReverted)
Copy link
Member

Choose a reason for hiding this comment

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

The process seems to fail before it would get a receipt. Supposedly the EstimateGas call (invoked by c.txService.Send above) returns with exection reverted.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

@mrekucci mrekucci force-pushed the redistribution-add-revert-reason branch from beb5631 to d6af522 Compare September 29, 2023 12:54
@mrekucci mrekucci requested a review from nugaon September 29, 2023 13:04
Copy link
Member

@nugaon nugaon left a comment

Choose a reason for hiding this comment

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

seems good for our current problem

}
}
return nil, err
return nil, c.transactionService.UnwrapRevertReason(ctx, request, transaction.ErrTransactionReverted)
Copy link
Member

Choose a reason for hiding this comment

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

could be deferred at the starting of the function such as in redistribution.go

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

}

if res, cErr := t.Call(ctx, req); cErr == nil {
if reason, uErr := abi.UnpackRevert(res); uErr == nil {
Copy link
Member

Choose a reason for hiding this comment

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

UnapckRevert will unpack abi encoded "Error(string)", but I do not think that it will unpack custom errors that are for example used in the redistribution contract. To unpack custom errors, contract abi is required, get the error with abi.ABI.ErrorByID using the first 4 bytes of the data and use the retuned *abi.Error to Unpack the error.

I did not try it, in this PR, but used this approach to get custom errors from the call traces.

Copy link
Member

Choose a reason for hiding this comment

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

This function may benefit from unit tests with different types of revert errors to ensure that they are not silently ignored.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, this is for revert reason as specified in: https://solidity.readthedocs.io/en/latest/control-structures.html#revert

Copy link
Member

Choose a reason for hiding this comment

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

Exactly, this is the one type of revert, there may be custom errors packed, and custom errors are used in our contracts. They supposed to be packed differently as they have arguments and custom name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can the custom errors be rewritten into this generic form so the error extraction is unified?

Copy link
Member

Choose a reason for hiding this comment

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

They can be just strings, but sometimes additional values are useful to be passed. In any case, solidity allows custom revert errors and I do not think that they are unpacked here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, merging this. The custom errors need to be reviewed and handled in different PR.

Copy link

@0xCardinalError 0xCardinalError Sep 29, 2023

Choose a reason for hiding this comment

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

Can the custom errors be rewritten into this generic form so the error extraction is unified?

actually no, this generic or string-only error form wasted a lot of blockchain space so was turned into a less wasteful form of generating errors, which in turn saves gas and in the end money for users. It's not a big deal to use them just need to be unpacked.

@mrekucci mrekucci force-pushed the redistribution-add-revert-reason branch from d6af522 to 7044098 Compare September 29, 2023 13:35
@mrekucci mrekucci merged commit 81e6e04 into master Sep 29, 2023
13 checks passed
@mrekucci mrekucci deleted the redistribution-add-revert-reason branch September 29, 2023 13:58
istae added a commit that referenced this pull request Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants