cowprotocol / cowprotocol/docs

chore: Simple app data config

Open
#334 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5
Forks
32
PR merge metrics
No merged PRs in 30d

Description

Background

App data has a lot of logic built on top and new users can find the whole thing inscrutable at first.
Nothing in the app data is too important unless the user has specific needs.
It would be good if they could just ignore the whole thing, at least at first when playing around with CoW Protocol.

Details

I'd like the main reference page for app data (which I believe is this) to include a section that states something like "if you don't care, just use this app data hash: 0x1337...".
The specific hash could be many things:

  • 0x00..00, cheaper and afaik supported by the backend.
  • hash({}), explicitly saying that we don't care about any field.
  • hash({"appCode":"CoW Docs"}), to let us know that this was taken from the docs.

It would also be very good to link to PUT /api/v1/app_data rather than asking users to upload to IPFS themselves.

Acceptance criteria
  • Add instructions on the app data page that allows a user to completely ignore what the app data is.

Contributor guide

Open the contributing guide

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

Open the app data reference page linked in the issue and review its current guidance for users who do not need app data. Add instructions explaining how to ignore app data, including the chosen default hash, and link users to the PUT /api/v1/app_data endpoint instead of requiring direct IPFS uploads. Done means the page contains the requested ignore instructions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.