Add Deposit Actions section + rewrite the API integration guide#32
Open
babgev wants to merge 3 commits into
Open
Add Deposit Actions section + rewrite the API integration guide#32babgev wants to merge 3 commits into
babgev wants to merge 3 commits into
Conversation
Rewrite integration/API.mdx as a consumer-focused guide (core concepts, a "who does what" table, and a discover -> quote -> create -> execute -> track flow) with a prominent token-identification warning: identify tokens by contract address or the `group` field, since symbols can change (USDT -> USDT0 on Arbitrum). This addresses the integration pitfall a partner hit. Add the Deposit Actions section -- an overview plus per-chain execution guides (EVM, Bitcoin, Solana, Starknet, TON, Tron, Fuel) -- and wire it into the navigation. The overview documents the three funding modes (direct transfer, deposit address, depository), the deposit-action schema including gas_limit/encoded_args, and cross-links the existing Depository page. No webhook content. All endpoints, fields, statuses, and per-chain mechanics verified against the deployed OpenAPI spec and the API source. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…e snippets
- Reorganize the Deposit Actions section into Overview + "Deposit methods"
(Choosing a method, Depository) + "Network support" (per-chain guides), and
nest the Depository page under Deposit methods instead of as a top-level item.
- Add a canonical "Choosing a method" page (funding-mode comparison + when to use
each); dedupe the comparison tables out of the overview and Depository pages.
- Extract the depository execution into reusable snippets (EVM + Tron) shared by
the Depository page and the EVM/Tron network guides, and document the
previously-missing Tron depository (TRC-20) flow.
- Fix duplicate sidebar labels via sidebarTitle ("Overview" for Deposit Actions
and Swap lifecycle landing pages).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Remove the "treat your API key as a secret / backend-only" warning and reframe the key as optional attribution (analytics/reporting) — keys are not secrets. - Drop the unsourced "Who does what" table from the API guide. - Trim the quote section's prose parameter list (the JSON example and the linked endpoint reference already cover it). - Make nav icons consistent — icons on groups and top-level entries (add Deposit Actions, Deposit methods, and Network support group icons), none on nested leaf pages (remove from Depository, Swap lifecycle Overview, and Refunds). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What & why
Rewrites the public API integration guide to describe what an API consumer does (not internal system behavior), adds a per-chain Deposit Actions section, and fixes the token-identification pitfall a partner hit (passing
source_token=USDTon Arbitrum after it was renamed to USDT0).Highlights
integration/API.mdxrewrite — consumer-focused guide: core concepts, a "who does what" table, and adiscover → quote → create → execute → trackflow. Prominent token-identification warning: identify tokens by contract address or the tokengroupfield (symbols change); includes a live/sourcesdiscovery snippet.deposit_actionsobject, funding modes,call_data-by-chain table) plus per-chain execution guides for EVM, Bitcoin, Solana, Starknet, TON, Tron, Fuel.Verification
All endpoints, fields, statuses, contract signatures, and per-chain
call_datamechanics verified against the deployed OpenAPI spec (api.layerswap.io/swagger/v2), the API source (layerswap/monorepo@dev), and the live API.docs.jsonvalidates; internal links resolve (the/api-reference/swaps/*endpoint links return HTTP 200 on the live docs; Mintlify's link-checker false-positives them because it doesn't expand the OpenAPI group).🤖 Generated with Claude Code