Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Automated Market Makers Contracts #20

Open
Graeme-Code opened this issue Jul 21, 2020 · 1 comment
Open

Documentation for Automated Market Makers Contracts #20

Graeme-Code opened this issue Jul 21, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request P2 High - Must have

Comments

@Graeme-Code
Copy link
Contributor

It's not clear how to use the Market makers we have designed for CT Framework. We have a great introduction to AMM with some good theoretical examples, but it's lacking code examples. The code examples we do have are in the LMSR tutorial but is abstracted a level above the smart contract to working with LMSR within Truffle.

https://github.com/gnosis/conditional-tokens-market-makers

I'd argue that for each market maker we should have instructions and examples for:
-> Deploying an instance of AMM
-> Use of each function with expected Happy/Unhappy returns

@auryn-macmillan auryn-macmillan added documentation Improvements or additions to documentation enhancement New feature or request P2 High - Must have labels Jul 23, 2020
@auryn-macmillan
Copy link
Contributor

Here is a really great writeup on AMMs that I saw earlier today.
I think we could adapt some of these explainers to our documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request P2 High - Must have
Projects
None yet
Development

No branches or pull requests

2 participants