Swing SDK Reference

import { SwingSDK } from '@swing.xyz/sdk';
 
const swingSDK = new SwingSDK();
await swingSDK.init();

new SwingSDK(options?): SwingSDK

get api(): Client

get bridges(): Required< Bridge >[]

get chains(): Chain[]

get contracts(): Contract[]

get isReady(): boolean

get project(): undefined | ProjectConfig

get projectId(): undefined | string

get rules(): Partial< Record< ChainSlug | "__any__", {fromTokens: TokenSymbol[]; rules: Partial< Record< TokenSymbol | "__any__", {rules: Partial< Record< ChainSlug | "__any__", {toTokens: TokenSymbol[];} > >; toChainSlugs: ChainSlug[];} > >;} > >

get tokens(): Required< Token > & {symbol: TokenSymbol;} & {symbol: string;}[]

get wallet(): object

claim(tx): Promise< void >

continueTransfer(tx, stepResults?): Promise< void >

getAvailableReceiveChains(parameters): Chain[]

getAvailableReceiveTokens(parameters): Token[]

getAvailableSendChains(): Chain[]

getAvailableSendTokens(parameters): Token[]

getAvailableStakingChains(parameters): Chain[]

getAvailableStakingTokens(parameters): Token[]

getBridge(bridgeSlug): undefined | Bridge

getChain(chainSlug): undefined | Chain

getChainRpcUrl(chainSlug): undefined | string

getChainsForProtocol(protocol): undefined | Chain[]

getChainsForTransfer(chainSlug): Chain[]

getContract({ id }: { id: string }): Contract | undefined;

getContracts(parameters): Contract[]

getContractsForChainToken(parameters): Contract[]

getDefaultChainForProtocol(protocol): undefined | Chain

getNativeTokenForChain(chainSlug): undefined | Token

getPopularTokensForChain(chainSlug): Token[]

getQuote(params, opts = {}): Promise< {debug: string[]; fromChain: Chain; fromToken: Token; routes: {distribution: {}; duration: number; gas: string; gasUSD: string; quote: {amount: string; amountUSD: string; bridgeFee: string; bridgeFeeInNativeToken: string; bridgeFeeInNativeTokenUSD: string; bridgeFeeUSD: string; decimals: number; fees: Fee[]; fromAmount: string;}; route: Route[];}[]; toChain: Chain; toToken: Token;} >

getStartingPair(): object

fromChain: undefined | Chain;

fromToken: undefined | Token;

toChain: undefined | Chain;

toToken: undefined | Token;

getStepsForBridge(bridgeSlug): TransferStep[]

getTokenForChain(chainSlug, tokenSymbol): undefined | Token

getTokenForChainByAddress(chainSlug, tokenAddress): undefined | Token

getTokensForChain(chainSlug): Token[]

getValidContractsForChainToken(parameters): Contract[] | undefined

getValidReceiveChain(parameters): undefined | Chain

getValidReceiveToken(parameters): undefined | Token

getValidSendChain(parameters): undefined | Chain

getValidSendToken(parameters): undefined | Token

getValidStakingChain(parameters): undefined | Chain

getValidStakingToken(parameters): undefined | Token

getWallet(address): undefined | SwingWallet

init(): Promise< void >

isNativeToken(chainSlug, tokenSymbol): boolean

on<P>(type, listener): () => void

transfer(transferRoute, transferParams): Promise< void >

Bridge: Omit< Required< Paths.V0TransferGetConfig.Responses.$200["bridges"][0] >, "steps" > & {steps: TransferStep[];}

BridgeOrAggregator: Components.Schemas.Bridge | Components.Schemas.Aggregator;

BridgeSlug: Components.Schemas.Bridge;

Chain: Components.Schemas.Chain;

ChainSlug: Components.Schemas.ChainSlug;

ContractCallInfo: Components.Schemas.ContractCallInfo;

interface Contract {
  id: string; // Unique Swing Identifier
  type: 'deposit' | 'withdraw';
  address: string; // Deployed contract address
  method: string; // Contract method (eg. deposit, withdraw)
  chain: string;
 
  inputToken: Token; // Token you send to the contract
  outputToken: Token | null; // Token you receive from the contract
 
  // Swing's integration provider
  integration: {
    type: 'staking';
    slug: string;
    name: string;
    logo: string;
    monetization: boolean;
  };
}

EventMap: object;

READY: () => void

TRANSFER: (transferStepStatus, transferResults) => void

Options: object;

optional analytics: boolean

optional debug: boolean

optional projectId: string

ProtocolType: Components.Schemas.ProtocolType;

SupportedProtocols: 'evm' | 'solana' | 'ibc' | 'multiversx';

Token: Required< Components.Schemas.Token > & {symbol: TokenSymbol;}

TokenSymbol: Components.Schemas.TokenSymbol;

Transaction: Components.Schemas.Transaction & Required< Pick< Components.Schemas.Transaction, "fromChainSlug" | "toChainSlug" | "fromTokenSymbol" | "toTokenSymbol" | "bridge" > > & {id: number; transferStatus: TransferStepStatus; transferStep: TransferStep;}

TransactionStatus: Transaction['status'];

TransferParams: object;

amount: string;

optional contractId: string

fromChain: ChainSlug;

fromToken: TokenSymbol;

fromUserAddress: string;

toChain: ChainSlug;

toToken: TokenSymbol;

toUserAddress: string;

TransferRoute: Paths.V0TransferGetQuote.Responses.$200['routes'][0];

TransferStatus: 'PENDING' | 'FAILED' | 'SUCCESS';

TransferStatusWithData: {status: "SUCCESS" | "PENDING" | "ACTION_REQUIRED" | "BRIDGING" | "CONFIRMING" | undefined;} | {error: string; status: "FAILED";} | {address: string; chain: Chain; status: "CHAIN_SWITCH_REQUIRED" | "WALLET_CONNECTION_REQUIRED"; token: Token;}

TransferStep: 'allowance' | 'approve' | 'send' | 'bridge' | 'sign' | 'claim';

TransferStepParams: object;

bridge: BridgeOrAggregator;

optional bridgeFee: string

optional bridgeFeeInNativeToken: string

optional contractId: string

optional fees: Components.Schemas.Fee[]

fromChain: Chain;

fromToken: Token;

fromUserAddress: string;

route: Components.Schemas.Route[]

toAmount: string;

toChain: Chain;

toToken: Token;

toUserAddress: string;

tokenAmount: string;

TransferStepResult: StepResult & TransferStatusWithData;

TransferStepResults: Record< TransferStep, TransferStepResult > & {id: number; status: TransferStatus;}

TransferStepStatus: TransferStatus |
  'BRIDGING' |
  'CONFIRMING' |
  'ACTION_REQUIRED' |
  'CHAIN_SWITCH_REQUIRED' |
  'WALLET_CONNECTION_REQUIRED';

TransferStepStatusName: Components.Schemas.TransferStepStatus;

TransferTxData: Components.Schemas.TransferTxData;

WalletProvider: Web3Provider |
  ExternalProvider |
  JsonRpcFetchFunc |
  Keplr |
  CoinbaseWalletProvider |
  ExtensionProvider;