Improve documentation

bindings/ndf.go

@@ -22,10 +22,9 @@ import (
 // ndfUrl is a hardcoded url to a bucket containing the signed NDF message.
 const ndfUrl = `elixxir.io`
 
-
 // DownloadSignedNdf retrieves the NDF from a hardcoded bucket URL.
 // The NDF returned requires further processing and verification
-// before being used. Use VerifySignedNdf to properly process
+// before being used. Use ProcessSignedNdf to properly process
 // the downloaded data returned.
 // DO NOT USE THE RETURNED DATA TO START A CLIENT.
 func DownloadSignedNdf() ([]byte, error) {
@@ -49,10 +48,10 @@ func DownloadSignedNdf() ([]byte, error) {
 
 // DownloadSignedNdfWithUrl retrieves the NDF from a specified URL.
 // The NDF returned requires further processing and verification
-// before being used. Use VerifySignedNdf to properly process
+// before being used. Use ProcessSignedNdf to properly process
 // the downloaded data returned.
 // DO NOT USE THE RETURNED DATA TO START A CLIENT.
-func DownloadSignedNdfWithUrl(url, cert string) ([]byte, error) {
+func DownloadSignedNdfWithUrl(url string) ([]byte, error) {
 	// Build a reqeust for the file
 	resp, err := http.Get(url)
 	if err != nil {
@@ -71,13 +70,13 @@ func DownloadSignedNdfWithUrl(url, cert string) ([]byte, error) {
 	return signedNdfEncoded, nil
 }
 
-// VerifySignedNdf takes the downloaded NDF from either
+// ProcessSignedNdf takes the downloaded NDF from either
 // DownloadSignedNdf or DownloadSignedNdfWithUrl (signedNdfEncoded)
-// an the scheduling certificate (cert). The downloaded NDF is parsed
+// and the scheduling certificate (cert). The downloaded NDF is parsed
 // into a protobuf containing a signature. The signature is verified using the
 // passed in cert. Upon successful parsing and verification, the NDF is
-// returned. This may be used to start a client.
-func VerifySignedNdf(signedNdfEncoded []byte, cert string) ([]byte, error) {
+// returned as byte data, which may be used to start a client.
+func ProcessSignedNdf(signedNdfEncoded []byte, cert string) ([]byte, error) {
 	// Base64 decode the signed NDF
 	signedNdfMarshaled, err := base64.StdEncoding.DecodeString(
 		string(signedNdfEncoded))
@@ -93,7 +92,6 @@ func VerifySignedNdf(signedNdfEncoded []byte, cert string) ([]byte, error) {
 			"signed NDF into protobuf")
 	}
 
-
 	// Load the certificate from it's PEM contents
 	schedulingCert, err := tls.LoadCertificate(cert)
 	if err != nil {
@@ -114,4 +112,3 @@ func VerifySignedNdf(signedNdfEncoded []byte, cert string) ([]byte, error) {
 
 	return signedNdfMsg.Ndf, nil
 }
-