Installation

Install the Mina SDK using your preferred package manager.

Package Managers

npm install @siphoyawe/mina-sdk

yarn add @siphoyawe/mina-sdk

pnpm add @siphoyawe/mina-sdk

bun add @siphoyawe/mina-sdk

Peer Dependencies

The SDK requires viem as a peer dependency for Ethereum interactions:

npm install viem

yarn add viem

pnpm add viem

React Integration

If you plan to use the React hooks, you also need React 18 or higher:

npm install @siphoyawe/mina-sdk viem react react-dom

yarn add @siphoyawe/mina-sdk viem react react-dom

TypeScript Support

The SDK is written in TypeScript and includes type definitions. No additional @types packages are required. Ensure your tsconfig.json includes:

tsconfig.json

{
  "compilerOptions": {
    "moduleResolution": "bundler", // or "node16"
    "target": "ES2020",
    "lib": ["ES2020", "DOM"]
  }
}

Import Paths

The SDK provides two entry points:

// Main SDK - client, services, types, errors
import { Mina, getChains, getTokens } from '@siphoyawe/mina-sdk';

// React hooks and provider
import { MinaProvider, useMina, useQuote } from '@siphoyawe/mina-sdk/react';

Bundle Formats

The SDK ships with both ESM and CommonJS bundles:

Format	File	Use Case
ESM	`index.mjs`	Modern bundlers (Vite, webpack 5, esbuild)
CJS	`index.js`	Node.js, older bundlers
Types	`index.d.ts`	TypeScript support

Verifying Installation

Create a simple test file to verify the SDK is installed correctly:

test.ts

import { Mina } from '@siphoyawe/mina-sdk';

const mina = new Mina({
  integrator: 'my-app'
});

// Fetch supported chains
const { chains } = await mina.getChains();
console.log(`SDK loaded. ${chains.length} chains available.`);

Run with:

npx tsx test.ts

You should see output like:

SDK loaded. 42 chains available.

Framework-Specific Setup

Next.js
Vite
Node.js

The SDK works with Next.js App Router and Pages Router. For server components, use the SDK in client components only:

'use client';

import { MinaProvider } from '@siphoyawe/mina-sdk/react';

export function Providers({ children }) {
  return (
    <MinaProvider config={{ integrator: 'my-app' }}>
      {children}
    </MinaProvider>
  );
}

No additional configuration needed. Import and use directly:

import { Mina } from '@siphoyawe/mina-sdk';

The SDK works in Node.js environments for server-side bridging:

import { Mina } from '@siphoyawe/mina-sdk';

const mina = new Mina({
  integrator: 'my-backend-service'
});

Troubleshooting

Module not found error

Ensure you have installed the peer dependency viem:

npm install viem

TypeScript errors with imports

Update your tsconfig.json to use moduleResolution: "bundler" or "node16".

React hooks not available

Import from the /react subpath:

import { useMina } from '@siphoyawe/mina-sdk/react';

Next Steps

Now that the SDK is installed, proceed to the Quick Start guide to execute your first bridge transaction.

Getting Started

Core Concepts

Advanced

Installation

Installation

Package Managers

Peer Dependencies

React Integration

TypeScript Support

Import Paths

Bundle Formats

Verifying Installation

Framework-Specific Setup

Troubleshooting

Next Steps

​Installation

​Package Managers

​Peer Dependencies

​React Integration

​TypeScript Support

​Import Paths

​Bundle Formats

​Verifying Installation

​Framework-Specific Setup

​Troubleshooting

​Next Steps

Installation

Package Managers

Peer Dependencies

React Integration

TypeScript Support

Import Paths

Bundle Formats

Verifying Installation

Framework-Specific Setup

Troubleshooting

Next Steps