Getting started with SwapDK

Choose Your Implementation

SwapDK offers two implementation approaches to suit your needs:

SwapDK SDK

Quick and Simple

The all-in-one solution that bundles Core with all available plugins and wallet integrations.

Perfect for developers who want to get started quickly with minimal configuration.

Pros:

• Simplicity and convenience
• Reduced setup time
• Pre-configured with all available plugins and wallets
• Faster implementation for multi-chain applications

Cons:

• Larger bundle size
• Less flexibility for specific customizations

Start with SDK

SwapDK Core

Flexible and Customized

The foundation package providing essential functionality.

Designed to be modular and flexible, allowing you to customize your implementation with only the specific components you need.

Pros:

• Lightweight bundle size
• Fine-grained control over dependencies
• Allows selective updates of components
• Better for specialized applications

Cons:

• Requires more configuration
• More imports and setup code

Start with Core

Note

Choose the implementation that best suits your project’s needs. SwapDK SDK is recommended for most users getting started.

SwapDK SDK: Quick Start

The fastest way to integrate SwapDK into your application.

1. Install the SDK

   Choose your package manager:

   bun
   bash bun add @swapdk/sdk
   pnpm
   bash pnpm add @swapdk/sdk
   npm
   bash npm install @swapdk/sdk
   yarn
   bash yarn add @swapdk/sdk

2. Initialize SwapDK

   import { createSwapKit } from "@swapdk/sdk";
   
   const defaultSwapDK = createSwapKit();
   
   const swapDK = createSwapKit({
     config: {
       apiKeys: {
         swapKit: "your-swapdk-api-key",
       },
     },
   });

3. Start Using SwapDK

   Connect a wallet:

   import { createSwapKit, Chain } from "@swapdk/sdk";
   
   const swapDK = createSwapKit({
     config: { apiKeys: { swapKit: "your-swapdk-api-key" } },
   });
   
   const wallet = await swapDK.connectKeystore(
     [Chain.Ethereum],
     "your mnemonic phrase here"
   );
   
   const address = swapDK.getAddress(Chain.Ethereum);

SwapDK Core: Advanced Setup

For developers who need more control and custom configurations.

1. Install Core Package

   Start with the core package:

   bun
   bash bun add @swapdk/core
   pnpm
   bash pnpm add @swapdk/core
   npm
   bash npm install @swapdk/core
   yarn
   bash yarn add @swapdk/core

2. Install Required Components

   Add only the components you need:

   Wallets
   bun

   bun add @swapdk/wallets

   pnpm

   pnpm add @swapdk/wallets

   npm

   npm install @swapdk/wallets

   yarn

   yarn add @swapdk/wallets

   Install to add integrations with specific wallets. Import specific wallet integrations as needed (e.g., keystoreWallet from @swapdk/sdk). Supports around 20+ wallets, including Ledger, Trezor, Coinbase, WalletConnect and more.

   Plugins
   bun

   bun add @swapdk/plugins

   pnpm

   pnpm add @swapdk/plugins

   npm

   npm install @swapdk/plugins

   yarn

   yarn add @swapdk/plugins

   Install for interactions with specific protocols or products. Install the main plugins package below; you can then import specific plugin integrations as needed (e.g., ThorchainPlugin from @swapdk/sdk). By building your own plugins, you can extend SwapDK to support new protocols, products or actions. Currently SwapDK includes plugins for Chainflip, Thorchain, EVM, Radix, and more.

   Toolboxes

   Toolboxes provide foundational, chain-specific functionalities used internally by wallets and plugins. They are included when you install @swapdk/core and typically don’t need separate installation unless you are building custom integrations or need direct access to low-level chain functions. Check out Toolbox Usage for more information on advanced scenarios.

3. Configure SwapDK

   import { SwapKit, Chain, ThorchainPlugin, EVMPlugin, keystoreWallet, ledgerWallet } from '@swapdk/sdk';
   
   const swapDK = SwapKit({
     config: {
       apiKeys: { swapKit: 'your-swapdk-api-key' }
     },
     plugins: { ...ThorchainPlugin, ...EVMPlugin },
     wallets: { ...keystoreWallet, ...ledgerWallet },
   });
   
   
   await swapDK.connectKeystore([Chain.Ethereum], 'your mnemonic phrase here');
   const wallet = swapDK.getWallet(Chain.Ethereum);

Tip

With the Core implementation, you only include the dependencies you actually need, resulting in a smaller bundle size.

Common Use Cases

No matter which implementation you choose, you can use these common patterns:

Check Balances

import { SwapKit, Chain } from '@swapdk/sdk';

const swapDK = SwapKit({
  config: { apiKeys: { swapKit: 'your-swapdk-api-key' } },
});

const balance = await swapDK.getBalance(Chain.Bitcoin, true);


const allWallets = swapDK.getAllWallets();

Transfer Assets

import { AssetValue, Chain, SwapKit, keystoreWallet } from '@swapdk/sdk';


const swapDK = SwapKit({
  config: { apiKeys: { swapKit: 'your-swapdk-api-key' }, wallets: { ...keystoreWallet } },
});

await swapDK.connectKeystore([Chain.Ethereum], 'your mnemonic phrase here');


const assetValue = AssetValue.from({
  chain: Chain.Ethereum,
  symbol: 'ETH',
  decimal: 18,
  value: '0.1',
});


const txHash = await swapDK.transfer({
  assetValue,
  recipient: '0xRecipientAddressHere',
  memo: 'Optional memo',
});

Perform Swaps

import { AssetValue, Chain, SwapKitApi, SwapKit, keystoreWallet } from '@swapdk/sdk';


const swapDK = SwapKit({
  config: { apiKeys: { swapKit: 'your-swapdk-api-key' }, wallets: { ...keystoreWallet } },
});


await swapDK.connectKeystore([Chain.Ethereum], 'your mnemonic phrase here');


const quoteResponse = await SwapKitApi.getSwapQ({
  fromAsset: AssetValue.from({
    chain: Chain.Ethereum,
    symbol: 'ETH',
    value: '0.1'
  }),
  toAsset: AssetValue.from({
    chain: Chain.Bitcoin,
    symbol: 'BTC'
  }),
});


const swapTx = await swapDK.swap({ route: quoteResponse.routes[0] });

Caution

Always secure sensitive information like mnemonic phrases. In production apps, never hardcode these values.

Next Steps

API Reference

Explore detailed documentation of all SwapDK components and APIs. View References

Guides

Learn how to implement specific use cases with SwapDK. Browse Guides

Toolboxes

Discover blockchain-specific toolboxes for extended functionality. Explore Toolboxes

Wallets

Integrate with different wallet providers using SwapDK. View Wallets