JohnBDB commented 5 years ago

CLI for Ocean squid client libraries

How can you help?

We want to implement a Command Line Interface for our client libraries “squid”. The latter are written in three languages JavaScript (referred as squid-js); Python (referred as squid-py); and Java (referred as squid-java). In our architecture, the squid libraries allow users (publishers and consumers) to interact with the Ocean Protocol smart contracts and network. They include the methods (in different languages) to, for example, buy an asset, or publish it. Different languages have different uses: the JavaScript version will be mostly used in the front-end part of Ocean Protocol, when users will access the web pages. For now in our current version Trilobite, developers can interact with the libraries using Tuna. Tuna is an example interface for our squid libraries. We want to give developers the option to use a CLI to execute the different commands and methods. By building the CLI, you would help Ocean by expanding its functionalities while making it easier for developers to improve Ocean Protocol via the squid libraries. It should at least reproduce the capabilities of Tuna.

Assumptions

Familiarity with the Ocean Protocol architecture (you need to understand well how squid the libraries interacts with the different components). More information here.
You have used the current version (Trilobite) of Ocean Protocol and tried the different functionalities. This is will help you understand what the CLI should allow.
You have used/are using CLIs in your work/free time so you have knowledge about how to build one.

What needs to be done?

A complete CLI that developers can use to execute all the commands interacting with the squid libraries.
Any language (Python, JavaScript, Java) can be used, but it needs to be properly documented and tested (unit tests and integration tests).

We are very happy when

Users can easily understand how to operate the CLI (so solid documentation).
All the squid commands can be executed from the CLI (see list of commands https://github.com/oceanprotocol/squid-java/blob/develop/README.md). Users can publish, register, search, and consume assets, interact with the Secret Store (encrypt/decrypt), and interact with metadata.
Each CLI command should reproduce each squid method.
Unit/integration test coverage for the code is >=85%.

Seen this problem before?

Any help solving this is welcome. Feel free to leave any comments and help someone else to solve it. We might airdrop tokens to someone even if not directly completing bounty.

Questions & Reviews

Pull requests will be reviewed by one of the maintainers or long-term contributors. In case of any additional questions feel free to ask in this thread and we will do our best to add the missing info :)

Things to know

The bounty lifecycle process including payout will be managed using Gitcoin. We'll be responding to your questions here, but for discussion and clarification we recommend to join also our Gitter channel where our tech community is accessible. In order to see the PROCN balance in your wallet you'll need to reference the related token contract with address 0xf2aabdd898a0139195b2b5da7387d43a45ded254. If you use a Metamask plugin you'll find the the exact steps here.

Reward

Once the project was reviewed and merged in the master branch, you will receive the reward. PROCN is a proto-Ocean token. Bounty hunters that earn PROCN will be able to convert them 1:1 to Ocean tokens on network launch (Ocean Token will be valued at at 0.22 EUR on network launch). Network launch is expected to happen by Mar 31, 2019. Until then PROCN will be locked and non-transferrable in the ETH wallet to which it is delivered to.

gitcoinbot commented 5 years ago

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

This issue now has a funding of 12500.0 PROCN attached to it as part of the Ocean Protocol Foundation 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
- $46,326.12 more funded OSS Work available on the Gitcoin Issue Explorer

Anirudh2490 commented 5 years ago

@speunz and @jayprakashstar welcome! Thanks for applying for this bounty, it's great to have you on board. If you've got any doubts on how to proceed, we're available on chat - https://gitter.im/oceanprotocol/Lobby. You can also tell us more about your approach to the work, what will be your steps and when you are planning to complete. Cheers!

Anirudh2490 commented 5 years ago

@rodwan-bakkar @speunz @jayprakashstar, would you have any update for us on this bounty? Please do share with us the progress made on this bounty, or any concerns you may have. You can also reach out to us on our Gitter channel.

Anirudh2490 commented 5 years ago

@Rodwan-Bakkar @speunz @jayprakashstar we've not heard any update from you about this bounty, so we will be removing you as you do not seem to be working on it. You can always re-apply to the bounty if you want to ofcourse!

nemani commented 5 years ago

Also: I will take inspiration from the heroku CLI.

https://devcenter.heroku.com/articles/cli-style-guide https://devcenter.heroku.com/articles/developing-cli-plugins

iamonuwa commented 5 years ago

I'll implement this task using JavaScript

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Cancelled

The funding of 12500.0 PROCN attached to this issue has been cancelled by the bounty submitter

Questions? Checkout Gitcoin Help or the Gitcoin Slack
$52,978.46 more funded OSS Work available on the Gitcoin Issue Explorer

oceanprotocol-archive / bounties