feat(SPV-879): TOTP example & all examples adjustments (#241)

examples/README.md

@@ -41,6 +41,7 @@ In addition to the above, there are additional examples showing how to use the c
 
 1. `xpriv_from_mnemonic` - allows you to generate/extract an xPriv key from a mnemonic phrase. To you use it you just need to replace the `mnemonic` variable with your own mnemonic phrase.
 2. `xpub_from_xpriv` - allows you to generate an xPub key from an xPriv key. To you use it you just need to replace the `xPriv` variable with your own xPriv key.
+3. `generate_totp` - allows you to generate and check validity of a TOTP code for client xPriv and a contact's PKI
 
 ## How to run an example
 

examples/Taskfile.yml

@@ -61,3 +61,8 @@ tasks:
     cmds:
       - echo "running xpub_from_xpriv..."
       - go run ./xpub_from_xpriv/xpub_from_xpriv.go
+  generate_totp:
+    desc: "running generate_totp..."
+    cmds:
+      - echo "running generate_totp..."
+      - go run ./generate_totp/generate_totp.go

examples/admin_add_user/admin_add_user.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 )
 
 func main() {

examples/admin_remove_user/admin_remove_user.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 )
 
 func main() {

examples/create_transaction/create_transaction.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 )
 
 func main() {
@@ -39,5 +39,4 @@ func main() {
 		os.Exit(1)
 	}
 	fmt.Println("GetTransaction response: ", tx)
-
 }

examples/example_keys.go

@@ -3,18 +3,11 @@ Package examples - key constants to be used in the examples and utility function
 */
 package examples
 
-import (
-	"fmt"
-	"os"
-
-	"github.com/bitcoin-sv/spv-wallet-go-client/xpriv"
-)
-
 const (
 	// ExampleAdminKey - example admin key
 	ExampleAdminKey string = "xprv9s21ZrQH143K3CbJXirfrtpLvhT3Vgusdo8coBritQ3rcS7Jy7sxWhatuxG5h2y1Cqj8FKmPp69536gmjYRpfga2MJdsGyBsnB12E19CESK"
 
-	// you can generate new keys using `task generate-keys`
+	// you can generate new keys using `task generate_keys`
 
 	// ExampleXPriv - example private key
 	ExampleXPriv string = ""
@@ -24,14 +17,3 @@ const (
 	// ExamplePaymail - example Paymail address
 	ExamplePaymail string = ""
 )
-
-// GenerateKeys - function for generating keys (private and public)
-func GenerateKeys() xpriv.KeyWithMnemonic {
-	keys, err := xpriv.Generate()
-	if err != nil {
-		fmt.Println(err)
-		os.Exit(1)
-	}
-
-	return keys
-}

examples/generate_keys/generate_keys.go

@@ -5,12 +5,18 @@ package main
 
 import (
 	"fmt"
+	"os"
 
-	"examples"
+	"github.com/bitcoin-sv/spv-wallet-go-client/xpriv"
 )
 
 func main() {
-	keys := examples.GenerateKeys()
+	keys, err := xpriv.Generate()
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+
 	exampleXPriv := keys.XPriv()
 	exampleXPub := keys.XPub().String()
 

examples/generate_totp/generate_totp.go

@@ -0,0 +1,44 @@
+/*
+Package main - generate_totp example
+*/
+package main
+
+import (
+	"fmt"
+	"os"
+
+	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
+	"github.com/bitcoin-sv/spv-wallet/models"
+)
+
+func main() {
+	defer examples.HandlePanic()
+
+	const server = "http://localhost:3003/v1"
+	const aliceXPriv = "xprv9s21ZrQH143K4JFXqGhBzdrthyNFNuHPaMUwvuo8xvpHwWXprNK7T4JPj1w53S1gojQncyj8JhSh8qouYPZpbocsq934cH5G1t1DRBfgbod"
+	const bobPKI = "03a48e13dc598dce5fda9b14ea13f32d5dbc4e8d8a34447dda84f9f4c457d57fe7"
+	const digits = 4
+	const period = 1200 // 20 minutes
+
+	client := walletclient.NewWithXPriv(server, aliceXPriv)
+
+	mockContact := &models.Contact{
+		PubKey:  bobPKI,
+		Paymail: "[email protected]",
+	}
+
+	totpCode, err := client.GenerateTotpForContact(mockContact, period, digits)
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+	fmt.Println("TOTP code from Alice to Bob: ", totpCode)
+
+	valid, err := client.ValidateTotpForContact(mockContact, totpCode, mockContact.Paymail, period, digits)
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+	fmt.Println("Is TOTP code valid: ", valid)
+}

examples/get_balance/get_balance.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 )
 
 func main() {

examples/handle_exceptions/handle_exceptions.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 )
 
 func main() {
@@ -23,7 +23,6 @@ func main() {
 	ctx := context.Background()
 
 	status, err := client.AdminGetStatus(ctx)
-
 	if err != nil {
 		fmt.Println("Response status: ", err.GetStatusCode())
 		fmt.Println("Content: ", err.Error())

examples/list_transactions/list_transactions.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 	"github.com/bitcoin-sv/spv-wallet/models/filter"
 )
 
@@ -44,5 +44,4 @@ func main() {
 		os.Exit(1)
 	}
 	fmt.Println("Filtered GetTransactions response: ", txsFiltered)
-
 }

examples/send_op_return/send_op_return.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"examples"
 	walletclient "github.com/bitcoin-sv/spv-wallet-go-client"
+	"github.com/bitcoin-sv/spv-wallet-go-client/examples"
 	"github.com/bitcoin-sv/spv-wallet/models"
 )
 

examples/utils.go

@@ -8,12 +8,8 @@ import (
 	"os"
 )
 
-// 'xPriv' | 'xPub' | 'adminKey' | 'Paymail'
-type keyType string
-
-// ErrMessage - function for displaying errors about missing keys (see CheckIfAdminKeyExists, CheckIfXPrivExists)
-func ErrMessage(key keyType) string {
-	return fmt.Sprintf("Please provide a valid %s.", key)
+func printMissingKeyError(key string) {
+	fmt.Printf("Please provide a valid %s. ", key)
 }
 
 // HandlePanic - function used to handle a recovery after a panic - use with defer
@@ -28,23 +24,23 @@ func HandlePanic() {
 // CheckIfXPrivExists - checks if ExampleXPriv is not empty
 func CheckIfXPrivExists() {
 	if ExampleXPriv == "" {
-		fmt.Println(ErrMessage("xPriv"))
+		printMissingKeyError("xPriv")
 		os.Exit(1)
 	}
 }
 
 // CheckIfXPubExists - checks if ExampleXPub is not empty
 func CheckIfXPubExists() {
 	if ExampleXPub == "" {
-		fmt.Println(ErrMessage("xPub"))
+		printMissingKeyError("xPub")
 		os.Exit(1)
 	}
 }
 
 // CheckIfAdminKeyExists - checks if ExampleAdminKey is not empty
 func CheckIfAdminKeyExists() {
 	if ExampleAdminKey == "" {
-		fmt.Println(ErrMessage("adminKey"))
+		printMissingKeyError("adminKey")
 		os.Exit(1)
 	}
 }