Class SwapQuoteService

Implements the creation of a Swap via a quote

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 SwapQuoteService(
    __namedParameters: {
        customerService: CustomerService;
        db: B2bDatabase;
        heliusRpcClient: HeliusRpcClient;
        jupiterClient: JupiterSwapClient;
        productQuoteService: ProductQuoteService;
        solanaBackofficeWalletService: SolanaBackofficeWalletService;
        solanaNonceService: SolanaNonceService;
        solanaTokenMintAddressService: SolanaTokenMintAddressService;
        solanaTokenService: SolanaTokenQueryService;
        solanaTransactionService: SolanaTransactionService;
        swapAdminService: SwapAdminService;
        temporalClient: Client;
        temporalTaskQueue: string;
        utilaSweepWalletQueryService: UtilaSweepWalletQueryService;
    },
): SwapQuoteService
Parameters
- __namedParameters: {
      customerService: CustomerService;
      db: B2bDatabase;
      heliusRpcClient: HeliusRpcClient;
      jupiterClient: JupiterSwapClient;
      productQuoteService: ProductQuoteService;
      solanaBackofficeWalletService: SolanaBackofficeWalletService;
      solanaNonceService: SolanaNonceService;
      solanaTokenMintAddressService: SolanaTokenMintAddressService;
      solanaTokenService: SolanaTokenQueryService;
      solanaTransactionService: SolanaTransactionService;
      swapAdminService: SwapAdminService;
      temporalClient: Client;
      temporalTaskQueue: string;
      utilaSweepWalletQueryService: UtilaSweepWalletQueryService;
  }
  - customerService: CustomerService
  - db: B2bDatabase
  - heliusRpcClient: HeliusRpcClient
  - jupiterClient: JupiterSwapClient
  - productQuoteService: ProductQuoteService
  - solanaBackofficeWalletService: SolanaBackofficeWalletService
  - solanaNonceService: SolanaNonceService
  - solanaTokenMintAddressService: SolanaTokenMintAddressService
  - solanaTokenService: SolanaTokenQueryService
  - solanaTransactionService: SolanaTransactionService
  - swapAdminService: SwapAdminService
  - temporalClient: Client
  - temporalTaskQueue: string
    For swap workflow
  - utilaSweepWalletQueryService: UtilaSweepWalletQueryService
Returns SwapQuoteService
Overrides SwapQuoteQueryService.constructor
- Defined in packages/swap-services/src/SwapQuoteService.ts:344

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`jupiterClient

jupiterClient: JupiterSwapClient

`Protected` `Readonly`productQuoteService

productQuoteService: ProductQuoteService

`Protected` `Readonly`solanaTokenMintAddressService

solanaTokenMintAddressService: SolanaTokenMintAddressService

`Protected` `Readonly`solanaTokenService

solanaTokenService: SolanaTokenQueryService

Methods

accept

accept(
    __namedParameters: {
        customerId: string;
        entityId: string;
        id: string;
        originator?: string;
        transaction?:
            | Readonly<
                { messageBytes: TransactionMessageBytes; signatures: SignaturesMap },
            >
            | null;
    },
): Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            id: string;
            quote: SwapQuote;
            receipt?: { id: string; type: "SOLANA_TRANSACTION_SIGNATURE" }[];
            status: "CREATED" | "PENDING" | "FAILED" | "COMPLETED";
            updatedAt: Date;
        };
    }
    | {
        error: | ServiceError<"INVALID_TRANSACTION">
        | ServiceError<"NOT_FOUND", { customerId?: string; entityId?: string }>
        | ServiceError<
            "INSUFFICIENT_FUNDS",
            { currency: string; walletAddress?: string },
        >
        | ServiceError<"LIMIT_REACHED", { violations: BigNumber }>;
        ok: false;
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      id: string;
      originator?: string;
      transaction?:
          | Readonly<
              { messageBytes: TransactionMessageBytes; signatures: SignaturesMap },
          >
          | null;
  }
  - customerId: string
  - entityId: string
  - id: string
  - Optionaloriginator?: string
    Workflow ID of the originator of this quote
    
    The originating workflows should expose a SWAP_COMPLETED signal that receives Swap (without quote) when the process is completed.
  - Optionaltransaction?:
        | Readonly<
            { messageBytes: TransactionMessageBytes; signatures: SignaturesMap },
        >
        | null
Returns Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            id: string;
            quote: SwapQuote;
            receipt?: { id: string; type: "SOLANA_TRANSACTION_SIGNATURE" }[];
            status: "CREATED" | "PENDING" | "FAILED" | "COMPLETED";
            updatedAt: Date;
        };
    }
    | {
        error: | ServiceError<"INVALID_TRANSACTION">
        | ServiceError<"NOT_FOUND", { customerId?: string; entityId?: string }>
        | ServiceError<
            "INSUFFICIENT_FUNDS",
            { currency: string; walletAddress?: string },
        >
        | ServiceError<"LIMIT_REACHED", { violations: BigNumber }>;
        ok: false;
    },
>
- Defined in packages/swap-services/src/SwapQuoteService.ts:635

create

create(
    __namedParameters: {
        customerId: string;
        depositId?: string;
        entityId: string;
        source: UnionOmit<SwapSide, "amountAfterFees">;
        target: UnionOmit<SwapSide, "amountAfterFees" | "amount">;
    },
): Promise<
    | { ok: true; value: SwapQuote }
    | {
        error:
            | ServiceError<
                "NOT_FOUND",
                { customerId?: string; entityId?: string },
            >
            | ServiceError<
                "INSUFFICIENT_FUNDS",
                { currency: string; walletAddress?: string },
            >
            | ServiceError<"LIMIT_REACHED", { violations: BigNumber }>
            | ServiceError<
                "NO_COUNTRY_FOR_IDENTITY"
                | "INVALID_INPUT"
                | "INVALID_AMOUNT",
            >
            | ServiceError<
                "INVALID_AMOUNT_AFTER_FEES",
                {
                    fees: Fees;
                    sourceAmount: number;
                    sourceAmountAfterFees: number;
                    sourceCurrency: "MOVEUSD"
                    | "USDC"
                    | "SOL"
                    | "WETH"
                    | "WBTC";
                    totalFees: BigNumber;
                },
            >;
        ok: false;
    },
>
Quote with partially-signed transaction
Parameters
- __namedParameters: {
      customerId: string;
      depositId?: string;
      entityId: string;
      source: UnionOmit<SwapSide, "amountAfterFees">;
      target: UnionOmit<SwapSide, "amountAfterFees" | "amount">;
  }
Returns Promise<
    | { ok: true; value: SwapQuote }
    | {
        error:
            | ServiceError<
                "NOT_FOUND",
                { customerId?: string; entityId?: string },
            >
            | ServiceError<
                "INSUFFICIENT_FUNDS",
                { currency: string; walletAddress?: string },
            >
            | ServiceError<"LIMIT_REACHED", { violations: BigNumber }>
            | ServiceError<
                "NO_COUNTRY_FOR_IDENTITY"
                | "INVALID_INPUT"
                | "INVALID_AMOUNT",
            >
            | ServiceError<
                "INVALID_AMOUNT_AFTER_FEES",
                {
                    fees: Fees;
                    sourceAmount: number;
                    sourceAmountAfterFees: number;
                    sourceCurrency: "MOVEUSD"
                    | "USDC"
                    | "SOL"
                    | "WETH"
                    | "WBTC";
                    totalFees: BigNumber;
                },
            >;
        ok: false;
    },
>
Throws
insufficientFunds
- Defined in packages/swap-services/src/SwapQuoteService.ts:399

estimate

estimate(
    __namedParameters: {
        customerId: string;
        entityId: string;
        sourceAmount: number;
        sourceCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
        targetCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
    },
): Promise<
    | { ok: true; value: SwapEstimate }
    | {
        error:
            | ServiceError<"INVALID_INPUT" | "INVALID_AMOUNT">
            | ServiceError<
                "INVALID_AMOUNT_AFTER_FEES",
                {
                    fees: Fees;
                    sourceAmount: number;
                    sourceAmountAfterFees: number;
                    sourceCurrency: "MOVEUSD"
                    | "USDC"
                    | "SOL"
                    | "WETH"
                    | "WBTC";
                    totalFees: BigNumber;
                },
            >;
        ok: false;
    },
>
Ephemeral (and entity-agnostic) quote of target amount and fees
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      sourceAmount: number;
      sourceCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
      targetCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
  }
Returns Promise<
    | { ok: true; value: SwapEstimate }
    | {
        error:
            | ServiceError<"INVALID_INPUT" | "INVALID_AMOUNT">
            | ServiceError<
                "INVALID_AMOUNT_AFTER_FEES",
                {
                    fees: Fees;
                    sourceAmount: number;
                    sourceAmountAfterFees: number;
                    sourceCurrency: "MOVEUSD"
                    | "USDC"
                    | "SOL"
                    | "WETH"
                    | "WBTC";
                    totalFees: BigNumber;
                },
            >;
        ok: false;
    },
>
Throws
invalidAmount
Inherited from SwapQuoteQueryService.estimate
- Defined in packages/swap-services/src/SwapQuoteService.ts:134

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: SwapQuote | null }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: SwapQuote | null }>
Inherited from SwapQuoteQueryService.get
- Defined in packages/swap-services/src/SwapQuoteService.ts:102

reject

reject(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: { id: string } }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: { id: string } }>
- Defined in packages/swap-services/src/SwapQuoteService.ts:764

Class SwapQuoteService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

customerService: CustomerService

db: B2bDatabase

heliusRpcClient: HeliusRpcClient

jupiterClient: JupiterSwapClient

productQuoteService: ProductQuoteService

solanaBackofficeWalletService: SolanaBackofficeWalletService

solanaNonceService: SolanaNonceService

solanaTokenMintAddressService: SolanaTokenMintAddressService

solanaTokenService: SolanaTokenQueryService

solanaTransactionService: SolanaTransactionService

swapAdminService: SwapAdminService

temporalClient: Client

temporalTaskQueue: string

utilaSweepWalletQueryService: UtilaSweepWalletQueryService

Returns SwapQuoteService

Properties

Protected Readonlydb

Protected ReadonlyjupiterClient

Protected ReadonlyproductQuoteService

Protected ReadonlysolanaTokenMintAddressService

Protected ReadonlysolanaTokenService

Methods

accept

Parameters

customerId: string

entityId: string

id: string

Optionaloriginator?: string

Optionaltransaction?: | Readonly< { messageBytes: TransactionMessageBytes; signatures: SignaturesMap }, > | null

create

Parameters

Throws

estimate

Parameters

Throws

get

Parameters

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

reject

Parameters

Returns Promise<{ ok: true; value: { id: string } }>

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`jupiterClient

`Protected` `Readonly`productQuoteService

`Protected` `Readonly`solanaTokenMintAddressService

`Protected` `Readonly`solanaTokenService

`Optional`originator?: string

`Optional`transaction?:
| Readonly<
{ messageBytes: TransactionMessageBytes; signatures: SignaturesMap },
>
| null