Migration Guide

Both the Skip Router SDK @skip-router/core and Skip Go Core @skip-go/core are deprecated. Please migrate to Skip Go Client @skip-go/client, our actively maintained TypeScript package.

4.0.0 Breaking changes

• Removed clientID param in SkipClient
• Added apiKey param in SkipClient
• Added requiredChainAddresses in SkipClient.route response
• Added smartSwapOptions in SkipClient.routerequest

JavaScript

smartSwapOptions:{
	splitRoutes: boolean
}

3.0.0 Breaking Changes

• Changed Param Type: userAddresses from a map of chainIDs to addresses to an array of UserAddress types:

TypeScript

export interface UserAddress {
  chainID: string;
  address: string;
}

2.0.0 Breaking changes

• Removed Method: SkipClient.executeMultiChainMessage
• Renamed Method: SkipClient.getGasAmountForMessage -> SkipClient.getCosmosGasAmountForMessage
• Renamed Method: SkipClient.getFeeForMessage -> SkipClient.getCosmosFeeForMe
• Renamed Type: MultiChainMsg -> CosmosMsg
• Renamed Method & Params changed: SkipClient.executeMultiChainMsgs-> SkipClient.executeTxs

Diff

const client = new SkipClient({
  apiURL: SKIP_API_URL,
// ... rest of your configs
});
- client.executeMultiChainMsgs({
+ client.executeTxs({
	...options
-	msgs: types.Msg[]
+	txs: types.Tx[]
})

• Param Changed in SkipClient.executeCosmosMessage: message:MultiChainMsg -> messages: CosmosMsg[]

Diff

const client = new SkipClient({
  apiURL: SKIP_API_URL,
// ... rest of your configs
});
client.executeCosmosMessage({
	...options
-	message: MultiChainMsg
+	messages: CosmosMsg[]
})