Skip to content

dymensionxyz/bridge-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dymension Bridge SDK

⚠️ EXPERIMENTAL ⚠️ : This SDK is in experimental release. 💚 Contributions are welcome. 💚

Programmatic bridging SDK for Dymension's Hyperlane integration. Enables developers and automated systems to construct bridge transactions without relying on the portal frontend. The SDK helps to construct transactions for dispatching to Dymension, Kaspa, EVM chains or Solana but does not send or sign them.

EXPERIMENTAL: This SDK is in experimental release. Contributions are welcome.

Repository Structure

.
├── sdk/          # The published SDK package for importing in your project
├── examples/     # Examples of importing and using the SDK

Quick Links

  • SDK README - General usage info
  • SDK Docs - Full SDK documentation and API reference
  • Examples - Working examples for all supported routes

Installation

npm install @daniel.dymension.xyz/bridge-sdk

Test Status

Source Destination Route Type Status
Hub Kaspa Direct ✅ (manually tested)
Kaspa Hub Direct ✅ (manually tested)
Hub EVM Direct ⚠️ (experimental)
Hub Solana Direct ⚠️ (experimental)
Hub IBC (inc rollapp) Direct ⚠️ (experimental)
EVM Hub Direct ⚠️ (experimental)
Solana Hub Direct ⚠️ (experimental)
EVM Hyperlane Via Hub ⚠️ (experimental)
Solana Hyperlane Via Hub ⚠️ (experimental)
Kaspa Hyperlane Via Hub ⚠️ (experimental)
IBC Hyperlane Via Hub ⚠️ (experimental)
Rollapp Hyperlane Via Hub ⚠️ (experimental)
Rollapp IBC Via Hub ⚠️ (experimental)

Hyperlane chains: Ethereum, Base, BSC, Solana, Kaspa

Quick Start

import { createBridgeClient } from '@daniel.dymension.xyz/bridge-sdk';

// Create client - requires Hub REST URL for fee queries
const client = createBridgeClient({
  restUrls: {
    dymension: 'https://dymension-api.myserver.com',
  },
});

// High-level transfer API
const result = await client.transfer({
  from: 'dymension',
  to: 'kaspa',
  token: 'KAS',
  amount: 5_000_000_000n, // 50 KAS
  recipient: 'kaspa:qz...',
  sender: 'dym1...',
});

// Sign result.tx with CosmJS and broadcast

Development

# Install dependencies
npm install

# Build SDK
npm run build

# Run tests
npm test

License

MIT

About

Bridge KAS, DYM and other tokens between Kaspa, EVM chains and Solana via Dymension

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published