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

Cleanup bb.js and binary interface and document communication convention #1671

Closed
kevaundray opened this issue Aug 19, 2023 · 0 comments · Fixed by #1672
Closed

Cleanup bb.js and binary interface and document communication convention #1671

kevaundray opened this issue Aug 19, 2023 · 0 comments · Fixed by #1672
Labels
C-bb.js Component: bb.js - wrapping bberg in js

Comments

@kevaundray
Copy link
Contributor

Problem

Using info for stdout

Currently the implementation will use info for information relevant to the command in question. For example, in the GetNumberGates command, we print the number of using info.

info prints to stderr whereas in this case we want to print it to stdout.

Document methods

Since we need to have the bb.js binary and the bb binaries have the same conventions and interface, we should document the bb binary interface and have the bb.js binary version copy it and use the documentation as the reference.

We should also ideally have tests which check that these two binaries are the same. proofs are non-determinsitic, but for all other commands, we can simply just check that the output is the same.

Supporting stdout and file system communication

For some commands, we print to stdout/stderr like GetGates and for others we write to a file. We should standardize this and document. In my head, I think for any command which outputs to a file, we can have it also print the relevant data to stdout. I think we can iterate on this as we use the API.

@iAmMichaelConnor iAmMichaelConnor added the C-bb.js Component: bb.js - wrapping bberg in js label Aug 20, 2023
kevaundray added a commit that referenced this issue Aug 21, 2023
codygunton pushed a commit that referenced this issue Jan 23, 2024
* Copied index.html to output (#1661)

* Generate htnl file (#1662)

* Deployment fix (#1663)

* Deployment fixes (#1665)

* Deployment fix attempt (#1667)

* Updated falafel and kebab terraform with new project directory structure (#1670)

* Reduce the amount of logging in kebab (#1668)

* Reduce the amount of logging in kebab

* Logging improvement

* Bug fix

* Reverted erroneous change

* Pw/increase faucet drip (#1669)

* Increased the faucet drip size

* Force contract redeployment

* Deploy terraform from correct directory (#1671)

* JB/Website grants updates (#1666)

* Add new grant

* Improve research images

* Mini typo

* JB/Website build manifest (#1672)

* Add website to build manifest

* JB/Brand iteration (#1673)

* Small build change

* JB/Fix website deployment (#1676)

* Fix deployment

* JB/Fix website deploy (#1677)

* Fix deploy

Co-authored-by: Jonathan Bursztyn <jobur93@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bb.js Component: bb.js - wrapping bberg in js
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants