Skip to content

fix(api): resolve multiple documentation and type inconsistencies #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leonschh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(api): resolve multiple documentation and type inconsistencies #571

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ export interface Route {

gasCostUSD?: string // Aggregation of underlying gas costs in usd

containsSwitchChain?: boolean // Features required for route execution
containsSwitchChain?: boolean // Whether the route contains a chain switch during execution

steps: LiFiStep[]

Expand Down Expand Up @@ -588,7 +588,9 @@ export const isContractCallsRequestWithToAmount = (
r: ContractCallsQuoteRequestFromAmount | ContractCallsQuoteRequestToAmount
): r is ContractCallsQuoteRequestToAmount => 'toAmount' in r

/* @deprecated */
/**
* @deprecated ContractCallQuoteRequest is deprecated and will be removed in future versions.
*/
export interface ContractCallQuoteRequest extends ToolConfiguration {
fromChain: number | string
fromToken: string
Expand Down Expand Up @@ -670,7 +672,7 @@ export interface PendingReceivingInfo {
const _StatusMessage = [
// The transaction was not found -- likely not mined yet
'NOT_FOUND',
// A third party service is not available
// The txHash is not tied to the requested tool (bridge / chains)
'INVALID',
// The transfer is pending
'PENDING',
Expand Down Expand Up @@ -1091,7 +1093,7 @@ export type RelayResponseData = {
export type RelayResponse = RelayerResponse<RelayResponseData>

export type RelayStatusRequest = {
taskId: Hash
taskId: string
bridge?: string
fromChain?: number
toChain?: number
Expand Down
Loading