gnosis / gnosis/conditional-tokens-docs

Documentation for Automated Market Makers Contracts

Open
#20 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement P2
Dominant language
JavaScript
Stars
7
Forks
7
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the existing AMM introduction and LMSR tutorial, then review the market-maker contracts in the linked conditional-tokens-market-makers repository. For each market maker, document deployment and the functions' expected happy and unhappy returns, using the existing examples as a reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.