Add the spec docs for the exchange module #1729
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d add link references to those sections.
…ve the L2 headings, and put a hr above each TOC. A L2 heading is underlined, so it looks weird when there's an hr above them too.
jtalis
approved these changes
Nov 3, 2023
Co-authored-by: Jason Talis <jason.talis@gmail.com>
Taztingo
approved these changes
Nov 3, 2023
iramiller
reviewed
Nov 7, 2023
iramiller
approved these changes
Nov 7, 2023
SpicyLemon
added a commit
that referenced
this pull request
Nov 10, 2023
* [1700]: make update-tocs to fix some existing TOCs. * [1700]: First crack at the exchange spec main README. * [1700]: First crack at the concepts spec doc. * [1700]: First crack at the state spec doc. * [1700]: Add empty place-holder files for the rest of the exchange spec docs. * [1700]: Initial write-up of messages spec doc. * [1700]: Events spec doc. * [1700]: Standardize the hr below the tocs. * [1700]: in the messages spec doc, include more sub-message content and add link references to those sections. * [1700]: Spec doc on the queries. * [1700]: Params spec doc. * [1700]: Turn lots of stuff into links and fix some inconsistent spacing. * [1700]: Reorder some market state entries. * [1700]: Add some missing blurbs under L1 headings. Remove the hrs above the L2 headings, and put a hr above each TOC. A L2 heading is underlined, so it looks weird when there's an hr above them too. * [1700]: Some updates to concepts from proof-reading them. Should be pretty solid now. * [1700]: Tweaks to state doc upon proof-reading. * [1700]: Proof reading of messages spec. * [1700]: Proof-read of the queries spec doc. * [1700]: Small tweak to the params spec doc upon proofreading. * Update x/exchange/spec/03_messages.md Co-authored-by: Jason Talis <jason.talis@gmail.com> --------- Co-authored-by: Jason Talis <jason.talis@gmail.com>
8 tasks
iramiller
added a commit
that referenced
this pull request
Nov 10, 2023
…1743) * Add the spec docs for the exchange module (#1729) * [1700]: make update-tocs to fix some existing TOCs. * [1700]: First crack at the exchange spec main README. * [1700]: First crack at the concepts spec doc. * [1700]: First crack at the state spec doc. * [1700]: Add empty place-holder files for the rest of the exchange spec docs. * [1700]: Initial write-up of messages spec doc. * [1700]: Events spec doc. * [1700]: Standardize the hr below the tocs. * [1700]: in the messages spec doc, include more sub-message content and add link references to those sections. * [1700]: Spec doc on the queries. * [1700]: Params spec doc. * [1700]: Turn lots of stuff into links and fix some inconsistent spacing. * [1700]: Reorder some market state entries. * [1700]: Add some missing blurbs under L1 headings. Remove the hrs above the L2 headings, and put a hr above each TOC. A L2 heading is underlined, so it looks weird when there's an hr above them too. * [1700]: Some updates to concepts from proof-reading them. Should be pretty solid now. * [1700]: Tweaks to state doc upon proof-reading. * [1700]: Proof reading of messages spec. * [1700]: Proof-read of the queries spec doc. * [1700]: Small tweak to the params spec doc upon proofreading. * Update x/exchange/spec/03_messages.md Co-authored-by: Jason Talis <jason.talis@gmail.com> --------- Co-authored-by: Jason Talis <jason.talis@gmail.com> * Fixed denom metadata source chain-id retrieval for new ibc markers (#1738) * should be using packet dest port and channel to get the correct source chain id * fix compile error * add upgrade handler for rc3, add changelog * add generated nav map * Add upgrade handler to add marker navs for pio-mainnet-1 (#1712) * add upgrade handler for net asset values * add upgrade handler for nav * add upgrade test * add more test cases * add changelog entry * check iterate error * add custom list processing, add a few examples for testnet * fix default logic and change log * fix test * Add new navs for mainnet in list * Update tests * update method comment * Rename update function, add detailed comments --------- Co-authored-by: Ira Miller <72319+iramiller@users.noreply.github.com> * Add additional trigger module logging (#1742) * Add additional logging. * Update logging to show success. * Update changelog. * Have exchange module update marker net-asset-value entries (#1741) * [1736]: Properly wrap the errors in AddSetNetAssetValues. * [1736]: Reorg SetNetAssetValue to emit the event last and create the key and store closer to where they're used. * [1736]: Move the NAV event back up to earlier and add a comment on why its not at the end like most other events. * [1736]: Add the marker keeper to the exchange keeper. * [1736]: Generate and record the NAVs with the marker module after a settlement. * [1736]: Unit tests on GetNAVs. * [1736]: update GetNAVs to use asks if there aren't any bids. * [1736]: Unit tests on the keeper changes and fix the ones that broke. * [1736]: Update the msg server tests too. * [1736]: Undo the marker keeper changes since it basically just boiled down to the addition of a comment. * [1736]: Update the changelog to mark v1.17.0-rc2 and also include an entry for this PR. --------- Co-authored-by: Ira Miller <72319+iramiller@users.noreply.github.com> * Add additional trigger events (#1740) * Create new events and generate protos. * Add events to emit. * Update tests for processing to test new dispatched event. * Add tests for EventTriggerDetection. * Update specs for events. * Update changelog. * Change EventTriggerExecuted to contain a success flag rather than an error string. It's possible for the error to be non-deterministic. * Update assert. --------- Co-authored-by: Ira Miller <72319+iramiller@users.noreply.github.com> * Mark v1.17.0-rc3 in the changelog and release notes. --------- Co-authored-by: Jason Talis <jason.talis@gmail.com> Co-authored-by: Carlton Hanna <nullpointer0x00@gmail.com> Co-authored-by: Ira Miller <72319+iramiller@users.noreply.github.com> Co-authored-by: Matt Witkowski <mwitkowski@provenance.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
closes: #1700
This PR includes the spec docs for the exchange module.
It also fixes a couple TOCs from other modules that got out of date.
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes