moved jsclient to the hidden .jsclient, removed yarn-error.log, added…

… some documentation
Argus-Labs · Aug 14, 2023 · 7b24f1d · 7b24f1d
1 parent 8e7efa5
commit 7b24f1d
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 41 deletions.
diff --git a/.gitignore b/.gitignore
@@ -114,5 +114,6 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# Node modules
-/jsclient/node_modules
+# Node
+/.jsclient/node_modules
+yarn-error.log
diff --git a/jsclient/README.md → .jsclient/README.md b/jsclient/README.md → .jsclient/README.md
diff --git a/jsclient/main.mjs → .jsclient/main.mjs b/jsclient/main.mjs → .jsclient/main.mjs
diff --git a/jsclient/package-lock.json → .jsclient/package-lock.json b/jsclient/package-lock.json → .jsclient/package-lock.json
diff --git a/jsclient/package.json → .jsclient/package.json b/jsclient/package.json → .jsclient/package.json
diff --git a/jsclient/yarn.lock → .jsclient/yarn.lock b/jsclient/yarn.lock → .jsclient/yarn.lock
diff --git a/jsclient/yarn-error.log b/jsclient/yarn-error.log
diff --git a/nakama/dispatcher.go b/nakama/dispatcher.go
@@ -101,10 +101,12 @@ func (r *receiptsDispatcher) streamBatchOfReceipts(log runtime.Logger, startTick
 }
 
 func (r *receiptsDispatcher) getBatchOfReceiptsFromCardinal(startTick uint64) (reply *TransactionReceiptsReply, err error) {
-	body := map[string]any{
-		"start_tick": startTick,
+	txReceiptRequest := struct {
+		StartTick uint64 `json:"start_tick"`
+	}{
+		StartTick: startTick,
 	}
-	buf, err := json.Marshal(body)
+	buf, err := json.Marshal(txReceiptRequest)
 	if err != nil {
 		return nil, err
 	}

diff --git a/nakama/match.go b/nakama/match.go
@@ -1,3 +1,8 @@
+// match.go defines a struct that implements Nakama's runtime.Match interface.
+// Matches are used to broadcast Cardinal data to connected clients. A client is 'connected' if they
+// are in a Nakama match.
+// See https://heroiclabs.com/docs/nakama/client-libraries/index.html for information on using Nakama client
+// libraries to join matches and consume broadcasted messages.
 package main
 
 import (
@@ -10,6 +15,8 @@ import (
 
 type ReceiptMatch struct{}
 
+var _ runtime.Match = &ReceiptMatch{}
+
 type ReceiptMatchState struct {
 	chanID         string
 	receiptsToSend receiptChan