feat(BUX-184): add admin/paymail/get endpoint

bitcoin-sv · Oct 10, 2023 · f3f3698 · f3f3698
1 parent 29e977c
commit f3f3698
Show file tree

Hide file tree

Showing 5 changed files with 187 additions and 2 deletions.
diff --git a/actions/admin/paymail_addresses.go b/actions/admin/paymail_addresses.go
@@ -10,6 +10,36 @@ import (
 	apirouter "github.com/mrz1836/go-api-router"
 )
 
+// paymailGetAddress will return a paymail address
+// Get Paymail godoc
+// @Summary		Get paymail
+// @Description	Get paymail
+// @Tags		Admin
+// @Param		address query string true "address"
+// @Produce		json
+// @Success		200
+// @Router		/v1/admin/paymail/get [get]
+// @Security	bux-auth-xpub
+func (a *Action) paymailGetAddress(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
+	params := apirouter.GetParams(req)
+	address := params.GetString("address")
+
+	if address == "" {
+		apirouter.ReturnResponse(w, req, http.StatusExpectationFailed, "address is required")
+		return
+	}
+
+	opts := a.Services.Bux.DefaultModelOptions()
+
+	paymailAddress, err := a.Services.Bux.GetPaymailAddress(req.Context(), address, opts...)
+	if err != nil {
+		apirouter.ReturnResponse(w, req, http.StatusExpectationFailed, err.Error())
+		return
+	}
+
+	apirouter.ReturnResponse(w, req, http.StatusOK, paymailAddress)
+}
+
 // paymailAddressesSearch will fetch a list of paymail addresses filtered by metadata
 // Paymail addresses search by metadata godoc
 // @Summary		Paymail addresses search

diff --git a/actions/admin/routes.go b/actions/admin/routes.go
@@ -29,6 +29,7 @@ func RegisterRoutes(router *apirouter.Router, appConfig *config.AppConfig, servi
 	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/block-headers/count", action.Request(router, require.Wrap(action.blockHeadersCount)))
 	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/destinations/search", action.Request(router, require.Wrap(action.destinationsSearch)))
 	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/destinations/count", action.Request(router, require.Wrap(action.destinationsCount)))
+	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/paymail/get", action.Request(router, require.Wrap(action.paymailGetAddress)))
 	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/paymails/search", action.Request(router, require.Wrap(action.paymailAddressesSearch)))
 	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/paymails/count", action.Request(router, require.Wrap(action.paymailAddressesCount)))
 	router.HTTPRouter.POST("/"+config.CurrentMajorVersion+"/admin/paymail/create", action.Request(router, require.Wrap(action.paymailCreateAddress)))

diff --git a/docs/docs.go b/docs/docs.go
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -565,6 +565,37 @@
                 }
             }
         },
+        "/v1/admin/paymail/get": {
+            "get": {
+                "security": [
+                    {
+                        "bux-auth-xpub": []
+                    }
+                ],
+                "description": "Get paymail",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Admin"
+                ],
+                "summary": "Get paymail",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "address",
+                        "name": "address",
+                        "in": "query",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            }
+        },
         "/v1/admin/paymails/count": {
             "post": {
                 "security": [
@@ -1712,6 +1743,33 @@
                 }
             }
         },
+        "/v1/utxo/unreserve": {
+            "patch": {
+                "security": [
+                    {
+                        "bux-auth-xpub": []
+                    }
+                ],
+                "description": "Unreserve UTXOs",
+                "tags": [
+                    "UTXO"
+                ],
+                "summary": "Unreserve UTXOs",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "draft tx id",
+                        "name": "reference_id",
+                        "in": "query"
+                    }
+                ],
+                "responses": {
+                    "201": {
+                        "description": "Created"
+                    }
+                }
+            }
+        },
         "/v1/xpub": {
             "get": {
                 "security": [
@@ -1813,4 +1871,4 @@
             "in": "header"
         }
     }
-}
+}
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -352,6 +352,25 @@ paths:
       summary: Delete paymail
       tags:
       - Admin
+  /v1/admin/paymail/get:
+    get:
+      description: Get paymail
+      parameters:
+      - description: address
+        in: query
+        name: address
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+      security:
+      - bux-auth-xpub: []
+      summary: Get paymail
+      tags:
+      - Admin
   /v1/admin/paymails/count:
     post:
       description: Paymail addresses count
@@ -1069,6 +1088,22 @@ paths:
       summary: Search UTXO
       tags:
       - UTXO
+  /v1/utxo/unreserve:
+    patch:
+      description: Unreserve UTXOs
+      parameters:
+      - description: draft tx id
+        in: query
+        name: reference_id
+        type: string
+      responses:
+        "201":
+          description: Created
+      security:
+      - bux-auth-xpub: []
+      summary: Unreserve UTXOs
+      tags:
+      - UTXO
   /v1/xpub:
     get:
       description: Get xPub