feat(docs): add Alloyed Assets integration page#315
Draft
JohnnyWyles wants to merge 1 commit into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
A new page at docs/overview/integrate/transmuter.md documenting the transmuter contract behind alloyed assets like allBTC: 1:1-backed pools that mint a single canonical Osmosis denom against multiple bridged variants of the same asset. The page is pinned to the deployed contract version (v3.2.0 on code id 996), verified by the cw2 contract_info raw query against the allBTC pool. Every query documented on the page was probed live against pool 1868 and the supported-query list (returned by sending an invalid query) matches exactly: calc_in_amt_given_out, calc_out_amt_given_in, get_admin, get_admin_candidate, get_corrupted_denoms, get_moderator, get_share_denom, get_shares, get_swap_fee, get_total_pool_liquidity, get_total_shares, is_active, list_asset_configs, list_limiters, spot_price. Admin and moderator permissions are sourced from the ensure_admin_authority! and ensure_moderator_authority! checks in the v3.2.0 source. The moderator owns set_active_status, mark_corrupted_assets, and unmark_corrupted_assets. The admin owns everything else, with claim_admin and reject_admin_transfer being called by the offered address rather than the current admin. The Routing through SQS section is sourced from sqs/router/usecase/pools/routable_cw_alloy_transmuter_pool.go: SQS quotes alloyed transmuter swaps in-process using normalization factors, enforces the static upper-limit at quote time, and skips balance validation on the alloyed side. Features that exist in transmuter main but are not deployed in v3.2 (asset groups, rebalancing configs, incentive pool) are intentionally omitted. sidebar_position: 15, next to sqs.md, rpc/rest/grpc, and orderbook.md.
JohnnyWyles
force-pushed
the
feat/alloyed-assets-docs
branch
from
67c9de0 to
7b06964
Compare
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
1 participant
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.
A new page at docs/overview/integrate/transmuter.md documenting the transmuter contract behind alloyed assets like allBTC: 1:1-backed pools that mint a single canonical Osmosis denom against multiple bridged variants of the same asset.
The page is pinned to the deployed contract version (v3.2.0 on code id 996), verified by the cw2 contract_info raw query against the allBTC pool. Every query documented on the page was probed live against pool 1868 and the supported-query list (returned by sending an invalid query) matches exactly:
calc_in_amt_given_out, calc_out_amt_given_in, get_admin,
get_admin_candidate, get_corrupted_denoms, get_moderator,
get_share_denom, get_shares, get_swap_fee,
get_total_pool_liquidity, get_total_shares, is_active,
list_asset_configs, list_limiters, spot_price.
Admin and moderator permissions are sourced from the ensure_admin_authority! and ensure_moderator_authority! checks in the v3.2.0 source. The moderator owns set_active_status, mark_corrupted_assets, and unmark_corrupted_assets. The admin owns everything else, with claim_admin and reject_admin_transfer being called by the offered address rather than the current admin.
The Routing through SQS section is sourced from
sqs/router/usecase/pools/routable_cw_alloy_transmuter_pool.go: SQS quotes alloyed transmuter swaps in-process using normalization factors, enforces the static upper-limit at quote time, and skips balance validation on the alloyed side.
Features that exist in transmuter main but are not deployed in v3.2 (asset groups, rebalancing configs, incentive pool) are intentionally omitted.