Update Solidity ABI compatibility related docs #418
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
davidsemakula
commented
Jun 16, 2025
Comment on lines
-76
to
-82
| ## MetaMask Compatibility | ||
|
|
||
| :::caution | ||
| This section has not yet been written for ink! v6. | ||
|
|
||
| TODO @davidsemakula | ||
| ::: |
There was a problem hiding this comment.
Belongs/exists in background/solidity-metamask-compat.md
| We added a new subcommand: | ||
|
|
||
| ```bash | ||
| $ cargo contract build ---metadata <ink|solidity> | ||
| ``` | ||
|
|
||
| Please see [#1930](https://github.com/use-ink/cargo-contract/pull/1930) for more information. | ||
| You can learn more [here](../basics/metadata/solidity-format.md). |
There was a problem hiding this comment.
Docs page has a lot more info than PR
Comment on lines
+331
to
+332
| `CallBuilder` also allows you to call contracts that are Solidity ABI encoded. | ||
| This enables interoperability between Solidity, ink!, and other Solidity ABI encoded contracts! |
There was a problem hiding this comment.
Pull Request Overview
Updates documentation for Solidity ABI compatibility in ink! v6, reorganizing sections and refining wording to reflect the new abi field and metadata formats.
- Introduce a dedicated “Solidity ABI compatible ink! contracts” section in the migration guide.
- Remove outdated placeholders and TODOs, and split long paragraphs for improved readability.
- Tweak phrasing in ABI overview and Metamask compatibility docs for clarity.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-v6/faq/migrating-from-ink-5-to-6.md | Added abi field docs, reorganized features, and updated headings. |
| versioned_docs/version-v6/basics/metadata/solidity-format.md | Removed the unfinished MetaMask compatibility section and TODO. |
| versioned_docs/version-v6/basics/cross-contract-calling.md | Split the CallBuilder description into two sentences for readability. |
| versioned_docs/version-v6/basics/abi/overview.md | Refined wording around selector and encoding specifications. |
| versioned_docs/version-v6/background/solidity-metamask-compat.md | Emphasized “semantically” equivalent for Option/Result mapping note. |
Comments suppressed due to low confidence (1)
versioned_docs/version-v6/faq/migrating-from-ink-5-to-6.md:294
- The snippet has an extra double quote in
abi = "all"". It should beabi = "all"to correctly represent the option.
The other option is `abi = "all""`. In this mode, the generated contract
Co-authored-by: Copilot <[email protected]>
Daanvdplas
reviewed
Jun 17, 2025
| The implication of supporting Solidity ABI encoding is that all types used as | ||
| constructor/message argument and return types, and event argument types must | ||
| define a mapping to an equivalent Solidity ABI type. | ||
| You won't be able to use Rust types for which no mapping to a Solidity ABI type is defined. |
There was a problem hiding this comment.
How do we envision developers finding out which types are sol compatible or not? With the below error only?
There was a problem hiding this comment.
See #418 (comment)
The next paragraph in this section links to the docs mentioned in that comment.
Co-authored-by: Daan van der Plas <[email protected]>
|
See https://use.ink/docs/v6/background/solidity-metamask-compatibility/ It includes:
|
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.
No description provided.