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;
        entityProductService: EntityProductService;
        entityService: EntityService;
        jupiterClient: JupiterSwapClient;
        lookupTableAddress: PublicKey;
        productFeeConfigService: ProductFeeConfigService;
        rewardCustomerInventoryService: RewardCustomerInventoryService;
        rewardService: RewardService;
        solanaConnection: Connection;
        solanaKeypairService: SolanaKeypairService;
        solanaNonceService: SolanaNonceService;
        solanaTokenService: SolanaTokenService;
        solanaTransactionService: SolanaTransactionService;
        sqlClient: Sql;
        swapAdminService: SwapAdminService;
        swapProductUsageService: SwapProductUsageService;
        temporalClient: Client;
        temporalTaskQueue: string;
        utilaWalletQueryService: UtilaWalletQueryService;
    },
): SwapQuoteService
Parameters
- __namedParameters: {
      customerService: CustomerService;
      entityProductService: EntityProductService;
      entityService: EntityService;
      jupiterClient: JupiterSwapClient;
      lookupTableAddress: PublicKey;
      productFeeConfigService: ProductFeeConfigService;
      rewardCustomerInventoryService: RewardCustomerInventoryService;
      rewardService: RewardService;
      solanaConnection: Connection;
      solanaKeypairService: SolanaKeypairService;
      solanaNonceService: SolanaNonceService;
      solanaTokenService: SolanaTokenService;
      solanaTransactionService: SolanaTransactionService;
      sqlClient: Sql;
      swapAdminService: SwapAdminService;
      swapProductUsageService: SwapProductUsageService;
      temporalClient: Client;
      temporalTaskQueue: string;
      utilaWalletQueryService: UtilaWalletQueryService;
  }
  - customerService: CustomerService
  - entityProductService: EntityProductService
  - entityService: EntityService
  - jupiterClient: JupiterSwapClient
  - lookupTableAddress: PublicKey
  - productFeeConfigService: ProductFeeConfigService
  - rewardCustomerInventoryService: RewardCustomerInventoryService
  - rewardService: RewardService
  - solanaConnection: Connection
  - solanaKeypairService: SolanaKeypairService
  - solanaNonceService: SolanaNonceService
  - solanaTokenService: SolanaTokenService
  - solanaTransactionService: SolanaTransactionService
  - sqlClient: Sql
  - swapAdminService: SwapAdminService
  - swapProductUsageService: SwapProductUsageService
  - temporalClient: Client
  - temporalTaskQueue: string
    For swap workflow
  - utilaWalletQueryService: UtilaWalletQueryService
Returns SwapQuoteService
Overrides SwapQuoteQueryService.constructor
- Defined in swap-services/src/SwapQuoteService.ts:349

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`jupiterClient

jupiterClient: JupiterSwapClient

`Protected` `Readonly`solanaTokenService

solanaTokenService: SolanaTokenService

Methods

accept

accept(
    __namedParameters: {
        customerId: string;
        entityId: string;
        id: string;
        originator?: string;
        transaction?: VersionedTransaction | null;
    },
): Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            id: string;
            quote: SwapQuote;
            receipt?: {
                id: string;
                type: "SOLANA_TRANSACTION_SIGNATURE"
                | "REWARD_ID"
                | "REWARD_CLAIM_ID";
            }[];
            status: "CREATED"
            | "PENDING"
            | "COMPLETED"
            | "FAILED";
            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?: VersionedTransaction | 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?: VersionedTransaction | null
Returns Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            id: string;
            quote: SwapQuote;
            receipt?: {
                id: string;
                type: "SOLANA_TRANSACTION_SIGNATURE"
                | "REWARD_ID"
                | "REWARD_CLAIM_ID";
            }[];
            status: "CREATED"
            | "PENDING"
            | "COMPLETED"
            | "FAILED";
            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 swap-services/src/SwapQuoteService.ts:718

create

create(
    __namedParameters: {
        customerId: string;
        depositId?: string;
        entityId: string;
        source:
            | Omit<
                { amount: number; amountAfterFees: number } & {
                    currency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
                    wallet: { address: PublicKey; chain: "SOLANA" };
                },
                "amountAfterFees",
            >
            | Omit<
                { amount: number; amountAfterFees: number } & {
                    currency: "REWARD";
                    wallet?: undefined;
                },
                "amountAfterFees",
            >;
        target: | Omit<
            { amount: number; amountAfterFees: number } & {
                currency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
                wallet: { address: PublicKey; chain: "SOLANA" };
            },
            "amount"
            | "amountAfterFees",
        >
        | Omit<
            { amount: number; amountAfterFees: number } & {
                currency: "REWARD";
                wallet?: undefined;
            },
            "amount"
            | "amountAfterFees",
        >;
    },
): 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<
                "INVALID_AMOUNT"
                | "NO_COUNTRY_FOR_IDENTITY"
                | "INVALID_INPUT",
            >
            | ServiceError<
                "INVALID_AMOUNT_AFTER_FEES",
                {
                    fees: Fees;
                    sourceAmount: number;
                    sourceAmountAfterFees: number;
                    sourceCurrency: "MOVEUSD"
                    | "USDC"
                    | "SOL"
                    | "WETH"
                    | "WBTC"
                    | "REWARD";
                    totalFees: BigNumber;
                },
            >;
        ok: false;
    },
>
Quote with partially-signed transaction
Parameters
- __namedParameters: {
      customerId: string;
      depositId?: string;
      entityId: string;
      source:
          | Omit<
              { amount: number; amountAfterFees: number } & {
                  currency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
                  wallet: { address: PublicKey; chain: "SOLANA" };
              },
              "amountAfterFees",
          >
          | Omit<
              { amount: number; amountAfterFees: number } & {
                  currency: "REWARD";
                  wallet?: undefined;
              },
              "amountAfterFees",
          >;
      target: | Omit<
          { amount: number; amountAfterFees: number } & {
              currency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC";
              wallet: { address: PublicKey; chain: "SOLANA" };
          },
          "amount"
          | "amountAfterFees",
      >
      | Omit<
          { amount: number; amountAfterFees: number } & {
              currency: "REWARD";
              wallet?: undefined;
          },
          "amount"
          | "amountAfterFees",
      >;
  }
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<
                "INVALID_AMOUNT"
                | "NO_COUNTRY_FOR_IDENTITY"
                | "INVALID_INPUT",
            >
            | ServiceError<
                "INVALID_AMOUNT_AFTER_FEES",
                {
                    fees: Fees;
                    sourceAmount: number;
                    sourceAmountAfterFees: number;
                    sourceCurrency: "MOVEUSD"
                    | "USDC"
                    | "SOL"
                    | "WETH"
                    | "WBTC"
                    | "REWARD";
                    totalFees: BigNumber;
                },
            >;
        ok: false;
    },
>
Throws
insufficientFunds
- Defined in swap-services/src/SwapQuoteService.ts:420

estimate

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

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 swap-services/src/SwapQuoteService.ts:106

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 swap-services/src/SwapQuoteService.ts:846

Class SwapQuoteService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

customerService: CustomerService

entityProductService: EntityProductService

entityService: EntityService

jupiterClient: JupiterSwapClient

lookupTableAddress: PublicKey

productFeeConfigService: ProductFeeConfigService

rewardCustomerInventoryService: RewardCustomerInventoryService

rewardService: RewardService

solanaConnection: Connection

solanaKeypairService: SolanaKeypairService

solanaNonceService: SolanaNonceService

solanaTokenService: SolanaTokenService

solanaTransactionService: SolanaTransactionService

sqlClient: Sql

swapAdminService: SwapAdminService

swapProductUsageService: SwapProductUsageService

temporalClient: Client

temporalTaskQueue: string

utilaWalletQueryService: UtilaWalletQueryService

Returns SwapQuoteService

Properties

Protected Readonlydb

Protected ReadonlyjupiterClient

Protected ReadonlysolanaTokenService

Methods

accept

Parameters

customerId: string

entityId: string

id: string

Optionaloriginator?: string

Optionaltransaction?: VersionedTransaction | null

create

Parameters

Throws

estimate

Parameters

countryCode: string

customerId: string

entityType: "IDENTITY" | "ORGANIZATION"

sourceAmount: number

sourceCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC" | "REWARD"

targetCurrency: "MOVEUSD" | "USDC" | "SOL" | "WETH" | "WBTC" | "REWARD"

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`solanaTokenService

`Optional`originator?: string

`Optional`transaction?: VersionedTransaction | null