0g-chain/x/swap/spec/05_params.md

<!--
order: 5
-->

# Parameters

Example parameters for the swap module:

| Key          | Type                | Example       | Description                             |
| ------------ | ------------------- | ------------- | --------------------------------------- |
| AllowedPools | array (AllowedPool) | [{see below}] | Array of tradable pools supported       |
| SwapFee      | sdk.Dec             | 0.03          | Global trading fee in percentage format |

Example parameters for `AllowedPool`:

| Key    | Type   | Example | Description         |
| ------ | ------ | ------- | ------------------- |
| TokenA | string | "ukava" | First coin's denom  |
| TokenB | string | "usdx"  | Second coin's denom |
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: 5`
			`-->`

			`# Parameters`

			`Example parameters for the swap module:`

			`\| Key \| Type \| Example \| Description \|`
			`\| ------------ \| ------------------- \| ------------- \| --------------------------------------- \|`
			`\| AllowedPools \| array (AllowedPool) \| [{see below}] \| Array of tradable pools supported \|`
			`\| SwapFee \| sdk.Dec \| 0.03 \| Global trading fee in percentage format \|`

			Example parameters for `AllowedPool`:

			`\| Key \| Type \| Example \| Description \|`
			`\| ------ \| ------ \| ------- \| ------------------- \|`
			`\| TokenA \| string \| "ukava" \| First coin's denom \|`
			`\| TokenB \| string \| "usdx" \| Second coin's denom \|`