Class ExternalMatchClient

Client for interacting with the Renegade external matching API.

Constructors

constructor

new ExternalMatchClient(
    apiKey: string,
    apiSecret: string,
    baseUrl: string,
): ExternalMatchClient
Initialize a new ExternalMatchClient.
Parameters
- apiKey: string
  The API key for authentication
- apiSecret: string
  The API secret for request signing
- baseUrl: string
  The base URL of the auth server API
Returns ExternalMatchClient
- Defined in packages/external-match/src/client.ts:296

Methods

assembleMalleableQuote

assembleMalleableQuote(
quote: SignedExternalQuote,
): Promise<MalleableExternalMatchResponse | null>
Assemble a quote into a malleable match bundle with default options.
Parameters
- quote: SignedExternalQuote
Returns Promise<MalleableExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:474

assembleMalleableQuoteWithOptions

assembleMalleableQuoteWithOptions(
quote: SignedExternalQuote,
options: AssembleMalleableExternalMatchOptions,
): Promise<MalleableExternalMatchResponse | null>
Assemble a quote into a malleable match bundle with custom options.
Parameters
- quote: SignedExternalQuote
- options: AssembleMalleableExternalMatchOptions
Returns Promise<MalleableExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:486

assembleQuote

assembleQuote(quote: SignedExternalQuote): Promise<ExternalMatchResponse | null>
Assemble a quote into a match bundle with default options.
Parameters
- quote: SignedExternalQuote
Returns Promise<ExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:365

assembleQuoteWithOptions

assembleQuoteWithOptions(
quote: SignedExternalQuote,
options: AssembleExternalMatchOptions,
): Promise<ExternalMatchResponse | null>
Assemble a quote into a match bundle with custom options.
Parameters
- quote: SignedExternalQuote
- options: AssembleExternalMatchOptions
Returns Promise<ExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:372

getExchangeMetadata

getExchangeMetadata(): Promise<ExchangeMetadataResponse>
Get exchange metadata including chain ID, settlement contract address, and supported tokens

Returns Promise<ExchangeMetadataResponse>
- Defined in packages/external-match/src/client.ts:598

getMarketDepth

getMarketDepth(mint: string): Promise<GetMarketDepthByMintResponse>
Get market depth for a given base token mint.
Parameters
- mint: string
Returns Promise<GetMarketDepthByMintResponse>
- Defined in packages/external-match/src/client.ts:534

getMarketDepthsAllPairs

getMarketDepthsAllPairs(): Promise<GetMarketDepthsResponse>
Get market depth for all pairs.

Returns Promise<GetMarketDepthsResponse>
- Defined in packages/external-match/src/client.ts:550

getMarkets

getMarkets(): Promise<GetMarketsResponse>
Get all tradable markets.

Returns Promise<GetMarketsResponse>
- Defined in packages/external-match/src/client.ts:520

getOrderBookDepth

getOrderBookDepth(mint: string): Promise<OrderBookDepth | null>
Parameters
- mint: string
Returns Promise<OrderBookDepth | null>
Deprecated
Use getMarketDepth() instead
- Defined in packages/external-match/src/client.ts:582

getOrderBookDepthAllPairs

getOrderBookDepthAllPairs(): Promise<GetDepthForAllPairsResponse | null>
Returns Promise<GetDepthForAllPairsResponse | null>
Deprecated
Use getMarketDepthsAllPairs() instead
- Defined in packages/external-match/src/client.ts:590

getSupportedTokens

getSupportedTokens(): Promise<SupportedTokensResponse>
Returns Promise<SupportedTokensResponse>
Deprecated
Use getMarkets() instead
- Defined in packages/external-match/src/client.ts:566

getTokenPrices

getTokenPrices(): Promise<TokenPricesResponse>
Returns Promise<TokenPricesResponse>
Deprecated
Use getMarkets() instead
- Defined in packages/external-match/src/client.ts:574

requestExternalMatch

requestExternalMatch(
order: ExternalOrder,
): Promise<ExternalMatchResponse | null>
Request an external match directly with default options.
Parameters
- order: ExternalOrder
Returns Promise<ExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:410

requestExternalMatchWithOptions

requestExternalMatchWithOptions(
order: ExternalOrder,
options: RequestExternalMatchOptions,
): Promise<ExternalMatchResponse | null>
Request an external match directly with custom options.
Parameters
- order: ExternalOrder
- options: RequestExternalMatchOptions
Returns Promise<ExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:417

requestMalleableExternalMatch

requestMalleableExternalMatch(
order: ExternalOrder,
): Promise<MalleableExternalMatchResponse | null>
Request a malleable external match directly with default options.
Parameters
- order: ExternalOrder
Returns Promise<MalleableExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:442

requestMalleableExternalMatchWithOptions

requestMalleableExternalMatchWithOptions(
order: ExternalOrder,
options: RequestExternalMatchOptions,
): Promise<MalleableExternalMatchResponse | null>
Request a malleable external match directly with custom options.
Parameters
- order: ExternalOrder
- options: RequestExternalMatchOptions
Returns Promise<MalleableExternalMatchResponse | null>
- Defined in packages/external-match/src/client.ts:454

requestQuote

requestQuote(order: ExternalOrder): Promise<SignedExternalQuote | null>
Request a quote for the given order.
Parameters
- order: ExternalOrder
Returns Promise<SignedExternalQuote | null>
- Defined in packages/external-match/src/client.ts:334

requestQuoteWithOptions

requestQuoteWithOptions(
order: ExternalOrder,
options: RequestQuoteOptions,
): Promise<SignedExternalQuote | null>
Request a quote for the given order with custom options.
Parameters
- order: ExternalOrder
- options: RequestQuoteOptions
Returns Promise<SignedExternalQuote | null>
- Defined in packages/external-match/src/client.ts:341

`Static`newArbitrumOneClient

newArbitrumOneClient(apiKey: string, apiSecret: string): ExternalMatchClient
Create a new client configured for the Arbitrum One mainnet.
Parameters
- apiKey: string
- apiSecret: string
Returns ExternalMatchClient
- Defined in packages/external-match/src/client.ts:318

`Static`newArbitrumSepoliaClient

newArbitrumSepoliaClient(apiKey: string, apiSecret: string): ExternalMatchClient
Create a new client configured for the Arbitrum Sepolia testnet.
Parameters
- apiKey: string
- apiSecret: string
Returns ExternalMatchClient
- Defined in packages/external-match/src/client.ts:304

`Static`newBaseMainnetClient

newBaseMainnetClient(apiKey: string, apiSecret: string): ExternalMatchClient
Create a new client configured for the Base mainnet.
Parameters
- apiKey: string
- apiSecret: string
Returns ExternalMatchClient
- Defined in packages/external-match/src/client.ts:325

`Static`newBaseSepoliaClient

newBaseSepoliaClient(apiKey: string, apiSecret: string): ExternalMatchClient
Create a new client configured for the Base Sepolia testnet.
Parameters
- apiKey: string
- apiSecret: string
Returns ExternalMatchClient
- Defined in packages/external-match/src/client.ts:311