Class SwapQuoteQueryService

Implements read only methods for swap quotes

The operations in this class assume that the Customer is already validated (both AuthN and AuthZ).

Hierarchy (View Summary)

SwapQuoteQueryService
- SwapQuoteService

Index

Constructors

constructor

new SwapQuoteQueryService(
    args: {
        db: B2bDatabase;
        jupiterClient: JupiterSwapClient;
        productQuoteService: ProductQuoteService;
        solanaTokenMintAddressService: SolanaTokenMintAddressService;
        solanaTokenService: SolanaTokenQueryService;
    },
): SwapQuoteQueryService
Parameters
- args: {
      db: B2bDatabase;
      jupiterClient: JupiterSwapClient;
      productQuoteService: ProductQuoteService;
      solanaTokenMintAddressService: SolanaTokenMintAddressService;
      solanaTokenService: SolanaTokenQueryService;
  }
Returns SwapQuoteQueryService
- Defined in packages/swap-services/src/SwapQuoteService.ts:222

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`jupiterClient

jupiterClient: JupiterSwapClient

`Protected` `Readonly`pricers

pricers: { cfx: VenuePricer; jupiter: VenuePricer } = ...

One pricer per venue: adding a venue to SWAP_VENUES adds one here.

`Protected` `Readonly`productQuoteService

productQuoteService: ProductQuoteService

`Protected` `Readonly`solanaTokenMintAddressService

solanaTokenMintAddressService: SolanaTokenMintAddressService

`Protected` `Readonly`solanaTokenService

solanaTokenService: SolanaTokenQueryService

`Static`instance

instance: (...args: []) => SwapQuoteQueryService = ...

The process service: the shared database, the quote engine, Jupiter and the token services.

Methods

`Protected`engineEstimate

engineEstimate(
    __namedParameters: Omit<PriceArgs, "quote" | "targetToken"> & {
        customerId: string;
        entityId: string;
    },
): Promise<
    { ok: true; value: QuoteOutput }
    | { error: ServiceError; ok: false },
>
The audit-free engine estimate() of the swap: the route, fees and amount math, with no product_quote row and no limit enforcement. Refuses SWAP_NOT_AVAILABLE, as create() does, when the engine will not price the swap.
Parameters
- __namedParameters: Omit<PriceArgs, "quote" | "targetToken"> & {
  customerId: string;
  entityId: string;
  }
Returns Promise<{ ok: true; value: QuoteOutput } | { error: ServiceError; ok: false }>
- Defined in packages/swap-services/src/SwapQuoteService.ts:340

estimate

estimate(
    __namedParameters: {
        customerId: string;
        entityId: string;
        sourceAmount: BigNumber;
        sourceCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
        targetCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
    },
): Promise<
    | { ok: true; value: SwapEstimate }
    | {
        error:
            | ServiceError<
                "INVALID_INPUT"
                | "INVALID_AMOUNT"
                | "SWAP_NOT_AVAILABLE",
            >
            | PricingError;
        ok: false;
    },
>
Ephemeral (and entity-agnostic) quote of target amount and fees
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      sourceAmount: BigNumber;
      sourceCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
      targetCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
  }
Returns Promise<
    | { ok: true; value: SwapEstimate }
    | {
        error:
            | ServiceError<
                "INVALID_INPUT"
                | "INVALID_AMOUNT"
                | "SWAP_NOT_AVAILABLE",
            >
            | PricingError;
        ok: false;
    },
>

Throws
invalidAmount
- Defined in packages/swap-services/src/SwapQuoteService.ts:272

get

get(
__namedParameters: { customerId: string; entityId?: string; id: string },
): Promise<{ ok: true; value: SwapQuote | null }>
Parameters
- __namedParameters: { customerId: string; entityId?: string; id: string }
  - customerId: string
  - OptionalentityId?: string
    
    The identity or organization that must own the quote.
  - id: string
Returns Promise<{ ok: true; value: SwapQuote | null }>
- Defined in packages/swap-services/src/SwapQuoteService.ts:236

Class SwapQuoteQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SwapQuoteQueryService

Properties

`Protected` `Readonly`db

`Protected` `Readonly`jupiterClient

`Protected` `Readonly`pricers

`Protected` `Readonly`productQuoteService

`Protected` `Readonly`solanaTokenMintAddressService

`Protected` `Readonly`solanaTokenService

`Static`instance

Methods

`Protected`engineEstimate

Parameters

Returns Promise<{ ok: true; value: QuoteOutput } | { error: ServiceError; ok: false }>

estimate

Parameters

Returns Promise<
    | { ok: true; value: SwapEstimate }
    | {
        error:
            | ServiceError<
                "INVALID_INPUT"
                | "INVALID_AMOUNT"
                | "SWAP_NOT_AVAILABLE",
            >
            | PricingError;
        ok: false;
    },
>

Throws

get

Parameters

customerId: string

`Optional`entityId?: string

id: string

Returns Promise<{ ok: true; value: SwapQuote | null }>

Settings

On This Page

Class SwapQuoteQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SwapQuoteQueryService

Properties

Protected Readonlydb

Protected ReadonlyjupiterClient

Protected Readonlypricers

Protected ReadonlyproductQuoteService

Protected ReadonlysolanaTokenMintAddressService

Protected ReadonlysolanaTokenService

Staticinstance

Methods

ProtectedengineEstimate

Parameters

Returns Promise<{ ok: true; value: QuoteOutput } | { error: ServiceError; ok: false }>

estimate

Parameters

Returns Promise< | { ok: true; value: SwapEstimate } | { error: | ServiceError< "INVALID_INPUT" | "INVALID_AMOUNT" | "SWAP_NOT_AVAILABLE", > | PricingError; ok: false; },>

Throws

get

Parameters

customerId: string

OptionalentityId?: string

id: string

Returns Promise<{ ok: true; value: SwapQuote | null }>

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`jupiterClient

`Protected` `Readonly`pricers

`Protected` `Readonly`productQuoteService

`Protected` `Readonly`solanaTokenMintAddressService

`Protected` `Readonly`solanaTokenService

`Static`instance

`Protected`engineEstimate

Returns Promise<
| { ok: true; value: SwapEstimate }
| {
error:
| ServiceError<
"INVALID_INPUT"
| "INVALID_AMOUNT"
| "SWAP_NOT_AVAILABLE",
>
| PricingError;
ok: false;
},
>

`Optional`entityId?: string