add search support

README.md

@@ -15,17 +15,5 @@ Every financial product is made up of different transactions happening concurren
 Blnk gives you, the developer, a starting point to improve how you build, operate and perfectly manage money movement and storage in a reliable, scaleable and secure way.
 
 ## Get Started and Core Features
-- [Install Blnk](https://docs.blnkserver.xyz)
-- [Managing ledgers](https://docs.blnkserver.xyz/ledger/get-started)
-- [Managing balances](https://docs.blnkserver.xyz/balance/get-started)
-- [Balance monitoring](https://docs.blnkserver.xyz/balance/monitoring)
-- [Accounts](https://docs.blnkserver.xyz/account/get-started)
-- [External account generation](https://docs.blnkserver.xyz/account/external-generation)
-- [Queuing transactions](https://docs.blnkserver.xyz/transaction/queuing-transactions)
-- [Scheduling transactions](https://docs.blnkserver.xyz/transaction/scheduling-transactions)
-- [Fraud detection](https://docs.blnkserver.xyz/fraud)
-- [Notifications and webhooks](https://docs.blnkserver.xyz/notifications)
-- [More Controls and configurations](https://docs.blnkserver.xyz/config)
-- [API Reference](https://docs.blnkserver.xyz/misc/create-ledger)
-
+- [Documentation](https://docs.blnkserver.xyz)
 

api/api.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"fmt"
+	"net/http"
 
 	"github.com/jerry-enebeli/blnk/config"
 
@@ -49,6 +50,8 @@ func (a Api) Router() *gin.Engine {
 
 	router.GET("/backup", a.BackupDB)
 	router.GET("/backup-s3", a.BackupDBS3)
+
+	router.POST("/search/:collection", a.Search)
 	return a.router
 }
 
@@ -66,7 +69,6 @@ func NewAPI(b *blnk.Blnk) *Api {
 	r.GET("/", func(c *gin.Context) {
 		c.JSON(200, "server running...")
 	})
-
 	r.POST("/webhook", func(c *gin.Context) {
 		var payload map[string]interface{}
 		err := c.Bind(&payload)
@@ -78,3 +80,24 @@ func NewAPI(b *blnk.Blnk) *Api {
 
 	return &Api{blnk: b, router: r}
 }
+
+func (a Api) Search(c *gin.Context) {
+	collection, passed := c.Params.Get("collection")
+	if !passed {
+		c.JSON(http.StatusBadRequest, gin.H{"error": "collection is required. pass id in the route /:collection"})
+		return
+	}
+
+	var query map[string]interface{}
+
+	c.BindJSON(&query)
+
+	resp, err := a.blnk.Search(collection, query)
+
+	if err != nil {
+		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
+		return
+	}
+
+	c.JSON(http.StatusCreated, resp)
+}

blnk.go

@@ -1,6 +1,7 @@
 package blnk
 
 import (
+	"context"
 	"embed"
 	"fmt"
 
@@ -37,7 +38,11 @@ func NewBlnk(db database.IDataSource) (*Blnk, error) {
 	}
 	bt := NewBalanceTracker()
 	newQueue := NewQueue(configuration)
-	newSearch := NewTypesenseClient("", []string{""})
+	newSearch := NewTypesenseClient("blnk-api-key", []string{"http://typesense:8108"})
 	newBlnk := &Blnk{datasource: db, bt: bt, queue: newQueue, redis: redis.Client(), search: newSearch}
 	return newBlnk, nil
 }
+
+func (b Blnk) Search(collection string, query map[string]interface{}) (interface{}, error) {
+	return b.search.Search(context.Background(), collection, query)
+}

docker-compose.dev.yaml

@@ -57,7 +57,7 @@ services:
 
   typesense:
     image: typesense/typesense:0.23.1 # Use the latest version suitable for your needs
-    command: ["--data-dir", "/data", "--api-key=your_typesense_api_key", "--listen-port", "8108"]
+    command: ["--data-dir", "/data", "--api-key=blnk-api-key", "--listen-port", "8108"]
     volumes:
       - typesense_data:/data
     ports:

docs/blnk-api.json

@@ -106,7 +106,6 @@
     },
     "/balances": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Create Balance",
         "operationId": "CreateBalance",
         "parameters": [],
@@ -204,7 +203,6 @@
     },
     "/transactions": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Record Transaction",
         "operationId": "RecordTransaction",
         "parameters": [],
@@ -388,7 +386,6 @@
     },
     "/transactions/inflight/{txID}/{status}": {
       "put": {
-        "tags": ["Misc"],
         "summary": "Update Inflight Transaction",
         "operationId": "UpdateInflightTransaction",
         "parameters": [
@@ -492,7 +489,6 @@
     },
     "/refund-transaction/{id}": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Refund Transaction",
         "operationId": "RefundTransaction",
         "parameters": [
@@ -607,7 +603,6 @@
     },
     "/balance-monitors": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Create Balance Monitor",
         "operationId": "CreateBalanceMonitor",
         "parameters": [],
@@ -715,7 +710,6 @@
     },
     "/identities": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Create Identity",
         "operationId": "CreateIdentity",
         "parameters": [],
@@ -859,7 +853,6 @@
     },
     "/accounts": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Create Account",
         "operationId": "CreateAccount",
         "parameters": [],
@@ -967,7 +960,6 @@
     },
     "/identities/{id}": {
       "put": {
-        "tags": ["Misc"],
         "summary": "Update Identity",
         "operationId": "UpdateIdentity",
         "parameters": [
@@ -1091,7 +1083,6 @@
         "deprecated": false
       },
       "get": {
-        "tags": ["Misc"],
         "summary": "Get Identity",
         "operationId": "GetIdentity",
         "parameters": [
@@ -1200,7 +1191,6 @@
     },
     "/accounts/{id}": {
       "put": {
-        "tags": ["Misc"],
         "summary": "Update Account",
         "operationId": "UpdateAccount",
         "parameters": [
@@ -1317,7 +1307,6 @@
         "deprecated": false
       },
       "get": {
-        "tags": ["Misc"],
         "summary": "Get Account",
         "operationId": "GetAccount",
         "parameters": [
@@ -1496,7 +1485,6 @@
     },
     "/balance-monitors/{id}": {
       "put": {
-        "tags": ["Misc"],
         "summary": "Update Balance Monitor",
         "operationId": "UpdateBalanceMonitor",
         "parameters": [
@@ -1554,7 +1542,6 @@
         "deprecated": false
       },
       "get": {
-        "tags": ["Misc"],
         "summary": "Get Balance Monitor",
         "operationId": "GetBalanceMonitor",
         "parameters": [
@@ -1639,7 +1626,6 @@
     },
     "/backup": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Back DB",
         "operationId": "BackDB",
         "parameters": [],
@@ -1736,7 +1722,6 @@
     },
     "/backup/s3": {
       "post": {
-        "tags": ["Misc"],
         "summary": "Back DB To S3",
         "operationId": "BackDBToS3",
         "parameters": [],
@@ -1833,7 +1818,6 @@
     },
     "/ledgers/{id}": {
       "get": {
-        "tags": ["Misc"],
         "summary": "Get Ledger",
         "operationId": "GetLedger",
         "parameters": [
@@ -1904,7 +1888,6 @@
     },
     "/balances/{id}": {
       "get": {
-        "tags": ["Misc"],
         "summary": "Get Balance",
         "operationId": "GetBalance",
         "parameters": [

model/transaction.go

@@ -24,7 +24,7 @@ type Transaction struct {
 	Destination       string                 `json:"destination,omitempty"`
 	Reference         string                 `json:"reference"`
 	Currency          string                 `json:"currency"`
-	Description       string                 `json:"description"`
+	Description       string                 `json:"description",omitempty`
 	Status            string                 `json:"status"`
 	Hash              string                 `json:"hash"`
 	GroupIds          []string               `json:"group_ids"`

transaction.go

@@ -186,6 +186,7 @@ func (l Blnk) RecordTransaction(ctx context.Context, transaction *model.Transact
 		logrus.Errorf("ERROR saying transaction to db. %s", err)
 	}
 
+	l.search.IndexDocument(context.Background(), "transactions", transaction)
 	err = SendWebhook(NewWebhook{
 		Event:   "transaction.applied",
 		Payload: transaction,
@@ -230,9 +231,13 @@ func (l Blnk) CommitInflightTransaction(ctx context.Context, transactionID strin
 		return nil, err
 	}
 
+	if amount == 0 {
+		amount = transaction.Amount
+	}
+
 	// Commit inflight balances
-	sourceBalance.CommitInflightDebit(transaction.Amount)       // For the source
-	destinationBalance.CommitInflightCredit(transaction.Amount) // For the destination
+	sourceBalance.CommitInflightDebit(amount)       // For the source
+	destinationBalance.CommitInflightCredit(amount) // For the destination
 
 	// Update balances in the database
 	if err = l.updateBalances(ctx, sourceBalance, destinationBalance); err != nil {
@@ -242,6 +247,8 @@ func (l Blnk) CommitInflightTransaction(ctx context.Context, transactionID strin
 	// create a new transaction with status applied
 	transaction.Status = StatusApplied
 	transaction.TransactionID = model.GenerateUUIDWithSuffix("txn")
+	transaction.Reference = model.GenerateUUIDWithSuffix("ref")
+	transaction.Hash = transaction.HashTxn()
 	transaction, err = l.datasource.RecordTransaction(cxt, transaction)
 	if err != nil {
 		return nil, logAndRecordError(span, "saving transaction to db error", err)