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

getBloom supports the hidden option --source and -s #454

Closed
crodnun opened this issue Oct 10, 2017 · 3 comments
Closed

getBloom supports the hidden option --source and -s #454

crodnun opened this issue Oct 10, 2017 · 3 comments
Assignees
Labels

Comments

@crodnun
Copy link
Contributor

crodnun commented Oct 10, 2017

Looking at the test cases defined so far, I see that we support these options:

--source:cache
-s:node
--parity

These options are not documented at README.md. Do we keep them hidden for the moment?

@tjayrush
Copy link
Member

tjayrush commented Oct 12, 2017

Just to document what this is:

  • --source:node is equivalent to --raw.
  • --source:cache forces QuickBlocks to pull the data from the cache or fail
  • --source:infura forces it to fallback to infura
  • -s is a shortcut for --source:...
  • normal operation is
    • look in cache, if not found...
    • look for a local node, if not found...
    • look for ${FALLBACK}, if not found
    • fail

For the time being (release 0.2.0) these options should remain hidden since it's not fully ready yet. I think it's fine to leave them in the test cases just so we know they don't get broken by some other change.

The --parity options is similar in the sense that it's available to every tool, but not documented because it's not really ready just yet. Again, I think it's okay to leave it in the test cases so it doesn't get accidentally broken, but we won't expose it for version 0.2.0.

@tjayrush tjayrush assigned crodnun and unassigned tjayrush Oct 12, 2017
@tjayrush tjayrush added this to the Release 0.5.0 - Wyndmore milestone Oct 12, 2017
@crodnun
Copy link
Contributor Author

crodnun commented Oct 13, 2017

OK closing per Thomas request. This part is delayed to next releases

@tjayrush
Copy link
Member

Referenced from list of hidden commands issue.

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

No branches or pull requests

2 participants