SDK docs#2
Open
andriy-shymkiv wants to merge 15 commits into
Open
Conversation
Velenir
reviewed
May 27, 2026
| --- | ||
|
|
||
| <Note>This page is a stub. Content coming soon.</Note> | ||
| The Delta module wraps the [Delta API](/delta/overview) — gasless, MEV-protected swaps where the user signs an off-chain order and a network of solvers (Portikus) competes to fill it. The user pays no gas; the solver covers execution cost out of their margin. |
Member
There was a problem hiding this comment.
Is this the telltale em dash 🤖 ? Should we replace it, wdyt?
|
|
||
| ## External and TWAP orders | ||
|
|
||
| The SDK also supports two advanced order families that share the same build/sign/post pattern: |
Comment on lines
+11
to
+13
| - The user has gas on the source chain and is happy to submit a transaction. | ||
| - You need the cheapest path across DEX aggregation (no auction, no off-chain settlement). | ||
| - You want full control over slippage, gas, and recipient. |
Member
There was a problem hiding this comment.
Mention that swaps are single-chain only
Comment on lines
+22
to
+23
| - **"I just want a quote and a swap."** Use the **Simple SDK** — one constructor, ready to call. | ||
| - **"I have a Node service that does Delta orders, market swaps, and price polling."** Use the **Full SDK** — namespaced access plus a typed `<TxResponse>` so your code knows what `approveToken` returns. |
Comment on lines
2
to
+4
| title: "Composable SDK" | ||
| description: "Use the tree-shakeable, modular SDK when bundle size matters." | ||
| keywords: ["sdk","composable","tree-shaking"] | ||
| description: "constructFullSDK gives you every namespace (sdk.swap, sdk.delta, sdk.quote) over a fetcher and contract caller you construct yourself, with a typed transaction-response generic." | ||
| keywords: ["sdk", "composable", "constructFullSDK", "full"] |
Member
There was a problem hiding this comment.
Why do you call the FullSDK composable?
Composable would be a partial SDK that you compose from the methods you picked
Comment on lines
+11
to
+16
| <CardGroup cols={3}> | ||
| <Card title="Versatile" icon="plug"> | ||
| Works with [viem](https://viem.sh), [ethers](https://docs.ethers.org) (v5 or | ||
| v6), or [web3.js](https://web3js.readthedocs.io) — bring whichever stack you | ||
| already use. | ||
| </Card> |
Member
There was a problem hiding this comment.
Some of these links don't display like you would expect
|
|
||
| <CodeGroup> | ||
|
|
||
| ```ts axios |
Member
There was a problem hiding this comment.
What is the use of axios in ts axios? I don't see the difference but there must be
Comment on lines
+99
to
+101
| <Note> | ||
| Write calls always resolve to a **transaction hash** (`string`). If you need the library-typed response object (viem's `Hex`, `ethers.ContractTransaction`, etc.), use [`constructFullSDK`](/sdk/composable-sdk) with the `<TxResponse>` generic. | ||
| </Note> |
Member
There was a problem hiding this comment.
Yeah, md doesn't really work when inside mdx Component
| ### Anvil (Foundry) | ||
|
|
||
| ```bash | ||
| anvil --fork-url https://eth-mainnet.alchemyapi.io/v2/$ALCHEMY_KEY |
Member
There was a problem hiding this comment.
Did you test this kind of anvil setup? This is very minimal, when our hardhat setup for tests is much more extensive
Comment on lines
+56
to
+65
| The SDK's own tests use a Hardhat fork seeded via the `PROVIDER_URL` env var. The same approach works for your integration: | ||
|
|
||
| ```js | ||
| // hardhat.config.ts | ||
| networks: { | ||
| hardhat: { | ||
| forking: { url: process.env.PROVIDER_URL }, | ||
| }, | ||
| }, | ||
| ``` |
Member
There was a problem hiding this comment.
The same approach works for your integration
Does it really work? Our hardhat set up for SDK test is much more involved.
We have specific params for gas, chain, methods to create forks...
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
2 participants
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.
closes FRNT-1333