Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.magicblock.gg/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

Install the Magic Router SDK using your preferred package manager: 
npm install magic-router-sdk

​
Basic Setup

Import the SDK functions you need: 
import { 
  prepareMagicTransaction, 
  sendMagicTransaction,
  getClosestValidator,
  getWritableAccounts
} from 'magic-router-sdk';
import { Connection, Transaction } from '@solana/web3.js';
Connect to the Magic Router endpoint: 
const connection = new Connection("https://devnet-router.magicblock.app", "confirmed");

​
Understanding the Fundamentals

Before diving into usage examples, it’s important to understand the core concepts behind Magic Router SDK. These concepts explain why certain methods exist and how they optimize your transaction flow.

Core Concepts

Learn about account delegation, blockhash management, and validator selection in the Magic Router ecosystem.

​
Basic Usage Examples

​
Preparing Transactions (Browser Wallets)

Use prepareMagicTransaction when working with browser wallets that handle signing: 
import { prepareMagicTransaction } from 'magic-router-sdk';

// Build your transaction as usual
const transaction = await program.methods
  .myInstruction()
  .accounts({
    user: userPublicKey,
    // ... other accounts
  })
  .transaction();

// Prepare the transaction with correct blockhash
const preparedTransaction = await prepareMagicTransaction(
  connection, 
  transaction
);

// Sign with wallet (e.g., Phantom, Solflare)
const signedTransaction = await wallet.signTransaction(preparedTransaction);

// Send the signed transaction
const signature = await connection.sendRawTransaction(
  signedTransaction.serialize()
);

​
Sending Transactions (Local Signers)

Use sendMagicTransaction when you have local signers or session keys: 
import { sendMagicTransaction } from 'magic-router-sdk';

// Build your transaction
const transaction = await program.methods
  .myInstruction()
  .accounts({
    user: userKeypair.publicKey,
    // ... other accounts
  })
  .transaction();

// Send transaction with automatic preparation and signing
const signature = await sendMagicTransaction(
  connection,
  transaction,
  [userKeypair] // Array of signers
);

console.log("Transaction signature:", signature);

​
Validator Discovery

Find the optimal validator for your connection: 
import { getClosestValidator } from 'magic-router-sdk';

const closestValidatorPubkey = await getClosestValidator(connection);
console.log("Closest validator:", closestValidatorPubkey.toBase58());

​
Delegating Accounts to a Validator

Once you have the closest validator, you can delegate accounts to enable Ephemeral Rollup execution: 
import { sendMagicTransaction, getClosestValidator } from 'magic-router-sdk';

async function delegateAccountToValidator(program, userKeypair, connection) {
  // Get the closest validator for optimal performance
  const validatorKey = await getClosestValidator(connection);
  
  // Create delegation transaction
  const delegationTx = await program.methods
    .delegate({
      commitFrequencyMs: 30000, // Commit every 30 seconds
      validator: validatorKey,
    })
    .accounts({
      payer: userKeypair.publicKey,
    })
    .transaction();

  // Send the delegation transaction
  const signature = await sendMagicTransaction(
    connection,
    delegationTx,
    [userKeypair]
  );

  console.log("✅ Account delegated to validator:", validatorKey.toBase58());
  console.log("Delegation signature:", signature);
  
  return signature;
}

// Example usage
await delegateAccountToValidator(myProgram, userKeypair, connection);
After delegation, transactions involving the delegated accounts will automatically route to the Ephemeral Rollup for faster execution.

​
Complete Example

Here’s a full example combining all concepts: 
import { 
  Connection, 
  Keypair, 
  Transaction,
  TransactionInstruction,
  PublicKey 
} from '@solana/web3.js';
import { 
  sendMagicTransaction,
  getWritableAccounts,
  getClosestValidator 
} from 'magic-router-sdk';

async function executeGameMove() {
  // Connect to Magic Router
  const connection = new Connection("https://devnet-router.magicblock.app", "confirmed");
  
  // Get optimal validator
  const validator = await getClosestValidator(connection);
  console.log(`Using validator: ${validator.toBase58()}`);
  
  // Build game transaction
  const transaction = await gameProgram.methods
    .makeMove({ x: 3, y: 4 })
    .accounts({
      gameState: gameStatePda,
      player: playerKeypair.publicKey,
    })
    .transaction();
  
  // Analyze accounts that will be modified
  const writableAccounts = getWritableAccounts(transaction);
  console.log("Modifying accounts:", writableAccounts);
  
  // Execute transaction with automatic routing
  const signature = await sendMagicTransaction(
    connection,
    transaction,
    [playerKeypair]
  );
  
  console.log("Move executed:", signature);
}

​
Next Steps

Core Concepts

Deep dive into the fundamental concepts behind Magic Router SDK.

Magic Router Overview

Learn more about account delegation and how Magic Router works.

Session Keys

Explore Session Keys for gasless gaming experiences.