@renegade-fi/node/src/clients/renegade/admin.ts

Node.js library for Renegade

import type { Logger, SDKConfig } from "@renegade-fi/core";
import { createConfig } from "@renegade-fi/core";
import {
    type CreateOrderInMatchingPoolParameters,
    createOrderInMatchingPool,
} from "@renegade-fi/core/actions";
import * as rustUtils from "../../../renegade-utils/index.js";
import { RenegadeClient } from "./base.js";
import type { ConstructorParams } from "./types.js";

/**
 * The client for interacting with the Renegade relayer's admin API, with a keychain.
 */
export class AdminRenegadeClient extends RenegadeClient {
    private readonly apiKey: string;

    /**
     * @internal
     */
    private constructor(params: ConstructorParams & { apiKey: string; logger?: Logger }) {
        const { apiKey, ...renegadeParams } = params;
        super(renegadeParams);
        this.apiKey = apiKey;
    }

    /**
     * Create an admin client for any chain by seed.
     *
     * @param params.chainId    the chain ID (e.g. CHAIN_IDS.ArbitrumMainnet)
     * @param params.seed       your 0x… seed
     * @param params.apiKey     your admin API key
     * @param params.overrides  optional overrides for SDK config values
     */
    static override new({
        chainId,
        seed,
        apiKey,
        overrides,
        logger,
    }: {
        chainId: number;
        seed: `0x${string}`;
        apiKey: string;
        overrides?: Partial<SDKConfig>;
        logger?: Logger;
    }): AdminRenegadeClient {
        return new AdminRenegadeClient({ chainId, mode: "seed", seed, apiKey, overrides, logger });
    }

    /**
     * @see AdminRelayerClient.new
     */
    static override newWithExternalKeychain: never;
    /**
     * @see AdminRelayerClient.new
     */
    static override newArbitrumOneClient: never;
    /**
     * @see AdminRelayerClient.new
     */
    static override newArbitrumOneClientWithKeychain: never;
    /**
     * @see AdminRelayerClient.new
     */
    static override newArbitrumSepoliaClient: never;
    /**
     * @see AdminRelayerClient.new
     */
    static override newArbitrumSepoliaClientWithKeychain: never;

    /**
     * Create an order in a matching pool
     *
     * @param params.matchingPool – the matching pool address
     */
    async createOrderInMatchingPool(params: CreateOrderInMatchingPoolParameters) {
        const config = createConfig({
            darkPoolAddress: this.configv2.darkpoolAddress,
            priceReporterUrl: this.configv2.priceReporterUrl,
            relayerUrl: this.configv2.relayerUrl,
            chainId: this.configv2.id,
            utils: rustUtils,
            logging: { logger: this.getConfig().getLogger() },
            // Inject the admin key
            adminKey: this.apiKey,
        });
        config.setState((s) => ({ ...s, seed: this.seed }));
        return createOrderInMatchingPool(config, params);
    }
}