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

Stonfi DEX Data Collection Module (Python) #767

Open
seriybeliy11 opened this issue Aug 20, 2024 · 1 comment
Open

Stonfi DEX Data Collection Module (Python) #767

seriybeliy11 opened this issue Aug 20, 2024 · 1 comment

Comments

@seriybeliy11
Copy link
Contributor

seriybeliy11 commented Aug 20, 2024

Summary

To build an asyncio-based Python client for parsing and interacting with Stonfi DEX's API.

Bounty Context

Why it's Important?
Creating a Python parsing client for Stonfi DEX will facilitate developers' access to DEX data. This can provide a foundation for building various services around these data, such as data mining or other data-related services. Having a Python client will make the DEX data more easily accessible and manipulable in one of the most widely used programming languages for data science.

Problem showcase
Currently, accessing Stonfi DEX's data may be less convenient than ideally possible. Developers needing this data for their projects might need to undertake tedious manual works to integrate the DEX's API into their applications. Additionally, they need to manually organize the data, which can be cumbersome and error-prone.

Potential Solution
We aim to build a Python client tool-kit that utilises asyncio for requests to the DEX's API, capable of both GET and POST requests. The toolkit will provide functions to efficiently serialize the obtained data. Moreover, it will provide the capability to save data for further usage or data mining purposes. Essentially, the toolkit will simplify the interaction between Python developers and the Stonfi DEX's data.

Defenition of Done

  • The code is well-documented and easy to understand.
  • The code is tested and all tests pass.
  • The code is reviewed by at least one other team member.
  • The code is merged into the main branch and deployed to production.
  • The feature is fully functional and meets all acceptance criteria.
  • The feature is properly documented in the project documentation.
  • The feature is properly integrated with the rest of the system.
  • The feature is properly monitored and any issues are addressed in a timely manner.
  • The feature is properly maintained and any necessary updates or improvements are made in a timely manner.
  • https://github.com/fedya-eremin/stonfi

References

Please review the similar solutions at:

  1. Python's asyncio documentation: https://docs.python.org/3/library/asyncio.html

  2. Python's requests library: https://docs.python-requests.org/en/latest/

  3. Some asyncio related medium blog: https://medium.com/@yeraydiazdiaz/asyncio-coroutine-patterns-beyond-await-a6121486656f

  4. https://docs.ston.fi/docs/developer-section/sdk

REWARD

  • SBT Bounty Reward
  • 600 USD in TON

Thank you for your attention and we ask for your support so that we can bring more quality and useful tools to the ecosystem!

@seriybeliy11
Copy link
Contributor Author

@delovoyhomie please see, the solution here: https://github.com/fedya-eremin/stonfi

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

No branches or pull requests

1 participant