From 825e4fd1196cd9490a18b5ebf35c2cb13d5be36d Mon Sep 17 00:00:00 2001 From: Han Tuzun Date: Mon, 4 Sep 2023 16:29:37 +0300 Subject: [PATCH] Add the initial development plan --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index cde6de8..3fc46b5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # ordivote-api The backend API for Ordivote + +## Specifications +Provide an API endpoint for a given BRC-20 and block height. + +Develop with multiple BRC-20 tokens in mind, but we will initially use this project for a single token. + +## Development Plan + +This project could consist of the following steps: + +* [ ] Set up a Planetscale database. +* [ ] Save all the BRC-20 transfers to our database from the BiS [Get BRC-20 Activity](https://docs.bestinslot.xyz/reference/api-reference/ordinals-and-brc-20-v3-api/brc-20#get-brc-20-activity) endpoint. + * Using this endpoint with `last_new_satpoint` would be better. +* [ ] Create the `GET /v1/snapshot?ticker=ABCD&block=15271002` endpoint. + * The response could be a sorted array of objects with `address` and `balance`. +* [ ] Add support for the bitcoin testnet.