arihantbansal / mayan-swap-sdk

npm package for sending cross-chain swap transactions

Home Page:https://swap.mayan.finance

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mayan Swap SDK

A minimal package for sending cross-chain swap transactions

Installation:

npm install --save @mayanfinance/swap-sdk

Usage:

Import the necessary functions and models:

import { fetchQuote, swapFromEvm, swapFromSolana, Quote } from '@mayanfinance/swap-sdk'

Then you will need to get a quote:

Getting Quote:

const quote = await fetchQuote({
  amount: 250,
  fromToken: fromToken.contract,
  toToken: toToken.contract,
  fromChain: "bsc",
  toChain: "solana",
  slippage: 3,
  gasDrop: 0.04, // optional
  referrer: "YOUR SOLANA WALLET ADDRESS", // optional
});

You can get the list of supported tokens using Tokens API

Gas on destination:

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

Referrer fee:

If you want to receive referrer fee, set the referrer param to your wallet address.

Slippage:

Slippage is in percentage, so 3 means "up to three percent slippage".


After you get the quote, you can send the swap transaction:

Swap from Solana:

swapTrx = await swapFromSolana(quote, originWalletAddress, destinationWalletAddress, deadlineInSeconds, referrerAddress, signSolanaTransaction, solanaConnection)

Swap from EVM:

swapTrx = await swapFromEvm(quote, destinationWalletAddress, deadlineInSeconds, referrerAddress, provider, signer)

referrerAddress must be a Solana wallet address. If you don't want to get referrer fee from users, set "referrerAddress" to null or "11111111111111111111111111111111"

Tracking:

To track the progress of swaps, you can use Mayan Explorer API

About

npm package for sending cross-chain swap transactions

https://swap.mayan.finance

License:MIT License


Languages

Language:TypeScript 100.0%