OpenTrader Documentation

To use the exchanges package in a server-side environment (e.g., Next.js Server Components), you should configure a persistent cache provider using PrismaCacheProvider from @opentrader/exchanges/server. This ensures that data like markets loaded via exchange.loadMarkets() are cached in your database.

import { ExchangeCode } from "@opentrader/types";
import { exchanges, cache } from "@opentrader/exchanges";
import { PrismaCacheProvider } from "@opentrader/exchanges/server";

// Configure the cache provider to use Prisma
cache.setCacheProvider(new PrismaCacheProvider());

export default async function Page() {
  // Access a specific exchange using its ExchangeCode
  const exchange = exchanges[ExchangeCode.OKX]();
  
  // Load markets (this call will be cached in Prisma)
  const markets = await exchange.loadMarkets(); 

  return <div>Markets: {Object.keys(markets).length}</div>;
}

To use @opentrader/trpc in a Nest.js application, create a middleware class that uses @trpc/server/adapters/express to mount the appRouter at the /api/trpc endpoint. Then, inject and apply this middleware in your application's bootstrap function.

// src/trpc.middleware.ts
import { INestApplication, Injectable } from "@nestjs/common";
import * as trpcExpress from "@trpc/server/adapters/express";

import { appRouter } from "@opentrader/trpc";

@Injectable()
export class TrpcMiddleware {
  applyMiddleware(app: INestApplication) {
    app.use(
      `/api/trpc`,
      trpcExpress.createExpressMiddleware({
        router: appRouter,
        createContext: () => ({
          // ...
        }),
      }),
    );
  }
}

// main.ts
import { TrpcMiddleware } from "src/trpc.middleware";

async function bootstrap() {
  // ...
  const trpc = app.get(TrpcMiddleware);
  trpc.applyMiddleware(app);
  // ...
}
bootstrap();

When using the exchanges package in a client-side environment (e.g., React Client Components), you can use MemoryCacheProvider from @opentrader/exchanges/client to manage caching in memory. Note that MemoryCacheProvider is used by default, so explicitly setting it is optional.

"use client";

import { useEffect, useState } from "react";
import { ExchangeCode } from "@opentrader/types";
import { exchanges, cache } from "@opentrader/exchanges";
import { MemoryCacheProvider } from "@opentrader/exchanges/client";

// Configure memory cache (optional, as it is the default)
cache.setCacheProvider(new MemoryCacheProvider());

const exchange = exchanges[ExchangeCode.OKX]();

export default function Page() {
  const [markets, setMarkets] = useState<Awaited<
    ReturnType<typeof exchange.loadMarkets>
  > | null>(null);

  useEffect(() => {
    exchange.loadMarkets().then((data) => {
      setMarkets(data);
    });
  }, []);

  if (markets === null) {
    return <div>Loading...</div>;
  }

  return <div>Markets: {Object.keys(markets).length}</div>;
}