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

Documentation for B256 #3240

Open
petertonysmith94 opened this issue Oct 2, 2024 · 5 comments
Open

Documentation for B256 #3240

petertonysmith94 opened this issue Oct 2, 2024 · 5 comments
Labels
docs Requests pertinent to documentation good first issue Suitable for newcomers looking to contribute

Comments

@petertonysmith94
Copy link
Contributor

Summary

Reference docs

  • We could rename these to B256 from Bits256to better align with the wider ecosystem.
  • Currently we display how use getRandomB256 however I believe we should use actual addresses for a better showcase of their use cases.
  • We're missing how to use these addresses with an actual contract.
  • We're also missing how these can be used in Sway programs.
@petertonysmith94 petertonysmith94 added docs Requests pertinent to documentation good first issue Suitable for newcomers looking to contribute labels Oct 2, 2024
@petertonysmith94 petertonysmith94 changed the title Documentation for B256 Documentation for B256 Oct 2, 2024
@cypherpepe
Copy link

  1. Using Real Addresses:
  • Which real addresses do you recommend using in the documentation examples? Should these be test data, pre-defined addresses, or perhaps specific examples from existing projects?
  • What specific use cases involving real addresses would you like to see in the examples? Should we demonstrate their use in real transactions, or is it sufficient to show how they can be created and manipulated?
  1. Integration with Contracts:
  • Should we add an example that shows how B256 can be used in contract calls to demonstrate interaction with contracts?
  • What level of detail do you expect for this example? Is a basic example sufficient, or should we include a more complex one, demonstrating interactions with other contracts or systems?
  1. Using B256 in Sway Programs:
  • What specific scenarios involving B256 in Sway would you like to see documented? For instance, is it enough to show how to create and use a B256 variable, or do you need a more complex example?
  • Would you like to see examples of using B256 in specific contexts, such as cryptographic functions, hashing, or interactions with other Sway components?

@cypherpepe
Copy link

Hi @petertonysmith94, just wanted to let you know that I'm waiting for your response on the questions I raised. This will help me better align the examples and documentation with your expectations. Let me know if there are any other details you’d like to discuss. Thanks!

@petertonysmith94
Copy link
Contributor Author

@cypherpepe We're really busy currently, I will get back to you next week.

@dmytroyatsenk0
Copy link

Hello @petertonysmith94 can I continue this task if it is still relevant? I have a solution.

@petertonysmith94
Copy link
Contributor Author

Hey @dmytroyatsenk0 👋🏼 Please continue and create a PR when you can :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation good first issue Suitable for newcomers looking to contribute
Projects
None yet
Development

No branches or pull requests

3 participants