;
-}
-
-interface FailedSolution {
- error: string;
-}
-```
-
-### Example Response
-
-import GasTip from "../\_gas-tip.md"
-
-
-
-```json
-[
- {
- "sourceChain": 84532,
- "destinationChain": 11155111,
- "sourceTokenAddress": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
- "destinationTokenAddress": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
- "senderAddress": "0x3e101ec02e7a48d16dade204c96bff842e7e2519",
- "tool": {
- "name": "Sygma-Testnet",
- "logoURI": "https://scan.buildwithsygma.com/assets/images/logo1.svg"
- },
- "gasCost": {
- "amount": "221055913000",
- "amountUSD": 0
- },
- "fee": {
- "amount": "1000000000000000",
- "amountUSD": 0
- },
- "amount": "100000000",
- "duration": 60000000000,
- "transaction": {
- "data": "0x73c45c98000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000540000000000000000000000000000000000000000000000000000000005f5e10000000000000000000000000000000000000000000000000000000000000000143e101ec02e7a48d16dade204c96bff842e7e251900000000000000000000000000000000000000000000000000000000000000000000000000000000000000023078000000000000000000000000000000000000000000000000000000000000",
- "to": "0x9D5C332Ebe0DaE36e07a4eD552Ad4d8c5067A61F",
- "from": "0x3E101Ec02e7A48D16DADE204C96bFF842E7E2519",
- "value": "0x38d7ea4c68000",
- "gasPrice": "0xf433d",
- "gasLimit": "0x35f48",
- "chainId": 84532
- },
- "approvals": [
- {
- "data": "0x095ea7b30000000000000000000000003b0f996c474c91de56617da13a52b22bb659d18e0000000000000000000000000000000000000000000000000000000005f5e100",
- "to": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
- "from": "0x3E101Ec02e7A48D16DADE204C96bFF842E7E2519",
- "value": "0x0",
- "gasPrice": "0xf433d",
- "gasLimit": "0xe484",
- "chainId": 84532
- }
- ]
- }
-]
-```
diff --git a/docs/docs/03-sdk/index.md b/docs/docs/03-sdk/index.md
deleted file mode 100644
index 362b61d..0000000
--- a/docs/docs/03-sdk/index.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-id: sdk-overview
-title: SDK
-sidebar_position: 3
----
-
-# SDK Overview
-
-The Sprinter SDK provides a set of tools and functionalities to interact with the Sprinter Intent Engine. It allows developers to easily retrieve intent-based solutions, such as cross-chain balance aggregation, token transfers, and contract calls, across multiple blockchain networks.
-
-## Key Features
-
-- **Cross-Chain Balance Retrieval**: Fetch user balances across multiple supported blockchains.
-- **Bridging Solutions**: Generate solutions for single-hop and multi-hop token transfers across chains.
-- **Contract Call Solutions**: Generate solutions to perform contract calls along with cross-chain transfers.
-- **Typed Methods**: TypeScript support for all SDK methods, ensuring type safety and better developer experience.
-
-## Use Cases
-
-1. **Balance Aggregation**: Aggregate a user's balance for a specific token across multiple chains.
-2. **Token Bridging**: Create bridging solutions to transfer tokens across different chains.
-3. **Contract Interactions**: Retrieve solutions for executing contract calls while bridging tokens.
-
-For more detailed usage and examples, please refer to the Methods Reference.
diff --git a/docs/docs/04-react-sdk/02-installation.md b/docs/docs/04-react-sdk/02-installation.md
deleted file mode 100644
index b3e086d..0000000
--- a/docs/docs/04-react-sdk/02-installation.md
+++ /dev/null
@@ -1,56 +0,0 @@
----
-id: react-sdk-installation
-title: Installation
-sidebar_position: 2
----
-
-# Installation
-
-To use the **Sprinter React SDK** in your project, follow these installation instructions.
-
-## Step 1: Install the React SDK and Sprinter SDK
-
-The React SDK requires the core Sprinter SDK (`@chainsafe/sprinter-sdk`) to function properly. You can install both packages using `yarn` or `npm`.
-
-```bash npm2yarn
-npm install @chainsafe/sprinter-react @chainsafe/sprinter-sdk
-```
-
-## Step 2: Ensure React Version
-
-Make sure your project uses **React** version 18.3.1 or higher, as it’s the minimum version supported by the React SDK.
-
-```bash npm2yarn
-npm install react@latest react-dom@latest
-```
-
-## Step 3: Wrap Your App with `SprinterContext`
-
-Once the installation is complete, wrap your app’s component tree with `SprinterContext` to provide access to Sprinter’s functionalities across your React components.
-
-:::note
-The `baseUrl` should be changed depending on whether you want to interract with test networks or main networks. E.g for Sepolia or BaseSepolia use `Environment.TESTNET`, otherwise use `Environment.MAINNET`
-:::
-
-```tsx
-import React from "react";
-import { SprinterContext } from "@chainsafe/sprinter-react";
-import { Environment } from "@chainsafe/sprinter-sdk";
-
-function App() {
- return (
-
-
-
- );
-}
-```
-
-By passing the `baseUrl`, you specify which endpoint to use for API calls. If you interract with test networks (e.g Sepolia, BaseSepolia...) use the Testnet url otherwise use the Mainnet one.
-
-### Available URLs:
-
-- **Testnet**: `https://api.test.sprinter.buildwithsygma.com`
-- **Mainnet**: `https://api.sprinter.buildwithsygma.com`
-
-For more information on available hooks and methods, proceed to the [Using Hooks](03-using-hooks.md) section.
diff --git a/docs/docs/04-react-sdk/03-using-hooks.md b/docs/docs/04-react-sdk/03-using-hooks.md
deleted file mode 100644
index a3f41ba..0000000
--- a/docs/docs/04-react-sdk/03-using-hooks.md
+++ /dev/null
@@ -1,151 +0,0 @@
----
-id: using-hooks
-title: Using React SDK Hooks
-sidebar_position: 3
----
-
-# Using React SDK Hooks
-
-The Sprinter React SDK provides a set of hooks to simplify access to the core Sprinter SDK's functionality. These hooks allow you to easily retrieve and manage user balances, tokens, chains, and transfer solutions directly within your React components.
-
-Each hook returns stateful data (`data`, `loading`, `error`) along with functions to interact with Sprinter’s Intent Engine.
-
-## Available Hooks
-
-### 1. `useSprinter`
-
-Access all of the context provided by `SprinterContext`. It allows you to get access to balances, chains, tokens, and solutions across your app.
-
-```tsx
-import { useSprinter } from "@chainsafe/sprinter-react";
-
-function YourComponent() {
- const {
- balances,
- tokens,
- chains,
- solution,
- getUserBalances,
- getAvailableTokens,
- getAvailableChains,
- getSweep,
- getTransfer,
- getTransferWithHook,
- getPoolAssetOnDestination,
- getPoolAssetOnDestinationWithHook,
- } = useSprinter();
-
- // You now have access to the full Sprinter context!
-}
-```
-
-### 2. `useSprinterTokens`
-
-Fetch the list of available tokens supported by Sprinter across various chains.
-
-```tsx
-import { useSprinterTokens } from "@chainsafe/sprinter-react";
-
-function TokenList() {
- const { tokens, getAvailableTokens } = useSprinterTokens();
-
- useEffect(() => {
- getAvailableTokens(); // Fetch tokens on component mount
- }, []);
-
- if (tokens.loading) return Loading tokens...
;
- if (tokens.error) return Error: {tokens.error}
;
-
- return (
- {tokens.data && tokens.data.map((token) => - {token.name}
)}
- );
-}
-```
-
-### 3. `useSprinterChains`
-
-This hook retrieves the supported blockchain networks.
-
-```tsx
-import { useSprinterChains } from "@chainsafe/sprinter-react";
-
-function ChainList() {
- const { chains, getAvailableChains } = useSprinterChains();
-
- useEffect(() => {
- getAvailableChains(); // Fetch chains on component mount
- }, []);
-
- if (chains.loading) return Loading chains...
;
- if (chains.error) return Error fetching chains: {chains.error}
;
-
- return (
- {chains.data && chains.data.map((chain) => - {chain.name}
)}
- );
-}
-```
-
-### 4. `useSprinterBalances`
-
-This hook allows you to fetch user balances across multiple blockchains.
-
-```tsx
-import { useSprinterBalances } from "@chainsafe/sprinter-react";
-
-function BalanceComponent({ account }) {
- const { balances, getUserBalances } = useSprinterBalances(account);
-
- useEffect(() => {
- getUserBalances(); // Fetch balances when the component mounts
- }, [account]);
-
- if (balances.loading) return Loading balances...
;
- if (balances.error) return Error fetching balances: {balances.error}
;
-
- return (
-
- {balances.data &&
- balances.data.map((balance) => (
- -
- {balance.symbol}: {balance.amount}
-
- ))}
-
- );
-}
-```
-
-### 5. `useSprinterTransfers`
-
-Generate cross-chain transfer and contract call solutions.
-
-```tsx
-import { useSprinterTransfers } from "@chainsafe/sprinter-react";
-
-function TransferSolution() {
- const { getPoolAssetOnDestination, solution } = useSprinterTransfers();
-
- useEffect(() => {
- const settings = {
- account: "0xYourAddressHere",
- destinationChain: 11155111, // Sepolia testnet
- token: "USDC",
- amount: 1000000, // 1 USDC in smallest denomination
- sourceChains: [84532, 1993], // Optional: source chains to consider
- };
-
- getPoolAssetOnDestination(settings);
- }, []);
-
- if (solution.loading) return Loading transfer solution...
;
- if (solution.error) return Error: {solution.error}
;
-
- return Transfer Solution: {JSON.stringify(solution.data)}
;
-}
-```
-
----
-
-## Summary
-
-The Sprinter React SDK hooks provide an easy way to interact with cross-chain balances, tokens, chains, and transfer solutions. These hooks manage state for you (`loading`, `error`, and `data`) and allow you to integrate Sprinter functionality seamlessly into your React components.
diff --git a/docs/docs/04-react-sdk/04-methods-reference/_category_.json b/docs/docs/04-react-sdk/04-methods-reference/_category_.json
deleted file mode 100644
index 74901d7..0000000
--- a/docs/docs/04-react-sdk/04-methods-reference/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Methods Reference",
- "collapsed": false
-}
diff --git a/docs/docs/04-react-sdk/04-methods-reference/useSprinterBalances.md b/docs/docs/04-react-sdk/04-methods-reference/useSprinterBalances.md
deleted file mode 100644
index 3de79e2..0000000
--- a/docs/docs/04-react-sdk/04-methods-reference/useSprinterBalances.md
+++ /dev/null
@@ -1,82 +0,0 @@
----
-id: use-sprinter-balances
-title: useSprinterBalances
-sidebar_position: 3
----
-
-# `useSprinterBalances`
-
-The `useSprinterBalances` hook allows you to retrieve a user's available token balances across multiple chains. It provides access to both native and fungible token balances for the specified account.
-
-## Usage
-
-### Example
-
-```tsx
-import { useSprinterBalances } from "@chainsafe/sprinter-react";
-import React, { useEffect } from "react";
-
-function BalancesComponent() {
- const { balances, getUserBalances } = useSprinterBalances("0xYourAddress");
-
- useEffect(() => {
- getUserBalances(); // Fetch balances when the component mounts
- }, [getUserBalances]);
-
- if (balances.loading) {
- return Loading...
;
- }
-
- if (balances.error) {
- return Error: {balances.error}
;
- }
-
- return (
-
- {Object.entries(balances.data || {}).map(([symbol, balanceEntry]) => (
- -
- {symbol}: {balanceEntry.total}
-
- ))}
-
- );
-}
-```
-
-## Return Value
-
-The `useSprinterBalances` hook returns an object with the following properties:
-
-- **`balances`**: An object containing:
-
- - `data`: The user's balances across chains, keyed by token symbol. Each token's balances are represented by:
- - `balances`: An array of balances on different chains.
- - `total`: The total balance for the token across all chains.
- - `loading`: A boolean indicating if the balances are being fetched.
- - `error`: A string containing the error message if the fetch fails.
-
-- **`getUserBalances`**: A function that triggers the retrieval of the user's balances.
-
-## Example Response
-
-Here’s an example of what `balances.data` might look like after calling `getUserBalances()`:
-
-```json
-{
- "ETH": {
- "balances": [
- { "balance": "1000000000000000000", "chainId": 11155111, "tokenDecimals": 18 },
- { "balance": "500000000000000000", "chainId": 84532, "tokenDecimals": 18 }
- ],
- "total": "1500000000000000000"
- },
- "USDC": {
- "balances": [{ "balance": "2000000", "chainId": 11155111, "tokenDecimals": 6 }],
- "total": "2000000"
- }
-}
-```
-
-## Parameters
-
-- `getUserBalances()`: A function that fetches the user's balances across all available tokens and native token balances for the specified account.
diff --git a/docs/docs/04-react-sdk/04-methods-reference/useSprinterChains.md b/docs/docs/04-react-sdk/04-methods-reference/useSprinterChains.md
deleted file mode 100644
index fbba8fd..0000000
--- a/docs/docs/04-react-sdk/04-methods-reference/useSprinterChains.md
+++ /dev/null
@@ -1,105 +0,0 @@
----
-id: use-sprinter-chains
-title: useSprinterChains
-sidebar_position: 2
----
-
-# `useSprinterChains`
-
-The `useSprinterChains` hook allows you to fetch and manage the list of supported blockchain networks (chains) in the Sprinter ecosystem. It provides access to details such as chain ID, name, and supported RPC URLs.
-
-## Usage
-
-### Example
-
-```tsx
-import { useSprinterChains } from "@chainsafe/sprinter-react";
-
-function ChainList() {
- const { chains, getAvailableChains } = useSprinterChains();
-
- useEffect(() => {
- getAvailableChains(); // Fetch chains on component mount
- }, []);
-
- if (chains.loading) return Loading chains...
;
- if (chains.error) return Error fetching chains: {chains.error}
;
-
- return (
-
- {chains.data &&
- chains.data.map((chain) => (
- -
- {chain.name} - Chain ID: {chain.chainID}
-
- ))}
-
- );
-}
-```
-
-## Return Value
-
-The `useSprinterChains` hook returns an object with the following properties:
-
-- **`chains`**: An object containing:
-
- - `data`: The list of supported blockchain networks, or `null` if chains haven’t been loaded yet.
- - `loading`: A boolean indicating if the chains are being fetched.
- - `error`: A string containing the error message if the fetch fails.
-
-- **`getAvailableChains`**: A function that triggers the retrieval of available chains.
-
-## Example Response
-
-Here is an example of what the `chains.data` might look like after calling `getAvailableChains()`:
-
-```json
-[
- {
- "chainType": "evm",
- "name": "Sepolia",
- "chainID": 11155111,
- "rpcURLs": ["https://ethereum-sepolia-rpc.publicnode.com/"],
- "logoURI": "https://scan.buildwithsygma.com/assets/icons/evm.svg",
- "blockTime": 12000000000,
- "nativeToken": {
- "name": "ETH",
- "decimals": 18
- }
- },
- {
- "chainType": "evm",
- "name": "B3Sepolia",
- "chainID": 1993,
- "rpcURLs": ["https://sepolia.b3.fun"],
- "logoURI": "https://cdn.b3.fun/b3_logo.svg",
- "blockTime": 1000000000,
- "nativeToken": {
- "name": "ETH",
- "decimals": 18
- }
- },
- {
- "chainType": "evm",
- "name": "BaseSepolia",
- "chainID": 84532,
- "rpcURLs": ["https://sepolia.base.org"],
- "logoURI": "https://scan.buildwithsygma.com/assets/icons/base.svg",
- "blockTime": 12000000000,
- "nativeToken": {
- "name": "ETH",
- "decimals": 18
- }
- }
-]
-```
-
-## Parameters
-
-- `getAvailableChains()`: A function that fetches the list of available blockchain networks from the Sprinter Intent Engine.
-
-## Notes
-
-- **Automatic Fetch**: The `getAvailableChains` function is automatically called when `SprinterContext` is initialized, so chains will be available in your app as soon as the context is ready.
-- If the chains have already been fetched, the hook will return the cached list for better performance.
diff --git a/docs/docs/04-react-sdk/04-methods-reference/useSprinterTokens.md b/docs/docs/04-react-sdk/04-methods-reference/useSprinterTokens.md
deleted file mode 100644
index 2025578..0000000
--- a/docs/docs/04-react-sdk/04-methods-reference/useSprinterTokens.md
+++ /dev/null
@@ -1,92 +0,0 @@
----
-id: use-sprinter-tokens
-title: useSprinterTokens
-sidebar_position: 1
----
-
-# `useSprinterTokens`
-
-The `useSprinterTokens` hook allows you to fetch and manage the list of supported fungible tokens across different blockchain networks in the Sprinter ecosystem. It provides access to the token details and offers functionality to retrieve the tokens directly within your React components.
-
-## Usage
-
-### Example
-
-```tsx
-import { useSprinterTokens } from "@chainsafe/sprinter-react";
-
-function TokenList() {
- const { tokens, getAvailableTokens } = useSprinterTokens();
-
- useEffect(() => {
- getAvailableTokens(); // Fetch tokens on component mount
- }, []);
-
- if (tokens.loading) return Loading tokens...
;
- if (tokens.error) return Error: {tokens.error}
;
-
- return (
-
- {tokens.data &&
- tokens.data.map((token) => (
- -
- {token.name} - {token.symbol}
-
- ))}
-
- );
-}
-```
-
-## Return Value
-
-The `useSprinterTokens` hook returns an object with the following properties:
-
-- **`tokens`**: An object containing:
-
- - `data`: The list of supported tokens, or `null` if tokens haven’t been loaded yet.
- - `loading`: A boolean indicating if the tokens are being fetched.
- - `error`: A string containing the error message if the fetch fails.
-
-- **`getAvailableTokens`**: A function that triggers the retrieval of available tokens, though it is automatically called when the context is initialized.
-
-## Example Response
-
-Here is an example of what the `tokens.data` might look like after calling `getAvailableTokens()`:
-
-```json
-[
- {
- "name": "USDC",
- "decimals": 6,
- "symbol": "USDC",
- "logoURI": "https://raw.githubusercontent.com/trustwallet/assets/8cee462de2cc16eed81ded90ced5dbd64f7145cb/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png",
- "addresses": {
- "11155111": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
- "1993": "0xE61e5ed4c4f198c5384Ef57E69aAD1eF0c911004",
- "84532": "0x036CbD53842c5426634e7929541eC2318f3dCF7e"
- }
- },
- {
- "name": "Wrapped ETH",
- "decimals": 18,
- "symbol": "WETH",
- "logoURI": "https://raw.githubusercontent.com/trustwallet/assets/8cee462de2cc16eed81ded90ced5dbd64f7145cb/blockchains/optimism/assets/0x4200000000000000000000000000000000000006/logo.png",
- "addresses": {
- "11155111": "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14",
- "1993": "0x3538f4C55893eDca690D1e4Cf9Fb61FB70cd0DD8",
- "84532": "0x4200000000000000000000000000000000000006"
- }
- }
-]
-```
-
-## Parameters
-
-- `getAvailableTokens()`: A function that fetches the list of available tokens from the Sprinter Intent Engine. This is automatically triggered when `SprinterContext` is initialized, but can be called manually if needed.
-
-## Notes
-
-- **Automatic Fetch**: When `SprinterContext` is initialized, the `getAvailableTokens` function is automatically called to pre-fetch token data.
-- If the tokens have already been fetched, the hook will return the cached list to optimize performance.
-- Tokens are fetched from Sprinter’s supported blockchain networks.
diff --git a/docs/docs/04-react-sdk/04-methods-reference/useSprinterTransfers.md b/docs/docs/04-react-sdk/04-methods-reference/useSprinterTransfers.md
deleted file mode 100644
index 3c97c56..0000000
--- a/docs/docs/04-react-sdk/04-methods-reference/useSprinterTransfers.md
+++ /dev/null
@@ -1,106 +0,0 @@
----
-id: use-sprinter-transfers
-title: useSprinterTransfers
-sidebar_position: 5
----
-
-# `useSprinterTransfers`
-
-The `useSprinterTransfers` hook provides a simplified interface for generating cross-chain transfer solutions and contract calls using the Sprinter Intent Engine. This hook wraps the following SDK methods:
-
-- `getTransfer`: Single-hop token transfers across chains.
-- `getTransferWithHook`: Single-hop token transfers combined with a contract call on the destination chain.
-- `getPoolAssetOnDestination`: Aggregates token balances across multiple chains into a single destination.
-- `getPoolAssetOnDestinationWithHook`: Aggregates token balances and performs a contract call on the destination chain.
-- `getSweep`: A function that generates a quote to transfer the full token balances of source chains to a destination chain
-
-You can trigger any of these methods via the hook to fetch a cross-chain solution.
-
-## Usage
-
-### Example
-
-```tsx
-import { useSprinterTransfers } from "@chainsafe/sprinter-react";
-import React, { useEffect } from "react";
-
-function TransferComponent() {
- const { solution, getPoolAssetOnDestination } = useSprinterTransfers();
-
- useEffect(() => {
- const settings = {
- account: "0xYourAddress",
- destinationChain: 11155111, // Sepolia Testnet
- token: "USDC",
- amount: 1000000, // 1 USDC (smallest denomination)
- sourceChains: [84532, 1993], // Optional: source chains to consider
- };
-
- getPoolAssetOnDestination(settings); // Fetch transfer solution when the component mounts
- }, [getPoolAssetOnDestination]);
-
- if (solution.loading) return Loading transfer solution...
;
- if (solution.error) return Error fetching transfer solution: {solution.error}
;
-
- return Transfer Solution: {JSON.stringify(solution.data)}
;
-}
-```
-
-## Return Value
-
-The `useSprinterTransfers` hook returns an object with the following properties:
-
-- **`solution`**: An object containing:
-
- - `data`: The transfer solution, or `null` if not yet retrieved.
- - `loading`: A boolean indicating if the solution is being fetched.
- - `error`: A string containing the error message if the fetch fails.
-
-- **`getTransfer`**: A function that generates a single-hop token transfer solution.
-- **`getTransferWithHook`**: A function that generates a single-hop token transfer combined with a contract call.
-- **`getPoolAssetOnDestination`**: A function that generates a solution to aggregate balances from multiple chains into a single destination.
-- **`getPoolAssetOnDestinationWithHook`**: A function that generates a solution to aggregate balances and execute a contract call on the destination chain.
-- **`getSweep`**: A function that generates a quote to transfer the full token balances of source chains to a destination chain
-
-## Example Response
-
-Here’s an example of what the `solution.data` might look like after calling `getPoolAssetOnDestination()`:
-
-```json
-[
- {
- "sourceChain": 84532,
- "destinationChain": 11155111,
- "sourceTokenAddress": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
- "destinationTokenAddress": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
- "amount": "1000000",
- "duration": 60000,
- "fee": { "amount": "100000", "amountUSD": 0.1 },
- "gasCost": { "amount": "200000", "amountUSD": 0.02 },
- "tool": {
- "name": "Sygma",
- "logoURI": "https://sygma.com/logo.png"
- },
- "transaction": {
- "from": "0xYourAddress",
- "to": "0xBridgeContractAddress",
- "value": "0",
- "data": "0x...",
- "gasPrice": "0x...",
- "gasLimit": "0x..."
- }
- }
-]
-```
-
-## Parameters
-
-Each method accepts a `settings` parameter, which varies depending on the operation:
-
-- **`getTransfer`**: See [SDK Transfer Method Reference](../../sdk/methods-reference/transfer/transfer).
-- **`getTransferWithHook`**: See [SDK Transfer with Contract Call Method Reference](../../sdk/methods-reference/transfer/transfer-with-hook).
-- **`getPoolAssetOnDestination`**: See [SDK Pool Asset Method Reference](../../sdk/methods-reference/pool-asset-on-destination/pool-asset-on-destination).
-- **`getPoolAssetOnDestinationWithHook`**: See [SDK Pool Asset with Contract Call Method Reference](../../sdk/methods-reference/pool-asset-on-destination/pool-asset-on-destination-with-hook).
-- **`getSweep`**: See [Sweep Method Reference](../../sdk/methods-reference/transfer/sweep).
-
-Each method calls the Sprinter SDK's corresponding function and returns the intent-based solution for cross-chain transfers or contract calls.
diff --git a/docs/docs/04-react-sdk/index.md b/docs/docs/04-react-sdk/index.md
deleted file mode 100644
index 0b193da..0000000
--- a/docs/docs/04-react-sdk/index.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-id: react-sdk-overview
-title: React SDK
-sidebar_position: 4
----
-
-# React SDK Overview
-
-The **Sprinter React SDK** provides a set of tools and hooks to interact with the Sprinter Intent Engine directly within React applications. It allows developers to easily manage cross-chain balance aggregation and bridging solutions using React components.
-
-## Key Features
-
-- **Cross-Chain Balance Retrieval**: Fetch user balances across multiple supported blockchains.
-- **Bridging Solutions**: Generate solutions for cross-chain token transfers and contract calls.
-- **Contract Call Solutions**: Generate solutions to perform contract calls along with cross-chain transfers.
-- **React Hooks**: Simplified and declarative access to Sprinter's core functionality through React hooks.
-
-## Use Cases
-
-1. **Balance Aggregation**: Aggregate a user’s balance for a specific token across multiple chains.
-2. **Token Bridging**: Create bridging solutions to transfer tokens across different chains.
-3. **Contract Interactions**: Retrieve solutions for executing contract calls while bridging tokens.
-
-For more detailed usage and examples, refer to the Methods Reference.
diff --git a/docs/docs/05-breaking-changes.md b/docs/docs/05-breaking-changes.md
deleted file mode 100644
index e6f78ff..0000000
--- a/docs/docs/05-breaking-changes.md
+++ /dev/null
@@ -1,326 +0,0 @@
----
-id: breaking-changes
-title: Breaking Changes
-sidebar_position: 5
----
-
-# Breaking Changes
-
-## SDK from Version 0.3.0 to 1.0.0
-
-### Summary of Changes:
-
-- **New Methods**:
- - `poolAssetOnDestination`, `poolAssetOnDestinationWithHook`, `transfer`, and `transferWithHook` replace the old `getSolution` and `getCallSolution` methods.
-- **Simplified API**: Each method now has a focused purpose, making it easier to understand and use.
-- **Parameter Renaming**: `whitelistedSourceChains` has been renamed to `sourceChains` for clarity.
-
-
- **1. Method Refactoring**
-
-#### Old API:
-
-Previously, there were two primary methods:
-
-- `getSolution`: Used for both **balance aggregation** and **contract calls**.
-- `getCallSolution`: Focused on **bridging with contract calls**.
-
-These methods were generalized, accepting complex and multifaceted parameters, which often led to confusion about the exact functionality.
-
-#### New API:
-
-The methods have been **separated and simplified** to offer more clarity and specialization. Now, there are four distinct methods:
-
-1. **`poolAssetOnDestination`**:
-
- - Used to **aggregate token balances** from multiple chains without contract interaction.
-
-2. **`poolAssetOnDestinationWithHook`**:
-
- - Used to **aggregate balances and perform a contract call** on the destination chain.
-
-3. **`transfer`**:
-
- - Focuses on a **single-hop token transfer** from one chain to another, without any contract call.
-
-4. **`transferWithHook`**:
- - Transfers tokens with an **additional contract call** on the destination chain.
-
-#### Impact:
-
-- **Simpler API**: Users no longer need to handle complex or overloaded methods like `getSolution` or `getCallSolution`. Now, they can choose the right method for their needs.
-
-##### Example Change:
-
-- **Old usage (`getSolution`)**:
-
- ```ts
- sprinter.getSolution({
- account: "0xYourAddressHere",
- destinationChain: 11155111,
- token: "USDC",
- amount: 1000000,
- contractCall: {
- callData: "0xabcdef",
- contractAddress: "0xContractAddress",
- gasLimit: 21000,
- },
- });
- ```
-
-- **New usage (`poolAssetOnDestinationWithHook`)**:
- ```ts
- sprinter.poolAssetOnDestinationWithHook({
- account: "0xYourAddressHere",
- destinationChain: 11155111,
- token: "USDC",
- amount: 1000000,
- contractCall: {
- callData: "0xabcdef",
- contractAddress: "0xContractAddress",
- gasLimit: 21000,
- },
- });
- ```
-
-
-
-
- **2. Parameter Name Changes**
-
-#### Old API:
-
-- **`whitelistedSourceChains`**: A parameter that allowed users to specify which source chains were eligible for the solution.
-
-#### New API:
-
-- **`sourceChains`**: The same functionality has been retained but with a **simpler, cleaner name**.
-
-#### Impact:
-
-- **No change in functionality**: The purpose of this parameter remains the same.
-- **Migration Tip**: Users should simply update the parameter name in their code.
-
-##### Example Change:
-
-- **Old usage (`whitelistedSourceChains`)**:
-
- ```ts
- sprinter.getSolution({
- account: "0xYourAddressHere",
- destinationChain: 11155111,
- token: "USDC",
- amount: 1000000,
- whitelistedSourceChains: [84532, 137],
- });
- ```
-
-- **New usage (`sourceChains`)**:
- ```ts
- sprinter.poolAssetOnDestination({
- account: "0xYourAddressHere",
- destinationChain: 11155111,
- token: "USDC",
- amount: 1000000,
- sourceChains: [84532, 137],
- });
- ```
-
-
-
----
-
-## React SDK Refactor: From Version 0.2.1 to 0.3.0
-
-### Summary of Changes:
-
-- **New Methods**:
- - `getTransfer`, `getTransferWithHook`, `getPoolAssetOnDestination`, and `getPoolAssetOnDestinationWithHook` replace the old `getSolution` and `getCallSolution` methods.
-- **Parameter Structure**: Methods now accept a single object as a parameter, instead of individual arguments.
-- **Parameter Renaming**: `whitelistedSourceChains` has been renamed to `sourceChains`.
-- **SDK as Peer Dependency**: The `@chainsafe/sprinter-sdk` is now a peer dependency, simplifying updates.
-
-
- **1. Method Refactoring**
-
-#### Old API:
-
-Previously, there were two primary methods in the React SDK:
-
-- `getSolution`: Used for both **balance aggregation** and **contract calls**.
-- `getCallSolution`: Focused on **bridging with contract calls**.
-
-These methods were generalized, requiring multiple parameters, leading to confusion about their exact purpose.
-
-#### New API:
-
-The methods have been split into specialized methods to clarify their purpose:
-
-1. **`getPoolAssetOnDestination`**:
-
- - Handles **balance aggregation** from multiple chains without contract interaction.
-
-2. **`getPoolAssetOnDestinationWithHook`**:
-
- - Handles **balance aggregation** from multiple chains with a contract call on the destination chain.
-
-3. **`getTransfer`**:
-
- - Used for **single-hop transfers** between chains without any contract call.
-
-4. **`getTransferWithHook`**:
- - Used for **single-hop transfers** with a contract call on the destination chain.
-
-#### Impact:
-
-- **Simplified API**: Users no longer need to manage overloaded methods. Instead, each method has a clear, focused purpose, reducing complexity.
-
-##### Example Change:
-
-- **Old usage (`getSolution`)**:
-
- ```ts
- getSolution(account, destinationChain, token, amount, threshold, whitelistedSourceChains);
- ```
-
-- **New usage (`getTransferWithHook`)**:
- ```ts
- getTransferWithHook({
- account,
- destinationChain,
- token,
- amount,
- threshold,
- sourceChains,
- });
- ```
-
-
-
-
- **2. Parameter Structure Changes**
-
-#### Old API:
-
-In previous versions, parameters were passed individually for each method:
-
-```typescript
-getSolution(
- account: Address,
- destinationChain: ChainID,
- token: TokenSymbol,
- amount: number,
- threshold?: number,
- whitelistedSourceChains?: ChainID[]
-)
-```
-
-#### New API:
-
-Now, methods accept a **single object** as an argument (e.g., `settings`). This aligns with the SDK design, making it easier to manage and extend.
-
-```typescript
-getTransfer({
- account,
- destinationChain,
- token,
- amount,
- threshold,
- sourceChains,
-});
-```
-
-#### Impact:
-
-- **Migration Tip**: Instead of passing individual parameters, pass a single object that encapsulates all the necessary values.
-
-##### Example Change:
-
-- **Old Usage**:
-
- ```typescript
- getSolution(account, destinationChain, token, amount, threshold, whitelistedSourceChains);
- ```
-
-- **New Usage**:
- ```typescript
- getTransfer({
- account,
- destinationChain,
- token,
- amount,
- threshold,
- sourceChains,
- });
- ```
-
-
-
-
- **3. Parameter Renaming**
-
-#### Old API:
-
-- **`whitelistedSourceChains`**: This parameter allowed users to specify the source chains for bridging.
-
-#### New API:
-
-- **`sourceChains`**: The functionality remains the same, but the name has been simplified for clarity.
-
-#### Impact:
-
-- **No change in functionality**: Users just need to update their code to use the new parameter name.
-
-##### Example Change:
-
-- **Old usage**:
-
- ```ts
- getSolution({
- account: "0xYourAddressHere",
- destinationChain: 11155111,
- token: "USDC",
- amount: 1000000,
- whitelistedSourceChains: [84532, 137],
- });
- ```
-
-- **New usage**:
- ```ts
- getTransfer({
- account: "0xYourAddressHere",
- destinationChain: 11155111,
- token: "USDC",
- amount: 1000000,
- sourceChains: [84532, 137],
- });
- ```
-
-
-
-
- **4. SDK as Peer Dependency**
-
-#### Old Setup:
-
-Previously, the React SDK bundled the `@chainsafe/sprinter-sdk` as a regular dependency. This meant that updating the SDK required updating the React SDK at the same time.
-
-#### New Setup:
-
-`@chainsafe/sprinter-sdk` is now a **peer dependency**, which allows independent updates to the SDK without needing to update the React SDK.
-
-#### Impact:
-
-- **Migration Tip**: Ensure that `@chainsafe/sprinter-sdk` is installed as a dependency in your project.
-
-##### Example (`package.json`):
-
-```json
-{
- "peerDependencies": {
- "@chainsafe/sprinter-sdk": "^0.4.0"
- }
-}
-```
-
-
diff --git a/docs/docs/05-sprnt.md b/docs/docs/05-sprnt.md
new file mode 100644
index 0000000..7b62ab6
--- /dev/null
+++ b/docs/docs/05-sprnt.md
@@ -0,0 +1,35 @@
+---
+id: sprnt-token
+title: SPRNT
+sidebar_position: 5
+---
+
+# SPRNT Token
+
+SPRNT is the native governance and utility token of the Sprinter Protocol. It is used to incentivize liquidity providers, solvers, and community participants.
+
+## Key Features & Utility
+
+### Governance
+
+- Stake SPRNT to earn **veSPRNT**
+- Participate in on-chain governance decisions
+
+### Incentives & Rewards
+
+- Distributed to LPs and solvers for protocol usage
+- Used to bootstrap solver routes and usage
+
+### Bonding Pools
+
+- Solvers can create Bonding Pools, where SPRNT can be bonded
+- Bonded SPRNT will allow solvers to have more favourable borrowing conditions
+- Bonding Pools will be controlled by governance and include slashing mechanisms
+
+## Token Supply & Allocation
+
+- **Total Supply:** 1,000,000,000 SPRNT
+- **Token Standard:** ERC20
+- **Network:** Ethereum Mainnet
+
+More details on the token generation event and distribution will be released soon.
diff --git a/docs/docs/07-governance.md b/docs/docs/07-governance.md
new file mode 100644
index 0000000..7fb64e0
--- /dev/null
+++ b/docs/docs/07-governance.md
@@ -0,0 +1,46 @@
+---
+id: governance
+title: Governance
+sidebar_position: 7
+---
+
+# Governance
+
+Sprinter Protocol governance is currently managed via two multisigs, with plans to gradually transition to community control.
+
+## Governance Structure
+
+### 1. Operations Admin Multisig
+
+- **Type:** 3-of-6
+- **Managed by:** Sprinter Labs team
+- **Responsibilities:**
+ - Routine upgrades
+ - Profit withdrawals
+ - Emergency pauses
+
+#### Roles:
+
+- `DEPOSIT_PROFIT_ROLE`
+- `WITHDRAW_PROFIT`
+- `PAUSER`
+- `REBALANCE`
+
+### 2. Super Admin Multisig
+
+- **Type:** 3-of-6
+- **Managed by:** Ethereum community members
+- **Responsibilities:**
+ - Upgrading protocol contracts
+ - Asset and configuration adjustments
+
+#### Roles:
+
+- `ASSETS_ADJUSTER`
+- `ADMIN` (Upgrades)
+
+## Long-Term Vision
+
+- Gradual shift to veSPRNT-based DAO governance
+- Protocol parameters and fee splits managed by tokenholders
+- On-chain voting for upgrades, integrations, emissions
diff --git a/docs/docs/08-partnerships.md b/docs/docs/08-partnerships.md
new file mode 100644
index 0000000..b54ea6d
--- /dev/null
+++ b/docs/docs/08-partnerships.md
@@ -0,0 +1,21 @@
+---
+id: partnerships
+title: Partnerships
+sidebar_position: 8
+---
+
+# Partnerships & Collaborations
+
+Sprinter is currently operating in private beta and selectively partnering with forward-thinking teams.
+
+## Who We're Looking to Partner With
+
+- CrossChain DEXs & Intent-Based Protocolschain execution
+- Liquidity Providers interested in sustainable, high-yield opportunities
+
+## Get in Touch
+
+- **Email:** [hello@sprinter.tech](mailto:hello@sprinter.tech)
+- **Telegram:** [@sprinter_tech](https://t.me/sprinter_tech)
+
+Let’s build the future of crosschain liquidity together.
diff --git a/docs/docs/09 -Resources/01-Audits.md b/docs/docs/09 -Resources/01-Audits.md
new file mode 100644
index 0000000..05770e1
--- /dev/null
+++ b/docs/docs/09 -Resources/01-Audits.md
@@ -0,0 +1,10 @@
+---
+id: Audit
+title: Sprinter Audits
+sidebar_position: 11
+---
+
+## Audits
+
+- [Sprinter Hub](https://github.com/sprintertech/sprinter-stash-contracts/blob/main/audits/VAR_Sygma_labs_Sprinter_liquidity_250212-final.pdf)
+- [Sprinter Liquidity Pools](https://github.com/sprintertech/sprinter-stash-contracts/blob/main/audits/VAR_Sygma_labs_Sprinter_liquidity_250212-final.pdf)
diff --git a/docs/docs/09 -Resources/02-glossary.md b/docs/docs/09 -Resources/02-glossary.md
new file mode 100644
index 0000000..a4c226c
--- /dev/null
+++ b/docs/docs/09 -Resources/02-glossary.md
@@ -0,0 +1,137 @@
+---
+id: glossary
+title: Sprinter Glossary
+sidebar_position: 12
+---
+
+### Account Abstraction (AA)
+
+A design that moves away from traditional externally owned accounts (EOAs) and allows more flexible wallet interactions.
+
+### Bridges
+
+Protocols that facilitate asset and data transfer between different blockchain networks. Bridges can be trust-minimized (e.g., ZK-proofs, MPC) or centralized.
+
+### Crosschain Finality
+
+Ensuring that transactions on one blockchain are finalized and verifiable on another without rollback risks.
+
+### Crosschain Governance
+
+Systems that enable decentralized governance across multiple chains without requiring users to vote on each network separately.
+
+### Crosschain Messaging
+
+A communication layer that enables smart contracts and applications on different blockchains to exchange messages and trigger actions.
+
+### Decentralized Order Flow
+
+A distributed mechanism where the process is open, permissionless, and avoids reliance on a central entity (such as a centralized exchange)
+
+### Execution Environments
+
+Different blockchain execution layers (e.g., EVM, WASM) that need to be abstracted for smooth multi-chain interactions.
+
+### Executable Intents
+
+Intents that include conditions and constraints to ensure execution only happens when all state change criteria are met.
+
+### Fair Ordering Protocols
+
+Systems that prevent MEV extraction and ensure user transactions are processed fairly in intent-based architectures.
+
+### Fill
+
+A fill represents the full lifecycle: Detecting a user intent ➔ Borrowing liquidity ➔ Executing the transaction ➔ Repaying liquidity ➔ Realizing solver and protocol profits.
+
+### Gas Abstraction
+
+A mechanism where users don’t need to hold native tokens to pay for gas fees, allowing transactions to be executed with alternative assets.
+
+### Intent Aggregation
+
+The process of bundling multiple user intents to optimize execution costs and efficiency.
+
+### Intent Standardization
+
+The process of creating common formats for intent expression so that multiple solvers can compete on execution.
+
+### Intent Systems
+
+A model where users specify desired outcomes, and solvers or order flow networks execute transactions accordingly.
+
+### Intent-Based Arbitrage
+
+Arbitrage that is facilitated through intents, allowing solvers or execution agents to optimize price discrepancies across multiple venues or chains without needing the user to manually define trade paths.
+
+### Interop
+
+The ability of multiple blockchain networks to communicate and share information in a seamless, trust-minimized, and permissionless way. This enables assets, smart contracts, and transactions to interact across chains without requiring users to manage complex bridging processes.
+
+### Liquidity Mining
+
+Incentivizing users to provide liquidity to decentralized protocols, crucial for ensuring deep liquidity in interoperable ecosystems.
+
+### MEV (Maximal Extractable Value)
+
+The value miners, validators, or solvers can extract by reordering transactions, with growing importance in MEV-resistant routing across chains.
+
+### Order Flow Auctions
+
+A mechanism where solvers compete to execute user intents by offering the most efficient execution path.
+
+### Recursive SNARKs
+
+A cryptographic method for verifying multiple proofs efficiently, often used for crosschain validation.
+
+### Solver Competition
+
+A model where multiple solvers bid to execute a user’s intent based on optimal execution parameters.
+
+### Solver Networks
+
+Decentralized networks of solvers that execute user intents efficiently while minimizing costs and MEV risks.
+
+### Solvers
+
+Automated agents that find and execute the most efficient way to fulfill a user’s intent, optimizing for cost, speed, and security.
+
+### Sprinter Solve Route
+
+Gets the finalized execution package returned by `/v2/route` which contains all necessary data to execute a transaction. It builds on a quote by including calldata, selected liquidity paths, slippage tolerances, and chain-specific details. Routes are consumed directly by solvers or smart contracts to simulate and execute cross-chain swaps or intent fills.
+
+### Stash Borrow Cost
+
+A borrow cost is the preliminary **estimated fee** a solver would incur to borrow credit from Sprinter Stash. It is returned off-chain via the Stash API and helps solvers determine if pursuing a fill is profitable. Borrow cost includes expected gas, risk premiums, protocol fees, and capital access costs — but it is not a binding or reserved price.
+
+### Stash Borrow Quote
+
+A **borrow quote** is the final, **authorized borrowing offer** issued by Sprinter Stash when a solver decides to proceed with a fill. It reserves credit under specific conditions, allowing solvers to confidently execute the crosschain transaction.
+
+### State Proofs
+
+Cryptographic proofs that verify the state of one blockchain on another without needing a centralized validator.
+
+### Swaps
+
+Asset exchanges that can occur within a single chain or across multiple chains using interoperability protocols.
+
+### Threshold Signature Scheme (TSS)
+
+A security mechanism where multiple signatures are required to execute a transaction across chains.
+
+### Threshold Signatures (TSS)
+
+A cryptographic scheme used in cross transactions to prevent single points of failure.
+
+### Trust-Minimized Interoperability
+
+A security model that ensures crosschain transactions can be verified without relying on a single centralized authority.
+
+### Unified Liquidity Pools
+
+Crosschain pools that allow users to access liquidity seamlessly without needing to bridge assets manually.
+
+### Universal Smart Accounts
+
+Wallet accounts that function across multiple blockchains and support advanced execution logic.
diff --git a/docs/docs/09 -Resources/Sprinter DOCS.code-workspace b/docs/docs/09 -Resources/Sprinter DOCS.code-workspace
new file mode 100644
index 0000000..9e0bde5
--- /dev/null
+++ b/docs/docs/09 -Resources/Sprinter DOCS.code-workspace
@@ -0,0 +1,10 @@
+{
+ "folders": [
+ {
+ "path": "../../..",
+ },
+ {
+ "path": "../../..",
+ },
+ ],
+}
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 719ab30..20fd2b5 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -1,16 +1,17 @@
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
+import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
const config: Config = {
title: "Sprinter",
- tagline: "Multichain interactions that feel like one",
+ tagline: "The Fast Lane For Crosschain",
favicon: "img/sprinter.ico",
url: "https://docs.sprinter.buildwithsygma.com/",
baseUrl: "/",
- organizationName: "ChainSafe",
+ organizationName: "Sprinter",
projectName: "sprinter-ts",
onBrokenLinks: "throw",
@@ -30,6 +31,7 @@ const config: Config = {
remarkPlugins: [
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
],
+ docItemComponent: "@theme/ApiItem",
sidebarPath: "./sidebars.ts",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
@@ -44,6 +46,14 @@ const config: Config = {
],
themeConfig: {
+ mermaid: {
+ theme: { light: "neutral", dark: "dark" },
+ },
+ colorMode: {
+ defaultMode: "dark",
+ disableSwitch: false, // optional: hide theme toggle switch
+ respectPrefersColorScheme: false, // always force dark unless user switches
+ },
navbar: {
title: "Sprinter",
logo: {
@@ -53,8 +63,8 @@ const config: Config = {
},
items: [
{
- href: "https://poc.sprinter.buildwithsygma.com/",
- label: "POC",
+ href: "https://app.sprinter.tech/",
+ label: "Stash",
position: "left",
},
{
@@ -63,7 +73,7 @@ const config: Config = {
position: "right",
},
{
- href: "https://github.com/ChainSafe/sprinter-ts",
+ href: "https://github.com/sprintertech",
label: "GitHub",
position: "right",
},
@@ -79,14 +89,6 @@ const config: Config = {
label: "Introduction",
to: "/",
},
- {
- label: "SDK",
- to: "/sdk",
- },
- {
- label: "React SDK",
- to: "/react-sdk/",
- },
],
},
{
@@ -144,7 +146,45 @@ const config: Config = {
indexDocs: true,
},
],
+ [
+ "docusaurus-plugin-openapi-docs",
+ {
+ id: "openapi",
+ docsPluginId: "classic",
+ config: {
+ // petstore: { // EXAMPLE
+ // specPath: "src/api/petstore-utf8.yaml",
+ // outputDir: "docs/../src/api/generated/petstore",
+ // downloadUrl:
+ // "https://raw.githubusercontent.com/PaloAltoNetworks/docusaurus-template-openapi-docs/main/examples/petstore.yaml",
+ // sidebarOptions: {
+ // groupPathsBy: "tag",
+ // },
+ // } satisfies OpenApiPlugin.Options,
+ solve: {
+ specPath: "src/api/solve-openapi.yaml",
+ outputDir: "docs/../src/api/generated/solve",
+ sidebarOptions: {
+ groupPathsBy: "tag",
+ },
+ } satisfies OpenApiPlugin.Options,
+ stash: {
+ specPath: "src/api/stash-openapi.yaml",
+ outputDir: "docs/../src/api/generated/stash",
+ sidebarOptions: {
+ groupPathsBy: "tag",
+ },
+ } satisfies OpenApiPlugin.Options,
+ },
+ },
+ ],
],
+
+ themes: ["docusaurus-theme-openapi-docs", "@docusaurus/theme-mermaid"],
+
+ markdown: {
+ mermaid: true,
+ },
};
export default config;
diff --git a/docs/package.json b/docs/package.json
index a0ab4d2..65b8811 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -16,28 +16,40 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
+ "generate-api-docs": "docusaurus gen-api-docs all",
"typecheck": "tsc"
},
"dependencies": {
"@chainsafe/sprinter-sdk": "workspace:^",
"@cmfcmf/docusaurus-search-local": "latest",
- "@docusaurus/core": "^3.5.2",
- "@docusaurus/preset-classic": "^3.5.2",
- "@docusaurus/remark-plugin-npm2yarn": "^3.5.2",
+ "@docusaurus/core": "^3.7.0",
+ "@docusaurus/preset-classic": "^3.7.0",
+ "@docusaurus/remark-plugin-npm2yarn": "^3.7.0",
+ "@docusaurus/theme-mermaid": "^3.7.0",
"@mdx-js/react": "^3.0.1",
"clsx": "^2.1.1",
"d3": "^7.9.0",
"d3-sankey": "^0.12.3",
+ "docusaurus-plugin-openapi-docs": "^4.3.7",
+ "docusaurus-theme-openapi-docs": "^4.3.7",
"prism-react-renderer": "^2.3.1",
"react": "^18.3.1",
- "react-dom": "^18.3.1"
+ "react-dom": "^18.3.1",
+ "styled-components": "^6.1.17"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "^3.5.2",
- "@docusaurus/tsconfig": "^3.5.2",
- "@docusaurus/types": "^3.5.2",
+ "@docusaurus/module-type-aliases": "^3.7.0",
+ "@docusaurus/plugin-content-docs": "^3.7.0",
+ "@docusaurus/theme-common": "^3.7.0",
+ "@docusaurus/tsconfig": "^3.7.0",
+ "@docusaurus/types": "^3.7.0",
+ "@docusaurus/utils": "^3.7.0",
+ "@docusaurus/utils-validation": "^3.7.0",
"@types/d3": "^7",
"@types/d3-sankey": "^0",
+ "@types/react": "^19.1.2",
+ "docusaurus-plugin-sass": "^0.2.6",
+ "sass": "^1.87.0",
"typescript": "~5.2.2"
},
"browserslist": {
diff --git a/docs/src/api/generated/solve/get-quote.api.mdx b/docs/src/api/generated/solve/get-quote.api.mdx
new file mode 100644
index 0000000..48591d5
--- /dev/null
+++ b/docs/src/api/generated/solve/get-quote.api.mdx
@@ -0,0 +1,183 @@
+---
+id: get-quote
+title: "getQuote"
+description: "Get a price estimation quote"
+sidebar_label: "getQuote"
+hide_title: true
+hide_table_of_contents: true
+api: eJztlt9v2zYQx/+VA7GHdpMb2ZHr2G+K43RGX7okBQoYXkqL54iNRCrkybVn6H8vKPpXYsfZAuxhWP1m8u745eeOp1syXaDhJLUaCtZjd0h/lJqQBUygTYws3BbrsQ9IwKEwMkFASzKvfeBhZVxww3MkNJb1RksmnctDiWbBAqZ4jqzHeK5LRbdS7cW+SRH8LugpkL5HZYE0WMwykAoEJjLnGShN9aksYDZJMeest3wSKt6E4QoGV/1W6OMBt8A3gSwZqe7gjdJgE4mK5FQmm/BvWcBoUTjN3rC+HxEad8Kfo7DRHf/2CwsYznleZM6uGe79XBBJ9e6NU+CVsSpgBh9KaVCwHpkSXwpTBYdx1td6jubqzkIYtBuUR7C1QpgsCGFAKRos840rqkQLFB5finP4LimFr+H8KxQGp3J+nFU4H/HGNG5cOmbLKKweYwvn78+bnXbUiQZn3bAb9aPognfPJt12NECBcT/qtludpggvd2jGXtpxkv8g8nHAuqS/R3hSLv5fgPthi/P4tDtptU4vB2cXYRxiux9dtjoYX3TDs9N+p/2+n7RYNXaBbKGVRevQtMJwn1DddsCWSYLWTsssW0BikBMKFrBEK0JFzosXRSaT+qGefLPOdfks9etNNN+oPFxKEXBeYEIoQJdUlLRqP1vWevINE/e/MK5BkvTKVz3MFcV/sPU8Suho9zLjrUedh6tVulhVOa/oUMLOuQAXDi29PkMDY7SBdXX4/AgkLjN7IBm76tF5OuGPM+SX9875vcy5AoNc8EmGUFtBjtbyOzzAfItXKltOp7JO1ZNicWTW1Op7bGg19wV8VrykVBv5FwpowFDNeCYFxJ+GcI+LnwB3AbYPldtQuVfgXhCaGRqv4Ce3LbcqYDlSqldjnO8cKeuxk/WQZjEpjaRFPaLFhfyIi7h0JqOx69Hr7WuHzF9q12i5FsvrRRb4r2aKXKDZfja/NOJPw4Y3eNIgfa171lNtck5g728zOcPbX+tLSTXV9UGry11/5wVMFnCecZUcjFdaFBsLcPYsYDM01ps034XvwsYEibuvWaEt5bwui5XYOyQ4OO8ut3X10ui7okI4p5Mi41K5o0qTuSA+AyPmbccBS7Ult7BcTrjFzyarKrfsRw+XFiGtKxTBelOeWTwi683VqijfwisG6IOqXSd6PKjPeFY6u3pKerW258bRIyJ2xtt/SYMf2F6U4AfArYax+2OkE1E/nGD9Alz2vGOcJFjseu01Jhdl81g/DG5YVf0AB+2RRg==
+sidebar_class_name: "get api-method"
+info_path: ../src/api/generated/solve/swap-by-blanc
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+
+
+
+
+Get a price estimation quote
+
+
+
+
+
+
+
+
diff --git a/docs/src/api/generated/solve/get-route-v-2.api.mdx b/docs/src/api/generated/solve/get-route-v-2.api.mdx
new file mode 100644
index 0000000..48c487c
--- /dev/null
+++ b/docs/src/api/generated/solve/get-route-v-2.api.mdx
@@ -0,0 +1,238 @@
+---
+id: get-route-v-2
+title: "getRouteV2"
+description: "Get a route for execution with additional parameters"
+sidebar_label: "getRouteV2"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWG1vGjkQ/iuWdSclvYUsGwiBb4SQHrovVZJWJ0U5atYDuN21N34hcIj/fpr1Znmnbar70Lvybe3x+JnH48czLKjKQDMrlOxz2qZjsLfKWfgQ0YByMLEWGU7SNn0LljCicZaMlCYwg9jhHHkWdkIY5wK/WEIyplkKFrShAV37aD8sqEBXTw70nAZUshRom7JUOWkHQu7seT8B4meJGhGrPoM0xCpiIEmIkIRDLFKWEKlsHgMNqIknkDLaXmy56pRumCS9224Uen+EGcJKR8ZqIcfkRCpiYgHSipGIS/enNKB2niFmb5jHZy1o3OGvh7DSevztFxpQmLE0S9CuFu780Imw+ew9IvDI6DKgGp6c0MBp22oHX3KzDPbTmYd1iM0iZs41mJLKI7RFIRnOLZCenYAGl5ZLQcaKA/f0TWDms+BjOPtIMg0jMTvOVTh7YJVRp3KDnC3q4XKTtnB2cVVrNurNeu+yFbbq3Xr9mrUuh61GvQccOt16qxE1azy8WWOz46EdZ/IbPB8nWDn7dQwP3fz/RXA3jBjrnLeGUXR+07u8DjshNLr1m6gJnetWeHnebTYuunF0kGCTiCxjY9jL78sksSoBzWQMqAQZ6BikxfETqI6rAQmrjVynwmrj19ONAyhYky4dgqYBHSmdMkvbdJQotnURRywx6+GF1cbBtGB6DHbAndfTQWr250duRl7Mcox2AoWyGmA6nmBEqUgSYSBWkpt98IW0MN7EL6S9qB/HH4Xh8hENTKakAYMOozDczctbD8fFMRgzckkyJ2OQ+FYApwGNlbQgLa5jWZaIOA/m7JPBxYuD2X637i/WgN6KyLdfEQ6WicSsslwNP0GMd24V3QN9csrCQCCk4hnx9zIVcrAx4GlHIp9ZNohZkgw4swzdMSGH6nkgZOYsfQxopvFRtMKzU+6wE8x7KZ4cEMH9OwG6PMt8zZ77ubolT4NadF5vXDQv8bzWkP6QD9cW2z9kDEWC/FcEeivNd8L6HWZlBGiGVmX+4uJvQP9mG/r5JfBa87yVa9HG9drB0cdhsrF7seIQivWNqtUqXS5XBOSqdVuI24eILpc4W98ncFeME1QSMPb1etbTWmnyoqY+A75OuABX7qqNH949LZcySTQwzoYJkNyKpGCMfyUPUySkcaORyK8TUc4i2azI+TXe8jhKtmr7tI45O1Fa/A2cVEhfTlkiOOm865PPMP9J4DqBjX3p1pd4dVDlQE9BewQ/eVvxhs8I2Ikq2lAvNxPapmfT6CwvEfDxhthpYed5L9nJxB8w7zi0enjEsuZl+g5Z83GtG5W1E8sHaeDruAkwnhdSRSH3Z6Xzrl/xBlvvmE93T7cvu4j5PEjEFAZv8riEHKl8oyK+u2eWkeGcXCVMxnv9OQO8tCB3XvOmoI03qVXDalgZgmUoppkyNmV5ZhRgsZb0tdpuz75YZddr2/eCMAsze5YlTEhE4XSCzv35PNApbuxP6DGgE2Usji4WQ2bgvU6WSxz2xTIeGxcGc2lVnB7EfHJb5O0pecU/AXuho1ht/uMwZYlDu7wbeTW2Q331ERBrffq/hMF3nl+E4AvkV2L4npbsCLK1FvA7gL2y1zrG2L4mb4XwET+0QIi5JgUv4oKJ7z104hiydcJ3ZB+9lFL4tndPl8t/ANxtndI=
+sidebar_class_name: "get api-method"
+info_path: ../src/api/generated/solve/swap-by-blanc
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+
+
+
+
+Get a route for execution with additional parameters
+
+
+
+
+
+
+
+
diff --git a/docs/src/api/generated/solve/get-route.api.mdx b/docs/src/api/generated/solve/get-route.api.mdx
new file mode 100644
index 0000000..9e12dcd
--- /dev/null
+++ b/docs/src/api/generated/solve/get-route.api.mdx
@@ -0,0 +1,229 @@
+---
+id: get-route
+title: "getRoute"
+description: "Get a route for execution"
+sidebar_label: "getRoute"
+hide_title: true
+hide_table_of_contents: true
+api: eJztV99v2zYQ/lcIYg9tJzeyY9eR3xTH6YJhQJGkwwDDS2npbLORSIU/UnuG/vfhSEV2IttNg+1hXf1m8nj87uN3d7o1lQUoZrgUFykd0DmYS2kN0ICmoBPFC9yiA/oeDGFE4R6ZSUVgCYl1ewEtmGI5GFCaDsZrytH+zoJa0YAKlgMdUJZLK8wNFw3H1wsgfpfIGTHyFoQmRhINWUa4ICkkPGcZEdKw6j6dLCBndLB+4iqu3TBBRpfDTuj9EaYJqx1po7iYk1dCEp1wEIbPeFK7f00DalYFYvaGLj5jQOENf47DVjT5+ScaUFiyvMjQrh02fuiEG7d7jQg8MloGVMGd5QpSOjDKwtfclMFuOl1Y+9isYk5TBbqm8gBtnZBMVwbIyCxAgc3royASmULq6VvAknzhZkE+hctPpFAw48vDXIXLMWvN4tY5crbuhuVj2sLlu9N2v9ftd0cnURh1h93uGYtOplGvO4IU4mE36nX67TQ832Iz9tAOM/kNnvcRnHNxU2lWWrOT5pwLniNbO8SrIAF+D9+tVqPoG6W6j8SGVqd29f+S6jDsMBYfR9NO5/h8dHIWxiH0ht3zTh/isyg8OR72e++GSYeWE3SkCyk0aKSmE4ZNhlz1JtomCWg9s1m2InMQWOIhpQFNpDAgDJ5jRZHxxAnp6LPGw+u9vF9t+0sUoLeqGTii625AUjCMZ3pDt5x+hgQff0PCmCYsczZzpukkoIXCLmS4j8tvNjNGKbbChBn9/htxNqgXfzNgp9BwZ0EksLmb4REaUG4g3+VR1L4aPe0QeiNpQO9ZZl2bZIY1YzDyuxGvD/Q/WcDc2zSQ/wLLmnJ8e2f1fIbfPKX3+ATSdv84omW5QTJkWeYWUOINCCNteO6SaM40edDWPhFyYWAOavvadg8j377QJf5lVR9oWeJed1eFOGWpuxG0eXlBGCklFXkoR16wz0t9wJPNhPHLzbeyORNEAUvZNAPirEgOWrM57HizzbNwoe1sxp3miLSmsKbq1I+eycVRs9VuAvgomDULqfhfkJIWuRD3LOMpiT9ckFtY/SBwm8DeLrldCMwiLAWg7kF5BD942/BWBjQHs5DV+OUrz4IO6JGqJjENiVXcrNx0FRf8V1jFFk3GE/woeNi+Qsp8UNtG67obukVshxjgAljqakr1nfZHK/5w0fIGTyq917rneiZVzgzRtzcZv4ebNy4oLmau3z0Ed/WFFWS6IqcZE8lOf1ZDWlsQtMeWCkp7k/bb8G3YmoJhWMYLqU3OnCwqsHMwZOecut7o6uDIWlFiYGmOioxxgfdYlaEHT/+YevonAV1IbXBhvZ4yDR9VVpa47D908U1SrlElKR3MWKbhAKZXl5UiX5MXDL47UWMZejxgVx2bum/yF2PbN0YeALE1lv4zGJ43Yx1A1Jjj/iVu/NjyVWqeYpjgH8URhMvm4CEtUVX+YJwkUGyfalRL9FJXkPeja1qWfwOX+fl8
+sidebar_class_name: "get api-method"
+info_path: ../src/api/generated/solve/swap-by-blanc
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+
+
+
+
+Get a route for execution
+
+
+
+
+
+
+
+
diff --git a/docs/src/api/generated/solve/sidebar.ts b/docs/src/api/generated/solve/sidebar.ts
new file mode 100644
index 0000000..42aaf4a
--- /dev/null
+++ b/docs/src/api/generated/solve/sidebar.ts
@@ -0,0 +1,36 @@
+import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
+
+const sidebar: SidebarsConfig = {
+ apisidebar: [
+ {
+ type: "doc",
+ id: "../src/api/generated/solve/swap-by-blanc",
+ },
+ {
+ type: "category",
+ label: "UNTAGGED",
+ items: [
+ {
+ type: "doc",
+ id: "../src/api/generated/solve/",
+ label: "Missing summary",
+ className: "api-method get",
+ },
+ {
+ type: "doc",
+ id: "../src/api/generated/solve/",
+ label: "Missing summary",
+ className: "api-method get",
+ },
+ {
+ type: "doc",
+ id: "../src/api/generated/solve/",
+ label: "Missing summary",
+ className: "api-method get",
+ },
+ ],
+ },
+ ],
+};
+
+export default sidebar.apisidebar;
diff --git a/docs/src/api/generated/solve/swap-by-blanc.info.mdx b/docs/src/api/generated/solve/swap-by-blanc.info.mdx
new file mode 100644
index 0000000..32d46f0
--- /dev/null
+++ b/docs/src/api/generated/solve/swap-by-blanc.info.mdx
@@ -0,0 +1,56 @@
+---
+id: swap-by-blanc
+title: "Swap by Blanc"
+description: "API used by Blanc Swap"
+sidebar_label: Introduction
+sidebar_position: 0
+hide_title: true
+custom_edit_url: null
+---
+
+import ApiLogo from "@theme/ApiLogo";
+import Heading from "@theme/Heading";
+import SchemaTabs from "@theme/SchemaTabs";
+import TabItem from "@theme/TabItem";
+import Export from "@theme/ApiExplorer/Export";
+
+
+
+
+
+API used by Blanc Swap
+
+
+
+
+
+ API key with format sk_live_*
+
+
+
+
+ | Security Scheme Type: |
+ apiKey |
+
+
+ | Header parameter name: |
+ X-API-Key |
+
+
+
+
+
- 
+ 
+