37.5.0 • Published 2 days ago

@dontuseit/swap-sdk v37.5.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 days ago

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".

Swap from Solana:

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

Swap from EVM:

swapTrx = await swapFromEvm(quote, destinationWalletAddress, deadlineInSeconds, referrerAddresses, 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

📱 React Native Support (Solana Mobile SDK):

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.

37.2.0

2 days ago

37.3.0

2 days ago

37.4.0

2 days ago

37.5.0

2 days ago

37.1.0

2 days ago

37.0.0

3 days ago

36.5.0

5 days ago

36.6.0

5 days ago

36.2.0

7 days ago

36.3.0

6 days ago

36.1.0

7 days ago

35.9.0

9 days ago

35.6.0

11 days ago

35.7.0

11 days ago

35.8.0

11 days ago

35.5.0

11 days ago

35.4.0

13 days ago

35.2.0

16 days ago

35.3.0

16 days ago

35.1.0

16 days ago

35.0.0

17 days ago

31.0.0

18 days ago

30.7.0

19 days ago

30.5.0

19 days ago

30.3.0

19 days ago

30.1.0

19 days ago

30.6.0

19 days ago

30.4.0

19 days ago

30.2.0

19 days ago

30.0.0

19 days ago

29.3.0

24 days ago

29.2.0

25 days ago

28.9.0

27 days ago

28.7.0

28 days ago

29.0.0

27 days ago

28.8.0

28 days ago

28.6.0

28 days ago

29.1.0

27 days ago

28.5.0

1 month ago

28.1.0

1 month ago

28.3.0

1 month ago

28.0.0

1 month ago

28.4.0

1 month ago

27.7.0

1 month ago

27.9.0

1 month ago

27.3.0

1 month ago

27.5.0

1 month ago

27.8.0

1 month ago

27.4.0

1 month ago

27.6.0

1 month ago

27.2.0

1 month ago

26.9.0

1 month ago

27.1.0

1 month ago

27.0.0

1 month ago

26.7.0

1 month ago

26.5.0

1 month ago

26.3.0

1 month ago

26.1.0

1 month ago

26.8.0

1 month ago

26.6.0

1 month ago

26.4.0

1 month ago

26.2.0

1 month ago

26.0.0

1 month ago

21.4.0

1 month ago

21.6.0

1 month ago

21.5.0

1 month ago

21.3.0

2 months ago

21.2.0

2 months ago

21.1.0

2 months ago

21.0.0

2 months ago

20.9.0

2 months ago

20.8.0

2 months ago

20.7.0

2 months ago

20.5.0

2 months ago

20.4.0

2 months ago

20.6.0

2 months ago

20.1.0

2 months ago

20.0.0

2 months ago

20.3.0

2 months ago

20.2.0

2 months ago

11.6.0

2 months ago

11.7.0

2 months ago

11.4.0

2 months ago

11.5.0

2 months ago

11.8.0

2 months ago

11.9.0

2 months ago

11.3.0

2 months ago

10.9.0

2 months ago

11.2.0

2 months ago

11.0.0

2 months ago

11.1.0

2 months ago

10.5.0

2 months ago

10.6.0

2 months ago

10.7.0

2 months ago

10.8.0

2 months ago

5.1.0

2 months ago

10.3.0

2 months ago

10.4.0

2 months ago

10.0.0

3 months ago

10.1.0

3 months ago

10.2.0

3 months ago

8.4.0

3 months ago

8.3.0

3 months ago

8.1.0

3 months ago

8.2.0

3 months ago

8.0.0

3 months ago

7.0.0

4 months ago

6.0.0

4 months ago

4.9.9

4 months ago