@swapkit/api-sdk-typescript 1.2.0-nightly.20260716102640 → 1.2.0-nightly.20260720155542
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +9 -0
- package/dist/index.d.cts +80 -2
- package/dist/index.d.ts +80 -2
- package/dist/index.js +8 -0
- package/package.json +1 -1
- package/src/index.ts +3 -0
- package/src/sdk.ts +7 -1
- package/src/types.ts +82 -1
package/dist/index.cjs
CHANGED
|
@@ -42,6 +42,7 @@ __export(index_exports, {
|
|
|
42
42
|
getSwapToAssets: () => getSwapToAssets,
|
|
43
43
|
getTokens: () => getTokens,
|
|
44
44
|
screenAddress: () => screenAddress,
|
|
45
|
+
searchTokens: () => searchTokens,
|
|
45
46
|
trackTransaction: () => trackTransaction
|
|
46
47
|
});
|
|
47
48
|
module.exports = __toCommonJS(index_exports);
|
|
@@ -856,6 +857,11 @@ var getTokens = (options) => (options?.client ?? client).get({
|
|
|
856
857
|
url: "/tokens",
|
|
857
858
|
...options
|
|
858
859
|
});
|
|
860
|
+
var searchTokens = (options) => (options.client ?? client).get({
|
|
861
|
+
security: [{ name: "x-api-key", type: "apiKey" }],
|
|
862
|
+
url: "/tokens/search",
|
|
863
|
+
...options
|
|
864
|
+
});
|
|
859
865
|
var getSwapToAssets = (options) => (options.client ?? client).get({
|
|
860
866
|
security: [{ name: "x-api-key", type: "apiKey" }],
|
|
861
867
|
url: "/swapTo",
|
|
@@ -936,6 +942,7 @@ var SwapKitService = class {
|
|
|
936
942
|
};
|
|
937
943
|
SwapKitService.getProviders = getProviders;
|
|
938
944
|
SwapKitService.getTokens = getTokens;
|
|
945
|
+
SwapKitService.searchTokens = searchTokens;
|
|
939
946
|
SwapKitService.getSwapTo = getSwapToAssets;
|
|
940
947
|
SwapKitService.getSwapFrom = getSwapFromAssets;
|
|
941
948
|
SwapKitService.getQuote = getQuote;
|
|
@@ -949,6 +956,7 @@ SwapKitService.createBrokerChannel = createBrokerChannel;
|
|
|
949
956
|
var TokenlistService = {
|
|
950
957
|
getProviders,
|
|
951
958
|
getTokens,
|
|
959
|
+
searchTokens,
|
|
952
960
|
getSwapTo: getSwapToAssets,
|
|
953
961
|
getSwapFrom: getSwapFromAssets
|
|
954
962
|
};
|
|
@@ -998,5 +1006,6 @@ var ChainflipService = {
|
|
|
998
1006
|
getSwapToAssets,
|
|
999
1007
|
getTokens,
|
|
1000
1008
|
screenAddress,
|
|
1009
|
+
searchTokens,
|
|
1001
1010
|
trackTransaction
|
|
1002
1011
|
});
|
package/dist/index.d.cts
CHANGED
|
@@ -400,6 +400,26 @@ type GetTokensResponse = {
|
|
|
400
400
|
supportedActions?: Array<'swap' | 'aggregation' | 'addLiquidity' | 'withdrawLiquidity' | 'addSavers' | 'withdrawSavers' | 'borrow' | 'repay' | 'name' | 'donate' | 'claim' | 'stake' | 'unstake' | 'createOrder' | 'cancelOrder'>;
|
|
401
401
|
supportedChainIds?: Array<'36900' | 'aptos' | '42161' | '1313161554' | '43114' | '8453' | '80094' | '56' | 'bitcoin' | 'bitcoincash' | '3637' | 'cardano' | 'chainflip' | '1116' | '21000000' | 'cosmoshub-4' | '25' | 'dash' | 'dogecoin' | '1' | '100' | 'harbor-1' | 'harbor-stagenet-1' | '999' | 'hype' | 'kaiyo-1' | 'litecoin' | '59144' | 'mayachain-mainnet-v1' | 'mayachain-stagenet-v1' | '4326' | '143' | 'near' | 'noble-1' | '10' | '9745' | 'polkadot' | '137' | 'radix-mainnet' | 'ripple' | 'solana' | '146' | 'spark' | 'stellar' | '0x534e5f4d41494e' | 'sui' | 'thorchain-1' | 'thorchain-stagenet-v2' | 'ton' | '728126428' | '130' | '196' | 'zcash'>;
|
|
402
402
|
}>;
|
|
403
|
+
type SearchTokensResponse = {
|
|
404
|
+
tokens: Array<{
|
|
405
|
+
identifier: string;
|
|
406
|
+
chainId: '36900' | 'aptos' | '42161' | '1313161554' | '43114' | '8453' | '80094' | '56' | 'bitcoin' | 'bitcoincash' | '3637' | 'cardano' | 'chainflip' | '1116' | '21000000' | 'cosmoshub-4' | '25' | 'dash' | 'dogecoin' | '1' | '100' | 'harbor-1' | 'harbor-stagenet-1' | '999' | 'hype' | 'kaiyo-1' | 'litecoin' | '59144' | 'mayachain-mainnet-v1' | 'mayachain-stagenet-v1' | '4326' | '143' | 'near' | 'noble-1' | '10' | '9745' | 'polkadot' | '137' | 'radix-mainnet' | 'ripple' | 'solana' | '146' | 'spark' | 'stellar' | '0x534e5f4d41494e' | 'sui' | 'thorchain-1' | 'thorchain-stagenet-v2' | 'ton' | '728126428' | '130' | '196' | 'zcash';
|
|
407
|
+
ticker: string;
|
|
408
|
+
symbol?: string;
|
|
409
|
+
name?: string;
|
|
410
|
+
address?: string;
|
|
411
|
+
decimals: number;
|
|
412
|
+
logoURI?: string;
|
|
413
|
+
coingeckoId?: string;
|
|
414
|
+
chain: 'ADI' | 'APT' | 'ARB' | 'AURORA' | 'AVAX' | 'BASE' | 'BERA' | 'BSC' | 'BTC' | 'BCH' | 'BOTANIX' | 'ADA' | 'FLIP' | 'CORE' | 'CORN' | 'GAIA' | 'CRO' | 'DASH' | 'DOGE' | 'ETH' | 'GNO' | 'HARBOR' | 'HYPEREVM' | 'HYPE' | 'KUJI' | 'LTC' | 'LINEA' | 'MAYA' | 'MEGAETH' | 'MONAD' | 'NEAR' | 'NOBLE' | 'OP' | 'XPL' | 'DOT' | 'POL' | 'XRD' | 'XRP' | 'SOL' | 'SONIC' | 'SPARK' | 'XLM' | 'STRK' | 'SUI' | 'THOR' | 'TON' | 'TRON' | 'UNI' | 'XLAYER' | 'ZEC';
|
|
415
|
+
providers: Array<'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3'>;
|
|
416
|
+
marketCapUsd?: number;
|
|
417
|
+
}>;
|
|
418
|
+
total: number;
|
|
419
|
+
page: number;
|
|
420
|
+
limit: number;
|
|
421
|
+
hasMore: boolean;
|
|
422
|
+
};
|
|
403
423
|
type GetProvidersResponse = Array<{
|
|
404
424
|
name: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
405
425
|
provider: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
@@ -1058,7 +1078,7 @@ type GetQuoteRequest = {
|
|
|
1058
1078
|
useConfidentialIntents?: boolean;
|
|
1059
1079
|
referrer?: string;
|
|
1060
1080
|
/**
|
|
1061
|
-
* EXACT_INPUT (default) or FLEX_INPUT. On FLEX_INPUT, routes whose first-leg provider can't honour the mode are filtered out. Supported first-leg providers: THORCHAIN, MAYACHAIN, CHAINFLIP (incl. streaming variants), and
|
|
1081
|
+
* EXACT_INPUT (default) or FLEX_INPUT. On FLEX_INPUT, routes whose first-leg provider can't honour the mode are filtered out. Supported first-leg providers: THORCHAIN, MAYACHAIN, CHAINFLIP (incl. streaming variants), NEAR, and FLASHNET.
|
|
1062
1082
|
*/
|
|
1063
1083
|
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1064
1084
|
/**
|
|
@@ -1234,6 +1254,10 @@ type GetQuoteResponse = {
|
|
|
1234
1254
|
streamingInterval?: number;
|
|
1235
1255
|
maxStreamingQuantity?: number;
|
|
1236
1256
|
referrer?: string;
|
|
1257
|
+
/**
|
|
1258
|
+
* The quoteType this route was built for (EXACT_INPUT or FLEX_INPUT). Echoes the request's quoteType so /swap can carry the mode forward.
|
|
1259
|
+
*/
|
|
1260
|
+
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1237
1261
|
/**
|
|
1238
1262
|
* Approval address for token swap
|
|
1239
1263
|
*/
|
|
@@ -1594,6 +1618,10 @@ type ExecuteSwapResponse = {
|
|
|
1594
1618
|
streamingInterval?: number;
|
|
1595
1619
|
maxStreamingQuantity?: number;
|
|
1596
1620
|
referrer?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* The quoteType this route was built for (EXACT_INPUT or FLEX_INPUT). Echoes the request's quoteType so /swap can carry the mode forward.
|
|
1623
|
+
*/
|
|
1624
|
+
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1597
1625
|
/**
|
|
1598
1626
|
* Price impact
|
|
1599
1627
|
*/
|
|
@@ -1813,6 +1841,53 @@ type GetTokensResponses = {
|
|
|
1813
1841
|
200: GetTokensResponse;
|
|
1814
1842
|
};
|
|
1815
1843
|
type GetTokensResponse2 = GetTokensResponses[keyof GetTokensResponses];
|
|
1844
|
+
type SearchTokensData = {
|
|
1845
|
+
body?: never;
|
|
1846
|
+
path?: never;
|
|
1847
|
+
query: {
|
|
1848
|
+
/**
|
|
1849
|
+
* Free-text token search query
|
|
1850
|
+
*/
|
|
1851
|
+
query: string;
|
|
1852
|
+
/**
|
|
1853
|
+
* Restrict results to a chain
|
|
1854
|
+
*/
|
|
1855
|
+
chain?: 'ADI' | 'APT' | 'ARB' | 'AURORA' | 'AVAX' | 'BASE' | 'BERA' | 'BSC' | 'BTC' | 'BCH' | 'BOTANIX' | 'ADA' | 'FLIP' | 'CORE' | 'CORN' | 'GAIA' | 'CRO' | 'DASH' | 'DOGE' | 'ETH' | 'GNO' | 'HARBOR' | 'HYPEREVM' | 'HYPE' | 'KUJI' | 'LTC' | 'LINEA' | 'MAYA' | 'MEGAETH' | 'MONAD' | 'NEAR' | 'NOBLE' | 'OP' | 'XPL' | 'DOT' | 'POL' | 'XRD' | 'XRP' | 'SOL' | 'SONIC' | 'SPARK' | 'XLM' | 'STRK' | 'SUI' | 'THOR' | 'TON' | 'TRON' | 'UNI' | 'XLAYER' | 'ZEC';
|
|
1856
|
+
/**
|
|
1857
|
+
* Restrict search to a provider token list
|
|
1858
|
+
*/
|
|
1859
|
+
provider?: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
1860
|
+
limit?: number;
|
|
1861
|
+
page?: number;
|
|
1862
|
+
};
|
|
1863
|
+
url: '/tokens/search';
|
|
1864
|
+
};
|
|
1865
|
+
type SearchTokensErrors = {
|
|
1866
|
+
/**
|
|
1867
|
+
* Default Response
|
|
1868
|
+
*/
|
|
1869
|
+
400: {
|
|
1870
|
+
message: string;
|
|
1871
|
+
error: string;
|
|
1872
|
+
data?: unknown;
|
|
1873
|
+
};
|
|
1874
|
+
/**
|
|
1875
|
+
* Default Response
|
|
1876
|
+
*/
|
|
1877
|
+
500: {
|
|
1878
|
+
message: string;
|
|
1879
|
+
error: string;
|
|
1880
|
+
data?: unknown;
|
|
1881
|
+
};
|
|
1882
|
+
};
|
|
1883
|
+
type SearchTokensError = SearchTokensErrors[keyof SearchTokensErrors];
|
|
1884
|
+
type SearchTokensResponses = {
|
|
1885
|
+
/**
|
|
1886
|
+
* Default Response
|
|
1887
|
+
*/
|
|
1888
|
+
200: SearchTokensResponse;
|
|
1889
|
+
};
|
|
1890
|
+
type SearchTokensResponse2 = SearchTokensResponses[keyof SearchTokensResponses];
|
|
1816
1891
|
type GetSwapToAssetsData = {
|
|
1817
1892
|
body?: never;
|
|
1818
1893
|
path?: never;
|
|
@@ -2418,6 +2493,7 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
|
|
|
2418
2493
|
};
|
|
2419
2494
|
declare const getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError>;
|
|
2420
2495
|
declare const getTokens: <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError>;
|
|
2496
|
+
declare const searchTokens: <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>) => RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError>;
|
|
2421
2497
|
declare const getSwapToAssets: <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>) => RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>;
|
|
2422
2498
|
declare const getSwapFromAssets: <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>) => RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>;
|
|
2423
2499
|
declare const createBrokerChannel: <ThrowOnError extends boolean = false>(options: Options<CreateBrokerChannelData, ThrowOnError>) => RequestResult<CreateBrokerChannelResponses, unknown, ThrowOnError>;
|
|
@@ -2440,6 +2516,7 @@ declare function configureSwapKit(options: SwapKitClientOptions): void;
|
|
|
2440
2516
|
declare class SwapKitService {
|
|
2441
2517
|
static getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError>;
|
|
2442
2518
|
static getTokens: <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError>;
|
|
2519
|
+
static searchTokens: <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>) => RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError>;
|
|
2443
2520
|
static getSwapTo: <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>) => RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>;
|
|
2444
2521
|
static getSwapFrom: <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>) => RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>;
|
|
2445
2522
|
static getQuote: <ThrowOnError extends boolean = false>(options: Options<GetQuoteData, ThrowOnError>) => RequestResult<GetQuoteResponses, GetQuoteErrors, ThrowOnError>;
|
|
@@ -2455,6 +2532,7 @@ declare class SwapKitService {
|
|
|
2455
2532
|
declare const TokenlistService: {
|
|
2456
2533
|
readonly getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError>;
|
|
2457
2534
|
readonly getTokens: <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError>;
|
|
2535
|
+
readonly searchTokens: <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>) => RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError>;
|
|
2458
2536
|
readonly getSwapTo: <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>) => RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>;
|
|
2459
2537
|
readonly getSwapFrom: <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>) => RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>;
|
|
2460
2538
|
};
|
|
@@ -2488,4 +2566,4 @@ declare const ChainflipService: {
|
|
|
2488
2566
|
readonly createBrokerChannel: <ThrowOnError extends boolean = false>(options: Options<CreateBrokerChannelData, ThrowOnError>) => RequestResult<CreateBrokerChannelResponses, unknown, ThrowOnError>;
|
|
2489
2567
|
};
|
|
2490
2568
|
|
|
2491
|
-
export { ChainflipService, type ClientOptions, type CreateBrokerChannelData, type CreateBrokerChannelRequest, type CreateBrokerChannelResponse, type CreateBrokerChannelResponse2, type CreateBrokerChannelResponses, type ExecuteSwapData, type ExecuteSwapError, type ExecuteSwapErrors, type ExecuteSwapRequest, type ExecuteSwapResponse, type ExecuteSwapResponse2, type ExecuteSwapResponses, GasService, type GetCachedPriceData, type GetCachedPriceRequest, type GetCachedPriceResponse, type GetCachedPriceResponse2, type GetCachedPriceResponses, type GetGasHistoryData, type GetGasHistoryResponse, type GetGasHistoryResponse2, type GetGasHistoryResponses, type GetGasPricesData, type GetGasPricesResponse, type GetGasPricesResponse2, type GetGasPricesResponses, type GetProvidersData, type GetProvidersError, type GetProvidersErrors, type GetProvidersResponse, type GetProvidersResponse2, type GetProvidersResponses, type GetProvidersStatusResponse, type GetQuoteData, type GetQuoteError, type GetQuoteErrors, type GetQuoteRequest, type GetQuoteResponse, type GetQuoteResponse2, type GetQuoteResponses, type GetSwapFromAssetsData, type GetSwapFromAssetsError, type GetSwapFromAssetsErrors, type GetSwapFromAssetsResponse, type GetSwapFromAssetsResponse2, type GetSwapFromAssetsResponses, type GetSwapToAssetsData, type GetSwapToAssetsError, type GetSwapToAssetsErrors, type GetSwapToAssetsResponse, type GetSwapToAssetsResponse2, type GetSwapToAssetsResponses, type GetTokensData, type GetTokensError, type GetTokensErrors, type GetTokensResponse, type GetTokensResponse2, type GetTokensResponses, type InsertTrackedTransactionRequest, type InsertTrackedTransactionResponse, type Options, PriceService, QuoteService, type ScreenAddressData, type ScreenAddressError, type ScreenAddressErrors, type ScreenAddressRequest, type ScreenAddressResponse, type ScreenAddressResponse2, type ScreenAddressResponses, ScreenService, type SwapKitClientOptions, SwapKitService, SwapService, TokenlistService, TrackService, type TrackTransactionData, type TrackTransactionError, type TrackTransactionErrors, type TrackTransactionRequest, type TrackTransactionResponse, type TrackTransactionResponse2, type TrackTransactionResponses, client, configureSwapKit, createBrokerChannel, executeSwap, getCachedPrice, getGasHistory, getGasPrices, getProviders, getQuote, getSwapFromAssets, getSwapToAssets, getTokens, screenAddress, trackTransaction };
|
|
2569
|
+
export { ChainflipService, type ClientOptions, type CreateBrokerChannelData, type CreateBrokerChannelRequest, type CreateBrokerChannelResponse, type CreateBrokerChannelResponse2, type CreateBrokerChannelResponses, type ExecuteSwapData, type ExecuteSwapError, type ExecuteSwapErrors, type ExecuteSwapRequest, type ExecuteSwapResponse, type ExecuteSwapResponse2, type ExecuteSwapResponses, GasService, type GetCachedPriceData, type GetCachedPriceRequest, type GetCachedPriceResponse, type GetCachedPriceResponse2, type GetCachedPriceResponses, type GetGasHistoryData, type GetGasHistoryResponse, type GetGasHistoryResponse2, type GetGasHistoryResponses, type GetGasPricesData, type GetGasPricesResponse, type GetGasPricesResponse2, type GetGasPricesResponses, type GetProvidersData, type GetProvidersError, type GetProvidersErrors, type GetProvidersResponse, type GetProvidersResponse2, type GetProvidersResponses, type GetProvidersStatusResponse, type GetQuoteData, type GetQuoteError, type GetQuoteErrors, type GetQuoteRequest, type GetQuoteResponse, type GetQuoteResponse2, type GetQuoteResponses, type GetSwapFromAssetsData, type GetSwapFromAssetsError, type GetSwapFromAssetsErrors, type GetSwapFromAssetsResponse, type GetSwapFromAssetsResponse2, type GetSwapFromAssetsResponses, type GetSwapToAssetsData, type GetSwapToAssetsError, type GetSwapToAssetsErrors, type GetSwapToAssetsResponse, type GetSwapToAssetsResponse2, type GetSwapToAssetsResponses, type GetTokensData, type GetTokensError, type GetTokensErrors, type GetTokensResponse, type GetTokensResponse2, type GetTokensResponses, type InsertTrackedTransactionRequest, type InsertTrackedTransactionResponse, type Options, PriceService, QuoteService, type ScreenAddressData, type ScreenAddressError, type ScreenAddressErrors, type ScreenAddressRequest, type ScreenAddressResponse, type ScreenAddressResponse2, type ScreenAddressResponses, ScreenService, type SearchTokensData, type SearchTokensError, type SearchTokensErrors, type SearchTokensResponse, type SearchTokensResponse2, type SearchTokensResponses, type SwapKitClientOptions, SwapKitService, SwapService, TokenlistService, TrackService, type TrackTransactionData, type TrackTransactionError, type TrackTransactionErrors, type TrackTransactionRequest, type TrackTransactionResponse, type TrackTransactionResponse2, type TrackTransactionResponses, client, configureSwapKit, createBrokerChannel, executeSwap, getCachedPrice, getGasHistory, getGasPrices, getProviders, getQuote, getSwapFromAssets, getSwapToAssets, getTokens, screenAddress, searchTokens, trackTransaction };
|
package/dist/index.d.ts
CHANGED
|
@@ -400,6 +400,26 @@ type GetTokensResponse = {
|
|
|
400
400
|
supportedActions?: Array<'swap' | 'aggregation' | 'addLiquidity' | 'withdrawLiquidity' | 'addSavers' | 'withdrawSavers' | 'borrow' | 'repay' | 'name' | 'donate' | 'claim' | 'stake' | 'unstake' | 'createOrder' | 'cancelOrder'>;
|
|
401
401
|
supportedChainIds?: Array<'36900' | 'aptos' | '42161' | '1313161554' | '43114' | '8453' | '80094' | '56' | 'bitcoin' | 'bitcoincash' | '3637' | 'cardano' | 'chainflip' | '1116' | '21000000' | 'cosmoshub-4' | '25' | 'dash' | 'dogecoin' | '1' | '100' | 'harbor-1' | 'harbor-stagenet-1' | '999' | 'hype' | 'kaiyo-1' | 'litecoin' | '59144' | 'mayachain-mainnet-v1' | 'mayachain-stagenet-v1' | '4326' | '143' | 'near' | 'noble-1' | '10' | '9745' | 'polkadot' | '137' | 'radix-mainnet' | 'ripple' | 'solana' | '146' | 'spark' | 'stellar' | '0x534e5f4d41494e' | 'sui' | 'thorchain-1' | 'thorchain-stagenet-v2' | 'ton' | '728126428' | '130' | '196' | 'zcash'>;
|
|
402
402
|
}>;
|
|
403
|
+
type SearchTokensResponse = {
|
|
404
|
+
tokens: Array<{
|
|
405
|
+
identifier: string;
|
|
406
|
+
chainId: '36900' | 'aptos' | '42161' | '1313161554' | '43114' | '8453' | '80094' | '56' | 'bitcoin' | 'bitcoincash' | '3637' | 'cardano' | 'chainflip' | '1116' | '21000000' | 'cosmoshub-4' | '25' | 'dash' | 'dogecoin' | '1' | '100' | 'harbor-1' | 'harbor-stagenet-1' | '999' | 'hype' | 'kaiyo-1' | 'litecoin' | '59144' | 'mayachain-mainnet-v1' | 'mayachain-stagenet-v1' | '4326' | '143' | 'near' | 'noble-1' | '10' | '9745' | 'polkadot' | '137' | 'radix-mainnet' | 'ripple' | 'solana' | '146' | 'spark' | 'stellar' | '0x534e5f4d41494e' | 'sui' | 'thorchain-1' | 'thorchain-stagenet-v2' | 'ton' | '728126428' | '130' | '196' | 'zcash';
|
|
407
|
+
ticker: string;
|
|
408
|
+
symbol?: string;
|
|
409
|
+
name?: string;
|
|
410
|
+
address?: string;
|
|
411
|
+
decimals: number;
|
|
412
|
+
logoURI?: string;
|
|
413
|
+
coingeckoId?: string;
|
|
414
|
+
chain: 'ADI' | 'APT' | 'ARB' | 'AURORA' | 'AVAX' | 'BASE' | 'BERA' | 'BSC' | 'BTC' | 'BCH' | 'BOTANIX' | 'ADA' | 'FLIP' | 'CORE' | 'CORN' | 'GAIA' | 'CRO' | 'DASH' | 'DOGE' | 'ETH' | 'GNO' | 'HARBOR' | 'HYPEREVM' | 'HYPE' | 'KUJI' | 'LTC' | 'LINEA' | 'MAYA' | 'MEGAETH' | 'MONAD' | 'NEAR' | 'NOBLE' | 'OP' | 'XPL' | 'DOT' | 'POL' | 'XRD' | 'XRP' | 'SOL' | 'SONIC' | 'SPARK' | 'XLM' | 'STRK' | 'SUI' | 'THOR' | 'TON' | 'TRON' | 'UNI' | 'XLAYER' | 'ZEC';
|
|
415
|
+
providers: Array<'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3'>;
|
|
416
|
+
marketCapUsd?: number;
|
|
417
|
+
}>;
|
|
418
|
+
total: number;
|
|
419
|
+
page: number;
|
|
420
|
+
limit: number;
|
|
421
|
+
hasMore: boolean;
|
|
422
|
+
};
|
|
403
423
|
type GetProvidersResponse = Array<{
|
|
404
424
|
name: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
405
425
|
provider: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
@@ -1058,7 +1078,7 @@ type GetQuoteRequest = {
|
|
|
1058
1078
|
useConfidentialIntents?: boolean;
|
|
1059
1079
|
referrer?: string;
|
|
1060
1080
|
/**
|
|
1061
|
-
* EXACT_INPUT (default) or FLEX_INPUT. On FLEX_INPUT, routes whose first-leg provider can't honour the mode are filtered out. Supported first-leg providers: THORCHAIN, MAYACHAIN, CHAINFLIP (incl. streaming variants), and
|
|
1081
|
+
* EXACT_INPUT (default) or FLEX_INPUT. On FLEX_INPUT, routes whose first-leg provider can't honour the mode are filtered out. Supported first-leg providers: THORCHAIN, MAYACHAIN, CHAINFLIP (incl. streaming variants), NEAR, and FLASHNET.
|
|
1062
1082
|
*/
|
|
1063
1083
|
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1064
1084
|
/**
|
|
@@ -1234,6 +1254,10 @@ type GetQuoteResponse = {
|
|
|
1234
1254
|
streamingInterval?: number;
|
|
1235
1255
|
maxStreamingQuantity?: number;
|
|
1236
1256
|
referrer?: string;
|
|
1257
|
+
/**
|
|
1258
|
+
* The quoteType this route was built for (EXACT_INPUT or FLEX_INPUT). Echoes the request's quoteType so /swap can carry the mode forward.
|
|
1259
|
+
*/
|
|
1260
|
+
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1237
1261
|
/**
|
|
1238
1262
|
* Approval address for token swap
|
|
1239
1263
|
*/
|
|
@@ -1594,6 +1618,10 @@ type ExecuteSwapResponse = {
|
|
|
1594
1618
|
streamingInterval?: number;
|
|
1595
1619
|
maxStreamingQuantity?: number;
|
|
1596
1620
|
referrer?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* The quoteType this route was built for (EXACT_INPUT or FLEX_INPUT). Echoes the request's quoteType so /swap can carry the mode forward.
|
|
1623
|
+
*/
|
|
1624
|
+
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1597
1625
|
/**
|
|
1598
1626
|
* Price impact
|
|
1599
1627
|
*/
|
|
@@ -1813,6 +1841,53 @@ type GetTokensResponses = {
|
|
|
1813
1841
|
200: GetTokensResponse;
|
|
1814
1842
|
};
|
|
1815
1843
|
type GetTokensResponse2 = GetTokensResponses[keyof GetTokensResponses];
|
|
1844
|
+
type SearchTokensData = {
|
|
1845
|
+
body?: never;
|
|
1846
|
+
path?: never;
|
|
1847
|
+
query: {
|
|
1848
|
+
/**
|
|
1849
|
+
* Free-text token search query
|
|
1850
|
+
*/
|
|
1851
|
+
query: string;
|
|
1852
|
+
/**
|
|
1853
|
+
* Restrict results to a chain
|
|
1854
|
+
*/
|
|
1855
|
+
chain?: 'ADI' | 'APT' | 'ARB' | 'AURORA' | 'AVAX' | 'BASE' | 'BERA' | 'BSC' | 'BTC' | 'BCH' | 'BOTANIX' | 'ADA' | 'FLIP' | 'CORE' | 'CORN' | 'GAIA' | 'CRO' | 'DASH' | 'DOGE' | 'ETH' | 'GNO' | 'HARBOR' | 'HYPEREVM' | 'HYPE' | 'KUJI' | 'LTC' | 'LINEA' | 'MAYA' | 'MEGAETH' | 'MONAD' | 'NEAR' | 'NOBLE' | 'OP' | 'XPL' | 'DOT' | 'POL' | 'XRD' | 'XRP' | 'SOL' | 'SONIC' | 'SPARK' | 'XLM' | 'STRK' | 'SUI' | 'THOR' | 'TON' | 'TRON' | 'UNI' | 'XLAYER' | 'ZEC';
|
|
1856
|
+
/**
|
|
1857
|
+
* Restrict search to a provider token list
|
|
1858
|
+
*/
|
|
1859
|
+
provider?: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
1860
|
+
limit?: number;
|
|
1861
|
+
page?: number;
|
|
1862
|
+
};
|
|
1863
|
+
url: '/tokens/search';
|
|
1864
|
+
};
|
|
1865
|
+
type SearchTokensErrors = {
|
|
1866
|
+
/**
|
|
1867
|
+
* Default Response
|
|
1868
|
+
*/
|
|
1869
|
+
400: {
|
|
1870
|
+
message: string;
|
|
1871
|
+
error: string;
|
|
1872
|
+
data?: unknown;
|
|
1873
|
+
};
|
|
1874
|
+
/**
|
|
1875
|
+
* Default Response
|
|
1876
|
+
*/
|
|
1877
|
+
500: {
|
|
1878
|
+
message: string;
|
|
1879
|
+
error: string;
|
|
1880
|
+
data?: unknown;
|
|
1881
|
+
};
|
|
1882
|
+
};
|
|
1883
|
+
type SearchTokensError = SearchTokensErrors[keyof SearchTokensErrors];
|
|
1884
|
+
type SearchTokensResponses = {
|
|
1885
|
+
/**
|
|
1886
|
+
* Default Response
|
|
1887
|
+
*/
|
|
1888
|
+
200: SearchTokensResponse;
|
|
1889
|
+
};
|
|
1890
|
+
type SearchTokensResponse2 = SearchTokensResponses[keyof SearchTokensResponses];
|
|
1816
1891
|
type GetSwapToAssetsData = {
|
|
1817
1892
|
body?: never;
|
|
1818
1893
|
path?: never;
|
|
@@ -2418,6 +2493,7 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
|
|
|
2418
2493
|
};
|
|
2419
2494
|
declare const getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError>;
|
|
2420
2495
|
declare const getTokens: <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError>;
|
|
2496
|
+
declare const searchTokens: <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>) => RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError>;
|
|
2421
2497
|
declare const getSwapToAssets: <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>) => RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>;
|
|
2422
2498
|
declare const getSwapFromAssets: <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>) => RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>;
|
|
2423
2499
|
declare const createBrokerChannel: <ThrowOnError extends boolean = false>(options: Options<CreateBrokerChannelData, ThrowOnError>) => RequestResult<CreateBrokerChannelResponses, unknown, ThrowOnError>;
|
|
@@ -2440,6 +2516,7 @@ declare function configureSwapKit(options: SwapKitClientOptions): void;
|
|
|
2440
2516
|
declare class SwapKitService {
|
|
2441
2517
|
static getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError>;
|
|
2442
2518
|
static getTokens: <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError>;
|
|
2519
|
+
static searchTokens: <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>) => RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError>;
|
|
2443
2520
|
static getSwapTo: <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>) => RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>;
|
|
2444
2521
|
static getSwapFrom: <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>) => RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>;
|
|
2445
2522
|
static getQuote: <ThrowOnError extends boolean = false>(options: Options<GetQuoteData, ThrowOnError>) => RequestResult<GetQuoteResponses, GetQuoteErrors, ThrowOnError>;
|
|
@@ -2455,6 +2532,7 @@ declare class SwapKitService {
|
|
|
2455
2532
|
declare const TokenlistService: {
|
|
2456
2533
|
readonly getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError>;
|
|
2457
2534
|
readonly getTokens: <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError>;
|
|
2535
|
+
readonly searchTokens: <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>) => RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError>;
|
|
2458
2536
|
readonly getSwapTo: <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>) => RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>;
|
|
2459
2537
|
readonly getSwapFrom: <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>) => RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>;
|
|
2460
2538
|
};
|
|
@@ -2488,4 +2566,4 @@ declare const ChainflipService: {
|
|
|
2488
2566
|
readonly createBrokerChannel: <ThrowOnError extends boolean = false>(options: Options<CreateBrokerChannelData, ThrowOnError>) => RequestResult<CreateBrokerChannelResponses, unknown, ThrowOnError>;
|
|
2489
2567
|
};
|
|
2490
2568
|
|
|
2491
|
-
export { ChainflipService, type ClientOptions, type CreateBrokerChannelData, type CreateBrokerChannelRequest, type CreateBrokerChannelResponse, type CreateBrokerChannelResponse2, type CreateBrokerChannelResponses, type ExecuteSwapData, type ExecuteSwapError, type ExecuteSwapErrors, type ExecuteSwapRequest, type ExecuteSwapResponse, type ExecuteSwapResponse2, type ExecuteSwapResponses, GasService, type GetCachedPriceData, type GetCachedPriceRequest, type GetCachedPriceResponse, type GetCachedPriceResponse2, type GetCachedPriceResponses, type GetGasHistoryData, type GetGasHistoryResponse, type GetGasHistoryResponse2, type GetGasHistoryResponses, type GetGasPricesData, type GetGasPricesResponse, type GetGasPricesResponse2, type GetGasPricesResponses, type GetProvidersData, type GetProvidersError, type GetProvidersErrors, type GetProvidersResponse, type GetProvidersResponse2, type GetProvidersResponses, type GetProvidersStatusResponse, type GetQuoteData, type GetQuoteError, type GetQuoteErrors, type GetQuoteRequest, type GetQuoteResponse, type GetQuoteResponse2, type GetQuoteResponses, type GetSwapFromAssetsData, type GetSwapFromAssetsError, type GetSwapFromAssetsErrors, type GetSwapFromAssetsResponse, type GetSwapFromAssetsResponse2, type GetSwapFromAssetsResponses, type GetSwapToAssetsData, type GetSwapToAssetsError, type GetSwapToAssetsErrors, type GetSwapToAssetsResponse, type GetSwapToAssetsResponse2, type GetSwapToAssetsResponses, type GetTokensData, type GetTokensError, type GetTokensErrors, type GetTokensResponse, type GetTokensResponse2, type GetTokensResponses, type InsertTrackedTransactionRequest, type InsertTrackedTransactionResponse, type Options, PriceService, QuoteService, type ScreenAddressData, type ScreenAddressError, type ScreenAddressErrors, type ScreenAddressRequest, type ScreenAddressResponse, type ScreenAddressResponse2, type ScreenAddressResponses, ScreenService, type SwapKitClientOptions, SwapKitService, SwapService, TokenlistService, TrackService, type TrackTransactionData, type TrackTransactionError, type TrackTransactionErrors, type TrackTransactionRequest, type TrackTransactionResponse, type TrackTransactionResponse2, type TrackTransactionResponses, client, configureSwapKit, createBrokerChannel, executeSwap, getCachedPrice, getGasHistory, getGasPrices, getProviders, getQuote, getSwapFromAssets, getSwapToAssets, getTokens, screenAddress, trackTransaction };
|
|
2569
|
+
export { ChainflipService, type ClientOptions, type CreateBrokerChannelData, type CreateBrokerChannelRequest, type CreateBrokerChannelResponse, type CreateBrokerChannelResponse2, type CreateBrokerChannelResponses, type ExecuteSwapData, type ExecuteSwapError, type ExecuteSwapErrors, type ExecuteSwapRequest, type ExecuteSwapResponse, type ExecuteSwapResponse2, type ExecuteSwapResponses, GasService, type GetCachedPriceData, type GetCachedPriceRequest, type GetCachedPriceResponse, type GetCachedPriceResponse2, type GetCachedPriceResponses, type GetGasHistoryData, type GetGasHistoryResponse, type GetGasHistoryResponse2, type GetGasHistoryResponses, type GetGasPricesData, type GetGasPricesResponse, type GetGasPricesResponse2, type GetGasPricesResponses, type GetProvidersData, type GetProvidersError, type GetProvidersErrors, type GetProvidersResponse, type GetProvidersResponse2, type GetProvidersResponses, type GetProvidersStatusResponse, type GetQuoteData, type GetQuoteError, type GetQuoteErrors, type GetQuoteRequest, type GetQuoteResponse, type GetQuoteResponse2, type GetQuoteResponses, type GetSwapFromAssetsData, type GetSwapFromAssetsError, type GetSwapFromAssetsErrors, type GetSwapFromAssetsResponse, type GetSwapFromAssetsResponse2, type GetSwapFromAssetsResponses, type GetSwapToAssetsData, type GetSwapToAssetsError, type GetSwapToAssetsErrors, type GetSwapToAssetsResponse, type GetSwapToAssetsResponse2, type GetSwapToAssetsResponses, type GetTokensData, type GetTokensError, type GetTokensErrors, type GetTokensResponse, type GetTokensResponse2, type GetTokensResponses, type InsertTrackedTransactionRequest, type InsertTrackedTransactionResponse, type Options, PriceService, QuoteService, type ScreenAddressData, type ScreenAddressError, type ScreenAddressErrors, type ScreenAddressRequest, type ScreenAddressResponse, type ScreenAddressResponse2, type ScreenAddressResponses, ScreenService, type SearchTokensData, type SearchTokensError, type SearchTokensErrors, type SearchTokensResponse, type SearchTokensResponse2, type SearchTokensResponses, type SwapKitClientOptions, SwapKitService, SwapService, TokenlistService, TrackService, type TrackTransactionData, type TrackTransactionError, type TrackTransactionErrors, type TrackTransactionRequest, type TrackTransactionResponse, type TrackTransactionResponse2, type TrackTransactionResponses, client, configureSwapKit, createBrokerChannel, executeSwap, getCachedPrice, getGasHistory, getGasPrices, getProviders, getQuote, getSwapFromAssets, getSwapToAssets, getTokens, screenAddress, searchTokens, trackTransaction };
|
package/dist/index.js
CHANGED
|
@@ -808,6 +808,11 @@ var getTokens = (options) => (options?.client ?? client).get({
|
|
|
808
808
|
url: "/tokens",
|
|
809
809
|
...options
|
|
810
810
|
});
|
|
811
|
+
var searchTokens = (options) => (options.client ?? client).get({
|
|
812
|
+
security: [{ name: "x-api-key", type: "apiKey" }],
|
|
813
|
+
url: "/tokens/search",
|
|
814
|
+
...options
|
|
815
|
+
});
|
|
811
816
|
var getSwapToAssets = (options) => (options.client ?? client).get({
|
|
812
817
|
security: [{ name: "x-api-key", type: "apiKey" }],
|
|
813
818
|
url: "/swapTo",
|
|
@@ -888,6 +893,7 @@ var SwapKitService = class {
|
|
|
888
893
|
};
|
|
889
894
|
SwapKitService.getProviders = getProviders;
|
|
890
895
|
SwapKitService.getTokens = getTokens;
|
|
896
|
+
SwapKitService.searchTokens = searchTokens;
|
|
891
897
|
SwapKitService.getSwapTo = getSwapToAssets;
|
|
892
898
|
SwapKitService.getSwapFrom = getSwapFromAssets;
|
|
893
899
|
SwapKitService.getQuote = getQuote;
|
|
@@ -901,6 +907,7 @@ SwapKitService.createBrokerChannel = createBrokerChannel;
|
|
|
901
907
|
var TokenlistService = {
|
|
902
908
|
getProviders,
|
|
903
909
|
getTokens,
|
|
910
|
+
searchTokens,
|
|
904
911
|
getSwapTo: getSwapToAssets,
|
|
905
912
|
getSwapFrom: getSwapFromAssets
|
|
906
913
|
};
|
|
@@ -949,5 +956,6 @@ export {
|
|
|
949
956
|
getSwapToAssets,
|
|
950
957
|
getTokens,
|
|
951
958
|
screenAddress,
|
|
959
|
+
searchTokens,
|
|
952
960
|
trackTransaction
|
|
953
961
|
};
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -25,12 +25,14 @@ import {
|
|
|
25
25
|
getSwapToAssets,
|
|
26
26
|
getTokens,
|
|
27
27
|
screenAddress,
|
|
28
|
+
searchTokens,
|
|
28
29
|
trackTransaction,
|
|
29
30
|
} from "./sdk";
|
|
30
31
|
|
|
31
32
|
export class SwapKitService {
|
|
32
33
|
static getProviders = getProviders;
|
|
33
34
|
static getTokens = getTokens;
|
|
35
|
+
static searchTokens = searchTokens;
|
|
34
36
|
static getSwapTo = getSwapToAssets;
|
|
35
37
|
static getSwapFrom = getSwapFromAssets;
|
|
36
38
|
static getQuote = getQuote;
|
|
@@ -51,6 +53,7 @@ export class SwapKitService {
|
|
|
51
53
|
export const TokenlistService = {
|
|
52
54
|
getProviders,
|
|
53
55
|
getTokens,
|
|
56
|
+
searchTokens,
|
|
54
57
|
getSwapTo: getSwapToAssets,
|
|
55
58
|
getSwapFrom: getSwapFromAssets,
|
|
56
59
|
} as const;
|
package/src/sdk.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './http';
|
|
4
4
|
import { client } from './client';
|
|
5
|
-
import type { CreateBrokerChannelData, CreateBrokerChannelResponses, ExecuteSwapData, ExecuteSwapErrors, ExecuteSwapResponses, GetCachedPriceData, GetCachedPriceResponses, GetGasHistoryData, GetGasHistoryResponses, GetGasPricesData, GetGasPricesResponses, GetProvidersData, GetProvidersErrors, GetProvidersResponses, GetQuoteData, GetQuoteErrors, GetQuoteResponses, GetSwapFromAssetsData, GetSwapFromAssetsErrors, GetSwapFromAssetsResponses, GetSwapToAssetsData, GetSwapToAssetsErrors, GetSwapToAssetsResponses, GetTokensData, GetTokensErrors, GetTokensResponses, ScreenAddressData, ScreenAddressErrors, ScreenAddressResponses, TrackTransactionData, TrackTransactionErrors, TrackTransactionResponses } from './types';
|
|
5
|
+
import type { CreateBrokerChannelData, CreateBrokerChannelResponses, ExecuteSwapData, ExecuteSwapErrors, ExecuteSwapResponses, GetCachedPriceData, GetCachedPriceResponses, GetGasHistoryData, GetGasHistoryResponses, GetGasPricesData, GetGasPricesResponses, GetProvidersData, GetProvidersErrors, GetProvidersResponses, GetQuoteData, GetQuoteErrors, GetQuoteResponses, GetSwapFromAssetsData, GetSwapFromAssetsErrors, GetSwapFromAssetsResponses, GetSwapToAssetsData, GetSwapToAssetsErrors, GetSwapToAssetsResponses, GetTokensData, GetTokensErrors, GetTokensResponses, ScreenAddressData, ScreenAddressErrors, ScreenAddressResponses, SearchTokensData, SearchTokensErrors, SearchTokensResponses, TrackTransactionData, TrackTransactionErrors, TrackTransactionResponses } from './types';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
8
8
|
/**
|
|
@@ -30,6 +30,12 @@ export const getTokens = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
30
30
|
...options
|
|
31
31
|
});
|
|
32
32
|
|
|
33
|
+
export const searchTokens = <ThrowOnError extends boolean = false>(options: Options<SearchTokensData, ThrowOnError>): RequestResult<SearchTokensResponses, SearchTokensErrors, ThrowOnError> => (options.client ?? client).get<SearchTokensResponses, SearchTokensErrors, ThrowOnError>({
|
|
34
|
+
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
35
|
+
url: '/tokens/search',
|
|
36
|
+
...options
|
|
37
|
+
});
|
|
38
|
+
|
|
33
39
|
export const getSwapToAssets = <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>): RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError> => (options.client ?? client).get<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>({
|
|
34
40
|
security: [{ name: 'x-api-key', type: 'apiKey' }],
|
|
35
41
|
url: '/swapTo',
|
package/src/types.ts
CHANGED
|
@@ -78,6 +78,27 @@ export type GetTokensResponse = {
|
|
|
78
78
|
supportedChainIds?: Array<'36900' | 'aptos' | '42161' | '1313161554' | '43114' | '8453' | '80094' | '56' | 'bitcoin' | 'bitcoincash' | '3637' | 'cardano' | 'chainflip' | '1116' | '21000000' | 'cosmoshub-4' | '25' | 'dash' | 'dogecoin' | '1' | '100' | 'harbor-1' | 'harbor-stagenet-1' | '999' | 'hype' | 'kaiyo-1' | 'litecoin' | '59144' | 'mayachain-mainnet-v1' | 'mayachain-stagenet-v1' | '4326' | '143' | 'near' | 'noble-1' | '10' | '9745' | 'polkadot' | '137' | 'radix-mainnet' | 'ripple' | 'solana' | '146' | 'spark' | 'stellar' | '0x534e5f4d41494e' | 'sui' | 'thorchain-1' | 'thorchain-stagenet-v2' | 'ton' | '728126428' | '130' | '196' | 'zcash'>;
|
|
79
79
|
}>;
|
|
80
80
|
|
|
81
|
+
export type SearchTokensResponse = {
|
|
82
|
+
tokens: Array<{
|
|
83
|
+
identifier: string;
|
|
84
|
+
chainId: '36900' | 'aptos' | '42161' | '1313161554' | '43114' | '8453' | '80094' | '56' | 'bitcoin' | 'bitcoincash' | '3637' | 'cardano' | 'chainflip' | '1116' | '21000000' | 'cosmoshub-4' | '25' | 'dash' | 'dogecoin' | '1' | '100' | 'harbor-1' | 'harbor-stagenet-1' | '999' | 'hype' | 'kaiyo-1' | 'litecoin' | '59144' | 'mayachain-mainnet-v1' | 'mayachain-stagenet-v1' | '4326' | '143' | 'near' | 'noble-1' | '10' | '9745' | 'polkadot' | '137' | 'radix-mainnet' | 'ripple' | 'solana' | '146' | 'spark' | 'stellar' | '0x534e5f4d41494e' | 'sui' | 'thorchain-1' | 'thorchain-stagenet-v2' | 'ton' | '728126428' | '130' | '196' | 'zcash';
|
|
85
|
+
ticker: string;
|
|
86
|
+
symbol?: string;
|
|
87
|
+
name?: string;
|
|
88
|
+
address?: string;
|
|
89
|
+
decimals: number;
|
|
90
|
+
logoURI?: string;
|
|
91
|
+
coingeckoId?: string;
|
|
92
|
+
chain: 'ADI' | 'APT' | 'ARB' | 'AURORA' | 'AVAX' | 'BASE' | 'BERA' | 'BSC' | 'BTC' | 'BCH' | 'BOTANIX' | 'ADA' | 'FLIP' | 'CORE' | 'CORN' | 'GAIA' | 'CRO' | 'DASH' | 'DOGE' | 'ETH' | 'GNO' | 'HARBOR' | 'HYPEREVM' | 'HYPE' | 'KUJI' | 'LTC' | 'LINEA' | 'MAYA' | 'MEGAETH' | 'MONAD' | 'NEAR' | 'NOBLE' | 'OP' | 'XPL' | 'DOT' | 'POL' | 'XRD' | 'XRP' | 'SOL' | 'SONIC' | 'SPARK' | 'XLM' | 'STRK' | 'SUI' | 'THOR' | 'TON' | 'TRON' | 'UNI' | 'XLAYER' | 'ZEC';
|
|
93
|
+
providers: Array<'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3'>;
|
|
94
|
+
marketCapUsd?: number;
|
|
95
|
+
}>;
|
|
96
|
+
total: number;
|
|
97
|
+
page: number;
|
|
98
|
+
limit: number;
|
|
99
|
+
hasMore: boolean;
|
|
100
|
+
};
|
|
101
|
+
|
|
81
102
|
export type GetProvidersResponse = Array<{
|
|
82
103
|
name: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
83
104
|
provider: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
@@ -752,7 +773,7 @@ export type GetQuoteRequest = {
|
|
|
752
773
|
useConfidentialIntents?: boolean;
|
|
753
774
|
referrer?: string;
|
|
754
775
|
/**
|
|
755
|
-
* EXACT_INPUT (default) or FLEX_INPUT. On FLEX_INPUT, routes whose first-leg provider can't honour the mode are filtered out. Supported first-leg providers: THORCHAIN, MAYACHAIN, CHAINFLIP (incl. streaming variants), and
|
|
776
|
+
* EXACT_INPUT (default) or FLEX_INPUT. On FLEX_INPUT, routes whose first-leg provider can't honour the mode are filtered out. Supported first-leg providers: THORCHAIN, MAYACHAIN, CHAINFLIP (incl. streaming variants), NEAR, and FLASHNET.
|
|
756
777
|
*/
|
|
757
778
|
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
758
779
|
/**
|
|
@@ -929,6 +950,10 @@ export type GetQuoteResponse = {
|
|
|
929
950
|
streamingInterval?: number;
|
|
930
951
|
maxStreamingQuantity?: number;
|
|
931
952
|
referrer?: string;
|
|
953
|
+
/**
|
|
954
|
+
* The quoteType this route was built for (EXACT_INPUT or FLEX_INPUT). Echoes the request's quoteType so /swap can carry the mode forward.
|
|
955
|
+
*/
|
|
956
|
+
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
932
957
|
/**
|
|
933
958
|
* Approval address for token swap
|
|
934
959
|
*/
|
|
@@ -1291,6 +1316,10 @@ export type ExecuteSwapResponse = {
|
|
|
1291
1316
|
streamingInterval?: number;
|
|
1292
1317
|
maxStreamingQuantity?: number;
|
|
1293
1318
|
referrer?: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* The quoteType this route was built for (EXACT_INPUT or FLEX_INPUT). Echoes the request's quoteType so /swap can carry the mode forward.
|
|
1321
|
+
*/
|
|
1322
|
+
quoteType?: 'EXACT_INPUT' | 'FLEX_INPUT';
|
|
1294
1323
|
/**
|
|
1295
1324
|
* Price impact
|
|
1296
1325
|
*/
|
|
@@ -1521,6 +1550,58 @@ export type GetTokensResponses = {
|
|
|
1521
1550
|
|
|
1522
1551
|
export type GetTokensResponse2 = GetTokensResponses[keyof GetTokensResponses];
|
|
1523
1552
|
|
|
1553
|
+
export type SearchTokensData = {
|
|
1554
|
+
body?: never;
|
|
1555
|
+
path?: never;
|
|
1556
|
+
query: {
|
|
1557
|
+
/**
|
|
1558
|
+
* Free-text token search query
|
|
1559
|
+
*/
|
|
1560
|
+
query: string;
|
|
1561
|
+
/**
|
|
1562
|
+
* Restrict results to a chain
|
|
1563
|
+
*/
|
|
1564
|
+
chain?: 'ADI' | 'APT' | 'ARB' | 'AURORA' | 'AVAX' | 'BASE' | 'BERA' | 'BSC' | 'BTC' | 'BCH' | 'BOTANIX' | 'ADA' | 'FLIP' | 'CORE' | 'CORN' | 'GAIA' | 'CRO' | 'DASH' | 'DOGE' | 'ETH' | 'GNO' | 'HARBOR' | 'HYPEREVM' | 'HYPE' | 'KUJI' | 'LTC' | 'LINEA' | 'MAYA' | 'MEGAETH' | 'MONAD' | 'NEAR' | 'NOBLE' | 'OP' | 'XPL' | 'DOT' | 'POL' | 'XRD' | 'XRP' | 'SOL' | 'SONIC' | 'SPARK' | 'XLM' | 'STRK' | 'SUI' | 'THOR' | 'TON' | 'TRON' | 'UNI' | 'XLAYER' | 'ZEC';
|
|
1565
|
+
/**
|
|
1566
|
+
* Restrict search to a provider token list
|
|
1567
|
+
*/
|
|
1568
|
+
provider?: 'CHAINFLIP' | 'CHAINFLIP_STREAMING' | 'MAYACHAIN' | 'MAYACHAIN_STREAMING' | 'ONEINCH' | 'PANCAKESWAP' | 'SUSHISWAP_V2' | 'THORCHAIN' | 'THORCHAIN_STREAMING' | 'TRADERJOE_V2' | 'UNISWAP_V2' | 'UNISWAP_V3' | 'JUPITER' | 'OKX' | 'NEAR' | 'GARDEN' | 'HARBOR' | 'FLASHNET' | 'MAYAN' | 'PANGOLIN_V1' | 'CAVIAR_V1' | 'OPENOCEAN_V2' | 'OCISWAP_V1' | 'CAMELOT_V3';
|
|
1569
|
+
limit?: number;
|
|
1570
|
+
page?: number;
|
|
1571
|
+
};
|
|
1572
|
+
url: '/tokens/search';
|
|
1573
|
+
};
|
|
1574
|
+
|
|
1575
|
+
export type SearchTokensErrors = {
|
|
1576
|
+
/**
|
|
1577
|
+
* Default Response
|
|
1578
|
+
*/
|
|
1579
|
+
400: {
|
|
1580
|
+
message: string;
|
|
1581
|
+
error: string;
|
|
1582
|
+
data?: unknown;
|
|
1583
|
+
};
|
|
1584
|
+
/**
|
|
1585
|
+
* Default Response
|
|
1586
|
+
*/
|
|
1587
|
+
500: {
|
|
1588
|
+
message: string;
|
|
1589
|
+
error: string;
|
|
1590
|
+
data?: unknown;
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
|
|
1594
|
+
export type SearchTokensError = SearchTokensErrors[keyof SearchTokensErrors];
|
|
1595
|
+
|
|
1596
|
+
export type SearchTokensResponses = {
|
|
1597
|
+
/**
|
|
1598
|
+
* Default Response
|
|
1599
|
+
*/
|
|
1600
|
+
200: SearchTokensResponse;
|
|
1601
|
+
};
|
|
1602
|
+
|
|
1603
|
+
export type SearchTokensResponse2 = SearchTokensResponses[keyof SearchTokensResponses];
|
|
1604
|
+
|
|
1524
1605
|
export type GetSwapToAssetsData = {
|
|
1525
1606
|
body?: never;
|
|
1526
1607
|
path?: never;
|