Skip to content

okxlabs/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DEX Router Documentation

This repository provides comprehensive documentation and example smart contracts for DEX Router products, supporting EVM, Solana, SUI, and Aptos ecosystems.

Project Structure

docs/
  docs/
    contracts/
      DEX-Router-Aptos-V1/
        guides.md
        overview.md
        technical-reference.md
      DEX-Router-EVM-V1/
        guides.md
        overview.md
        technical-reference.md
      DEX-Router-Solana-V1/
        guides.md
        overview.md
        technical-reference.md
      DEX-Router-Sui-V1/
        guides.md
        overview.md
        technical-reference.md
  examples/
    DEX-Router-EVM-V1/
      foundry.toml
      interface/
        IDexRouter.sol
        IDexRouterExactOut.sol
      remappings.txt
      src/
        smartswap.sol
        smartswapByInvest.sol
        swapWrap.sol
        uniswapV3swap.sol
        uniswapV3SwapExactOutTo.sol
        unxswap.sol
        unxswapExactOutTo.sol
  • docs/contracts/DEX-Router-Aptos-V1/: Documentation for the Aptos version of the DEX Router, including overview, guides, and technical reference.
  • docs/contracts/DEX-Router-EVM-V1/: Documentation for the EVM version of the DEX Router, including overview, guides, and technical reference.
  • docs/contracts/DEX-Router-Solana-V1/: Documentation for the Solana version of the DEX Router, including overview, guides, and technical reference.
  • docs/contracts/DEX-Router-Sui-V1/: Documentation for the SUI version of the DEX Router, including overview, guides, and technical reference.
  • examples/DEX-Router-EVM-V1/: Example Solidity contracts and interfaces for the EVM DEX Router.

Getting Started

Prerequisites

  • Node.js (for documentation tooling, if needed)
  • Foundry (for Solidity contract development)
  • Solana CLI (for Solana development, if needed)
  • Aptos CLI (for Aptos development, if needed)
  • SUI CLI (for SUI development, if needed)

Usage

  • Browse documentation in docs/docs/contracts/ for EVM, Solana, SUI, and Aptos routers.
  • Explore example smart contracts in the docs/examples/ directory.

Contributing

We welcome contributions! Please follow these steps:

  1. Pick the appropriate section for your addition (EVM, Solana, SUI, or Aptos, docs or examples).
  2. Add new documentation under the correct folder:
    • overview.md for product overviews
    • guides.md for step-by-step guides
    • technical-reference.md for contract references
  3. Add example contracts in the examples/ directory.
  4. Open a Pull Request with a clear description of your changes.

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •