# Getting Started An overview of XY Finance and the services that spawn on it
## XY Finance at a Glance XY Finance Ecosystem, with XY Token ($XY as the ticker), serves as the heart of the XY DAO and the protocol itself. XY is a community-driven platform established to address what might be called the "liquidity problem," ensuring that users benefit from the best routes, while liquidity providers are incentivized with $XY to steadily stack yields. Meanwhile, we are providing utility and functionality to $XY through multiple innovative methods and strategic partnerships. As a cross-chain interoperability protocol that aggregates not only DEXs but also bridges, we help route your assets of various **types**, with the best **rate** possible and the top **speed** & **security**. Regardless of split or batch transactions, XY Finance helps strike the best bargains with minimized rates. Plus, cross-chain transfer & every transaction step will be carried out in an instant, faster than that of our competitors in the industry. While most have this sneaking suspicion that the platform's safety might be sacrificed due to our pursuit of transaction speed, they're mistaken. Our devs have tapped effortlessly into some mechanisms to ensure the security of your funds.\ \ XY Finance connects every chain, swaps every asset, and serves every user here and there. With the ultimate routing across multi-chains, borderless and seamless swapping is simply several clicks away. ### yBridge In order to achieve the most convenient and fastest cross-chain swap process, XY Finance also has its own bridge called **yBridge**. While yBridge serves as a decentralized non-custodial interoperability solution, it facilitates communication and connection between different blockchain networks. It offers a user-friendly interface for transferring a wide variety of tokens to various blockchains and L2 roll-up solutions while maintaining an efficient cross-chain liquidity pool. As a result, we are able to create more opportunities for this cross-chain network to provide users with more convenient and cost-effective pricing, as well as offer developers and Dapp creators a more convenient cross-chain infrastructure. ### Closing Thoughts XY Finance establishes a thorough cross-chain swap mechanism and seamless user experience for both brands and traders. \ \ That having been said, this is just the beginning. XY Finance will continue to extend ourselves and keep evolving with the DeFi community to introduce new features. With the Research & Development Team's creativity and XY DAO community's engagement, XY Finance will constantly vet our own products and do the utmost to develop more diverse functions to further stabilize this ecosystem.
# XY Token ## Token Distribution Since XY Finance launched in August 2021, we have been early members and developers of the community. We are here today because there have been many community members and liquidity providers who have supported us during the journey over the past few months. With the growth and development of XY Finance, DAO governance is the next step in our community and LP outreach. In order to advance towards this goal, XY Token will be launched. XY Token is XY Finance's native utility token and governance token and has the following current and planned functions: * **Staking incentives:** XY Token holders will be able to stake their tokens on the protocol. XY Token holders who stake their tokens will receive a portion of the revenue generated by the protocol. (Pause from 2023/11) * **Governance:** XY token holders will be able to **participate and vote in the governance process** of the platform. Through governance, users can influence and **modify product features and key parameters** of XY Finance. This will enable XY Token holders to influence the direction of the protocol's development. XY Token will be supplied on every single chain supported by XY protocol. If joining liquidity mining program on BSC, you receive XY Token as rewards on BSC. Similarly, providing liquidity on Ethereum brings you XY Token on Ethereum. XY Finance provides an official bridge for XY Token to cross among supported chains. With the support of consensus, users are able to deposit assets and collect rewards on multiple chains easily and safely. ### Allocation The total supply will be 100,000,000 XY Tokens to be minted with no possibility for future inflation. The tokens will be distributed in the Token Generation Event (TGE), also known as our initial DEX offering (IDO) on Copper Launch, to the following stakeholders within the DAO. ![](/files/qQgxEnog8iimOrOQug5w)
LotAllocationVesting Period
LotAllocationVesting Period
Seed Round7.5%vesting over 3 years with 10 months cliff
Private Round10%vesting over 2 years with 6 months cliff
Strategy Round6.5%vesting over 1.5 years with 4 months cliff
Public Sale (IDO)4%TGE
Liquidity Fund for Mining & GameFi Reward37%asymptotic vesting over 3 years
Marketing and Bounties15%vesting over 3 years
Teams & Advisor15%vesting over 3 years with 10 months cliff
Insurance5%

fully locked in a multi-sign wallet and set as an emergency insurance fund that cannot be unlocked without XY DAO’s

approval

### Circulating Supply ![](/files/8msgyKKRNffFdXOyAO45) ## Token Economics ![XY Token Economy](/files/36bt9jEfnynEHUxMTHe1) ### veXY The XY Finance is governed and upgraded by veXY Token holders. The contract of veXY Token allows the community to propose, vote, and implement changes through the administrative functions of strategies. Proposals can modify system parameters, or add entirely new functionality to the protocol.‌ You can lock your XY Tokens into veXY contract to get veXY Tokens. And there are five of periods to lock-in, from **1 week to 104 weeks**. As longer period lock, the incentive will much higher than the shorter one.‌ ### Vote As protocol grows, there will be more strategies to be integrated, more proposals to be raised from the community. As veXY holder, you will have voting rights for future protocol changes, **including but not limited to change entry / exit fee factor, DAO reserves usage, protocol structure changes.**‌ ### Treasury **As 40% of the swap fee** goes into the treasury, the funds in the treasury will be used for two main purposes. **50% of the funds will be used for buying back XY tokens**, and **the remaining 50% will be used for XY DAO operations**, including improving security, rewarding long-term contributors, paying for operational costs, and other related expenses across the entire XY ecosystem. Therefore, the treasury funds will become an important resource for XY DAO to actively invest in development, not only increasing the value of XY tokens but also maintaining the operation and security of the ecosystem for its prosperous growth. {% content-ref url="/pages/XSU90n6zK5KKF4FfCCAC" %} [Treasury](/smart-contract/addresses/treasury) {% endcontent-ref %} # Supported Blockchains/Bridges/DEXs Lists a good selection of blockchains that are currently supported by XY Finance ## Supported Blockchains | Network Name | Chain ID | Status | | ----------------- | :------: | ----------- | | **Ethereum** | 1 | ✅ | | **BNB** | 56 | ✅ | | **Polygon** | 137 | ✅ | | **Cronos** | 25 | ✅ | | **Avalanche** | 43114 | ✅ | | **KuCoin** | 321 | ✅ | | **Arbitrum** | 42161 | ✅ | | **Optimism** | 10 | ✅ | | **Astar** | 592 | ✅ | | **zkSync Era** | 324 | ✅ | | **Polygon zkEVM** | 1101 | ✅ | | **Linea** | 59144 | ✅ | | **Base** | 8453 | ✅ | | **Numbers** | 10507 | ✅ | | **Mantle** | 5000 | ✅ | | **Scroll** | 534352 | ✅ | | **Blast** | 81457 | ✅ | | **X Layer** | 196 | ✅ | | **Taiko** | 167000 | ✅ | | **Cronos zkEVM** | 388 | ✅ | | **Abstract** | 2741 | ✅ | | **Berachain** | 80094 | ✅ | | **Sonic** | 146 | Coming soon | | **OX Chain** | 6699 | ❌ | | **Klaytn** | 8217 | ❌ | | **Moonriver** | 1285 | ❌ | | **ThunderCore** | 108 | ❌ | | **Fantom** | 250 | ❌ | ## Supported Bridges | Network Name | Status | | ------------------- | ------ | | yBridge | ✅ | | cBridge | ✅ | | Circle CCTP | ✅ | | Synapse | ✅ | | Across | ✅ | | Owlto Finance | ✅ | | Arbitrum Bridge | ✅ | | Polygon Bridge | ✅ | | Optimism Bridge | ✅ | | Base Bridge | ✅ | | Stargate Finance v2 | ✅ | | Multichain | ❌ | ## Supported DEXs | Network Name | Status | | ------------ | ------ | | OpenOcean | ✅ | | OKX Dex | ✅ | | KyberSwap | ✅ | | SushiSwap v2 | ✅ | | Uniswap v2 | ✅ | | ZipSwap | ✅ | | VVSFinance | ✅ | | MDex | ✅ | | PancakeSwap | ✅ | | QuickSwap v2 | ✅ | | MojitoSwap | ✅ | | ArthSwap | ✅ | | Pangolin | ✅ | | TraderJoe v2 | ✅ | | 1inch | ❌ | # Fee Structure Highlights the rates on XY Finance and lets users know what to expect when working with us. When engaging in the swapping process, various fees come into play, commonly including the gas fee, as well as the swap fee imposed by bridges, aggregators, and decentralized exchanges, among others. We provide a variety of functions and conveniences to satisfy users in a single step while using our service. Each service is associated with a specific fee, which can be categorized as **Withholding Fee** or **Bridge Fee**. These fees are paid using the native token of the source chain. $$ TotalFee = WithholdingFee + BridgeFee $$ {% hint style="info" %} `Fee Structure describes how XY Finance charges for our services, laying down policies in advance and making transactions via XY Finance transparent.` {% endhint %} ### Withholding Fee XY Finance charges a `Withholding Fee` to cover the additional gas usage and processes involved in the swapping of tokens on the destination chain. For example, when users swap tokens from the pool token of the bridge to their desired token, a protocol fee is incurred. We are continuously expanding our range of services and will be introducing more in the future. {% hint style="info" %} The fee amount is determined based on the gas price fluctuations across different chains, particularly on `Ethereum`. You can check the current gas price on Ethereum by following this [link](https://etherscan.io/gastracker). {% endhint %} {% hint style="info" %} When [Gasless](/products/x-swap/gasless-transaction) is enabled, the platform covers the network gas cost and the withholding fee from the original token used in the transaction. For example, if a user swaps USDC on Arbitrum to a meme token on Base with Gasless enabled, the fee is deducted directly from the USDC amount used in the swap, no native tokens is used from user's EOA. {% endhint %} ### Bridge Fee We have integrated the following bridges to facilitate token bridging across different chains. The `Bridge Fee` is charged by these bridges, which provide liquidity for asset transfers between chains. * **cBridge** * To understand how fees are charged, please refer to the [FAQ](https://cbridge-docs.celer.network/reference/faq). * **Synapse** * **Celer-CCTP** * **Across** * **Owlto Finance** * **yBridge** {% hint style="success" %} **yBridge** is a bridge owned by XY Finance itself. Through yBridge, XY Finance can offer users/partners better pricing and more convenient services. For more information about the specific bridges and their fee structure, please refer to the link below. {% endhint %} {% content-ref url="/pages/R6ZNeJGabWH2sUpAkY3H" %} [yBridge Fee Information](/fee-structure/ybridge-fee-information) {% endcontent-ref %} # yBridge Fee Information ## How is the bridge fee calculated? Users are able to roughly estimate the cost of a transaction depending on the formulae given below as reference. * The Bridge Fee consists of two components. The first part is allocated to cover the gas expenses associated with transferring tokens to users on the destination chain. This portion is determined by the fluctuations in the market gas price on the destination chain. The second part is levied to provide rewards to both the yBridge liquidity providers and the XY DAO. $$ BridgeFee = BaseFee + ProtocolFee $$ * The Protocol Fee will be calculated based on the amount and a predetermined percentage factor. Typically, this percentage is determined by the XY DAO. $$ ProtocolFee= amount \cdot rate $$ * There are **lower bound** and **upper** **bound** in the Protocol Fee. $$ \begin{equation} \left{ \begin{array}{lr} ProtocolFee=minimum, & minimum > ProtocolFee \\ ProtocolFee = amount \cdot rate, & minimum < ProtocolFee < maximum\\ ProtocolFee=maximum, & ProtocolFee > maximum \\ \end{array} \right. \end{equation}\notag $$ {% hint style="info" %} If the trading volume multiplied by ***rate*** is less than the ***minimum***, then XY Finance will still charge the ***minimum*** as a basic commission. If the trading volume multiplied *by **rate*** is more than the ***maximum***, then XY Finance will only charge the ***maximum*** as a basic commission. {% endhint %} {% hint style="info" %} `protocolFeeRate & minimumProtocolFee & maximumProtocolFee are determined by XY`[`DAO`](broken://pages/xInosIqsU9Fb0JrCkjfE)`.` {% endhint %} ## How much does the fee cost? ### BaseFee The fee charged to cover the gas cost on the destination chain will be influenced by several factors. For instance, the ***BaseFee*** will be determined by fluctuations in the gas price on the destination chain. Furthermore, if users request a swap process on the destination chain, it may also incur additional transaction fees. {% hint style="info" %} For the actual amount that we charge for ***BaseFee***, please refer to our [fee structure API](/single-bridge-integration/ybridge-api/get-fee-structure). {% endhint %} ### ProtocolFee The protocolFee is calculated as **the product of the srcBridgeTokenAmount and rate**. This fee is then allocated to reward yBridge liquidity providers and XY DAO. {% hint style="info" %} For the actual amount that we charge for ***ProtocolFee***, please refer to our [fee structure API](/single-bridge-integration/ybridge-api/get-fee-structure). {% endhint %} ### xAsset Bridge Fee * `rate`: 0.1% * `maximum`: $1,000 * `minimum`: The following values represent the reference minimumFee ranges for different chains. However, it is important to note that actual prices may be subject to adjustment based on market conditions. * `Ethereum`: $50 * `Avalanche, Cronos, BNB Chain, Optimism, Arbitrum, zkSync Era, Polygon zkEVM, Linea, Base, Mantle, Scroll, Blast, Taiko, OX Chain, Cronos zkEVM`: $0.6 - $2.3 * `Others`: $0.15 - $0.285 {% hint style="info" %} **The actual fee charged for the xAsset Bridge may fluctuate based on the real-time market gas conditions.** Please refer to the real-time display on app.xy.finance for the final fee. We apologize for any inconvenience this may cause {% endhint %} # (Legacy) XY Bridge Fee Information ## How is the bridge fee calculated? Users are able to roughly estimate the cost of a transaction depending on the formulae given below as reference. * A small portion of fees is taken as a basic commission. Note that one can imagine the ***feeRate*** in the formula below as a constant, or a percentage figure by which any transaction amount (trading volume) should multiply, usually determined by XY DAO. $$ BridgeFee = Amount \*feeRate $$ * There are **lower bound** and **upper** **bound** in the Fee Structure to ensure that XY Finance can afford gas fees and will not impose any surcharges upon users. $$ \begin{equation} \left{ \begin{array}{lr} BridgeFee=minimumFee, & minimumFee > BridgeFee \\ BridgeFee=Amount \cdot feeRate, & minFee < BridgeFee < maximumFee\\ BridgeFee=maximumFee, & BridgeFee > maximumFee \\ \end{array} \right. \end{equation}\notag $$ {% hint style="info" %} If the trading volume multiplied by ***feeRate*** is less than the ***minimumFee***, then XY Finance will still charge the ***minimumFee*** as a basic commission. If the trading volume multiplied *by **feeRate*** is more than the ***maximumFee***, then XY Finance will only charge the ***maximumFee*** as a basic commission. {% endhint %} {% hint style="info" %} `feeRate, minimumFee & maximumFee are determined by XY`[`DAO`](broken://pages/xInosIqsU9Fb0JrCkjfE)`.` {% endhint %} ## How much does the fee cost? ### General Cross-Chain When you perform cross-chain transactions of your assets through mainstream token pools (e.g., USDC/USDT/ETH), the following fees will be charged: * `feeRate`: 0.050% - 0.400% * `maximumFee` : $1,000 * `minimumFee`: The following value represent reference minimumFee for different chains; however, it is important to note that the actual prices may be subject to adjustment based on market conditions: * `Ethereum`: $15 * `Avalanche, Cronos, BNB Chain, Optimism, Arbitrum, zkSync Era, Polygon zkEVM, Linea, Base, Mantle, Scroll`: $0.4 - $1.5 * `Others`: $0.1 - $0.19 ### xAsset Bridge The xAsset Bridge helps projects deploy their tokens onto different chains. When you perform cross-chain transactions involving these specific protocol tokens (e.g., XY/NUM), the following fees will be charged: * `feeRate`: 0.1% * `maximumFee`: $1,000 * `minimumFee`: The following values represent the reference minimumFee ranges for different chains. However, it is important to note that actual prices may be subject to adjustment based on market conditions. * `Ethereum`: $22.5 * `Avalanche, Cronos, BNB Chain, Optimism, Arbitrum, zkSync Era, Polygon zkEVM, Linea, Base, Mantle`: $0.6 - $1.35 * `Others`: $0.15 - $0.285 {% hint style="info" %} Please note that bridge fees are subject to **change based on fluctuations in the market gas price**. If you are interested in integrating our service and **would like to know the current actual price, please feel free to contact us.** {% endhint %} # Bridge Aggregator : XY Finance An algorithm-driven trading platform that creates functionality to make swaps and add/remove liquidity with ease. ### Overview We believe all crypto users should be able to trade and swap as they want even if the transaction is going to involve different chains. As previously noted, XY Finance serves as an atomic-swap-based aggregator that supports different token swaps between unique blockchains ecosystem with the minimum disruption possible (no intermediary or central authority involved). Users only need to enter the token they wish to trade and then submit the transaction on the *source chain* box; the following cross-chain proceedings will take place automatically good and proper, and then the swap to the *target chain* will be submitted by our protocol shortly thereafter. The whole transaction will be completed between nodes (participants) in a quick and prompt fashion (more often than not, the transaction only requires one stop to go through).
### Trade WITHOUT limits The sky is the limit when it comes to the token types you wish to select/place in the source chain and the target chain box respectively, where users are much welcome to provide any token they intend to swap. The source-chain token will be first swapped to sort of a *medium* stablecoin, technically termed "**bridge token**" under our definition and usually USDT or USDC, and then go through a succession of cross-chain steps and be swapped via the target chain DEX at the end. Below is the **`circle`** (or route if you like) that demonstrates how users' funds flow during a transaction: Note that the above circle is merely a simple swap flow to showcase how a swap is dealt with in our ecosystem. Each step or transaction (TX) is not arranged in chronological order. For example, the TX on the source chain DEX and the one on the target chain DEX usually happen at the same time. ### Nail it with just ONE transaction With projects and platforms around Web3 proliferating, trading with cryptos seems to become a problem of complexity for many. That being the case, *simplicity* is the key vibe of XY Finance In the course of the swapping process, there is only one transaction that requires users to submit, and the remainder will be handled automatically during the cross-chain trading proceedings by our inbuilt robot (*told ya! we're algorithm-driven*). Users are only required to configure their trade settings ONCE and submit/send the transaction, which, though seemingly straightforward and intuitive, includes not just the swap information of the source chain token to the bridge token, but the swap information on the target chain as well. All the related details within this transaction will be *logged* on the blockchain, such as the bridge token address, the amount swapped, and the minimum amount of the target chain token to receive in your browser wallet, just to name a few. Then, our bot will follow the instructions users provide from the beginning and pass down these source-chain logs amidst the following trade proceedings, and, finally, activate the transaction on the target chain. {% hint style="info" %} `Note that if the trade on the target chain fails, XY Finance (the inbuilt robot) will return bridge tokens to users instead.` {% endhint %} ### Dodge indirect routing for the BEST price Trading on the chains we support with XY Finance ensures that our routing algorithm will only route the logs to liquidity pools between the two tokens in the trading pair users choose and will automatically ignore any routes that will take more effort and trading costs to complete. Our Protocol will calculate and pick out the best swapping route to offer the best price and at the same time the least slippage possible to users. Practically speaking, we do help simplify and minimize the "complexity" of token-to-token swap in general that most users would have to experience. By the time we've ascertained that the token that users wish to obtain is available on our platform, we've also had the route and liquidity necessary all set. {% hint style="info" %} `Note that if the difference between the market price and the quoted price from our liquidity sources for tokens you wish to swap exceeds the slippage tolerance on the interface, the trade will fail.` {% endhint %} # Gasless Transaction At this point, it's a well-known fact that managing and paying gas tokens for your on-chain transactions has always been a pain. While the account abstraction method in EIP-4337 can help abstract away gas completely, not all users or ecosystems have adopted EIP-4337. Given that more than 80% of users are still using EOAs instead of a smart contract accounts, XY Finance is now ready to support Gasless Transaction to bring a better UX to our cross-chain swap service for everyone. ### What Is Gasless Transaction? Gasless Transaction is an optional method added to our token swap interface that enables users to swap certain tokens without paying gas on-chain. ### How Does It Work? To allow EOAs to perform transactions gaslessly, * Permit (EIP-2612) is used to collect an off-chain token approval signature from user EOAs * EIP-712 is used to collect an off-chain transaction signature from user EOAs * A Relayer EOA will send the transaction on-chain by paying gas itself * User EOA signatures are still mandatory in this process, all transactions can only be processed on-chain if proper signatures are provided * Our smart contracts will revert the transactions if the signatures are invalid When Gasless is enabled, our platform covers the network gas cost using our native tokens. In return, a corresponding fee is deducted from the original token used in the swap to offset that cost. For example, if a user swaps USDC on Arbitrum to a meme token on Base, the fee is taken directly from the USDC amount being swapped, no additional tokens are spent from the user EOA. Refer to [Fee Structure](/fee-structure) for more details on the fee structure. ### How Can I Use Gasless Transaction? {% tabs %} {% tab title="Token Selection" %}
{% endtab %} {% tab title="Route Selection" %}
{% endtab %} {% tab title="Enable Gasless" %}
{% endtab %} {% tab title="Token Approval" %}
{% endtab %} {% tab title="Tx Signature" %}
{% endtab %} {% tab title="Track Status" %}
{% endtab %} {% endtabs %} 1. Select a token labeled with `Gasless` next to its symbol 2. Proceed with your swap configuration, click `Review Route` to continue 3. At the Confirmation page, you can enable Gasless with `Pay Fees With ` toggle 4. Upon clicking `Transfer`, you will be asked to sign a token approval 5. After token approval is signed, you will still be asked to sign a transaction 6. Once the approvals are signed, your transaction will be sent on-chain for processing # Bridge : yBridge ### Mechanism There will be at most three transactions involved in the `circle` of the swapping process. Under normal circumstances and as previously noted, users will only have to engage in ONE transaction (hereinafter abbreviated as "*TX*") for the swap to get closed, which is **TX1**. However, it's worth noting that there is still one TXs pertinent to whether users' funds could be transferred onto the target chain with success. * **TX1**: Users send assets (quoted price) via the yBridge on Chain A (the source chain DEX). * **TX2**: yBridge (our executor) helps swap on Chain B (the target chain DEX) and transfers tokens back to users. This TX will be conducted using a proof of [consensus](broken://pages/-Mf2CmT5CnIATIVo90EA), and by so doing the whole swap can be closed, good and proper. ### Example Suppose Bob would like to swap 1 **`wBTC on ETH`** for some **`CAKE on BSC`**. With the assistance of yBridge, Bob simply needs to give us permission to access their assets in his wallet (i.e. TX 1 as ➀ below), and the rest of the swap process will thenceforth be well taken care of. From his viewpoint, he will be able to receive his desired CAKE on BSC with only two TXs that are pertinent to his swap (➀ & ➄). The next section will give the breakdown of the full swapping process. ![ A simple flow chart of a swap](/files/-Mgsi4Vw00fColmmlcpu) ### Swap Breakdown Please refer to the flow chart above for reference. ➀ Firstly, Bob will receive a quotation by interacting with our APIs, which have been instructed to search for and single out the best route for Bob. For instance, `1 wBTC (ETH)` could be swapped for 3000 CAKE (BNB) in return and with a **1%** slippage tolerance. If Bob accepts the quoted price, he can file a TX request, namely **TX1**, by sending `1 wBTC` to yBridge ➁ Our **yBridge** on Ethereum will trade `1 wBTC` on Chain A (Dex1) for the best offer **30000 USDT**. ➂ yBridge will charge some fees, say **20 USDT**, and then submits a transaction request to swap **29980** **USDT** to yBridge for `CAKE on BNB`. Should you wish to learn more about how the fees are calculated, feel free to check the section attached below. {% content-ref url="/pages/R6ZNeJGabWH2sUpAkY3H" %} [yBridge Fee Information](/fee-structure/ybridge-fee-information) {% endcontent-ref %} ➃ ➄ yBridge on BNB will swap USDT for CAKE via DEXs such as *Pancake*. Once successfully traded, CAKE will be transferred to Bob right after. However, if, unfortunately, the price of `CAKE on BNB` suddenly fluctuates following **TX1** and a trading failure results, which means the swap fails to swap **2970** **CAKE** (at least) to Bob, then yBridge will instead transfer **29980 USDT** (BSC) from yBridge to Mr. Bob, who still gets his assets back, safe and sound. {% hint style="info" %} If yBridge is unable to successfully complete the transaction on the destination chain due to force majeure, yBridge and/or the Validator Set will reach a consensus that one of them is required to initiate a new transaction in which the equivalent amount of "30000 minus gas fees" USDT (ETH) will be returned to Bob. {% endhint %} # Yield Farming When LPs deposit their funds to incentivize yBridge Pool and provide liquidity, they will earn the *yield* that consists of swap fees and liquidity mining (farming) rewards. Each pool has its specific token (only USDT or USDC are available for the time being), and the liquidity they provide is the token in that pool, hence USDT, USDC or ETH.
The mechanism of our Pool, like that of *Multichain*, which focuses on the provision of bridging services, is designed as a **single-asset** liquidity pool where users provide only one type of token (USDC/USDT/ETH for now) as liquidity so that LPs never have to be exposed to the well-known risk called impermanent loss that LPs of DEXs (such as *UniSwap*) are facing and the risks such as price swings/fluctuations or the likelihood of high slippage. ### Key Points to Know Before Joining yBridge Yield Farming Due to the pool being built on the OmniChain, there are several key features you should be aware of when engaging in Yield Farming: #### **yBridge LPs Earn Bridge Fee automatically** The gains are distributed to be included in the deposit certificate, which is like an interest-bearing token but earning from bridge fees, not from interests. Feel free to dilute my position. More TVL can generate more bridge fees and keep the APY maintaining good. A month ago, there were only 350 ETH in pools, but there are almost 590 right now, 65% MoM. #### Before depositing into yBridge you must know the “Withholding Fee” Why will yBridge have a Withholding Fee? Because yBridge is using its own OmniChain Solution to run the bridge pools on 16 EVM chains (more are coming on zkrollups). **Therefore, the deposit and withdrawal of yBridge will have been completed in two transactions. To cover the gas fee used for the second transaction, yBridge will charge a withholding fee.** #### Why does yBridge use “OmniChain” to build bridge liquidity pools? By doing so, all assets deposited in yBridge will be calculated together. That’s to say, 1 xyETH on Arbitrum is equal to 1 xyETH on Poylgon zkEVM. Both are equal to 1.034675 ETH (current price.) #### How long does Deposit and Withdraw in/from yBridge take? On average, **it takes around 1 mins to complete the deposit and withdrawal**. When you deposit assets into yBridge, the system will send your deposit certificates such as xyUSDC, xyUSDT, and xyETH in the second transaction. #### How to withdraw your assets in yBridge? It’s simple as long as you click the withdrawal and the system will process it. If the liquidity isn’t enough, please wait for a while, and the team will inject more liquidity into it. #### How to Deposit (Provide Liquidity) on yBridge To deposit and provide liquidity on the yBridge you can follow these [step-by-step instructions](https://blog.xy.finance/ethpool/) # Omnichain Settlement Enables greater speed, low transaction costs, and features higher capacity for better interoperability and decentralized user experience. ### Settlement Chain Within the yBridge system, a crucial component is the settlement chain. This can be envisaged as a digital ledger, documenting the transaction details of users. Furthermore, this layer is vital within the entire ecosystem for establishing liquidity across each chain; it listens to and records the activities of all peripheral chains supported by yBridge. Firstly, a settlement is defined as a payment or transaction that is conclusive and executed. In the cryptocurrency sector, a transaction is only considered settled once it is recorded on the blockchain, ensuring the irreversibility of the exchanged cryptocurrencies. Consequently, we have established the yBridge settlement chain, which supports EVM-compatible smart contracts, thereby enabling code execution in an environment akin to EVMs. This eliminates the need for yBridge to develop solutions from the ground up. Additionally, this approach enhances transaction speed, increases capacity, and reduces gas fees And on the settlement chain, we will deploy a smart contract to record the pool token balance on each chain and also keep track of the liquidity balance of each user, which makes the settlement chain an arbitrator. The following flow chart demonstrates how different chains interact with the settlement chain and users. Furthermore, on the settlement chain, a smart contract will be deployed to monitor the pool token balance on each chain and track each user's liquidity balance, positioning the settlement chain as a mediator. The subsequent flowchart illustrates the interaction between different chains and the settlement chain, along with user involvement.en balance on each chain and also keep track of the liquidity balance of each user, which makes the settlement chain an arbitrator. ### Validators To smooth the process of decentralized transactions and to ensure the mechanism function normally, we have several validators set to keep information on each chain updated constantly. They are used to check the validity or syntactical correctness of a fragment of code or document. Not only will the validators help verify whether our web pages are correctly coded, but they are also furnished with a consensus algorithm to prevent malicious attacks, keeping the network security and efficiency up to standard 24/7. You can learn more about the details of consensus and validators at [Consensus](/products/y-pool/consensus) ### Settlement Contract (yBridge) Once we confirm the completion of a user's source chain transaction, the executor initiates a request on the settlement chain's contract. After our validators complete the verification, the executor, with the signature, is authorized to issue a transaction on the destination chain to fulfill the bridge request. Upon the transaction's completion on the destination chain, the executor returns to the contract on the settlement chain to settle the original request. This process ensures that all behaviors on the peripheral chains are accounted for and error-free. ### Settlement Contract (yBridge Vault) When users deposit yBridge-supported tokens (i.e. USDT or USDC) into a chain, they will receive `xyUSDT/xyUSDC` (obviously depending on what stablecoins they put into the pool) as proof of deposit or their shares. In contrast, as users withdraw the tokens from a chain, they will return `xyUSDT/xyUSDC` as their shares, as ➀ and ➂ in the following illustrations. Validators will thus interact with the settlement contract to update the balance of the corresponding chain as well as that of users, as ➁ in the following illustration.
As time goes by, users' deposits will pay off. They may choose to withdraw their funds using `xyUSD` and get `xyToken` (`&XY`) in return, and that's where the settlement contract calculates or "settles" the corresponding quantity of reward distributed to users, as ➁ shown below. ![User Withdraw Liquidity](/files/-MgtGGDwcL3BpvmhfYlm) # Consensus A fault-tolerant mechanism to achieve agreement, assurance, and security in the blockchain system across the decentralized network. ## Basics An easy way to interpret the notion of our consensus is to imagine it as a prevalent record-keeping mechanism in the crypto space that helps keep all contributing nodes (or you may call them participants or transactors as you like) in the network *honest*. Hundreds of thousands of users work on authentication/verification of transactions on the blockchain every day and with such a dynamically changing status of the blockchain, it is then essential for these publicly-shared ledgers to have a secure and real-time consensus algorithm to ensure that all the trade happening on our network are genuine and all participants agree on a *consensus* on the status of the ledger. Thus, we brought about this consensus to determine the *legitimacy* of contributions made by the users on the chain. Consensus is playing an important role in the protocol security of users' funds in cross-chain transactions. There will be two roles involved in our consensus mechanism: ➊ **Executor**: the one that executes the target chain transaction\ ➋ **Validator**: the one that validates the data of the executor's target transaction and signs/approves ## Roles ![The flow chart that demonstrates the roles involved in the proof of consensus](/files/bNOIAHA8bz1yiRwAwd79) ### Executor For the time being, there will be only one executor within our consensus, which will continually check and process transactions according to the set routine as follows. However, in the future, we plan to open up to more verified partners and institutions to become executors. This will help enhance the stability of the entire system and further diversify risks. #### ➀ Parse and check the request information from the source blockchain The executor keeps monitoring cross-chain swaps on each of our supported blockchains, and then parses and validates the events with regard to the transactions. Events in the transactions contain the source and the target chain swap information, which includes the amount of the bridge token, the amount being swapped, the minimum of target tokens to be received, etc. It is also responsible for checking the validity of the orders of the events, and whether the desired amount (the quoted price) within the event tallies with users' funds on the source chain. If the events within transactions are found *invalid*, the executor will require the validators to sign a refund request and submit a source chain refund transaction to refund the swap request from users along with their assets. #### ➁ Execute swap transaction on the target chain Once the events are validated and with the prerequisite that the liquidity on the target chain is sufficient, the executor will apply the best route on the target chain to swap bridge tokens to the target tokens. If liquidity is insufficient to underpin the swap, the executor might require the validators to sign the refund request and submit a source chain refund transaction for the swap request from users along with their assets. ### Validator Within our consensus, there will be multiple validators, predominantly sourced from investors of XY Finance currently. They will support and constantly validate the data of the requests from the executors where necessary. In return, each validator will receive corresponding rewards at each cycle. #### ➀ Validate requests from source chain and transactions The validators will continue to validate the executor's requests to ensure they meet the requirements of users, such as the target-chain token amount for closing or the amount of bridge token given to users in case of a failed swap. #### ➁ Put signatures to transactions for the executors Upon validating transactions, the validators are responsible for providing signatures to the executor for executing transactions on the destination chain Validators ensure to only listen to specific events from our particular contract, ensuring the correctness of user requests before issuing the corresponding signature, to avoid exposure to false events and maintain the system's security ## Prospect In the future, we will further optimize our consensus based on the following plans to maintain and enhance overall stability and security 1. We plan to invite 1-2 external executors to enhance system stability, throughput, and mitigate risks 2. We will dynamically adjust the number of reliable validators based on system transaction volume and user count to mitigate the risk of single validator failure or dysfunction, ensuring uninterrupted operation. # Refuel Managing native or gas tokens across multiple blockchains can be cumbersome and frustrating, especially when a cross-chain swap is required just to get enough gas for your main transaction. If you've ever felt this pain, Refuel is here to help. ### What Is Refuel? Refuel is an instant bridge that allows users to swap gas tokens from one chain for gas tokens on other chains. Since gas swaps are typically small transactions meant to facilitate larger ones, processing speed and convenience are crucial. To ensure quick and efficient swaps, we've chosen a centralized approach for Refuel to make gas-to-gas swaps as fast as possible. ### How Does It Work? 1. **Deployment**: [Refuel contracts](/smart-contract/addresses) are deployed on supported chains. In the first wave, Refuel will be available on Ethereum, Arbitrum, Base, and zkSync Era, with plans to expand support to all chains supported by XY Finance 2. **Transaction Creation**: When users interact with Refuel on [XY Finance](https://app.xy.finance/refuel), a transaction is initiated (after your approval) to transfer gas tokens from your wallet to our Refuel contract on the source chain. 3. **Confirmation**: We monitor the contracts for successful transfers on the source chain to confirm these transfers are indeed completed on the source chain 4. **Completion**: Upon confirmation, the contracts will initiate a corresponding transaction on the destination chain, transferring the appropriate amount of gas tokens to your address. ### How Can I Use Refuel? Here's a quick step-by-step guide. {% tabs %} {% tab title="Navigate" %}
{% endtab %} {% tab title="Input" %}
{% endtab %} {% tab title="Confirm" %}
{% endtab %} {% tab title="Track" %}
{% endtab %} {% tab title="History" %}
{% endtab %} {% endtabs %} 1. **Navigate**: Click the "[Refuel](https://app.xy.finance/refuel)" button in the upper navigation bar. 2. **Connect Wallet**: Connect your wallet. 3. **Select Chains**: Choose the source and destination chains for your gas tokens. 4. **Input Amount**: Enter the token amount to swap or use the "5x Gas" / "10x Gas" buttons for pre-defined amounts based on estimated gas price. 5. **Refuel**: Click the "Refuel" button to proceed. 6. **Confirm:** Click the "Refuel" button again to confirm & approve the transaction. 7. **Track**: After approval, monitor your transaction status on the same page. 8. **Tips**: If you switched to a different page, you may find your Refuel transactions under "Transaction -> Refuel" # Proxy Bridge Transferring assets across different blockchains is challenging; moving them between exchanges on different chains can feel overwhelming. To make this seamless and accessible, XY Finance introduces the Proxy Bridge, a solution that eliminates complex steps and enables fast, easy asset movement across exchanges & any application chain. ### What Is Proxy? A Proxy is a unique address created and operated by XY Finance, serving as a user’s personalized gateway to partner exchanges. When a user interacts with a supported exchange, Proxy provides a simplified pathway for transactions, bypassing the usual multi-step processes. ### How Does It Work? Once a user receives their unique Proxy address, transferring assets becomes simple and intuitive: * **Deposit Flexibility**: Users can transfer supported assets to their Proxy address from any source, including wallets and other exchanges. * **Automated Cross-Chain Transfer**: Upon successful deposit, XY Finance captures and verifies the transaction. * **Seamless Delivery**: After confirmation, XY Finance completes the cross-chain transfer in the background, directly depositing the corresponding amount into the user’s exchange account.

Simplified Proxy Bridge Diagram

### Use Case: [Hybrid Derivatives Exchange - GRVT](https://grvt.io/) GRVT is a self-custodial hybrid exchange. As the [first official appchain on zkSync’s Hyperchain](https://t.co/KlxIeo4VbS), GRVT leverages advanced zk technology to deliver fast, low-cost transactions while ensuring user autonomy and asset control, setting a new standard for secure, scalable DeFi solutions. As XY Finance’s latest application chain partner, GRVT will leverage XY's cutting-edge Proxy Bridge technology to offer a user-friendly solution, bridging mass crypto users into decentralized ecosystems. This integration combines the speed of CEXs with the security and control of DeFi, ensuring seamless cross-chain transfers and a smooth user experience. This collaboration introduces: * **XY Finance’s Proxy Bridge**: offering users a frictionless way to deposit funds directly from a CEX into GRVT’s smart contract. * **Gas-Free Transactions**: Eliminates gas fees, streamlining the user experience. * **Single-Step Process:** No need for multiple wallet transactions, simplifying cross-chain transfers. * **Industry First for DEXs**: Pioneering frictionless, gas-free bridging for decentralized exchanges. * **Enhanced Speed and Security**: Ensures faster, more secure cross-chain transactions. * **User-Friendly**: Accessible for both crypto newcomers and experienced users alike. {% embed url="" %} # Cross Chain Infrastructure A Toolkit That Makes Going Cross-Chain Easier ## 1. What is our Cross Chain Infrastructure ### 1-1. API Our API is highly versatile and can be easily integrated into any service. You can design your interface around our bridge and swap functionalities. We now offers two types of APIs: * **XY Finance API (Multiple Bridges Aggregator)**: This is our newly launched aggregation API where we have integrated various bridges (cBridge/Synapse/CCTP and more) and DEXs (1inch/OpenOcean and more) to provide you with the best quotes. Additionally, it offers you more new features like Monetization (Additional Fee). If you don't want to integrate those DEXs and Bridges on your own but still want to offer bridge services within your Dapp and wallet, you can choose **XY Finance API (Multiple Bridges Aggregator)** {% content-ref url="/pages/o7vJtps2sMrOdigVjaGL" %} [XY Finance API (Multiple Bridges Aggregator)](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator) {% endcontent-ref %} * **yBridge API**: This API also provides bridge and swap services, but it is limited to our own cross-chain bridge (yBridge). If you want to integrate DEX and Bridges on your own and you want to include yBridge in your services, you can choose **yBridge API** {% content-ref url="/pages/e9cVeZ15mr0OuwLRJ0lm" %} [yBridge API](/single-bridge-integration/ybridge-api) {% endcontent-ref %} ### 1-2. Widget Our user-friendly widget can be implemented in as little as 10 minutes, offering a simple solution for onboarding users from any platform or device. We offer two different types of integration methods to suit your needs: * Installed via an iframe. {% content-ref url="/pages/zef4Ixeyy3RnU6BHKrmT" %} [XY Finance Widget (iframe)](/bridge-aggregator-integration/xy-finance-widget-iframe) {% endcontent-ref %} * Installed via npm {% content-ref url="/pages/WhTOvmZWNAyJ3PDF0ci4" %} [XY Finance Widget (NPM)](/bridge-aggregator-integration/xy-finance-widget-npm) {% endcontent-ref %} {% hint style="info" %} If your intention is to integrate our widget to help users buy your token more easily, you can also refer to [Token Listing](/bridge-aggregator-integration/token-listing) to list your token on XY Finance together. {% endhint %} ### 1-3. Custom-Built Link Our custom-built link enables you to pre-configure your token and chain and link to our website in just a few clicks. This feature is especially useful for those with limited time or resources. {% content-ref url="/pages/spxQT8UQJi75NwNRwpd2" %} [Custom-Built Link](/bridge-aggregator-integration/custom-built-link) {% endcontent-ref %} Example : Swap **1000 USDC From Ethereum** to **USDC on Polygon**. [https://app.xy.finance/?amount=1000\&fromTokenAddress=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48\&sourceChainId=1\&targetChainId=137\&toTokenAddress=0x2791bca1f2de4661ed88a30c99a7a9449aa84174](https://app.xy.finance/?amount=1000\&fromTokenAddress=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48\&sourceChainId=1\&targetChainId=137\&toTokenAddress=0x2791bca1f2de4661ed88a30c99a7a9449aa84174) {% hint style="info" %} If your intention is to use a custom-built link to help users buy your token more easily, you can also refer to [Token Listing](/bridge-aggregator-integration/token-listing) to list your token on XY Finance together. {% endhint %} ### 1-4. xAsset Bridge Our xAsset Bridge helps projects **Bridge their tokens to different chains**. you can refer to the following steps to set up a bridge on XY Finance, allowing users to conveniently and securely wrap their assets on various chains. {% content-ref url="/pages/aSHnkKnB7ACOPjFIVt3s" %} [xAsset Bridge](/single-bridge-integration/xasset-bridge) {% endcontent-ref %} ### 1-5. Contract Integration If you want to integrate our smart contract directly to access our services, you can follow the guide below to understand how to interact with our own bridge, **yBridge**. {% content-ref url="/pages/L4dfBrPIW2vo5nP2BTJF" %} [yBridge Contract Integration](/single-bridge-integration/ybridge-contract-integration) {% endcontent-ref %} Currently, **we have not yet provided a guide for direct contract interaction with our aggregator service, XY Finance**. If you require such the guide, please contact us ## **2. Which Projects Should Use XY Finance Cross-Chain** Infrastructure ### **2-1. API** * **Bridge/DEX Aggregator**：Leverage the API to seamlessly bridge and aggregate liquidity from multiple DEXs across 14+ chains, giving your users a wider range of options with better prices and faster transaction completion times.

Example: https://app.rubic.exchange/

* **Web3 Wallet:** Customize the entry to suit your interface to provide users with a unified experience to bridge and swap any token across 14+ chains.

Example : https://www.frontier.xyz/

* **DEX, Lending, Yield, Yield Aggregator, Derivative and more Dapps**: Enhance your Dapp's functionality by adding bridge and swap service through API. Allow users to swap and bridge any token across 14+ chains without leaving the Dapp.

DCA Project supported by XY Finance https://neonprotocol.io/v4.html

### **2-2. Widget** * **GameFi/GameFi Management Platform:** Provides players a one-stop platform for everything they need to trade and manage their GameFi assets. Ultimately increase user stickiness & enhance your presence in the GameFi industry by inflowing more liquidity for game players, guilds as well as other GameFi projects.

Example: https://app.croskull.com/#/bank

* **DEX, Lending, Yield, Yield Aggregator, Derivative and more Dapps :** Whether you provide token staking, yield farming, lending, or other services, our cross-chain widget can help facilitate user onboarding and improve the user experience by enabling seamless swapping and bridging of tokens across 14+ chains without having to leave your dApp.

Example: https://xy.mojitoswap.finance/

* **Web3 Wallet:** Hot or cold, give your users a one-stop experience to manage and trade their cryptocurrencies across 14+ chains. * **NFT Marketplace:** With the cross-chain widget, the NFT trading part just became super simple and easy. Users can get tradeable tokens from any chains on any available liquidity pool. By doing so, onboarding more NFT collectors will become easier and have a much better experience. ### **2-3.** Custom-Built Link * **Any projects:** With Custom-Built Link, you can make it easier for users to buy your tokens, allowing them to complete their purchases with just one click across 10+ different chains.

Example: https://app.bolide.fi/

## 3. How to contact with us ### If you have further questions, please fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSeJamZPxZm2oDyMGUFcEqlSHfy_WjIpuAYEqwu98rPg5xAedA/viewform) and include the services you would like to integrate. Once we receive it, we will contact you as soon as possible. # XY Finance API (Multiple Bridges Aggregator) XY Finance API offers developers a seamless solution for transferring liquidity and information across various chains. With this API, you can effortlessly access aggregated liquidity and information from numerous decentralized exchange networks, both on-chain and off-chain, as well as bridges, spanning multiple blockchains. The API provides a wide range of parameters that can be tailored to suit the specific requirements of your application and users. It empowers you to effortlessly navigate the multi-chain ecosystem and interact with on-chain XY contracts on different chains. This versatility enables you to integrate and leverage the benefits of the multi-chain world with ease. #### XY Finance **API** **(Multiple Bridges Aggregator)** Endpoint
VersionNoteEndpoint
v1The latest versionhttps://aggregator-api.xy.finance/v1/
{% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Get Quote This endpoint will return currently available routes with estimated target token amount for your quote. You can also designate specific bridges or aggregator to customize the route. If there is no available route, it will return an error\_code, which you can reference [here](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/error-message) to get error detail. {% openapi src="/files/TtIQ5kToU9bWazZWUKQj" path="/quote" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2F992nLSFootyLzNGT3OSd%2Fopenapi.json?alt=media\&token=dbdd978e-3fd3-4af0-a7aa-36ce013023ad) {% endopenapi %} ### Parameter/Response Details * Use `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE` as the address for the native token in your parameter. * If you would like to know more about **commissionRate** fields and fee collection function, please refer to [Monetization / Take Fees](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/monetization-take-fees) * If you would like to know latest supported bridge provider and swap provider, please refer to [Supported Blockchains/Bridges/DEXs](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/supported-blockchains-bridges-dexs) * The `estimatedGas` field in the API response is an estimated value. For now, please use a method similar to RPC, such as [eth\_estimateGas](https://www.quicknode.com/docs/ethereum/eth_estimateGas), to re-estimate the actual gas limit. You can refer to the following sample code to do that: ```python from web3 import Web3 import requests ​ if __name__ == "__main__": # 1st: get tx data from xy aggregator api endpoint = 'https://aggregator-api.xy.finance/v1/buildTx?srcChainId=137&srcQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&srcQuoteTokenAmount=9000000000000000000&dstChainId=56&dstQuoteTokenAddress=0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d&slippage=1&receiver=0x9cEEEbdF49cF5DEa891C9D74f8ea03af2aCf284F&bridgeProvider=yBridge&srcBridgeTokenAddress=0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174&dstBridgeTokenAddress=0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d&srcSwapProvider=OneInch%20V4%20DexAggregator&affiliate=0x512E00f66217714BAee5F0736428b026e8c30AF5' resp = requests.get(endpoint) resp_json = resp.json() ​ # 2nd: get estimateGas by calling web3 rpc rpc_endpoint = 'https://polygon.llamarpc.com' w3 = Web3(Web3.HTTPProvider(rpc_endpoint)) estimate_gas = w3.eth.estimate_gas(resp_json["tx"]) ​ # 3rd: Combine the estimateGas with the tx data tx = resp_json["tx"] tx["gas"] = estimate_gas ​ # 4th: sign the tx & send it priv_key = "0x" tx_signed = w3.eth.account.sign_transaction(tx, priv_key) tx_hash = w3.eth.send_raw_transaction(tx_signed.rawTransaction) ``` ### Example Request ```shell $ curl "https://aggregator-api.xy.finance/v1/quote?srcChainId=10&srcQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&srcQuoteTokenAmount=1000000000000000000&dstChainId=56&dstQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&slippage=1&bridgeProviders=yBridge ``` This request is asking a quote of **1 ETH** on **Optimism** to **ETH** on **Arbitrum Chain** and designate yBridge as bridgeProvider. {% hint style="warning" %} **`IMPORTANT:`**` ``Note that the amount parameter should be padded with zeroes. For example, pass`` `**`100000000`**` ``instead of`` `**`100`**` ``if the decimals of the token is 6.` {% endhint %} {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Get Allowance If source quoting asset is an ERC20 token, you should ensure that source token owner has approved sufficient token amount to spender before proceed swap operation. This endpoint provide convenient way to check ERC20 allowance amount. {% openapi src="/files/WHsYhaZR0heNBFy7A96c" path="/allowance" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2FnbSx9SgRqHu6Fj5VWo1E%2Fopenapi.json?alt=media\&token=aa194fc4-5d6d-43c2-b4f2-e972276123f6) {% endopenapi %} {% hint style="info" %} **NOTE :** The spender should be the `contractAddress` in the response of [Get Quote](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/get-quote).\ e.g. `routes[{ROUTE_INDEX}]["contractAddress"]` {% endhint %} {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Build Approval Transaction If your allowance is not sufficient, this endpoint can help you initiate an ERC20 approval transaction. {% openapi src="/files/TtIQ5kToU9bWazZWUKQj" path="/approveTx" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2F992nLSFootyLzNGT3OSd%2Fopenapi.json?alt=media\&token=dbdd978e-3fd3-4af0-a7aa-36ce013023ad) {% endopenapi %} {% hint style="info" %} **NOTE :** The spender should be the `contractAddress` in the response of [Get Quote](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/get-quote).\ e.g. `routes[{ROUTE_INDEX}]["contractAddress"]` {% endhint %} {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Build Swap Transaction {% openapi src="/files/TtIQ5kToU9bWazZWUKQj" path="/buildTx" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2F992nLSFootyLzNGT3OSd%2Fopenapi.json?alt=media\&token=dbdd978e-3fd3-4af0-a7aa-36ce013023ad) {% endopenapi %} When building transaction, there are 6 additional parameters along with **quote** input.
Field nameRequirement
receiverRequired
srcSwapProviderRequired when srcSwapDescription is presented in quote result
dstSwapProviderRequired when dstSwapDescription is presented in quote result
bridgeProviderRequired when bridgeDescription is presented in quote result
srcBridgeTokenAddressRequired when bridgeDescription is presented in quote result
dstBridgeTokenAddressRequired when bridgeDescription is presented in quote result
To build transaction, please fill the corresponding fields (`srcSwapDescription`, `bridgeDescription` and `dstSwapDescription`) from **quote** response's route to **buildTx** input . If parameters are not filled properly, it may not return the desired routing result. You can review the transaction calldata route by checking `route` field in **buildTx** response. For example, following response is **quote** result of **Arbitrum USDT** to **KCC native token**. 
// quote response
{
    "success": true,
    "routes": [
        {
            "srcChainId": 42161,
            "srcQuoteTokenAddress": "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9",
            "srcQuoteTokenAmount": "10000000",
            "dstChainId": 321,
            "dstQuoteTokenAddress": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
            "srcSwapDescription": null,
            "bridgeDescription": {
                "provider": "yBridge",
                // ...
            },
            "dstSwapDescription": {
                "provider": "XY DexAggregator",
                // ...
            },
            // ...
        }
    ],
}
* `srcSwapDescription` is **null** because these is no source chain swap needed in this route, so we don't have to fill `srcSwapProvider` when calling buildTx. * We have a non-empty `bridgeDescription` because it's a cross-chain quote. We need to fill corresponding `bridgeProvider`, `srcBridgeTokenAddress` and `dstBridgeTokenAddress` when calling buildTx. For single chain quote, we can skip these parameters. * `dstSwapDescription` is needed in this route. So we need to fill `dstSwapProvider` when calling buildTx. Therefore, we can create the following **buildTx** request from above information: ```sh // buildTx request curl -G \ -d 'srcChainId=42161' \ -d 'srcQuoteTokenAddress=0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9' \ -d 'srcQuoteTokenAmount=10000000' \ -d 'dstChainId=321' \ -d 'dstQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ -d 'slippage=1' \ -d 'receiver=YOUR_DESTINATION_CHAIN_RECEIVER_ADDRESS' \ -d 'bridgeProvider=yBridge' \ -d 'srcBridgeTokenAddress=0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9' \ -d 'dstBridgeTokenAddress=0x0039f574eE5cC39bdD162E9A88e3EB1f111bAF48' \ -d 'dstSwapProvider=XY%20DexAggregator' \ https://aggregator-api.xy.finance/v1/buildTx ``` ### Parameter/Response Details * Use `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE` as the address for the native token in your parameter. * If you would like to know more about **commissionRate** fields and fee collection function, please refer to [Monetization / Take Fees](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/monetization-take-fees) * If you would like to know latest supported bridge provider and swap provider, please refer to [Supported Blockchains/Bridges/DEXs](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/supported-blockchains-bridges-dexs) * The `estimatedGas` field in the API response is an estimated value. For now, please use a method similar to RPC, such as [eth\_estimateGas](https://www.quicknode.com/docs/ethereum/eth_estimateGas), to re-estimate the actual gas limit. You can refer to the following sample code to do that: ```python from web3 import Web3 import requests ​ if __name__ == "__main__": # 1st: get tx data from xy aggregator api endpoint = 'https://aggregator-api.xy.finance/v1/buildTx?srcChainId=137&srcQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&srcQuoteTokenAmount=9000000000000000000&dstChainId=56&dstQuoteTokenAddress=0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d&slippage=1&receiver=0x9cEEEbdF49cF5DEa891C9D74f8ea03af2aCf284F&bridgeProvider=yBridge&srcBridgeTokenAddress=0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174&dstBridgeTokenAddress=0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d&srcSwapProvider=OneInch%20V4%20DexAggregator&affiliate=0x512E00f66217714BAee5F0736428b026e8c30AF5' resp = requests.get(endpoint) resp_json = resp.json() ​ # 2nd: get estimateGas by calling web3 rpc rpc_endpoint = 'https://polygon.llamarpc.com' w3 = Web3(Web3.HTTPProvider(rpc_endpoint)) estimate_gas = w3.eth.estimate_gas(resp_json["tx"]) ​ # 3rd: Combine the estimateGas with the tx data tx = resp_json["tx"] tx["gas"] = estimate_gas ​ # 4th: sign the tx & send it priv_key = "0x" tx_signed = w3.eth.account.sign_transaction(tx, priv_key) tx_hash = w3.eth.send_raw_transaction(tx_signed.rawTransaction) ``` ### Example Request 
$ curl https://aggregator-api.xy.finance/v1/buildTx?srcChainId=10&srcQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&srcQuoteTokenAmount=1000000000000000000&dstChainId=56&dstQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&slippage=1&receiver=0xb6EFA1C3679f1943f8aC4Fc9463Cc492435c6C92&bridgeProvider=yBridge&srcBridgeTokenAddress=0x94b008aA00579c1307B0EF2c499aD98a8ce58e58&dstBridgeTokenAddress=0x55d398326f99059fF775485246999027B3197955&affiliate=0x90d67a9eaC7324A1a2942D6Dea9f6174Ad6048c9&commissionRate=100000&srcSwapProvider=OKX+DEX&dstSwapProvider=OKX+DEX
This request is asking to bridge **1** **ETH** from **Optimism** for **ETH** on the **BNB Chain** {% hint style="warning" %} **`IMPORTANT:`**` ``Note that the amount parameter should be padded with zeroes. For example, pass`` `**`100000000`**` ``instead of`` `**`100`**` ``if the decimals of the token is 6.` {% endhint %} {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Get Cross-Chain Status After cross-chain transaction sent, you can check the current cross-chain status using this endpoint. ## Get Cross Chain Status `GET` `https://aggregator-api.xy.finance/v1/crossChainStatus` #### Query Parameters | Name | Type | Description | | -------------------------------------------- | ------- | ----------------------------- | | srcChainId\* | Integer | Source chain ID | | srcTxHash\* | String | Source chain transaction hash | {% tabs %} {% tab title="200: OK Done" %} ```json { "success": true, "status": "Done", "msg": "Transaction has been completed.", "tx": "" } ``` {% endtab %} {% tab title="200: OK Processing" %} ```json { "success": true, "status": "Processing", "msg": "Source chain transaction detected, destination chain transaction pending.", "tx": null } ``` {% endtab %} {% tab title="200: OK Not found" %} ```json { "success": false, "status": "Not found", "msg": "No transaction found in the system.", "tx": null } ``` {% endtab %} {% tab title="200: OK Receive bridge token" %} ```json { "success": true, "status": "Receive bridge token ", "msg": "Transaction reverted, bridge token received.", "tx": "" } ``` {% endtab %} {% tab title="200: OK Receive synapse token" %} ```json { "success": true, "status": "Receive synapse bridge token ", "msg": "Transaction reverted, Synapse token received.", "tx": "" } ``` {% endtab %} {% tab title="200: OK Pending refund" %} ```json { "success": true, "status": "Pending refund", "msg": "Transaction cannot be executed on destination chain, refund pending.", "tx": null } ``` {% endtab %} {% tab title="200: OK Refunded" %} ```json { "success": true, "status": "Refunded", "msg": "Transaction cannot be executed on destination chain, refunded.", "tx": "" } ``` {% endtab %} {% endtabs %} There are seven possible statuses: **Not found, Processing, Done, Receive bridge token, Receive synapse token, Pending refund, and Refunded.** | Status | Msg | Discription | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Not found** | No transaction found in the system. | No matching system record or source chain transaction detected. | | **Processing** | Source chain transaction detected, destination chain transaction pending. | System record exists; source transaction complete, destination pending. | | **Done** | Transaction has been completed. | There is a system record, and the destination transaction has been completed. | |

Receive bridge token (TOKEN\_NAME)

For example :

  • Receive bridge token (USDT)
  • Receive bridge token (USDC)
  • Receive bridge token (ETH)
| Transaction reverted, bridge token received. | Due to price change over the slippage tolerance or other unforeseen issues, the transaction has been reverted on the destination chain and received bridge token instead. | |

Receive synapse token ( TOKEN\_NAME )

  • Receive synapse token (nUSD)
  • Receive synapse token (nETH)
| Transaction reverted, Synapse token received. | Due to price swap over the slippage tolerance or other unforeseen issues, your transaction was reverted on the destination chain and received Synapse's bridge token instead. | | **Pending refund** | Transaction cannot be executed on destination chain, refund pending. | Transaction encountered an error and cannot be executed on the destination chain, we will refund the bridge token on the source chain. Once the refund transaction has been completed, it will be marked as Refunded. | | **Refunded** | Transaction failed on destination chain, refunded. | Refund completed, pool token sent to source chain sender's address. | {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Get MinimumSwapAmount {% openapi src="/files/MzPUh2zZX7pVgpcroUKz" path="/info/minimumSwapAmount" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2FuliN2Fmxbutd9Ej5RST4%2Fopenapi.json?alt=media\&token=3f444dcb-a8e6-432c-b79d-d602068dd4a5) {% endopenapi %} ```json { "success": true, "chainMinimumSwapAmount": { "1": { "minimumSwapAmountUsdValue": 37, "expiredAt": 1708329600 }, "56": { "minimumSwapAmountUsdValue": 1.16, "expiredAt": 1708329600 } } } ``` For the provided example response, the keys '10' and '137' represent the chain IDs of the destination chains you intend to bridge to. Within this structure, the information indicates the minimum required amount in USD Value for a seamless transaction, along with its expiration time. * `minimumSwapAmount`: Please ensure that your source bridge token amount is greater than this amount; otherwise, the response may result in an error. * `expiryAt`: Each chain has its own expiry time. The details in the object will **no longer be usable** once the expiry time has passed. {% hint style="info" %} Please confirm the expiration time before it's due. The **quickest** we update is **every 20 minutes,** but it can vary. {% endhint %} # Recommended Tokens {% openapi src="/files/WHsYhaZR0heNBFy7A96c" path="/recommendedTokens" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2FnbSx9SgRqHu6Fj5VWo1E%2Fopenapi.json?alt=media\&token=aa194fc4-5d6d-43c2-b4f2-e972276123f6) {% endopenapi %} {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Supported Blockchains/Bridges/DEXs Full list of supported blockchain networks #### 1. Supported Blockchains {% openapi src="/files/TtIQ5kToU9bWazZWUKQj" path="/supportedChains" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2F992nLSFootyLzNGT3OSd%2Fopenapi.json?alt=media\&token=dbdd978e-3fd3-4af0-a7aa-36ce013023ad) {% endopenapi %} #### 2. Supported Bridges Providers {% openapi src="/files/TtIQ5kToU9bWazZWUKQj" path="/supportedBridgeProviders" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2F992nLSFootyLzNGT3OSd%2Fopenapi.json?alt=media\&token=dbdd978e-3fd3-4af0-a7aa-36ce013023ad) {% endopenapi %} #### 3. Supported Swap Providers (DEXs) {% openapi src="/files/TtIQ5kToU9bWazZWUKQj" path="/supportedSwapProviders" method="get" %} [openapi.json](https://3694085950-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mcs9EhDrgbKHodtcAT6%2Fuploads%2F992nLSFootyLzNGT3OSd%2Fopenapi.json?alt=media\&token=dbdd978e-3fd3-4af0-a7aa-36ce013023ad) {% endopenapi %} * XY Finance has currently integrated several DEX Aggregators. The `supported dexes` field may vary with updates to the DEX Aggregator. If the field is empty, it indicates that the DEX Aggregator has not provided this information. {% hint style="info" %} Here you can find our full [API reference](https://aggregator-api.xy.finance/v1/docs) {% endhint %} # Error Message ``` // error response schema { success: boolean errorCode: integer errorMsg: string } ```
DescriptionerrorMsgerrorCode
Unknown error.Unknown error.10000
System maintenance.System under maintenance. Please wait and check our Twitter for updates.10001
Parameter 'affiliate' is invalid.Affiliate is required if commission_rate is provided.20001
Parameter 'slippage" is invalid.Slippage must be within the range [0, 50]20003
Parameter 'swapProviders' is required.If 'srcQuoteTokenAddress' differs from 'srcBridgeTokenAddress' or 'dstQuoteTokenAddress' differs from 'dstBridgeTokenAddress', API request parameter 'swapProviders' is required.20004
Parameter 'bridgeProvider', 'srcBridgeTokenAddress' and 'dstBridgeTokenAddress' are required.If 'srcChainId' differs from 'dstChainId', API request parameters 'bridgeProvider', 'srcBridgeTokenAddress' and 'dstBridgeTokenAddress' are required.20005
Address is invalid.Address {address} is invalid.20006
Cannot apply parameter 'swap provider'.{Source/Destination} 'swapProviders' is not allowed {reason}.20007
Cannot apply parameter 'bridge provider'.If 'srcChainId' equals 'dstChainId', API request parameter 'bridgeProviders' is not allowed.20008
Parameter 'sourceQuoteToken' ≤ 0API request parameter 'srcTokenAmount' must be greater than 0.20009
Not supported network.Chain {chain_id} is not supported.30001
No available route found.No available route found, please try again later.30002
Not supported 'bridgeProviders''bridgeProvider' : {bridgeProvider} is not supported.30003
Invalid 'commisionRate'API request parameter 'commission_rate' {value} is not in the range [{lower_bound}, {upper_bound}].30004
Not supported 'swapProviders''swapProvider' : {swapProvider} is not supported on chain {chain_id}.30005
Network under maintenance.The network chain id : {chain_id} is under maintenance, please follow our update.30006
Applied dex aggregator currently no route.Applied DEX aggregator is currently unable to provide available route for requested swap pair, please try again later.30007
Not supported bridge token amount; amount is too low.Bridge token amount below minimum threshold. Please try a higher amount. Minumum threshold : {Threshold_bridge_token_amount: int} {src_bridge_token_symbol: int} Threshold bridge token address : {src_bridge_token_address: int}30008
Not supported bridge token amount; amount is too high.Bridge token amount exceeds maximum threshold. Please try a lower amount. Maximum threshold : {Threshold_bridge_token_amount: int} {src_bridge_token_symbol: int} Threshold bridge token address : {src_bridge_token_address: int}30009
[yBridge] requested bridge token is not a yBridge tokenRequested bridge token is invalid and not supported by yBridge.31003
[cBridge] API failcBridge API error.32004
# Monetization / Take Fees Integrate [XY Finance API (Multiple Bridges Aggregator)](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator) to enable fee collection from transaction volumes in your dApp ### How it works By integrating XY Finance API to request transaction quotes, dApps can now include a fee parameter to specify the percentage of the transaction volume they wish to collect as fees. This percentage fee will be deducted from the user's initial asset in the transaction and directly distributed to the designated wallet address. XY Finance will receive a percentage share of the collected fees based on the specific use case and transaction volume. ### How to set up To configure the fee collection, there are two relevant parameters that you can adjust: `affiliate` and `commission rate` during the execution of [Get Quote](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/get-quote) and [Build Swap Transaction](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/build-swap-transaction) * `commission rate` represents the fee you wish to collect. It is an integer between 0 and 100,000. In this range, 100,000 corresponds to 10%, 10,000 represents 1%, and so on in a similar fashion. * `affiliate` parameter represents the address where you want to receive the fees. The collected fee in every transaction will be directly transferred to this address. Before proceeding, please ensure that the provided address is under your management and capable of receiving assets correctly. Below are examples demonstrating how to configure the fee setup. **API Example** ``` // quote request with affiliate and commissionRate curl -G \ -d 'srcChainId=42161' \ -d 'srcQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ -d 'srcQuoteTokenAmount=10000000000000000' \ -d 'dstChainId=59144' \ -d 'dstQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ -d 'slippage=1' \ -d 'affiliate=YOUR_AFFILIATE_ADDRESS' \ -d 'commissionRate=1000' \ https://aggregator-api.xy.finance/v1/quote ``` ```bash // buildTx request with affiliate and commissionRate curl -G \ -d 'srcChainId=42161' \ -d 'srcQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ -d 'srcQuoteTokenAmount=10000000000000000' \ -d 'dstChainId=59144' \ -d 'dstQuoteTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ -d 'slippage=1' \ -d 'affiliate=YOUR_AFFILIATE_ADDRESS' \ -d 'commissionRate=1000' \ -d 'receiver=YOUR_DESTINATION_CHAIN_RECEIVER_ADDRESS' \ -d 'bridgeProvider=Synapse' \ -d 'srcBridgeTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ -d 'dstBridgeTokenAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' \ https://aggregator-api.xy.finance/v1/buildTx ``` #### Transaction example Here is the link of the transaction where you can actually know how the affiliate fee is collected and distributed {% embed url="" %} In this case, the quote parameters are as follows: * **commisionRate** = 1000 * it means the transaction will take 1000/1000000 = 0.1% as the affiliate fee. * **srcQuoteTokenAmount** = 10000000000000000 * it represents 0.01 without decimals. * **srcQouteTokenAddess** = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE * it represents as native token in our API You can find the following process executed in this transaction: * **XY router** (0x062.....08c) will distribute 0.1 % of the volume as the affiliate fee (0.00001 ETH) * Transfer 0.000008 ETH to the designated affiliate address (0xBF.....362) * Transfer 0.000002 ETH to XY fee collector (0x46.....29d) # Change Log ### \[2023-09-22] #### Features * New API : [Supported Bridges Providers](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/supported-blockchains-bridges-dexs) * New API : [Supported Swap Providers (DEXs)](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/supported-blockchains-bridges-dexs) ### \[2023-07-19] #### Features * Public Release [XY Finance API (Multiple Bridges Aggregator)](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator) * [Build Swap Transaction](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/build-swap-transaction) supports bridgeProvider, srcSwapProvider and dstSwapProvider. * Support [Monetization / Take Fees](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/monetization-take-fees) for API * New API : [Supported Blockchains API ](/bridge-aggregator-integration/xy-finance-api-multiple-bridges-aggregator/supported-blockchains-bridges-dexs) # XY Finance Widget (iframe) XY Finance Widget is easy to embed into your apps and sites alike, helping engage and retain your users. XY Finance team has been wracking our brains just to come up with a powerful engagement tool to help strengthen your user retention, making them want to come back more for a satisfying user experience that this widget provides for your website and reducing friction by letting them fast-forward into your app's/site's key functionality. Note that this Widget will be constantly renewed as we're also gathering more resources and collecting feedback from users along the way. ## Get Started Place the `