Skip to content

Add sweep to the contract execution guide #155

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

Merged
pedromcunha merged 1 commit into from
Dec 10, 2025
Merged

Add sweep to the contract execution guide #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion references/api/api_guides/calling-integration-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,12 +412,29 @@ quote_request = {

</CodeGroup>

### Sweeping ERC20 Balance

Relay's router contract has a useful function that you can call to transfer out full balance of an ERC20 token, even if you don't know the full balance. There are currently two methods for doing this:

* [cleanupErc20s](https://github.com/relayprotocol/relay-periphery/blob/db8d066881e6d190bd33cbe6abd94e23deeb6b31/src/v2/RelayRouter.sol#L82-L113)
* [cleanupNative](https://github.com/relayprotocol/relay-periphery/blob/db8d066881e6d190bd33cbe6abd94e23deeb6b31/src/v2/RelayRouter.sol#L158-L172)

You can use these by passing in the txs field as follows:

```json
{
"to": "0xRouterContractAddress",
"data": "0xEncodedCalldata", // encoded calldata for cleanupErc20s or cleanupNative
"value": 0,
}
```

### ERC20 Troubleshooting Guide

**Problem**: "ERC20: transfer amount exceeds allowance" error
**Solution**: Ensure you include the approval transaction before your contract call

**Problem**: Transaction reverts with "ERC20: insufficient allowance"\
**Problem**: Transaction reverts with "ERC20: insufficient allowance"
**Solution**: Check that the approval amount is sufficient for your contract call

**Problem**: Approval transaction succeeds but contract call fails
Expand Down