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

Add documentation for entrypoints #13

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Add documentation for entrypoints #13

wants to merge 14 commits into from

Conversation

aumetra
Copy link
Member

@aumetra aumetra commented Apr 29, 2024

This is just the very very basic outline of the documentation for the entrypoints.
We can improve this later.

The main idea here is to just have some start for the entrypoint docs that we can then iterate on (especially once we document the actor model and some types from the standard library).

Copy link

vercel bot commented Apr 29, 2024

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

Name Status Preview Comments Updated (UTC)
cosmwasm-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2024 9:30am

Copy link
Contributor

@chipshort chipshort left a comment

Choose a reason for hiding this comment

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

I left some comments below. Feel free to put them as TODO comments if you don't want to change all of them in this PR.

src/pages/core/entrypoints/migrate.mdx Outdated Show resolved Hide resolved
src/pages/core/entrypoints/migrate.mdx Outdated Show resolved Hide resolved
Comment on lines +42 to +46
But your storage on-chain still stores the old format. You need to somehow
transform it.

That's what you do in the `migrate` entrypoint. You transform the structure of
the storage in there.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this warrants some more explanation about how to do that in practice, probably with some example code: You need to keep / copy'n'paste the old storage type and use that to load from storage, then put it into the new type and save that using the new version.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a little example. Hope that's good enough

src/pages/core/entrypoints/migrate.mdx Outdated Show resolved Hide resolved
src/pages/core/entrypoints/execute.mdx Outdated Show resolved Hide resolved
src/pages/core/entrypoints/instantiate.mdx Show resolved Hide resolved
aumetra and others added 3 commits May 6, 2024 16:00
Co-authored-by: Christoph Otter <chipshort@tutanota.com>
Co-authored-by: Christoph Otter <chipshort@tutanota.com>
Co-authored-by: Christoph Otter <chipshort@tutanota.com>

import { Callout } from "nextra/components";

# Reply
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this section could be extended with a description of how the reply is requested (Response::add_submessage) and how the IDs work.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a little example on how it is used. Should hopefully be good enough? Not sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants