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

For Cycle 34 #1033

Closed
ghubstan opened this issue Mar 24, 2022 · 6 comments
Closed

For Cycle 34 #1033

ghubstan opened this issue Mar 24, 2022 · 6 comments
Assignees
Labels
parsed:valid https://bisq.wiki/Compensation#Ensure_your_request_is_valid team:dev https://bisq.wiki/Dev_Team was:accepted Indicates that a compensation request was accepted by DAO voting
Milestone

Comments

@ghubstan
Copy link

ghubstan commented Mar 24, 2022

Summary

Specify the total amount of BSQ you are requesting, along with the USD total and BSQ/USD rate (don't include the brackets!):

  • BSQ requested: 10365.85
  • USD requested: 12750
  • BSQ rate: 1.23 USD per BSQ
  • Previous compensation request (if applicable): For Cycle 33 #1008

Contributions delivered

Add contributions you have delivered and roles you have performed here as new rows in the table below. Role line-items should include an asterisk (*) in the team column.

Title Team USD Link Notes
Add API 'gettrades' method dev 3000 bisq-network/bisq#5976 merged, approved in cycle 33
Modify .proto file comments to be parsed by bisq-grpc-api-doc [No. 1] dev 100 bisq-network/bisq#6042 merged, approved in cycle 33
Fix API FeeService NPE dev 50 bisq-network/bisq#6052 merged, approved in cycle 33
Fix BSQ swap description of BTC price for 1 BSQ dev 0 bisq-network/bisq#6074 merged
Prepare API Offers .proto defs for significant changes [No. 1] dev bisq-network/bisq#6055 merged
Change API's OfferInfo proto's price field to string [No. 2] dev bisq-network/bisq#6056 merged
Change API grpc.proto triggerPrice field to string [No. 3] dev bisq-network/bisq#6057 merged
Change API OfferInfo volume/minVolume proto fields to string [No. 4] dev bisq-network/bisq#6060 merged
Change TradeInfo proto's tradePrice & tradeVolume fields to string [No. 5] dev bisq-network/bisq#6062 merged
Clarify meaning of API/Offer related % fields [No. 6] dev bisq-network/bisq#6065 merged
Continue documenting grpc.proto for API reference site [No. 7] dev bisq-network/bisq#6068 merged
Remove GetTradeStatistics service from grpc.proto [No. 8] dev bisq-network/bisq#6079 merged
Convert grpc.proto field names to snake_case [No. 9] dev bisq-network/bisq#6080 merged
Fix 3 misleading .proto TradeInfo field names [No. 10] dev bisq-network/bisq#6081 merged
Move get (cryptocurrency) offer filter to daemon [No. 1] dev bisq-network/bisq#6086 merged
Send meaningful io.grpc.Status.Code to gRPC clients [No. 2] dev bisq-network/bisq#6088 merged
API bug-fix for incorrect BsqSwap's OfferInfo.isActivated value [No. 3] dev bisq-network/bisq#6094 merged
Generate API Reference markdown, implement API cli/java/python examples dev 9000 https://github.com/ghubstan/bisq-api-reference generates API reference + examples
Deploy API Reference site with cli/java/python examples + python bot examples dev 200 https://bisq-network.github.io/slate/No. introduction deployed
Host API reference on https://bisq-network.github.io/slate dev 200 https://github.com/bisq-network/slate/pulls?q=is%3Apr merged
Exclude persistedAccountName from API payment acct json forms dev 100 bisq-network/bisq#6098 merged
Send pretty payment details to API clients dev 100 bisq-network/bisq#6103 merged

Contributions in progress

Provide links to work you're involved with that is still in progress. This section is optional (the linter ignores it), and is for your own benefit in keeping track of what you're doing and keeping other contributors up to date with the same.

  • Working together with some individuals interested in running API bots, including representative at BTCPay.
  • Will be working on a basic API daemon and CLI release, as executable jars.
  • Continue to simplify the API Python examples setup task.
  • Improve API reference doc & examples as needed, fix API bugs when found.
@ghost ghost added parsed:valid https://bisq.wiki/Compensation#Ensure_your_request_is_valid team:dev https://bisq.wiki/Dev_Team labels Mar 24, 2022
@MwithM MwithM added this to the Cycle 34 milestone Mar 25, 2022
@ripcurlx
Copy link
Contributor

@ghubstan As Generate API Reference markdown, implement API cli/java/python examples is quite a big contribution, could you break it down a bit, so it is easier to evaluate by all contributors? Thanks!

@ghubstan
Copy link
Author

@ghubstan As Generate API Reference markdown, implement API cli/java/python examples is quite a big contribution, could you break it down a bit, so it is easier to evaluate by all contributors? Thanks!

I break it down in today's changes to the project's and subprojects' READMEs, primarily in the top-level project's README, and the doc-generator subproject README.

In Summary: What is the bisq-api-reference repo?

The repo's main purpose is to generate the Markdown text for the API Reference. It also provides a Java and Python workarea for running API client example code, and developing new Java and Python clients and bots.

It contains four subprojects:

  1. reference-doc-builder -- The Java application that produces the API Reference content, from commented Bisq protobuf definition files.
  2. cli-examples -- A folder of bash scripts demonstrating how to run API CLI commands. Each script is named for the RPC method call being demonstrated.
  3. java-examples -- A Java project demonstrating how to call the API from Java gRPC clients. Each class in the bisq.rpccalls package is named for the RPC method call being demonstrated.
  4. python-examples -- A Python3 project demonstrating how to call the API from Python3 gRPC clients. Each class in the bisq.rpccalls package is named for the RPC method call being demonstrated. There are also some simple bot examples in the bisq.bots package.

The RPC method examples are also displayed in the API Reference. While navigating the RPC method links in the reference's table of contents on the left side of the page, they appear in the dark, right side of the page. There is also a copy-to-clipboard icon at the top right of each example.

@ripcurlx
Copy link
Contributor

As dev team lead I approve this compensation request for dev. Please submit your CR to the DAO for voting and post the transaction ID afterwards. Thanks!

@ghubstan
Copy link
Author

64e9ec64c0aa222797ae4fa362b9fc04235a0d5ef3eb962a7fbd03a2e869e563

@MwithM MwithM added the was:accepted Indicates that a compensation request was accepted by DAO voting label Apr 7, 2022
@ghost
Copy link

ghost commented Apr 7, 2022

Issuance by Team:

team amount BSQ amount USD
dev 10365.85 12750.00

Total Issuance: 10365.85 BSQ (equivalent to: 12750.00 USD)

@MwithM
Copy link
Contributor

MwithM commented Apr 7, 2022

Closed as accepted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
parsed:valid https://bisq.wiki/Compensation#Ensure_your_request_is_valid team:dev https://bisq.wiki/Dev_Team was:accepted Indicates that a compensation request was accepted by DAO voting
Projects
Archived in project
Development

No branches or pull requests

3 participants