updates

.github/workflows/go.yml

@@ -22,4 +22,4 @@ jobs:
       run: go build -v ./...
 
     - name: Test
-      run: go test -v -timeout=10s -race ./... 
+      run: go test -v -timeout=10s ./... 

cmd/golem/main.go

@@ -22,15 +22,25 @@ func main() {
 		Short: "an order matching engine in Go",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			motd()
+
+			// create a context
 			ctx := context.Background()
+
+			// setup an accounts manager
 			accts := &accounts.InMemoryManager{}
+
+			// setup channels for wrapping our market
 			in := make(chan orderbook.Order)
 			out := make(chan *orderbook.Match)
 			status := make(chan []orderbook.Order)
 
+			// Run the book
 			go orderbook.Run(ctx, accts, in, out, status)
 
+			// start the server to bolt up to the engine
 			engine := server.NewServer(accts, in, out, status)
+
+			// run the server
 			return engine.Run()
 		},
 	}
@@ -46,16 +56,12 @@ func main() {
 
 func motd() {
 	fmt.Printf(`
-									$$\                         
-									$$ |                        
-				 $$$$$$\   $$$$$$\  $$ | $$$$$$\  $$$$$$\$$$$\  
-				$$  __$$\ $$  __$$\ $$ |$$  __$$\ $$  _$$  _$$\ 
-				$$ /  $$ |$$ /  $$ |$$ |$$$$$$$$ |$$ / $$ / $$ |
-				$$ |  $$ |$$ |  $$ |$$ |$$   ____|$$ | $$ | $$ |
-				\$$$$$$$ |\$$$$$$  |$$ |\$$$$$$$\ $$ | $$ | $$ |
-				 \____$$ | \______/ \__| \_______|\__| \__| \__|
-				$$\   $$ |                                      
-				\$$$$$$  |                                      
-				 \______/                                       
-			`)
+===================================================
+||  ██████   ██████  ██      ███████ ███    ███  ||
+|| ██       ██    ██ ██      ██      ████  ████  ||
+|| ██   ███ ██    ██ ██      █████   ██ ████ ██  ||
+|| ██    ██ ██    ██ ██      ██      ██  ██  ██  ||
+||  ██████   ██████  ███████ ███████ ██      ██  ||
+===================================================
+`)
 }

pkg/orderbook/attempt_fill.go → pkg/orderbook/attempt_fill/attempt_fill.go

@@ -19,6 +19,15 @@ type OpWrite struct {
 	Result chan WriteResult
 }
 
+// FillResult contains the buy and sell order that were
+// matched and filled. FillResult is only created after
+// everything has been committed to state.
+type FillResult struct {
+	Buy    *Order
+	Sell   *Order
+	Filled uint64
+}
+
 // WriteResult is returned as the result of an OpWrite.
 type WriteResult struct {
 	Order Order

pkg/orderbook/orderbook.go

@@ -14,15 +14,6 @@ import (
 
 var delay time.Duration = time.Second * 1
 
-// FillResult contains the buy and sell order that were
-// matched and filled. FillResult is only created after
-// everything has been committed to state.
-type FillResult struct {
-	Buy    *Order
-	Sell   *Order
-	Filled uint64
-}
-
 // Order is a struct for representing a simple order in the books.
 type Order struct {
 	ID        string