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 getting started node <=> client tutorial #451

Merged
merged 2 commits into from
Feb 6, 2024
Merged

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Feb 2, 2024

After discussion with @Dominik1999 and @hackaugusto we decided to propose the addition of a getting started guide enabling a newcomer to user the core features of the Miden rollup.

I have been able to deploy an EC2 instance on AWS running the node. We are able to send queries and get responses from it's RPC. We can now use it as a testing ground for the Miden rollup.

Depends on: 0xPolygonMiden/miden-node#200

@phklive phklive requested a review from Dominik1999 February 2, 2024 19:23
Copy link
Collaborator

@igamigo igamigo left a comment

Choose a reason for hiding this comment

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

This looks good! I think it's a kind of expectable that the client will change and this will have to be maintained, so I wonder if this should be more generic and have this living somewhere else. But in general I think it looks good.

docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Dominik1999 Dominik1999 left a comment

Choose a reason for hiding this comment

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

Nice done @phklive !

I like that you are quick and pragmatic in this. After you have implemented the small changes, I will give it a try.

docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
```

## Step 2: Setting-up the Miden-Client

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we maybe already deploy a faucet account on the remote node? Then the user just needs to create account A and account B. That might be easier and more intuitive.

Copy link
Contributor

Choose a reason for hiding this comment

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

The faucet account should already exist on the remote node - but users won't be able to get assets from it as executing transactions against the faucet account requires knowing its state and performing authorization.

One potential way to address it, is to have a simple website where the users could go, enter their account ID, and ask the faucet account to send them some tokens. Maybe this can even be run on the same machine as the node. Should we create an issue for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Issue created here: 0xPolygonMiden/miden-node#215

docs/src/introduction/getting-started.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

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

Thank you! Looks good! Once @igamigo and @Dominik1999 comments are addressed, this is good to merge.

Let's create an issue to revisit this in the future. The primary reason is that while the node/client are rapidly changing, this section is likely to get out of sync pretty quickly.

Another reasons is that we'd eventually want a more comprehensive "Getting started" guide which would cover probably a few more topics (e.g., running node in the local environment, writing firs smart contract, maybe something else) but probably not in as much depth.

@phklive phklive marked this pull request as ready for review February 6, 2024 21:33
@phklive
Copy link
Contributor Author

phklive commented Feb 6, 2024

Thank you! Looks good! Once @igamigo and @Dominik1999 comments are addressed, this is good to merge.

Let's create an issue to revisit this in the future. The primary reason is that while the node/client are rapidly changing, this section is likely to get out of sync pretty quickly.

Another reasons is that we'd eventually want a more comprehensive "Getting started" guide which would cover probably a few more topics (e.g., running node in the local environment, writing firs smart contract, maybe something else) but probably not in as much depth.

Opened: 0xPolygonMiden/miden-docs#3

@phklive phklive merged commit f557aaf into main Feb 6, 2024
6 checks passed
@phklive phklive deleted the phklive-node-tutorial branch February 6, 2024 21:38
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.

4 participants