# almm:swap — Ammora SDK 0.3.8

Check the source for arguments and transaction requirements.

[Read in Docs](https://docs.ammora.org/examples?command=almm%3Aswap) · [Detailed guide](https://docs.ammora.org/guides/src-almm-readme) · [Local setup](https://docs.ammora.org/guides/example-setup)

## Context and execution

GIWA Sepolia 91342. Public SDK 0.3.8, Math 0.3.0. Source revision: `a9b3fd798fa51495e8defec99a25de59e4d70672`.
Install the SDK in your app, or prepare the example project using the local setup guide for its npm commands. Review the entry source and guide for required arguments, roles and deployment selection. `AMMORA_SEND=0` does not turn send-only commands into previews. Never put CLI keys in a browser or resend an uncertain transaction.

Command: `npm run almm:swap -- <arguments from the source below>` (`tsx src/almm/swap.ts`). Omit `--` and arguments when the source accepts none.

## Entry file: `src/almm/swap.ts`

```typescript
import { tokenAmount, slippage } from "../shared/input.js";
/**
 * Swap on a bin (ALMM) pool.
 *
 *   npm run almm:swap -- <poolAddress> <amountIn> [base-for-quote]
 *
 * Quote first with `almm:quote-swap`. This sends the same trade with a slippage floor.
 */
import { ALMMClient } from "@ammora-protocol/sdk";
import { clientOptions, address, deployment, reader, signer } from "../shared/env.js";
import { amount, approve, asPool, main, requireContract, send, tokenInfo } from "../shared/run.js";

/** Conservative default; override with AMMORA_SLIPPAGE_BPS. */
const slippageBps = slippage();

main(async () => {
  const [poolArgument, amountArgument, directionArgument] = process.argv.slice(2);
  const pool = address("ALMM_POOL", poolArgument);
  if (!amountArgument) {
    throw new Error("pass an input amount: npm run almm:swap -- <pool> <amountIn> [base-for-quote]");
  }
  const baseForQuote = directionArgument === "base-for-quote";

  const { wallet, account } = signer();
  const client = await reader();
  const contracts = deployment().contracts.liquidityMarketMaker;
  await requireContract(client, "pool", pool);
  const sdk = new ALMMClient(client, pool, contracts.positionManager, contracts.binLens, clientOptions());

  // Read the pair first so the amount can be scaled by the input token's own decimals.
  const state = await asPool(pool, "a bin pool", () => sdk.getPoolState());
  const [base, quote] = await Promise.all([
    tokenInfo(client, state.baseToken),
    tokenInfo(client, state.quoteToken),
  ]);
  const input = baseForQuote ? base : quote;
  const output = baseForQuote ? quote : base;
  const includedAmountIn = tokenAmount(amountArgument, input.decimals);

  // Planning both prices the trade and states which approval it needs. The pool's
  // provenance is proved here, before any approval is prepared, so a contract that is
  // not a pool from the reviewed factory is refused with a message that says so.
  const plan = await sdk.planSwapExactInput({
    includedAmountIn,
    baseForQuote,
    allowPartialFill: true,
    slippageBps,
    recipient: account.address,
    deadline: BigInt(Math.floor(Date.now() / 1000) + 600),
  });

  console.log(`pool   ${pool}`);
  console.log(`in     ${amount(includedAmountIn, input.decimals, input.symbol)}`);
  console.log(`out    ${amount(plan.quote.amountOut, output.decimals, output.symbol)} (quoted)`);
  console.log(`floor  ${slippageBps} bps slippage`);
  console.log("");

  await approve(plan.approvalRequirements, wallet, account, client);
  await send("swap", plan.transaction, wallet, account, client);
});
```

## Supporting files

Keep relative paths intact. Local imports are listed recursively; JSON templates are choices to review, not approved inputs. Runtime-selected files and wallet/environment setup still follow the detailed guide.

- [src/shared/env.ts](https://docs.ammora.org/examples/source/src/shared/env.ts.txt)
- [src/shared/input.ts](https://docs.ammora.org/examples/source/src/shared/input.ts.txt)
- [src/shared/retry.ts](https://docs.ammora.org/examples/source/src/shared/retry.ts.txt)
- [src/shared/rpc.ts](https://docs.ammora.org/examples/source/src/shared/rpc.ts.txt)
- [src/shared/run.ts](https://docs.ammora.org/examples/source/src/shared/run.ts.txt)
- [src/almm/rebalance.example.json](https://docs.ammora.org/examples/source/src/almm/rebalance.example.json.txt)
- [package.json](https://docs.ammora.org/examples/source/package.json.txt)
- [package-lock.json](https://docs.ammora.org/examples/source/package-lock.json.txt)
- [tsconfig.json](https://docs.ammora.org/examples/source/tsconfig.json.txt)
- [.env.giwa.example](https://docs.ammora.org/examples/source/file.env.giwa.example.txt)
- [.nvmrc](https://docs.ammora.org/examples/source/file.nvmrc.txt)

## AI implementation checklist

Use the actual SDK exports and parameter types in the linked files. Start with reads and unsigned plans where supported. Use a connected wallet for browser signing. Preserve raw integer units, exact approvals, caller authority, deadlines and receipt reconciliation. Report local checks separately from live-chain verification.