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

standardize roles CLI #813

Open
plebhash opened this issue Mar 22, 2024 · 4 comments
Open

standardize roles CLI #813

plebhash opened this issue Mar 22, 2024 · 4 comments
Assignees
Labels
refactor Implies refactoring code sv2 pool sv2 proxy translation proxy SV1>SV2 translation proxy issues

Comments

@plebhash
Copy link
Collaborator

plebhash commented Mar 22, 2024

context

Stratum Reference Implementation implies that the community will look at our roles to understand how to implement one.

therefore, code readability on the application level of the SRI stack (roles) implementations is a requirement

problem

all crates under roles follow a similar pattern for CLI args parsing, but each with slightly different approaches, making them clumsy to navigate and reason about

proposal

standardizing coding patterns across all roles CLI is essential for code readability

@plebhash plebhash added translation proxy SV1>SV2 translation proxy issues sv2 pool sv2 proxy refactor Implies refactoring code labels Mar 26, 2024
This was referenced Mar 28, 2024
@plebhash plebhash mentioned this issue May 26, 2024
Closed
@rrybarczyk rrybarczyk linked a pull request May 27, 2024 that will close this issue
Closed
@plebhash plebhash mentioned this issue May 27, 2024
10 tasks
@rrybarczyk rrybarczyk removed a link to a pull request May 27, 2024
Closed
@rrybarczyk rrybarczyk linked a pull request May 27, 2024 that will close this issue
10 tasks
@jbesraa
Copy link
Contributor

jbesraa commented Jun 21, 2024

@plebhash is CLI the only way we expect users to interact with the roles?
because here we have two things:

  1. How to configure the role(our approach is currently supports only toml files)
  2. How to run the role(our approach is currently assuming this will always be CLI)

I wonder if there is a previous discussion you could link me to? thanks

@plebhash
Copy link
Collaborator Author

@plebhash is CLI the only way we expect users to interact with the roles? because here we have two things:

  1. How to configure the role(our approach is currently supports only toml files)
  2. How to run the role(our approach is currently assuming this will always be CLI)

I wonder if there is a previous discussion you could link me to? thanks

right now, the only way to interact with the roles is to give them a path to a config.toml file over CLI, I think that is enough for a reasonable UX for now, we just need to make sure all roles are following the same coding patterns, since they are currently scattered

here's a discussion on the topic #857

@average-gary
Copy link
Contributor

#937 closed for future consideration of this issue.

@average-gary
Copy link
Contributor

Related: #1058

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Implies refactoring code sv2 pool sv2 proxy translation proxy SV1>SV2 translation proxy issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants