docs: backasset is deprecated in v2 and always fails - #31
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates AtomicAssets v2 integrator-facing documentation to reflect that the backasset action is deprecated and fails unconditionally, while clarifying what remains functional for previously backed assets.
Changes:
- Update README feature list to mark fungible-token backing as disabled in v2 and describe unaffected flows (burn + withdraw).
- Update
backassetRicardian clause to state the action always fails in v2 and that pre-v2 backed assets are unaffected.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| resource/atomicassets.contracts.md | Updates backasset Ricardian clause title/summary/description to reflect v2 deprecation and failure behavior. |
| README.md | Adjusts the feature list entry to note backasset is disabled in v2 and summarizes what still works for already-backed assets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
The v2 contract makes
backassetfail unconditionally:Two documents still described it as working, and both are the ones an integrator reads first.
README
The feature list advertised backing as current, promising assets "a guaranteed intrinsic value". It now says the action fails on v2, and states what is unaffected: burning an asset still releases tokens backed before the upgrade, and
withdrawstill works. That reassurance matters because holders of already-backed assets would otherwise have no way to tell whether their value was stranded.Ricardian clause
resource/atomicassets.contracts.mdstill titled the clause "Backs an asset with tokens" and described a successful backing, including "The tokens backed to this asset can be retreived by burning the asset". It now says native backing is deprecated, the action always fails, no tokens move, and pre-v2 backed assets still release on burn.Why this is worth doing now rather than at deploy
backassetis in live use. On WAX mainnet there are more than 10,000 recorded calls, roughly 100 in the last four days across 18 distinct accounts, the most recent yesterday. Those callers break the moment the v2 upgrade executes, and until then the documentation tells them the feature is supported. EOS has no calls at all.The change is invisible to an ABI diff, since the action is still present with an unchanged struct, so documentation is the only place it surfaces.
Note on scope
This does not change the ABI. Ricardian text is not currently embedded in the AtomicAssets ABI at all: the shipped
atomicassets.abihasricardian_clauses: []and every action carriesricardian_contract: "", because the Makefile omits the-R./resourceflag its atomicmarket counterpart passes. That gap is real and worth its own change, but it cannot ride v2.0.0 since adding the flag changesabiSha256and the release is pinned by hash. Raised separately.