ONLYSwaps Documentation

This website is built using Docusaurus, a modern static website generator.

ONLYSwaps is a cross-chain token transfer protocol that facilitates the seamless movement of ERC-20 tokens across various EVM-compatible blockchains. Unlike traditional pool-based models, ONLYSwaps uses BLS Threshold Signatures and decentralized verification to create a trustless, efficient, and secure cross-chain transfer system.

Key Features

• Intent-Based Architecture: Users signal their desire to move funds and specify fees, while Solvers compete to fulfill transfers
• BLS Threshold Security: Secured by the decentralized dcipher committee using advanced threshold cryptography
• EVM Compatibility: Supports Avalanche, Base, and other EVM blockchains
• Dynamic Fee Management: Users can update fees for faster fulfillment
• Developer-Friendly: Comprehensive SDKs and React UI components

Documentation Structure

• Getting Started: Integration guides for developers and end users
• Protocol Overview: Architecture, security model, and technical details
• API Reference: Smart contracts, SDKs, supported chains, and fees

Development

This documentation site is built using Docusaurus, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Resources

• ONLYSwaps-js (GitHub) - TypeScript SDK
• ONLYSwaps-solidity (GitHub) - Smart contracts
• ONLYSwaps-ui (GitHub) - React UI library
• ONLYSwaps-solver (GitHub) - Solver implementation

Contributing

We welcome contributions to improve this documentation. Please feel free to submit issues and pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.