Client Libraries - Githubissues

YingyaoX commented 4 years ago

Description: Please refer to the BLZJS repo: https://github.com/bluzelle/blzjs

We need libraries similar to BLZJS in each of the following languages. We will look at the completeness of your submission, including unit tests and a sample folder with an example of use, config, etc.

Requirements:

Use the BLZJS library as a reference for which API calls to make, and as an example of how to interact with the REST endpoint on our TestNet.
For each language, please also provide a samples folder (like BLZJS) that shows an example crud program demonstrating the use of your library with our TestNet. These are critical so we can evaluate your submission.

Rewards:

USD $1,250 for each library

C++ (GCC compliant on Windows,
Linux, Mac)
Java (Android)
Swift (iOS)
Python
Ruby
Java
C#
Go
PHP

Resources:

Developer Documentation for BluzelleDB: https://docs.bluzelle.com/developers/
Bluzelle Curie Testnet Github link: https://github.com/bluzelle/curium
Bluzelle Javascript Library: https://github.com/bluzelle/blzjs
Community discord chat (you can reach out to the team if you have any questions): https://discord.gg/KbDVsxE

Important points:

Your submission will be a pull request.
Your submission WILL be judged significantly based on how well you use Bluzelle DB. It is a key value store, so please use it effectively using best practices including proper data normalization/de-normalization.
Update the README to reflect your submission including description, notes, and other pertinent details.
You can participate in any of Bluzelle bounty, or even multiple ones, as you desire. You can be an individual or a team -- it is up to you.
The code you submit will be under the MIT license, with you being credited as the author. When you submit this code, you agree to give all publishing and intellectual rights of the video freely over to the community via the terms of the MIT license.
Ensure the code is written by you or your team. It is imperative that you own the rights to the code and are writing code that can be fully licensed under MIT.
Please submit your code to Github with the proper MIT license file included in it, to be considered. If your submission includes a front end and back end, put these into separate FOLDERS and include them both in the same pull request with your submission.
Be sure your submission is in a ready and demo-able state. We will not evaluate incomplete projects nor will code alone be an acceptable submission. Include all necessary details so we can try out your app.
Record a screencast showing us how your submission works. Include a link to your video in the README.
The Bluzelle team will be solely responsible for choosing the winners, and if warranted, multiple winners are possible for each bounty.
The Bluzelle team will make the final decision, and reserves the right to not award a bounty for a challenge if no acceptable submissions are made.
Once you have made your pull request, submit your work and include information on the link to your pull request.

Please 100% ensure that the README for each of your library submissions follow these guidelines and assumptions:

While the team members testing are each software engineers, they have no specific experience whatsoever in the language. So if it is C#, assume they do not know C#. They do not know how to setup an environment for C# and do not know how to write even a basic C# program. Even if they have C# experience, they might not know the latest standards and tools and conventions, so it is best to assume they know nothing about C#.
The person is ssh'ed onto a fresh new Ubuntu 18.04 Linux install. There is nothing installed on this machine yet, whatsoever. Not even basic developer tools. There is no GUI. Just base OS.
List out all the steps necessary to install all the tools/dependencies to get your library running. Nothing is too obvious.
List out all the steps to actually copy and install your library submission to the machine. This could be a "git clone", but ideally, your library is installable through a suitable package manager in the language. Like "composer" for PHP, or "pip" for Python.
Include with your submission at least one example program that can be run "out of the box". It should have all the credentials (for the Bluzelle DB, including mnemonic, endpoints, UUID, etc) so that it can just be run. Please include as many examples as possible. The more you submit, the better a showcase it is of the library and more likely to win.
Include instructions on how to actually run your example program or programs.
Include tests if you can, as well as clear instructions on how to run the tests and interpret their results. Most critical is ensuring that there are no blockers, so that the Bluzelle team can seamlessly test your submission. We 100% appreciate all the hard work and want to go through each submission diligently, and need your help to achieve this. Please ensure you "QA" all the instructions for your library on a fresh new Ubuntu 18.04 install by actually running through these steps and verifying it all works. Do not do this on your own dev machine, as there could be dependencies that are missed. We recommend using a VM with Ubuntu 18.04 or alternatively, use a free-tier Ubuntu 18.04 instance on AWS (or Azure or GCP).

gitcoinbot commented 4 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 75700.0 BLZ (3158.2 USD @ $0.04/BLZ) attached to it as part of the bluzelle fund.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
- Want to chip in? Add your own contribution here.
- Questions? Checkout Gitcoin Help or the Gitcoin Slack
- $132,653.18 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 4 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work has been started.

These users each claimed they can complete the work by 1 year, 9 months ago. Please review their action plans below:

1) coderrick has started work.

Pull request with repo containing new APIs for Golang, Java, and Python. Maybe be able to implement the rest of the languages will given update after initial submission of work. 2) mul53 has started work.

Hi i will implement the ruby client 3) paulsd2020 has started work.

fetch and update to push. cheers 4) developer-dewd-labs has started work.

Will submit a Library for C++ (GCC compliant on Windows, Linux, Mac). 5) bardinpetr has started work.

Will create Python and C# clients, I time will remain - for Java too 6) theakshaygupta has started work.

I'm an experienced python and go developer and seems it should be done quickly. I am starting work today and will give update soon. 7) vbstreetz has started work.

Will familiarize myself with the overall Bluzelle technology and features, before proceeding to port the js client lib to a golang package. 8) developerfred has started work.

My plan is to create a client in v-lang and another in dart lang 9) aqoleg has started work.

I will create java client, maybe java(android)

Learn more on the Gitcoin Issue Details page.

kelonye commented 4 years ago

Working on the go pkg here...

Mutation methods

[x] Create
[x] Update
[x] Delete
[x] Rename
[x] DeleteAll
[ ] MultiUpdate (seems this is still being worked on...returns 404)

Query methods

[x] Read
[x] Has
[x] Keys
[x] KeyValues
[x] Count
[x] TxRead
[x] TxHas
[x] TxKeys
[x] TxCount
[x] TxKeyValues

Misc methods

[x] ReadAccount
[x] Version

kelonye commented 4 years ago

Hey! Almost done on my end 👆 except for one method, MultiUpdate, whose endpoint /crud/multiupdate appears not to have been implemented 🤔? The endpoint fails with a 404 error. I'll proceed to do a bit more clean up, add tests and docs etc. Please test and let me know...

njmurarka commented 4 years ago

Hey! Almost done on my end 👆 except for one method, MultiUpdate, whose endpoint /crud/multiupdate appears not to have been implemented 🤔? The endpoint fails with a 404 error. I'll proceed to do a bit more clean up, add tests and docs etc. Please test and let me know...

Hi. Please standby (with respect to multiupdate only) as we look into this. I believe we need to update the public testnet as you have identified a function that did not make the cut.

We will do so and let you all know. In the meantime, please continue your great work.

kelonye commented 4 years ago

Hey! Almost done on my end 👆 except for one method, MultiUpdate, whose endpoint /crud/multiupdate appears not to have been implemented 🤔? The endpoint fails with a 404 error. I'll proceed to do a bit more clean up, add tests and docs etc. Please test and let me know...

Hi. Please standby (with respect to multiupdate only) as we look into this. I believe we need to update the public testnet as you have identified a function that did not make the cut.

We will do so and let you all know. In the meantime, please continue your great work.

Awesome. Will proceed to implement the python and ruby sdks as well...

kelonye commented 4 years ago

Hey. Should we submit PRs to this exact repo or can we submit links to other repos?

kelonye commented 4 years ago

I got the python lib bootstrapped https://github.com/vbstreetz/blzpy. Hopefully be done by tomorrow...

nanspro commented 4 years ago

@YingyaoX almost done with my python library(manage to recreate cosmos module and all it's methods just testing and structuring left), will push the code to my github by the end of day.

kelonye commented 4 years ago

Done with my implementation of the python sdk as well. Onto ruby...

gitcoinbot commented 4 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 75700.0 BLZ has been submitted by:

@bluzelle-team please take a look at the submitted work:

PR by @bardinpetr
PR by @bardinpetr
(Link Not Provided) by @paulsd2020
PR by @mul53
PR by @aqoleg
PR by @vbstreetz

Learn more on the Gitcoin Issue Details page
Want to chip in? Add your own contribution here.
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$138,568.92 more funded OSS Work available on the Gitcoin Issue Explorer

kelonye commented 4 years ago

Managed to sort out the crypto stuff in the case ruby :phew:, so here are now all my completed submissions (please change the bounty to multi-submit):

njmurarka commented 4 years ago

@paulsd2020 Please provide a link to your submission.

njmurarka commented 4 years ago

@aqoleg Please contact me on Discord.

mul53 commented 4 years ago

Submission: PHP library

njmurarka commented 4 years ago

Submission: PHP library

@mul53

Need help installing. Please check Discord IM

YingyaoX commented 4 years ago

Hi all, thanks for submitting your work for the client library, to ensure our QA process is smooth and in time for bounty payouts, please make sure you have done your own testing and follow the below guidelines.

Please 100% ensure that the README for each of your library submissions follow these guidelines and assumptions:

While the team members testing are each software engineers, they have no specific experience whatsoever in the language. So if it is C#, assume they do not know C#. They do not know how to setup an environment for C# and do not know how to write even a basic C# program. Even if they have C# experience, they might not know the latest standards and tools and conventions, so it is best to assume they know nothing about C#.
The person is ssh'ed onto a fresh new Ubuntu 18.04 Linux install. There is nothing installed on this machine yet, whatsoever. Not even basic developer tools. There is no GUI. Just base OS.
List out all the steps necessary to install all the tools/dependencies to get your library running. Nothing is too obvious.
List out all the steps to actually copy and install your library submission to the machine. This could be a "git clone", but ideally, your library is installable through a suitable package manager in the language. Like "composer" for PHP, or "pip" for Python.
Include with your submission at least one example program that can be run "out of the box". It should have all the credentials (for the Bluzelle DB, including mnemonic, endpoints, UUID, etc) so that it can just be run. Please include as many examples as possible. The more you submit, the better a showcase it is of the library and more likely to win.
Include instructions on how to actually run your example program or programs.
Include tests if you can, as well as clear instructions on how to run the tests and interpret their results. Most critical is ensuring that there are no blockers, so that the Bluzelle team can seamlessly test your submission. We 100% appreciate all the hard work and want to go through each submission diligently, and need your help to achieve this. Please ensure you "QA" all the instructions for your library on a fresh new Ubuntu 18.04 install by actually running through these steps and verifying it all works. Do not do this on your own dev machine, as there could be dependencies that are missed. We recommend using a VM with Ubuntu 18.04 or alternatively, use a free-tier Ubuntu 18.04 instance on AWS (or Azure or GCP).

Please also stay in touch with our CTO Neeraj on Discord in case any issue needs to be resolved.

gitcoinbot commented 4 years ago

Issue Status: 1. Open 2. Cancelled

The funding of 75700.0 BLZ (2455.48 USD @ $0.03/BLZ) attached to this issue has been cancelled by the bounty submitter

Questions? Checkout Gitcoin Help or the Gitcoin Chat
$140,040.21 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot commented 4 years ago

⚡️ A tip worth 40322.00000 BLZ (1307.92 USD @ $0.03/BLZ) has been granted to @vbstreetz for this issue from @Bluzelle-Team. ⚡️

Nice work @vbstreetz! Your tip has automatically been deposited in the ETH address we have on file.

$140040.21 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Chat

gitcoinbot commented 4 years ago

⚡️ A tip worth 40322.00000 BLZ (1307.92 USD @ $0.03/BLZ) has been granted to @vbstreetz for this issue from @Bluzelle-Team. ⚡️

Nice work @vbstreetz! Your tip has automatically been deposited in the ETH address we have on file.

$140040.21 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Chat

gitcoinbot commented 4 years ago

⚡️ A tip worth 40322.00000 BLZ (1307.92 USD @ $0.03/BLZ) has been granted to @vbstreetz for this issue from @Bluzelle-Team. ⚡️

Nice work @vbstreetz! Your tip has automatically been deposited in the ETH address we have on file.

$140040.21 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Chat

gitcoinbot commented 4 years ago

⚡️ A tip worth 40322.00000 BLZ (1307.92 USD @ $0.03/BLZ) has been granted to @aqoleg for this issue from @Bluzelle-Team. ⚡️

Nice work @aqoleg! To redeem your tip, login to Gitcoin at https://gitcoin.co/explorer and select 'Claim Tip' from dropdown menu in the top right, or check your email for a link to the tip redemption page.

$140040.21 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Chat

gitcoinbot commented 4 years ago

⚡️ A tip worth 9583.00000 BLZ (160.61 USD @ $0.02/BLZ) has been granted to @mul53 for this issue from @Bluzelle-Team. ⚡️

Nice work @mul53! Your tip has automatically been deposited in the ETH address we have on file.

$486033.91 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Chat

gitcoinbot commented 4 years ago

⚡️ A tip worth 9583.00000 BLZ (160.61 USD @ $0.02/BLZ) has been granted to @mul53 for this issue from @Bluzelle-Team. ⚡️

Nice work @mul53! Your tip has automatically been deposited in the ETH address we have on file.

$486073.37 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Chat

bluzelle / swarm-of-duty

Client Libraries #8

Mutation methods

Query methods

Misc methods