mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-11-10 18:15:19 +00:00
9d9b169e6a
* 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>
36 lines
904 B
Markdown
36 lines
904 B
Markdown
<!--
|
|
order: 2
|
|
-->
|
|
|
|
# State
|
|
|
|
## Parameters and Genesis State
|
|
|
|
`Parameters` define the governance parameters and default behavior of the swap module.
|
|
|
|
```go
|
|
// Params are governance parameters for the swap module
|
|
type Params struct {
|
|
AllowedPools AllowedPools `json:"allowed_pools" yaml:"allowed_pools"`
|
|
SwapFee sdk.Dec `json:"swap_fee" yaml:"swap_fee"`
|
|
}
|
|
|
|
// AllowedPool defines a tradable pool
|
|
type AllowedPool struct {
|
|
TokenA string `json:"token_a" yaml:"token_a"`
|
|
TokenB string `json:"token_b" yaml:"token_b"`
|
|
}
|
|
|
|
// AllowedPools is a slice of AllowedPool
|
|
type AllowedPools []AllowedPool
|
|
```
|
|
|
|
`GenesisState` defines the state that must be persisted when the blockchain stops/restarts in order for the normal function of the swap module to resume.
|
|
|
|
```go
|
|
// GenesisState is the state that must be provided at genesis.
|
|
type GenesisState struct {
|
|
Params Params `json:"params" yaml:"params"`
|
|
}
|
|
```
|