-
Notifications
You must be signed in to change notification settings - Fork 46
/
index.d.ts
177 lines (157 loc) · 6.09 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
import { CSSProperties } from 'react';
import { Root } from 'react-dom/client';
import { createStore } from 'jotai';
import { Wallet } from '@jup-ag/wallet-adapter';
import { Connection, PublicKey, TransactionError } from '@solana/web3.js';
import { QuoteResponseMeta, SwapResult } from '@jup-ag/react-hook';
import { WalletContextState } from '@jup-ag/wallet-adapter';
import EventEmitter from 'events';
import { PlatformFeeAndAccounts } from '@jup-ag/common';
import { SwapMode } from './enums';
declare global {
interface Window {
Jupiter: JupiterTerminal;
}
}
/** The position of the widget */
export type WidgetPosition = 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
/** The size of the widget */
export type WidgetSize = 'sm' | 'default';
export interface FormProps {
/** Default to `ExactInOrOut`. ExactOut can be used to get an exact output of a token (e.g. for Payments) */
swapMode?: SwapMode;
/** Initial amount to swap */
initialAmount?: string;
/** When true, user cannot change the amount (e.g. for Payments) */
fixedAmount?: boolean;
/** Initial input token to swap */
initialInputMint?: string;
/** When true, user cannot change the input token */
fixedInputMint?: boolean;
/** Initial output token to swap */
initialOutputMint?: string;
/** When true, user cannot change the output token (e.g. to buy your project's token) */
fixedOutputMint?: boolean;
/** Initial slippage to swap */
initialSlippageBps?: number;
}
/** Built in support for these explorers */
export type DEFAULT_EXPLORER = 'Solana Explorer' | 'Solscan' | 'Solana Beach' | 'SolanaFM';
export interface TransactionInstruction {
accounts: {
pubkey: string;
isSigner: boolean;
isWritable: boolean;
}[];
data: string;
programId: string;
}
export interface IOnRequestIxCallback {
meta: {
sourceAddress: PublicKey;
destinationAddress: PublicKey;
quoteResponseMeta: QuoteResponseMeta;
};
instructions: {
tokenLedgerInstruction: TransactionInstruction;
computeBudgetInstructions: ComputeBudgetInstruction;
setupInstructions: TransactionInstruction[];
swapInstruction: TransactionInstruction;
cleanupInstruction: TransactionInstruction;
addressLookupTableAddresses: AddressLookupTableAccount;
error: string;
};
onSubmitWithIx: (swapResult: SwapResult) => void;
}
export interface IInit {
/** Solana RPC, declare either endpoint, or Connection object */
/** Solana RPC endpoint */
endpoint?: string;
/** Solana RPC Connection object */
connectionObj?: Connection;
/** TODO: Update to use the new platform fee and accounts */
platformFeeAndAccounts?: PlatformFeeAndAccounts;
/** Configure Terminal's behaviour and allowed actions for your user */
formProps?: FormProps;
/** Only allow strict token by [Jupiter Token List API](https://station.jup.ag/docs/token-list/token-list-api) */
strictTokenList?: boolean;
/** Default explorer for your user */
defaultExplorer?: DEFAULT_EXPLORER;
/** Auto connect to wallet on subsequent visits */
autoConnect?: boolean;
/** Use user's slippage instead of initialSlippageBps, defaults to true */
useUserSlippage?: boolean;
/** TODO: NOT Supported yet, presets of slippages, defaults to [0.1, 0.5, 1.0] */
slippagePresets?: number[];
/** RPC refetch interval for getTABO in milliseconds, defaults to 10000 */
refetchIntervalForTokenAccounts?: number;
/** Display & Styling */
/** Display mode */
displayMode?: 'modal' | 'integrated' | 'widget';
/** When displayMode is 'integrated', this is the id of the element to render the integrated widget into */
integratedTargetId?: string;
/** When displayMode is 'widget', this is the behaviour and style of the widget */
widgetStyle?: {
position?: WidgetPosition;
size?: WidgetSize;
};
/** In case additional styling is needed for Terminal container */
containerStyles?: CSSProperties;
/** In case additional styling is needed for Terminal container */
containerClassName?: string;
/** When true, wallet connection are handled by your dApp, and use `syncProps()` to syncronise wallet state with Terminal */
enableWalletPassthrough?: boolean;
/** Optional, if wallet state is ready, you can pass it in here, or just use `syncProps()` */
passthroughWalletContextState?: WalletContextState;
/** When enableWalletPassthrough is true, this allows Terminal to callback your dApp's wallet connection flow */
onRequestConnectWallet?: () => void | Promise<void>;
/** Callbacks */
/** When an error has occured during swap */
onSwapError?: ({
error,
quoteResponseMeta,
}: {
error?: TransactionError;
quoteResponseMeta: QuoteResponseMeta | null;
}) => void;
/** When a swap has been successful */
onSuccess?: ({
txid,
swapResult,
quoteResponseMeta,
}: {
txid: string;
swapResult: SwapResult;
quoteResponseMeta: QuoteResponseMeta | null;
}) => void;
/** Callback when there's changes to the form */
onFormUpdate?: (form: IForm) => void;
/** Callback when there's changes to the screen */
onScreenUpdate?: (screen: IScreen) => void;
/** Ask jupiter to quote with a maximum number of accounts, essential for composing with Jupiter Swap instruction */
maxAccounts?: number;
/** Request Ix instead of direct swap */
onRequestIxCallback?: (ixAndCb: IOnRequestIxCallback) => Promise<void>;
/** Internal resolves */
/** Internal use to resolve domain when loading script */
scriptDomain?: string;
}
export interface JupiterTerminal {
_instance: JSX.Element | null;
init: (props: IInit) => void;
resume: () => void;
close: () => void;
root: Root | null;
/** Passthrough */
enableWalletPassthrough: boolean;
onRequestConnectWallet: IInit['onRequestConnectWallet'];
store: ReturnType<typeof createStore>;
syncProps: (props: { passthroughWalletContextState?: IInit['passthroughWalletContextState'] }) => void;
/** Callbacks */
onSwapError: IInit['onSwapError'];
onSuccess: IInit['onSuccess'];
onFormUpdate: IInit['onFormUpdate'];
onScreenUpdate: IInit['onScreenUpdate'];
/** Request Ix instead of direct swap */
onRequestIxCallback: IInit['onRequestIxCallback'];
}