ergoplatform/ergo

Wallet API and Exchange Integration Documentation

Open

#878 opened on Aug 18, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Scala (201 forks)github user discovery
A-docsB-200 Ergbountyhelp wanted

Repository metrics

Stars
 (519 stars)
PR merge metrics
 (Avg merge 12d 5h) (13 merged PRs in 30d)

Description

By combining these articles

https://github.com/ergoplatform/ergo/wiki/Ergo-REST-API https://ergoplatform.org/en/blog/2019_06_04_wallet-documentation/ https://ergoplatform.org/en/blog/2019_07_03_mining_withdrawal/

and adding new material, make a comprehensive wallet API documentation, which also covers an example exchange integration workflow.

Contributor guide

Research direction
Read the three linked articles and the existing Ergo REST API documentation. Understand the wallet API endpoints, then draft a comprehensive wallet API documentation that covers all aspects including exchange integration workflow. Consider adding examples and addressing any gaps.
Tech stack
scalarest api
Domain
backendblockchain
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60