Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions frontends/web/src/api/swap.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/**
* Copyright 2025 Shift Crypto AG
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import type { FailResponse, SuccessResponse } from './response';
import type { AccountCode } from './account';
import { apiGet, apiPost } from '@/utils/request';
import { subscribeEndpoint, TUnsubscribe } from './subscribe';

export type TSwapQuotes = {
quoteId: string;
buyAsset: 'ETH.ETH';
sellAsset: 'BTC.BTC';
sellAmount: '0.001';
// expectedBuyAmount;
// expectedBuyAmountMaxSlippage;
// fees: [];
// routeId: string;
// ...
// expiration
// estimatedTime
// warnings: [];
// targetAddress // so we can show the address in the app so the user can confirm with the one on the device
// memo?
};

export const getSwapState = (): Promise<TSwapQuotes> => {
return apiGet('swap/state');
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I know this is just a draft, but I thought I'd take a look)

I'm not sure I understand the purpose of this endpoint. What's the intended flow here?

Frontend calls quote, gets a quote id, user selects the quote they want, frontend calls swap (called execute here). At what point in "state" called?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just a draft but a good moment to discuss. Feel free to open a PR or comment here what I should change.

Does the quote stay the same forever? Or do we need a way that the backend can push updates to the quote if anything changes?

If a quote stays forever the same we can just return the data (TSwapQuotes or TSwapQuotes[]) via the POST request. But if the backend needs to be able to inform the frontend and push updates to the quotes, then we need some subscription.

};

export const syncSwapState = (
cb: (state: TSwapQuotes) => void
): TUnsubscribe => {
return subscribeEndpoint('swap/state', cb);
};

export type TProposeSwap = {
buyAsset: AccountCode;
sellAmount: string;
sellAsset: AccountCode;
};

export const proposeSwap = (
data: TProposeSwap,
): Promise<void> => {
return apiPost('swap/quote', data);
};

type TSwapFailed = FailResponse & { aborted: boolean };
type TSwapExecutionResult = SuccessResponse | TSwapFailed;

export const executeSwap = (): Promise<TSwapExecutionResult> => {
return apiPost('swap/execute');
};