Skip to content
LogoLogo

SDK Overview

The @mure/sdk is a TypeScript library that combines the Mure API with blockchain adapters into one interface for executing on-chain intents.

What the SDK Provides

  • One-call transfers — create a transfer intent via the API and submit it on-chain in a single await client.transfer(...) call. transfer resolves to a bare transaction hash.
  • Swaps and bridges — express same-chain swaps with an { in, out } asset shape, or move value across chains through the same transfer call.
  • Raw transaction broadcast — submit one or more prepared transactions with client.send. send returns one outcome per input: success, reverted, failed, or unknown. Wallets without atomic batch support fall back to sequential sends.
  • Read operations — list transfers and tokens, and fetch one transfer by id, through client.listTransfers, client.listTokens, and client.getTransfer.
  • API configuration — pass an optional API URL and API key under api in createClient, or configure ApiClient.layer directly in an Effect program.
  • Wallet abstraction — plug in any adapter that implements the AdapterService interface. The SDK ships with a viem adapter.
  • Type-safe errors — every failure is surfaced as a typed ClientServiceError or AdapterServiceError, carrying the original cause.
  • Effect-TS native — the entire SDK is built on Effect-TS. Compose the client through ClientService.layer or use the Promise-based facade.

Architecture

┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│   Client    │────▶│   API v2    │────▶│  Mure API   │
└─────────────┘     └─────────────┘     └─────────────┘
       │
       ▼
┌─────────────┐
│   Adapter   │────▶  viem / ethers / custom
└─────────────┘

The SDK layers three concepts:

  1. Adapter — talks to the blockchain (signs and sends transactions).
  2. API Client — talks to the Mure REST API (@mure/api-v2).
  3. Client — orchestrates the two so you don't have to.

Installation

PageWhat you'll learn
Getting StartedInstall, configure, and run your first transfer, swap, or bridge. Read transfers and tokens.
ClientThe createClient factory, nested api config, transfer, send outcomes, the read methods, and Effect integration.
AdaptersThe adapter pattern, ViemAdapter, the batch outcome contract, and how to bring your own wallet.

When to Use the SDK

Use the SDK when you want:

  • A Promise-based API that hides Effect complexity.
  • Automatic transaction submission after the API returns a transfer intent.
  • A single dependency that handles both the API and the blockchain.

If you only need raw HTTP access to the Mure API, consider using @mure/api-v2 directly.