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

Add missing network configurations with Client #845

Open
11 tasks
RickyLB opened this issue Sep 11, 2024 · 1 comment
Open
11 tasks

Add missing network configurations with Client #845

RickyLB opened this issue Sep 11, 2024 · 1 comment
Assignees
Labels
good first issue Issues which are ideal for a first time or new project contributor. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. help wanted Extra attention is needed

Comments

@RickyLB
Copy link
Contributor

RickyLB commented Sep 11, 2024

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'good first issue' is to help you make your first contribution to Hedera.

👾 Description of the issue

These SDK methods for the Hedera network are critical for configuring client behavior and ensuring robust network communication. The methods allow for setting and checking transport security (TLS), managing retry attempts for nodes with failed gRPC statuses, and controlling the number of nodes involved in each transaction, which impacts both security and network efficiency.

The Rust SDK is missing the following Client methods that allow developers to configure the Network behavior in client/mod.rs.

impl Client {
	///
	/// Set if transport security should be used to connect to consensus nodes.
	///
	pub fn set_transport_security(&self, transport_security: bool) {}

	///
	/// Is tls enabled for consensus nodes.
	///
	pub fn is_transport_security(&self) {}

	///
	/// Max number of times any node in the network can receive a bad gRPC status 
	///
	pub fn get_max_node_attempts(&self) {}

	///
	/// Set the max number of times any node in the network can receive a bad gRPC status before being removed from the network.
	///
	pub fn set_max_node_attempts(&self, max_node_attempts: u32) {}

	///
    /// Set the max amount of nodes that will be chosen per request. By default, the request will use 1/3rd the network
    /// nodes per request.
    ///
	pub fn set_max_nodes_per_transaction(&self, max_nodes_per_transaction: u32) {}
}

Solution

These methods exist in the Java SDK (sdk/Client.java)

Implementation

  1. Create logic for each method within Impl NetworkData
  2. Expose methods to configure network using Client

📋 Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.

  • Claim this issue: Comment below that you are interested in working on the issue
  • Wait for assignment: A community member with the given rights will add you as an assignee of the issue
  • Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org). More details can be found in our CONTRIBUTING.md
  • Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
  • Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hedera developer community for support.
  • Wait for reviews: Members of the Hedera developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
  • You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hedera community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

@RickyLB RickyLB added the good first issue candidate Issues that can become a good first issue but need more description/context. label Sep 11, 2024
@RickyLB RickyLB changed the title Add missing network Configurations with Client Add missing network configurations with Client Sep 11, 2024
@hendrikebbers hendrikebbers added good first issue Issues which are ideal for a first time or new project contributor. help wanted Extra attention is needed hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. and removed good first issue candidate Issues that can become a good first issue but need more description/context. labels Sep 30, 2024
@shivaram19
Copy link

shivaram19 commented Oct 7, 2024

hello , I'm shivaram , I've been working on the rust lately , could you assign me this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues which are ideal for a first time or new project contributor. hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants