A minimal package for sending cross-chain swap transactions
npm install --save @mayanfinance/swap-sdk
Import the necessary functions and models:
import { fetchQuote, swapFromEvm, swapFromSolana, Quote } from '@mayanfinance/swap-sdk'
Then you will need to get a quote:
const quotes = await fetchQuote({
amount: 250,
fromToken: fromToken.contract,
toToken: toToken.contract,
fromChain: "avalanche",
toChain: "solana",
slippageBps: 300, // means 3%
gasDrop: 0.04, // optional
referrer: "YOUR SOLANA WALLET ADDRESS", // optional
referrerBps: 5, // optional
});
You can get the list of supported tokens using Tokens API
To enable Gas on destination set the gasDrop param to the amount of native token (e.g. ETH, BNB..) you want to receive on the destination chain.
Maximum supported amount of gasDrop for each destination chain:
ethereum: 0.05 ETH
bsc: 0.02 BNB
polygon: 0.2 MATIC
avalanche: 0.2 AVAX
solana: 0.2 SOL
arbitrum: 0.01 ETH
optimism: 0.01 ETH
base: 0.01 ETH
If you want to receive referrer fee, set the
referrer
param to your wallet address.
Slippage is in bps (basis points), so 300 means "up to three percent slippage".
After you get the quote, you can build and send the swap transaction:
swapTrx = await swapFromSolana(quotes[0], originWalletAddress, destinationWalletAddress, deadlineInSeconds, referrerAddresses, signSolanaTransaction, solanaConnection)
referrerAddresses
is an optional object with two keys evm
and solana
that contains the referrer addresses for each network type.
example:
{
evm: "YOUR EVM WALLET",
solana: "YOUR SOLANA WALLET"
}
If you need more control over the transaction and manualy send the trx you can use createSwapFromSolanaInstructions
function to build the solana intruction.
swapTrx = await swapFromEvm(quotes[0], destinationWalletAddress, deadlineInSeconds, referrerAddress, provider, signer)
If you need to get the transaction payload and send it manually, you can use getSwapFromEvmTxPayload
function to build the EVM transaction payload.
referrerAddress
must be a Solana wallet address. If you don't want to get referrer fee from users, set "referrerAddress" tonull
or"11111111111111111111111111111111"
To track the progress of swaps, you can use Mayan Explorer API by passing the transaction hash of the swap transaction.
The response contains a lot of info about the swap but the important field is `clientStatus` which can be one of the following values:
-
INPROGRESS
- the swap is being processed -
COMPLETED
- the swap is completed -
REFUNDED
- the swap has refunded
You can also use this SDK in your react native app:
import { transact, Web3MobileWallet } from '@solana-mobile/mobile-wallet-adapter-protocol-web3js';
For swaps from solana after importing the above functions from Solana Mobile SDK you have to pass a callback function that calls transact
function as the signSolanaTransaction
parameter of swapFromSolana
function:
const signSolanaTransaction = useCallback(
async (tx: Transaction) => {
return await transact(async (wallet: Web3MobileWallet) => {
authorizeSession(wallet);
const signedTransactions = await wallet.signTransactions({
transactions: [tx],
});
return signedTransactions[0];
});
},
[authorizeSession],
);
For swaps from EVM you can use useWalletConnectModal
hook from WalletConnet to get the provider and pass it to swapFromEvm
function as the signer
:
import {useWalletConnectModal} from '@walletconnect/modal-react-native';
...
const { provider: evmWalletProvider} =
useWalletConnectModal();
...
const web3Provider = new ethers.providers.Web3Provider(
evmWalletProvider,
);
const signer = web3Provider.getSigner(0);
To learn more about how to use Mayan SDK in a react-native project, you can check this scaffold.