@0x/0x-parser

0x-parser

Designed for 0x integrators, this library is used to parse swap amounts from 0x transactions, a task that becomes complex when trades involve Automated Market Makers (AMMs). Given the potential for slippage in these trades, the final swap amounts cannot be anticipated before trade execution. This library addresses this challenge by accepting a transaction hash as input, then parses through the event logs to identify the exact swap amounts.

Installation

npm install @0x/0x-parser

Usage

import { parseSwap } from '@0x/0x-parser';

async function main() {
  const abiUrl = "https://raw.githubusercontent.com/0xProject/protocol/development/packages/contract-artifacts/artifacts/IZeroEx.json";
  const response = await fetch(abiUrl);
  const IZeroEx = await response.json();

  const data = await parseSwap({
    transactionHash: "0xf705df9127065ae8a8da3c1939d7096011ea13c81e4a2ed8c59ea1b039f7565d",
    exchangeProxyAbi: IZeroEx.compilerOutput.abi,
    rpcUrl: "https://eth.llamarpc.com"
  });

  console.log(JSON.stringify(data);
}

main();

Live demo

Try a demo app that uses 0x-parser here.

Examples

This repository includes an example you can execute locally using the npm run web:example command. Additionally, there's another repository that showcases how to use this package within a simple React app, which you can find here.

Contributing

Contributions are always welcomed! Please read the contributing guidelines before submitting a pull request 📖.

Changelog

0.1.0 (2023-05-22)

Features

• rewrite api interface (b7d90e5)