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

feat: app data tutorials #21

Merged
merged 10 commits into from
Jan 5, 2024
Merged

feat: app data tutorials #21

merged 10 commits into from
Jan 5, 2024

Conversation

mfw78
Copy link
Contributor

@mfw78 mfw78 commented Jan 5, 2024

This PR:

  1. Adds app data tutorials.

Notable exceptions: Due to size limitations for including libraries in the common.zip for IPFS, uploading the app data document to IPFS is not covered.

Implementing this in a more coherent method within the app-data SDK would be better (and then with a subsequent tutorial).

@mfw78 mfw78 requested a review from a team January 5, 2024 08:29
@mfw78 mfw78 self-assigned this Jan 5, 2024
Copy link

vercel bot commented Jan 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
tutorial ✅ Ready (Inspect) Visit Preview Jan 5, 2024 11:52am

Base automatically changed from basic-orders to main January 5, 2024 08:52
Copy link
Contributor

@shoom3301 shoom3301 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing!

This PR:

1. Removes CI/CD tests
2. Adds project management / CLA workflows
3. Adds github issues / pull request templates
4. Updates the repo README
"orderClass": "twap"
},
"quote": {
"slippageBips": "7500"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a big ape order!

Comment on lines +46 to +51
## Order meta data

For analytics purposes, we can add some metadata to the order.
The metadata is a JSON document that is stored in IPFS and referenced by the order.
The metadata is optional, but it's recommended to add it.
After order creation, the metadata will be displayed in [the Explorer](https://explorer.cow.fi/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we link to the app-data tutorial here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, will do that to de-dupe on the advanced orders!

Comment on lines +15 to +16
// Slippage percent, it's 0 to 100
const quote = { slippageBips: '50' }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, it's in basis points (bips) witch is percent/100, so from 0 to 10000.
50 -> 0.5%

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am removing in-line comments in general (as exhaustive comments in the "walkthrough") so this will be taken care of with the advanced orders.

title: Merkle tree
---

It's trees all the way down.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😆

@mfw78 mfw78 merged commit 12b7f45 into main Jan 5, 2024
2 of 3 checks passed
@mfw78 mfw78 deleted the app-data branch January 5, 2024 11:52
@github-actions github-actions bot locked and limited conversation to collaborators Jan 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants