@morpho-dev/router

Router Client

A TypeScript client to interact with the Morpho Router.

Installation

pnpm add @morpho-dev/router

Usage

Running the Local Server

import { RouterApi } from "@morpho-dev/router";

// Start a local router api on port 8081
await RouterApi.serve({ port: 8081 });
// Server will be available at http://localhost:8081

Basic Setup

import { RouterApi } from "@morpho-dev/router";

// Create a router client
const router = RouterApi.connect();

// With custom URL
const router = RouterApi.connect({ url: "https://router.morpho.dev" });

// Connect to local server
const router = RouterApi.connect({ url: "http://localhost:8081" });

Get Offers

// Get all offers
const result = await router.get({});

// Get buy offers on Ethereum mainnet
const result = await router.get({ side: "buy", chains: [1], limit: 10 });

// Get offers with specific filters
const result = await router.get({
  side: "sell",
  chains: [1, 137],
  loanTokens: ["0x1234567890123456789012345678901234567890"],
  minAmount: 1000n,
  maxAmount: 10000n,
  minRate: 500000000000000000n,
  maxRate: 1500000000000000000n,
  sortBy: "rate",
  sortOrder: "asc"
});

Match Offers

// Match offers for buy on Ethereum mainnet
const result = await router.match({ side: "buy", chainId: 1 });

// Match with specific requirements
const result = await router.match({
  side: "sell",
  chainId: 1,
  rate: 1000000000000000000n,
  loanToken: "0x1234567890123456789012345678901234567890",
  collaterals: [
    {
      asset: "0x1234567890123456789012345678901234567890",
      oracle: "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
      lltv: 800000000000000000n
    }
  ],
  minMaturity: 1700000000,
  maxMaturity: 1800000000
});