experiment with word-based representation of base32 addresses for human-to-human transmission

Makefile

@@ -18,6 +18,8 @@ USR := usr/
 LOCAL := local/
 VERSION := 0.1
 
+GO111MODULE=on
+
 echo:
 	@echo "$(GOPATH)"
 	find . -path ./.go -prune -o -name "*.go" -exec gofmt -w {} \;

interface/interface.go

@@ -5,19 +5,26 @@ import (
 )
 
 type SAMTunnel interface {
-	GetType() string
+
-	Cleanup()
+	// Tunnel Options
-	Print() string
+	GetType() string             // Get the type of the tunnel in use(server, client, http, udp, etc)
-	Props() map[string]string
+	Print() string               // Print all the tunnel options as a string
-	Search(search string) string
+	Props() map[string]string    //Get a full list of tunnel properties as a map for user display/analysis
-	Target() string
+	Search(search string) string //Search the Props for a common term
-	ID() string
+	Target() string              //The address of the local client or service to forward with a SAM tunnel
+	ID() string                  //The user-chosen tunnel ID
 	//Destination() string
-	Base32() string
+
-	Base64() string
+	// Key handling
-	Keys() i2pkeys.I2PKeys
+	Base32() string         // Get the .b32.i2p address of your service
-	Serve() error
+	Base32Readable() string // Create a more-readable representation of the .b32.i2p address using English words
-	Close() error
+	Base64() string         // Get the public base64 address of your I2P service
-	Up() bool
+	Keys() i2pkeys.I2PKeys  // Get all the parts of the keys to your I2P service
-	Load() (SAMTunnel, error)
+
+	// Service Management
+	Load() (SAMTunnel, error) // Prepare tunnel keys and tunnel options
+	Serve() error             // Start the tunnel
+	Close() error             // Stop the tunnel and close all connections
+	Cleanup()                 // Stop the tunnel but leave the sockets alone for now
+	Up() bool                 // Return "true" if the tunnel is ready to go up.
 }