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: create helper for running docker locally #1834

Closed
adklempner opened this issue Feb 7, 2024 · 7 comments
Closed

feat: create helper for running docker locally #1834

adklempner opened this issue Feb 7, 2024 · 7 comments

Comments

@adklempner
Copy link
Member

adklempner commented Feb 7, 2024

Problem

Under harsh network conditions, especially at hackathons, it becomes difficult for a js-waku instance in the browser to connect to a Waku node on the network. It's easier for a user to move forward and build when there is a local instance of nwaku running that js-waku can connect to.

Proposed Solutions

Create an npm script that:

  • checks if docker is installed
  • pulls the latest stable image of nwaku
  • runs nwaku
  • prints the multiaddr of the node once running

Notes

@fryorcraken fryorcraken added this to Waku Feb 7, 2024
@weboko weboko changed the title create a script for running a service node via Docker feat: create helper for running docker locally Feb 7, 2024
@weboko
Copy link
Collaborator

weboko commented Feb 7, 2024

Proposed solution: similarly to how we use npx @waku/create-app [options] we can publish npm package so that consumer can spin nwaku docker container with simple command: npx @waku/docker [options].

@waku-org/eco-dev your thoughts?

@vpavlin
Copy link
Member

vpavlin commented Feb 7, 2024

I think that if we are clear about only using this node for development and ideally just making it work without any extra configuration, it sounds good and fits into waku-org/pm#137

2 questions/considerations:

  1. Should the node be/stay isolated, or attempt to connect to the waku network - in which case it would need to deal with RLN
  2. Should we ignore RLN on this dev node and risk that the app will not be compatible with the waku network, or push for having some RLN membership set there (think something like hardhat dev accounts on local dev blockchain)

@weboko
Copy link
Collaborator

weboko commented Feb 8, 2024

My perspective here is:

  1. It should stay isolated with option to connect to the network - but in that case you might as well just use default bootstrap.
  2. Default probably should be without RLN verification but with ability to enable it.

@fryorcraken
Copy link
Collaborator

What about RLN? Using ganache or something like that?

@vpavlin
Copy link
Member

vpavlin commented Feb 12, 2024

Yeah, I think that if we talk about being able to run everything locally, we might need to consider something like Ganache, Hardhat, Foundry to run alongside the docker waku node to make it all self-contained.

I'd also say that once we have the UX for working with RLN in js-waku polished, we should enable it by default, but might be worth to keep it off by default initially

@fryorcraken
Copy link
Collaborator

I'd also say that once we have the UX for working with RLN in js-waku polished, we should enable it by default, but might be worth to keep it off by default initially

I expect different APIs to be available.

@chair28980
Copy link
Contributor

@chair28980 chair28980 closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2024
@github-project-automation github-project-automation bot moved this from To Do to Done in Waku May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

5 participants