[bisq-network/projects] Prepare roll out of API for January or February release (#46)

chimp1984 notifications at github.com
Sun Jan 3 18:52:55 CET 2021


> _This is a Bisq Network project. Please familiarize yourself with the [project management process](https://bisq.wiki/Project_management)._

## Description
Prepare roll out of API for January or February release

## Rationale
API seems to be pretty complete now, so lets prepare the last steps for deployment.

## Criteria for delivery
API usage is sufficiently documented and announced. Protection tools are in place.

## Measures of success
Users are using the API, no major problems.

## Risks
- Scripts could cause heavy load for network if incorrectly used.
- Trade peers can suffer in case of bugs.
- Hidden bugs can be revealed by using the network and protocols in a different manner as from the UI app.
- Security risks if a malicious actor gets access to API users wallet.

## Tasks

#### Protection
- [ ] Add more fields to filter for network wide filtering of certain data
- [ ] Add a flag to the `OfferPayload` to give maker option to not accept API takers
- [ ] API should check for that field and not take such offers
- [ ] Add a flag at offerAvailibility message to show that taker is API user
- [ ] Add "disable API" flag to filter, which would prevent trading with API users

@ghubstan 
Can you add the protection mechanism which are in place from the API side and which are planned but not implemented yet? E.g. protect against endless loops,...

#### Track API usage
- [ ] Add referral ID to offer so we can track how much API is used in offers
- [ ] Maybe show icon in offer book (not sure if that is needed?)
- [ ] Add a field to trade statistics so we can track how much API is used in trades

#### Documentation
- [ ] Add descition about security model (authentication,...) 
- [ ] Add wiki/docs page for overview (maybe @ghubstan can provide basic content and @m52go finalizes it?)

#### Scripts:
- [ ] Add a few simple example scripts for usage. Some use cases for added value what cannot be done in the UI would be good like "create offer if price > x"
- [ ] Find some tech savvy traders who are willing to Beta test and provide input to scripts
- [ ] Find some traders experienced with APIs to provide some sample scripts

## Estimates
I will work on the app related protection tasks. I estimate 2000 USD.
@sqrrm , @ghubstan , @m52go Could you add your estimates as well?

## Notes
@ghubstan @sqrrm @cbeams @ripcurlx @m52go @pazza83 Do you have any further input?

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/projects/issues/46
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20210103/1d15804b/attachment-0001.htm>


More information about the bisq-github mailing list