Getting Started with LuminaDex SDK

The LuminaDex SDK is a powerful library for interacting with the Lumina DEX contracts on the Mina and Zeko blockchains. It provides a state machine-driven approach to managing wallet connections, token swaps, liquidity provision, and other DEX-related operations.

Installation

npm

npm install @lumina-dex/sdk

pnpm

pnpm add @lumina-dex/sdk

yarn

yarn add @lumina-dex/sdk

bun

bun add @lumina-dex/sdk

Prerequisites

To develop a dapp using the LuminaDex SDK effectively, you'll need:

• A modern JavaScript environment with ES modules support
• A Mina wallet extension installed in the user's browser (like Auro Wallet)
• Basic familiarity with state machines (though not strictly required)

Quick Start

The core of the SDK revolves around two main modules:

1. Wallet: Manages wallet connection, network switching, and balance fetching
2. DEX: Handles all DEX-related operations like swapping, liquidity, and token deployment

These modules are xstate machines. Here's a quick example to connect a wallet and initialize the DEX:

import { createDex, createWallet } from "@lumina-dex/sdk"

// Create and start the wallet
const Wallet = createWallet()

// Create and start the Dex
const Dex = createDex({
	input: {
		wallet: Wallet,
		frontendFee: {
			destination: "B62qmdQRb8FKaKA7cwaujmuTBbpp5NXTJFQqL1X9ya5nkvHSuWsiQ1H",
			amount: 1
		}
	}
})

// Connect the wallet
Wallet.send({ type: "Connect" })

The SDK provides dedicated integration modules for both React and Vue, making it easy to use in your framework of choice.

Framework Integration

The SDK is framework-agnostic, but it provides dedicated integration modules for both React and Vue. See the React Integration and Vue Integration pages for complete examples.

What's Next?

• Learn about the Core Concepts behind the SDK's design
• Set up Wallet Connection in your application
• Understand how to implement Token Swapping
• Explore the API Reference for detailed information on all available functions and options