Quickstart

npm install @lifi/composer-sdk @lifi/compose-spec
# or: yarn add @lifi/composer-sdk @lifi/compose-spec
# or: pnpm add @lifi/composer-sdk @lifi/compose-spec

export LIFI_API_KEY=<your-key>

import {
  createComposeSdk,
  guards,
  materialisers,
  resources,
  terminalOutputs,
} from '@lifi/composer-sdk';

const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
const A_ETH_USDC = '0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c';

const sdk = createComposeSdk({
  baseUrl: 'https://composer.li.quest',
  apiKey: process.env.LIFI_API_KEY!,
});

// One resource input: the WETH the flow spends, on chain 1.
const builder = sdk.flow(1, {
  name: 'swap-and-zap-quickstart',
  inputs: {
    amountIn: resources.erc20(WETH, 1),
  },
});

const swap = builder.lifi.swap('swap', {
  bind: { amountIn: builder.inputs.amountIn },
  config: { resourceOut: resources.erc20(USDC, 1), slippage: 0.03 },
});

builder.lifi.zap('zap', {
  bind: { amountIn: swap.amountOut },
  config: { resourceOut: resources.erc20(A_ETH_USDC, 1) },
  guards: [guards.slippage({ port: 'amountOut', bps: 100 })],
});

const main = async () => {
  const result = await builder.compile({
    signer: '0xYourSignerAddress',
    inputs: {
      amountIn: materialisers.directDeposit({
        amount: '1000000000000000000', // 1 WETH (18 decimals)
      }),
    },
    sweepTo: builder.context.sender,
  });

  if (result.status !== 'success') {
    throw new Error(`${result.error.kind}: ${result.error.message}`);
  }

  // Every transaction to submit, in order.
  for (const action of result.actions ?? []) {
    if (action.kind !== 'transaction') continue;
    console.log(action.purpose, action.transactionRequest.to);
  }

  // What the signer receives, with the expected and the guaranteed amount.
  for (const [key, output] of Object.entries(terminalOutputs(result.outputs))) {
    console.log(key, output.amount.estimate?.value, output.amount.minimum?.value);
  }
};

main().catch((err) => {
  console.error(err);
  process.exit(1);
});

npx tsx quickstart.ts