Documenting objects

Author: gianfelipe93

api/api/api.go

@@ -166,6 +166,7 @@ var mutationType = graphql.NewObject(
 	},
 )
 
+//Start start the API
 func Start() error {
 	http.HandleFunc("/bftx-api", httpHandler(&schema))
 	fmt.Println("Now server is running on: http://localhost:12345")

api/handlers/transactionHandler.go

@@ -26,6 +26,7 @@ import (
 	abciTypes "github.com/tendermint/abci/types"
 )
 
+//TendermintClient object to call function from tendermint
 var TendermintClient abcicli.Client
 
 // ConstructBfTx function to create a BFTX via API

config/config.go

@@ -53,10 +53,12 @@ import (
 	"github.com/blockfreight/go-bftx/lib/pkg/common" // Implements common functions for Blockfreight™
 )
 
+//Config objetc to isolate all the app config in a single object
 type Config struct {
 	BFTX_API_ADDRESS string `json:"bftx-api-address"`
 }
 
+//LoadConfiguration loads the app config into an object
 func LoadConfiguration() (Config, error) {
 	var config Config
 	configFile, err := common.ReadJSON("./config.json")

lib/app/bft/bft.go

@@ -143,6 +143,7 @@ func (app *BftApplication) Commit() types.ResponseCommit {
 	return types.ResponseCommit{Code: code.CodeTypeOK, Data: hash}
 }
 
+//Query retrieves a transaction from the network
 func (app *BftApplication) Query(reqQuery types.RequestQuery) (resQuery types.ResponseQuery) {
 	if reqQuery.Prove {
 		value, proof, err := app.state.GetWithProof(reqQuery.Data)