From 0ba8accb6708065b7114a955c88968b3893331fb Mon Sep 17 00:00:00 2001 From: joshemb <josh@elixxir.io> Date: Thu, 28 Jul 2022 11:57:05 -0700 Subject: [PATCH] Specify what's returned in DownloadNdfFromGateway docstring --- xxdk/ndf.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/xxdk/ndf.go b/xxdk/ndf.go index 01de46358..861fea406 100644 --- a/xxdk/ndf.go +++ b/xxdk/ndf.go @@ -26,6 +26,8 @@ import ( // DownloadNdfFromGateway will download an NDF from a gateway on the cMix network. // It will take the given address and certificate and send a request to a gateway // for an NDF over HTTP/2 using the xx network's gRPC implementation. +// This returns a gRPC protobuf message which contains the NDF in the +// PartialNDF field of the pb.GatewayPollResponse. func DownloadNdfFromGateway(address string, cert []byte) ( *pb.GatewayPollResponse, error) { // Establish parameters for gRPC -- GitLab