<p></p>
<blockquote>
<p><em>This is a Bisq Network project. Please familiarize yourself with the <a href="https://bisq.wiki/Project_management" rel="nofollow">project management process</a>.</em></p>
</blockquote>
<h2>Description</h2>
<p>Prepare roll out of API for January or February release</p>
<h2>Rationale</h2>
<p>API seems to be pretty complete now, so lets prepare the last steps for deployment.</p>
<h2>Criteria for delivery</h2>
<p>API usage is sufficiently documented and announced. Protection tools are in place.</p>
<h2>Measures of success</h2>
<p>Users are using the API, no major problems.</p>
<h2>Risks</h2>
<ul>
<li>Scripts could cause heavy load for network if incorrectly used.</li>
<li>Trade peers can suffer in case of bugs.</li>
<li>Hidden bugs can be revealed by using the network and protocols in a different manner as from the UI app.</li>
<li>Security risks if a malicious actor gets access to API users wallet.</li>
</ul>
<h2>Tasks</h2>
<h4>Protection</h4>
<ul class="contains-task-list">
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add more fields to filter for network wide filtering of certain data</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add a flag to the <code>OfferPayload</code> to give maker option to not accept API takers</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> API should check for that field and not take such offers</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add a flag at offerAvailibility message to show that taker is API user</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add "disable API" flag to filter, which would prevent trading with API users</li>
</ul>
<p><a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/ghubstan/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/ghubstan">@ghubstan</a><br>
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,...</p>
<h4>Track API usage</h4>
<ul class="contains-task-list">
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add referral ID to offer so we can track how much API is used in offers</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Maybe show icon in offer book (not sure if that is needed?)</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add a field to trade statistics so we can track how much API is used in trades</li>
</ul>
<h4>Documentation</h4>
<ul class="contains-task-list">
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add descition about security model (authentication,...)</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Add wiki/docs page for overview (maybe <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/ghubstan/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/ghubstan">@ghubstan</a> can provide basic content and <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/m52go/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/m52go">@m52go</a> finalizes it?)</li>
</ul>
<h4>Scripts:</h4>
<ul class="contains-task-list">
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> 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"</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Find some tech savvy traders who are willing to Beta test and provide input to scripts</li>
<li class="task-list-item"><input type="checkbox" id="" disabled="" class="task-list-item-checkbox"> Find some traders experienced with APIs to provide some sample scripts</li>
</ul>
<h2>Estimates</h2>
<p>I will work on the app related protection tasks. I estimate 2000 USD.<br>
<a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/sqrrm/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/sqrrm">@sqrrm</a> , <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/ghubstan/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/ghubstan">@ghubstan</a> , <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/m52go/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/m52go">@m52go</a> Could you add your estimates as well?</p>
<h2>Notes</h2>
<p><a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/ghubstan/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/ghubstan">@ghubstan</a> <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/sqrrm/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/sqrrm">@sqrrm</a> <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/cbeams/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/cbeams">@cbeams</a> <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/ripcurlx/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/ripcurlx">@ripcurlx</a> <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/m52go/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/m52go">@m52go</a> <a class="user-mention" data-hovercard-type="user" data-hovercard-url="/users/pazza83/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/pazza83">@pazza83</a> Do you have any further input?</p>

<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br />You are receiving this because you are subscribed to this thread.<br />Reply to this email directly, <a href="https://github.com/bisq-network/projects/issues/46">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AJFFTNQJQCP3QJB7NIVAB7LSYCVHPANCNFSM4VSBU6HQ">unsubscribe</a>.<img src="https://github.com/notifications/beacon/AJFFTNQRDM7SICNZCNYZBD3SYCVHPA5CNFSM4VSBU6H2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4LS2RMDA.gif" height="1" width="1" alt="" /></p>
<script type="application/ld+json">[
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"potentialAction": {
"@type": "ViewAction",
"target": "https://github.com/bisq-network/projects/issues/46",
"url": "https://github.com/bisq-network/projects/issues/46",
"name": "View Issue"
},
"description": "View this Issue on GitHub",
"publisher": {
"@type": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
}
]</script>