search

gnosis / conditional-tokens-docs

Conditional Tokens Docs [WIP]
https://docs.gnosis.io/conditionaltokens/
4 stars 7 forks source link

Documentation for Automated Market Makers Contracts #20

Open Graeme-Code opened 4 years ago

Graeme-Code commented 4 years ago

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 commented 4 years ago

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.