SwapKit

🚧🚧🚧🚧🚧🚧 ALPHA version of SwapKit SDK. Under heavy development. Use at your own risk. 🚧🚧🚧🚧🚧🚧

Usage

Install

yarn add @thorswap-lib/swapkit-core

Usage

Architecture of SwapKit SDK is pretty simple. It's based on the concept of toolboxes. Each toolbox is responsible for interacting with specific blockchain. For example, @sequelfinance/toolbox-evm is responsible for interacting with ETH, AVAX, BSC, etc. Toolboxes are extending SwapKitCore instance with methods to interact with specific blockchain. SwapKitCore is responsible for managing wallets and providing unified interface for interacting with them. To extend SDK with wallet support you need to pass array of wallets to extend method. Wallets are responsible for interacting with specific wallet provider. After extend method is called, you can start connecting to wallets and interacting with them.

import { Chain, FeeOption } from '@sequelfinance/types';
import { SwapKitCore } from '@thorswap-lib/swapkit-core';
import { keystoreWallet } from '@thorswap-lib/keystore';
import { ledgerWallet } from '@thorswap-lib/ledger';
import { trustwalletWallet } from '@thorswap-lib/trustwallet';
import { evmWallet, keplrWallet, xdefiWallet } from '@thorswap-lib/web-extensions';

const getSwapKitClient = () => {
  const client = new SwapKitCore()

  client.extend({
    config: {
      // Blockchair API KEY
      utxoApiKey: ''
      covalentApiKey: '',
      ethplorerApiKey: '',
    },
    wallets: [
      keystoreWallet,
      ledgerWallet,
      trustwalletWallet,
      evmWallet,
      keplrWallet,
      xdefiWallet,
    ],
  });

  return SKClient;
}

// [44, 60, 2, 0, 0]
const llderivationPath = getDerivationPathFor({ chain: Chain.ETH, index: 2, type: 'ledgerLive' })
// [44, 60, 0, 0, 2]
const derivationPath = getDerivationPathFor({ chain: Chain.ETH, index: 2 })

const connectLedger = (chain: Chain) => {
  await getSwapKitClient().connectLedger(Chain.ETH, derivationPath)

  // { address: '0x...', balance: [], walletType: 'LEDGER' }
  const walletData = await getSwapKitClient().getWalletByChain(Chain.ETH)
}

// quoteRoute is returned from `/quote` API endpoint
// https://dev-docs.thorswap.net/aggregation-api/examples/Swap#fetch-quote
const quoteParams = (sender: string, recipient: string) => {
    sellAsset: 'ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044',
    buyAsset: 'BTC.BTC',
    sellAmount: '1000',
    senderAddress: sender,
    recipientAddress: recipient
}

const baseUrl = `https://api.thorswap.net/aggregator`;
const paramsStr = new URLSearchParams(quoteParams).toString();

const fetchQuote = (sender: string, recipient: string) => {
  const params = quoteParams(sender, recipient)
  const paramsStr = new URLSearchParams(params).toString();

  return fetch(`${baseUrl}/tokens/quote?${paramsStr}`).then(res => res.json())
}

const swap = () => {
  const senderAddress = '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC'
  const recipient = 'bc1qcalsdh8v03f5xztc04gzqlkqhx2y07dakv7f5c'
  const { routes } = fetchQuote()
  // select best route from routes -> it has `optimal` flag set to true
  const route = routes[0]

  if (getSwapKitClient().validateAddress({ chain: Chain.BTC, address: recipient })) {
    const txHash = await SKClient.swap({
      route,
      // Fee option multiplier -> it will be used if wallet supports gas calculation params
      feeOptionKey: FeeOption.Fastest,
      recipient
    })

    // txHash: '0x...'
  }
}

Development

This repo contains packages around SwapKit sdk and its integrations with different blockchains.

Packages

Package	Description	Chains
@thorswap-lib/swapkit-core	Core package for SwapKit	-
@sequelfinance/toolbox-evm	Toolkit to integrate EVM chain	ETH, AVAX, BSC
@thorswap-lib/toolbox-utxo	Toolkit to integrate UTXO chain	BTC, LTC, DOGE, BCH
@thorswap-lib/toolbox-cosmos	Toolkit to integrate Cosmos chains	THOR, ATOM, BNB
@thorswap-lib/keystore	Keystore implementation	All chains supported by toolboxes
@thorswap-lib/ledger	Ledger implementation	All chains supported by toolboxes
@thorswap-lib/trustwallet	Trustwallet implementation	THOR, BNB, ETH
@thorswap-lib/walletconnect	Walletconnect implementation	ETH
@thorswap-lib/web-extensions	Browser extensions	See more

Setup

yarn install; yarn build

Contributing

New package

To create new package use yarn generate and pick one of the options It will setup the package with the necessary files for bundling and publishing.

Rules and conventions

Project comes with @commitlint/config-lerna-scopes so we can generate changelogs with changesets so commits should have scope in task when it's touching just one package i.e. "chore(ledger): add ATOM integration". See more

Release and publish

Packages are automatically published to npm when new PR is merged to develop and main branches. To automate and handle process we use changesets and github action workflows.

To release new version of package you need to create PR with changes and add changeset file to your commit.

yarn changeset

After PR is merged to develop branch with changeset file, github action will create new PR with updated versions of packages and changelogs.

Testing

To run tests use yarn test command.