Squid Dev Documentation
Search
⌃K

Types

We recommend using the types from our npm package. If you are using our API without our SDK, you can find the types inside node_modules/@0xsquid/sdk/dist/types/index.d.ts after Installing our SDK​

ChainData

export type ChainData = {
chainName: ChainName;
chainType: ChainType;
chainId: number | string;
networkName: string;
rpc: string;
blockExplorerUrls: string[];
nativeCurrency: {
name: string;
symbol: string;
decimals: number;
icon: string;
};
chainNativeContracts: {
wrappedNativeToken: string;
distributionEnsExecutable: string;
ensRegistry: string;
multicall: string;
};
axelarContracts: {
gateway: string;
forecallable: string;
};
squidContracts: {
squidMain: string;
defaultCrosschainToken: string;
multicall: string;
};
estimatedRouteDuration: number;
};
​
export type ChainsData = ChainData[];

ChainName

export enum ChainName {
ETHEREUM = "Ethereum",
OSMOSIS = "osmosis",
OSMOSIS4 = "osmosis-4",
MOONBEAM = "Moonbeam",
AVALANCHE = "Avalanche",
COSMOS = "cosmoshub",
AXELARNET = "Axelarnet",
KUJIRA = "kujira",
SEI = "sei",
FETCH = "fetch",
CRESCENT = "crescent",
EMONEY = "e-money",
INJECTIVE = "injective",
JUNO = "juno",
SECRET = "secret",
TERRA2 = "terra-2",
POLYGON = "Polygon"
}

ChainType

export enum ChainType {
EVM = "evm",
Cosmos = "cosmos"
}

Config

export type Config = {
apiKey?: string;
baseUrl?: string;
executionSettings?: {
infiniteApproval?: boolean;
};
};

MapChainIdName

export type MapChainIdName = {
[key: string | number]: ChainName;
};

GetRoute

export type GetRoute = {
fromChain: number | string;
toChain: number | string;
fromToken: string;
toToken: string;
fromAmount: string;
toAddress: string;
slippage: number;
quoteOnly?: boolean;
enableForecall?: boolean;
};

RouteResponse

export type RouteResponse = {
route: Route;
};
​
export type Route = {
estimate: Estimate;
transactionRequest: TransactionRequest;
params: GetRoute & { fromToken: TokenData; toToken: TokenData };
};
​
export type Estimate = {
fromAmount: string;
sendAmount: string;
toAmount: string;
toAmountMin: string;
route: RouteData[];
exchangeRate?: string;
estimatedRouteDuration: number;
aggregatePriceImpact: string;
};
​
export type RouteData = SwapData[];
​
export type SwapData = {
dex: {
chainName: string;
dexName: string;
swapRouter: string;
};
path: string[];
fromToken: TokenData;
toToken: TokenData;
fromAmount: string;
toAmount: string;
toAmountMin: string;
};
​
export type TransactionRequest = {
routeType: string;
targetAddress: string;
data: string;
value: number;
};

RoutePopulatedData

export type RoutePopulatedData = {
fromChain: ChainData;
toChain: ChainData;
fromToken: TokenData | undefined;
toToken: TokenData | undefined;
fromTokenContract: ethers.Contract | undefined;
fromProvider: ethers.providers.JsonRpcProvider;
fromIsNative: boolean;
targetAddress: string;
};

ExecuteRoute

export type ExecuteRoute = {
signer: ethers.Wallet | ethers.Signer;
route: Route;
executionSettings?: {
infiniteApproval?: boolean;
};
};

TokenData

export type TokenData = {
chainId: number | string;
address: string;
name: string;
symbol: string;
decimals: number;
crosschain: boolean;
commonKey: string;
logoURI: string;
coingeckoId: string;
};

​

IsRouteApproved

export type IsRouteApproved = {
route: Route;
sender: string;
};

Allowance

export type Allowance = {
owner: string;
spender: string;
tokenAddress: string;
chainId: number | string;
};

Approve

export type Approve = {
signer: ethers.Wallet | ethers.Signer;
spender: string;
tokenAddress: string;
amount?: string;
chainId: number | string;
};

ApproveRoute

export type ApproveRoute = {
route: Route;
signer: ethers.Wallet | ethers.Signer;
};

GetStatus

export type GetStatus = {
transactionId: string;
};

StatusResponse

type StatusResponse = {
id: string
status: string
gasStatus: string
destinationTransactionId: string
blockNumber: number
}
Previous
Resources
Next
Understanding Gas Payments
Last modified 1mo ago