@renegade-fi/node
Version:
Node.js library for Renegade
71 lines • 2.57 kB
TypeScript
import { type Config, type SDKConfig } from "@renegade-fi/core";
import type { AssignOrderParameters, CreateMatchingPoolParameters, DestroyMatchingPoolParameters, GetOpenOrdersParameters, GetOrderMatchingPoolParameters, GetOrderMetadataParameters, GetWalletMatchableOrderIdsParameters } from "@renegade-fi/core/actions";
/**
* The client for interacting with the Renegade relayer's admin API with an API key.
*/
export declare class AdminRelayerClient {
readonly config: Config;
readonly configv2: SDKConfig;
/**
* @internal
*/
private constructor();
/**
* Create a new AdminRelayerClient
*
* @param params.apiKey your API key
* @param params.chainId the chain ID
* @param params.overrides any SDKConfig field can be passed directly as an override
*/
static new({ apiKey, chainId, overrides, }: {
apiKey: string;
chainId: number;
overrides?: Partial<SDKConfig>;
}): AdminRelayerClient;
/**
* Assign an order to a matching pool
*
* @param params.orderId the order ID
* @param params.matchingPool name of the matching pool
*/
assignOrder(params: AssignOrderParameters): Promise<void>;
/**
* Create a matching pool
*
* @param params.matchingPool name of the matching pool
*/
createMatchingPool(params: CreateMatchingPoolParameters): Promise<void>;
/**
* Destroy a matching pool
*
* @param params.matchingPool name of the matching pool
*/
destroyMatchingPool(params: DestroyMatchingPoolParameters): Promise<void>;
/**
* Get open orders managed by the relayer
*/
getOpenOrders(params: GetOpenOrdersParameters): Promise<import("@renegade-fi/core/actions").GetOpenOrdersReturnType>;
/**
* Get the matching pool for an order
*/
getOrderMatchingPool(params: GetOrderMatchingPoolParameters): Promise<string>;
/**
* Get the metadata for an order
*/
getOrderMetadata(params: GetOrderMetadataParameters): Promise<import("@renegade-fi/core").AdminOrderMetadata>;
/**
* Get the matchable order IDs for a wallet
*/
getWalletMatchableOrderIds(params: GetWalletMatchableOrderIdsParameters): Promise<import("@renegade-fi/core").GetWalletMatchableOrderIdsReturnType>;
/**
* Trigger a relayer raft snapshot
*/
triggerSnapshot(): Promise<void>;
/**
* Get the config
*
* TODO: Remove once we migrate to the SDK config
*/
getConfig(): Config;
}
//# sourceMappingURL=index.d.ts.map