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

Circuit compiler UI #4144

Merged
merged 26 commits into from
Oct 31, 2023
Merged

Circuit compiler UI #4144

merged 26 commits into from
Oct 31, 2023

Conversation

ioedeveloper
Copy link
Member

User Interface for Circom Plugin

@netlify
Copy link

netlify bot commented Oct 17, 2023

Deploy Preview for remixproject ready!

Name Link
🔨 Latest commit 1849efb
🔍 Latest deploy log https://app.netlify.com/sites/remixproject/deploys/6540c338e0961b00095ebb9a
😎 Deploy Preview https://deploy-preview-4144--remixproject.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


useEffect(() => {
new CircomPluginClient()
const plugin = new CircomPluginClient()
Copy link
Collaborator

Choose a reason for hiding this comment

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

setting plugin clients in useeffect and in a state will cause problems. especially when using strict mode. I've seen situations with other plugins doing this where it would either try to connect to Remix twice or never connect at all. You can can listen on the onload event here just fine. but I'd set the plugin as a const and export it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Can you make a commit with your recommended changes?

Copy link
Collaborator

Choose a reason for hiding this comment

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

sure

@ioedeveloper ioedeveloper added this to In progress in v0.38.0 - Feature Freeze 29/11 via automation Oct 19, 2023
@ioedeveloper ioedeveloper added the ready-to-review PR ready to review label Oct 19, 2023
@ioedeveloper ioedeveloper added this to the Zero Knowledge milestone Oct 19, 2023
@ryestew
Copy link
Collaborator

ryestew commented Oct 19, 2023

The name should updated to:
Circom ZKP compiler

@ryestew
Copy link
Collaborator

ryestew commented Oct 19, 2023

Links to docs and we need a medium article.

@ryestew
Copy link
Collaborator

ryestew commented Oct 19, 2023

Needs a button to make some example files - but if this is a workspace and a workspace is created - somehow the user needs to be informed that a workspace has been created. So you could generate workspace and automatically get switched to the FE.

@ryestew
Copy link
Collaborator

ryestew commented Oct 19, 2023

and we need documentation for this plugin

@ryestew ryestew added the documentation-needed Documentation should be updated label Oct 19, 2023
@@ -8,8 +8,8 @@
"canActivate": [],
"url": "",
"description": "Enables circuit compilation and computing a witness for ZK proofs",
"icon": "https://docs.circom.io/assets/images/favicon.png",
"location": "hiddenPanel",
"icon": "assets/img/circom.webp",
Copy link
Contributor

Choose a reason for hiding this comment

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

the icon doesn't show up...


constructor() {
super()
createClient(this)
this.internalEvents = new EventManager()
this.methods = ['init', 'parse']
Copy link
Collaborator

Choose a reason for hiding this comment

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

set the methods before the createclient

Copy link
Collaborator

Choose a reason for hiding this comment

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

If I remember correctly :D

@bunsenstraat
Copy link
Collaborator

I think you can add the plugin tor required plugins in app manager so you don't have to give permissions.

@@ -255,13 +255,13 @@ class FileManager extends Plugin {
* @param {string} path path of the file
* @returns {string} content of the file
*/
async readFile(path) {
async readFile(path, isBuffer?) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

if we start doing this we should maybe just add encoding as a param, which is the standard fs way. so we can support everything.

0.37.0 - Feature Freeze 31/10 - Release 07/11 automation moved this from In progress to Review in progress Oct 30, 2023
@ioedeveloper ioedeveloper mentioned this pull request Oct 30, 2023
Copy link
Collaborator

@ryestew ryestew left a comment

Choose a reason for hiding this comment

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

For translations, you have updated the index.js and the circuit.json file in remix-ide/src/app/tabs/locales/en.

You don't need to add the circuit.json file in the es, fr, and zh folders. Please remove these .json files - only keep the one in the en folder.

@ioedeveloper ioedeveloper merged commit 50d745d into master Oct 31, 2023
32 checks passed
0.37.0 - Feature Freeze 31/10 - Release 07/11 automation moved this from Reviewer approved to Done Oct 31, 2023
@ioedeveloper ioedeveloper deleted the circuit-compiler branch October 31, 2023 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-needed Documentation should be updated ready-to-review PR ready to review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants