Dexter

Customizable Typescript SDK for interacting with Cardano DEXs.

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

• 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.

dexByName(string): BaseDex | undefined Grab a DEX instance by name.

Using

dexter.dexByName(Minswap.identifier)
    ...

withDataProvider(BaseDataProvider): Dexter Set where Dexter should grab liquidity pool data.

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)
    ...

withWalletProvider(BaseWalletProvider): Dexter Set who Dexter sends wallet requests to.

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)
            ...
    });

withMetadataProvider(BaseMetadataProvider): Dexter Set where Dexter grabs necessary asset metadata.

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)
    ...

newFetchRequest(): FetchRequest Create new request for liquidity pool data.

For available methods on the FetchRequest instance, please see those specific docs.

Using

dexter.newFetchRequest()
    ...

newSwapRequest(): SwapRequest Create new request for a swap order.

For available methods on the SwapRequest instance, please see those specific docs.

Using

dexter.newSwapRequest()
    ...

newCancelSwapRequest(): CancelSwapRequest Create new request for cancelling a swap order.

For available methods on the CancelSwapRequest instance, please see those specific docs.

Using

dexter.newCancelSwapRequest()
    ...

More Docs

• Data Providers
• Wallet Providers
• Creating a Fetch Request
• Creating a Swap Request
• Creating a Split Swap Request
• Creating a Cancel Swap Request
• Listening for transaction events
• Commonly returned models