0g-chain/x/bep3/spec/04_events.md
Denali Marsh a4c5a13822
[R4R] BEP3 module spec and clean up (#450)
* bump SDK version to v0.38.2

* fix module.go and remove codespaces

* fix coins Add()

* fixes to handlers

* migrate errors

* more fixes

* fixes fixes fixes

* build

* check for paramstore keytable

* empty param validation function (TODO)

* param validations

* fix some tests

* fix all tests

* simulation fixes (WIP)

* auction and bep3 sim refactor

* fixes

* bep3 sims fixes

* auction and pricefeed fix

* cdp sims fixes

* fix tests

* Update x/auction/keeper/auctions.go

Co-Authored-By: Denali Marsh <denali@kava.io>

* Update x/bep3/types/params.go

Co-Authored-By: Denali Marsh <denali@kava.io>

* Apply suggestions from code review

Co-Authored-By: Denali Marsh <denali@kava.io>

* Update x/bep3/keeper/swap.go

Co-Authored-By: Denali Marsh <denali@kava.io>

* address comments from review

* address comments from review

* fix: run sims

* fix: implement marshal/unmarshal JSON for validator vesting account

* fix: don't call set on sealed config

* remove swap interface

* add concepts spec

* add state spec

* add messages spec

* update event names

* implement swap expired event

* add events spec

* add params spec

* add begin block spec

* add module readme

* update alias

* revisions

* aggregate expired swap ids for event emisison

* markdown-link-check-disable for circleci

* exclude api-endpoint links in Makefile

Co-authored-by: Federico Kunze <federico.kunze94@gmail.com>
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Kevin Davis <kjydavis3@gmail.com>
2020-04-23 13:57:25 -07:00

53 lines
2.6 KiB
Markdown

# Events
The `x/bep3` module emits the following events:
## Handlers
### MsgCreateAtomicSwap
| Type | Attribute Key | Attribute Value |
|--------------------|--------------------|--------------------------|
| create_atomic_swap | sender | {sender address} |
| create_atomic_swap | recipient | {recipient address} |
| create_atomic_swap | atomic_swap_id | {swap ID} |
| create_atomic_swap | random_number_hash | {random number hash} |
| create_atomic_swap | timestamp | {timestamp} |
| create_atomic_swap | sender_other_chain | {sender other chain} |
| create_atomic_swap | expire_height | {swap expiration block} |
| create_atomic_swap | amount | {coin amount} |
| create_atomic_swap | expected_income | {expected value received}|
| create_atomic_swap | direction | {incoming or outgoing} |
| message | module | bep3 |
| message | sender | {sender address} |
### MsgClaimAtomicSwap
| Type | Attribute Key | Attribute Value |
|--------------------|--------------------|--------------------------|
| claim_atomic_swap | claim_sender | {sender address} |
| claim_atomic_swap | recipient | {recipient address} |
| claim_atomic_swap | atomic_swap_id | {swap ID} |
| claim_atomic_swap | random_number_hash | {random number hash} |
| claim_atomic_swap | random_number | {secret random number} |
| message | module | bep3 |
| message | sender | {sender address} |
## MsgRefundAtomicSwap
| Type | Attribute Key | Attribute Value |
|--------------------|--------------------|--------------------------|
| refund_atomic_swap | refund_sender | {sender address} |
| refund_atomic_swap | sender | {swap creator address} |
| refund_atomic_swap | atomic_swap_id | {swap ID} |
| refund_atomic_swap | random_number_hash | {random number hash} |
| message | module | bep3 |
| message | sender | {sender address} |
## BeginBlock
| Type | Attribute Key | Attribute Value |
|---------------|------------------|------------------------------|
| swaps_expired | atomic_swap_ids | {array of swap IDs} |
| swaps_expired | expiration_block | {block height at expiration} |