Add note about token compatibility in the IArbToken interface #83
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a note in the IArbToken interface to encourage users to keep an implementation as close as possible to the
TestArbCustomTokenexample, since custom changes to the standard implementation ofbridgeMintandbridgeBurnhave caused issues with certain tokens not behaving as expected using some of the tooling available.As an example, the bridge UI does not prompt an approval transaction when withdrawing a custom token, so tokens that customize
bridgeBurnto check for allowance can't withdraw their tokens back to the parent chain.This note has also been added to the docs here: https://docs.arbitrum.io/build-decentralized-apps/token-bridging/token-bridge-erc20#setting-up-your-token-with-the-generic-custom-gateway