transactions: add big comment about offers and the order book. #2027
Conversation
|
I'll take a look at this a bit later. Glancing at it, most should probably go in the "distributed exchange" docs https://github.com/stellar/docs/blob/master/guides/concepts/exchange.md as any user (not just stellar-core devs) should understand it. You can leave the technical bits about where in the code things live in comments. |
There was a problem hiding this comment.
added an extra comment after reviewing, you may also be interested in the comment I just made in the cap006 PR #2016 (comment)
Repeating what I said earlier, I think this should be moved to the docs repo: it's a good intro for the order book that should be pushed to all devs (not just core devs).
|
this patch is very illuminating, thanks. |
|
I split the first half (orientation) off to stellar-deprecated/docs#453 against the docs repo, and fixed the associated suggestions here. Anything else? |
|
just noticed that you have a libmedida change in there, probably not what you wanted to do |
|
@MonsieurNicolas whoops! nice catch thanks, reverted the medida change. |
This adds a big explanatory comment about how the order book works and what the general ideas behind the limit and exact offers in the system are all about. I wrote it because the order book code is pretty opaque to me still, and I really couldn't make heads or tail of CAP-0006 without this level of pedantic self-explanation. Figured it might be useful to others.
I would love a thorough read-through and correction of it if possible from @jonjove and/or @MonsieurNicolas because I'm only very very moderately convinced I got it right. I think the commentary hangs together in the sense that I think it's painting a logically-consistent explanation for things, but I am much less sure that it's correct with respect to the code.
Apologies for the level of repetitiveness / redundancy of phrasing / pictures / etc. I know it's probably overkill for people familiar with the subsystem and ideas, but for me I really get completely lost every time I dig into it. Wanted a very explicit guide.