0g-chain/x/swap/spec/README.md

<!--
order: 0
title: "Swap Overview"
parent:
  title: "swap"
-->

# `swap`

<!-- TOC -->

1. **[Concepts](01_concepts.md)**
2. **[State](02_state.md)**
3. **[Messages](03_messages.md)**
4. **[Events](04_events.md)**
5. **[Params](05_params.md)**

## Abstract

`x/swap` is a Cosmos SDK module that implements an Automated Market Maker (AMM) that enables users to swap coins by trading against liquidity pools.
Swap module scaffolding and params (#922) * swap module scaffolding * global swap fee * can't think of a reason for begin blocker; removing for abci.go for now; * test pair types; refactor pair name logic; simplify pairs validation and fix stack overflow error * check comparison * use test package * init swap module genesis * add basic marshall tests * remove reward apy from pairs * fix integration helpers * use max swap fee constant; fix validation of swap fee; add tests to cover param validation and param set setup * use noerror over nil * start genesis tests * test param set validation mirrors param validation * add genesis tests * remove print statement * add subtests for genesis test cases; add extra querier test for unknown route; add keeper params testing * add spec * update swagger * find replace hard -> swap in comments * remove unused method * rename pairs to allowed pools; pool is more commonly used, and allowedPool makes it more clear what swap parameter is for. In addition, we won't conflict with Pool data structure for storing a created pool in the store. * remove generated link * missed spec rename * validate token order for allowed pools * fix swagger * json should be snakecase; change allowedPools to allowed_pools Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com> 2021-06-08 15:19:12 +00:00			`<!--`
			`order: 0`
			`title: "Swap Overview"`
			`parent:`
			`title: "swap"`
			`-->`

			# `swap`

			`<!-- TOC -->`

			`1. [Concepts](01_concepts.md)`
			`2. [State](02_state.md)`
			`3. [Messages](03_messages.md)`
			`4. [Events](04_events.md)`
			`5. [Params](05_params.md)`

			`## Abstract`

			`x/swap` is a Cosmos SDK module that implements an Automated Market Maker (AMM) that enables users to swap coins by trading against liquidity pools.