@indigo-labs/dexter
v5.4.8
Published
Customizable Typescript SDK for interacting with Cardano DEXs
Downloads
212
Readme
What You Can Do
- Pull Liquidity Pools from DEX APIs or On-chain using Blockfrost / Kupo
- Submit and cancel swap orders
- Submit split swap orders across multple DEXs
- Build your own data, wallet, or asset metadata providers to plug into Dexter
- Build swap datums given specific parameters using Dexters Definition Builder
- Load wallets using a seedphrase or CIP-30 interface using Lucid
Notes
- You may need to use the flag
--experimental-specifier-resolution=node
when building your project to correctly import Dexter - All figures/parameters represented as a bigint are denominated in lovelaces
Install
NPM
npm i @indigo-labs/dexter
Yarn
yarn add @indigo-labs/dexter
Quick Start
const dexterConfig: DexterConfig = {
shouldFetchMetadata: true, // Whether to fetch asset metadata (Best to leave this `true` for accurate pool info)
shouldFallbackToApi: true, // Only use when using Blockfrost or Kupo as data providers. On failure, fallback to the DEX API to grab necessary data
shouldSubmitOrders: false, // Allow Dexter to submit orders from swap requests. Useful during development
metadataMsgBranding: 'Dexter', // Prepend branding name in Tx message
};
const requestConfig: RequestConfig = {
timeout: 5000, // How long outside network requests have to reply
proxyUrl: '', // URL to prepend to all outside URLs. Useful when dealing with CORs
retries: 3, // Number of times to reattempt any outside request
};
const dexter: Dexter = new Dexter(dexterConfig, requestConfig);
// Basic fetch example
dexter.newFetchRequest()
.onAllDexs()
.getLiquidityPools()
.then((pools: LiquidityPool[]) => {
console.log(pools);
});
// Example loading wallet to be used in a swap
const lucidProvider: BaseWalletProvider = new LucidProvider();
lucidProvider
.loadWallet(cip30Interface, {
url: 'https://cardano-mainnet.blockfrost.io/api/v0',
projectId: '<blockfrost-project-id>'
})
.then((walletProvider: BaseWalletProvider) => {
dexter.withWalletProvider(walletProvider)
.newFetchRequest()
...
});
Dexter API
All providers outlined below are modular, so you can extend the 'base' of the specific provider you want to supply, and provide it to Dexter with one of the methods below.
Using
dexter.dexByName(Minswap.identifier)
...
By default, Dexter will use the DEX APIs to grab information. However, you can use Blockfrost or Kupo to supply your own data.
Using
const provider: BaseDataProvider = new BlockfrostProvider(
{
url: 'https://cardano-mainnet.blockfrost.io/api/v0',
projectId: '<blockfrost-project-id>',
}
);
dexter.withDataProvider(provider)
...
At this time, Dexter only supplies a Mock wallet provider & a Lucid provider. Behind the scenes, the lucid provider leverages Lucid to manage your wallet & create transactions.
Using
const provider: BaseWalletProvider = new LucidProvider();
const seedphrase: string[] = ['...'];
const blockfrostConfig: BlockfrostConfig = {
url: 'https://cardano-mainnet.blockfrost.io/api/v0',
projectId: '<blockfrost-project-id>',
};
provider.loadWalletFromSeedPhrase(seedphrase, blockfrostConfig)
.then((walletProvider: BaseWalletProvider) => {
dexter.withWalletProvider(walletProvider)
...
});
By default, Dexter will use the Cardano Token Registry for grabbing
asset metadata. You can extend the BaseMetadataProvider
interface to provide your own metadata.
Using
const provider: BaseMetadataProvider = new TokenRegistryProvider();
dexter.withMetadataProvider(provider)
...
For available methods on the FetchRequest
instance, please see those specific
docs.
Using
dexter.newFetchRequest()
...
For available methods on the SwapRequest
instance, please see those specific
docs.
Using
dexter.newSwapRequest()
...
For available methods on the SplitSwapRequest
instance, please see those specific
docs.
Using
dexter.newSplitSwapRequest()
...
For available methods on the CancelSwapRequest
instance, please see those specific
docs.
Using
dexter.newCancelSwapRequest()
...
For available methods on the SplitCancelSwapRequest
instance, please see those specific
docs.
Using
dexter.newSplitCancelSwapRequest()
...