cowprotocol / cowprotocol/learn

feat: Add Milkman Tutorial

Open
#11 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Svelte
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Problem

We have people trying to create milkman orders not knowing how to create the correct calldata, how to simulate their deployment beforehand and how to debug if their order isn't getting matched

Suggested solution

A clear and concise tutorial showing all steps (including how to run your own milkman bot)

Alternatives considered

Completely ditch milkman in favor of programmatic orders, although given its success and everything else going on at the moment it's probably worthwhile documenting.

Additional context

@cmagan may have some scattered bits and pieces of such a tutorial in notion/hackmd somewhere. There is also this debugging tutorial in Notion

Acceptance criteria

Next time we have a tg support request, we can direct them to this tutorial and they can unblock themselves.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by gathering the scattered tutorial material mentioned for @cmagan and review the linked Notion debugging tutorial. Organize guidance for creating Milkman calldata, simulating deployment, diagnosing unmatched orders, and running a Milkman bot. Done means support requests can be answered by linking to the tutorial and users can unblock themselves.

Written by the indexing model from the issue text.

Assessment

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.