mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-11-13 03:25:20 +00:00
6c68e41758
* most audit revisions * remove expected income * update begin block spec * filter queryAtomicSwaps, add queryAssetSupplies * update old address * update test * Remove legacy method * remove legacy comment * address PR comments * IsValid for SwapDirection, SwapStatus * fix rng logging * query asset supplies * return [64]byte from rng * remove cross chain field from MsgCreateAtomicSwap * move swap filtering to querier * rename Limit field to SupplyLimit
81 lines
3.3 KiB
Markdown
81 lines
3.3 KiB
Markdown
# State
|
|
|
|
## Parameters and genesis state
|
|
|
|
`Paramaters` define the rules according to which swaps are executed. Parameter updates can be made via on-chain parameter update proposals.
|
|
|
|
```go
|
|
// Params governance parameters for bep3 module
|
|
type Params struct {
|
|
BnbDeputyAddress sdk.AccAddress `json:"bnb_deputy_address" yaml:"bnb_deputy_address"` // deputy's address on Kava
|
|
MinBlockLock int64 `json:"min_block_lock" yaml:"min_block_lock"` // minimum swap expire height
|
|
MaxBlockLock int64 `json:"max_block_lock" yaml:"max_block_lock"` // maximum swap expire height
|
|
SupportedAssets AssetParams `json:"supported_assets" yaml:"supported_assets"` // array of supported asset
|
|
}
|
|
|
|
// AssetParam governance parameters for each asset within a supported chain
|
|
type AssetParam struct {
|
|
Denom string `json:"denom" yaml:"denom"` // name of the asset
|
|
CoinID int `json:"coin_id" yaml:"coin_id"` // internationally recognized coin ID
|
|
Limit sdk.Int `json:"limit" yaml:"limit"` // asset supply limit
|
|
Active bool `json:"active" yaml:"active"` // denotes if asset is active or paused
|
|
}
|
|
```
|
|
|
|
`GenesisState` defines the state that must be persisted when the blockchain stops/restarts in order for normal function of the bep3 module to resume.
|
|
|
|
```go
|
|
// GenesisState - all bep3 state that must be provided at genesis
|
|
type GenesisState struct {
|
|
Params Params `json:"params" yaml:"params"`
|
|
AtomicSwaps AtomicSwaps `json:"atomic_swaps" yaml:"atomic_swaps"`
|
|
AssetSupplies AssetSupplies `json:"assets_supplies" yaml:"assets_supplies"`
|
|
}
|
|
```
|
|
|
|
## Types
|
|
|
|
```go
|
|
// AtomicSwap contains the information for an atomic swap
|
|
type AtomicSwap struct {
|
|
Amount sdk.Coins `json:"amount" yaml:"amount"`
|
|
RandomNumberHash tmbytes.HexBytes `json:"random_number_hash" yaml:"random_number_hash"`
|
|
ExpireHeight int64 `json:"expire_height" yaml:"expire_height"`
|
|
Timestamp int64 `json:"timestamp" yaml:"timestamp"`
|
|
Sender sdk.AccAddress `json:"sender" yaml:"sender"`
|
|
Recipient sdk.AccAddress `json:"recipient" yaml:"recipient"`
|
|
SenderOtherChain string `json:"sender_other_chain" yaml:"sender_other_chain"`
|
|
RecipientOtherChain string `json:"recipient_other_chain" yaml:"recipient_other_chain"`
|
|
ClosedBlock int64 `json:"closed_block" yaml:"closed_block"`
|
|
Status SwapStatus `json:"status" yaml:"status"`
|
|
Direction SwapDirection `json:"direction" yaml:"direction"`
|
|
}
|
|
|
|
// SwapStatus is the status of an AtomicSwap
|
|
type SwapStatus byte
|
|
|
|
const (
|
|
NULL SwapStatus = 0x00
|
|
Open SwapStatus = 0x01
|
|
Completed SwapStatus = 0x02
|
|
Expired SwapStatus = 0x03
|
|
)
|
|
|
|
// SwapDirection is the direction of an AtomicSwap
|
|
type SwapDirection byte
|
|
|
|
const (
|
|
INVALID SwapDirection = 0x00
|
|
Incoming SwapDirection = 0x01
|
|
Outgoing SwapDirection = 0x02
|
|
)
|
|
|
|
// AssetSupply contains information about an asset's supply
|
|
type AssetSupply struct {
|
|
Denom string `json:"denom" yaml:"denom"`
|
|
IncomingSupply sdk.Coin `json:"incoming_supply" yaml:"incoming_supply"`
|
|
OutgoingSupply sdk.Coin `json:"outgoing_supply" yaml:"outgoing_supply"`
|
|
CurrentSupply sdk.Coin `json:"current_supply" yaml:"current_supply"`
|
|
Limit sdk.Coin `json:"limit" yaml:"limit"`
|
|
}
|
|
``` |