From 9cba3e0a7e7edd93707f720743bde70d43d6f658 Mon Sep 17 00:00:00 2001
From: Larry Ruane <larry@electriccoin.co>
Date: Tue, 15 Oct 2024 17:34:50 -0600
Subject: [PATCH] non-functional change - re-run protoc to update comments

This is a follow-on to PR 495, which changed the comments in
service.proto but didn't regenerate service.pb.go. This commits re-runs
protoc so the two are back in sync (but the changes were comments only).
---
 docs/rtd/index.html     | 23 ++++++++++++++++++++---
 walletrpc/service.pb.go | 29 ++++++++++++++++++++++++-----
 2 files changed, 44 insertions(+), 8 deletions(-)

diff --git a/docs/rtd/index.html b/docs/rtd/index.html
index cfd44c36..35bf4bda 100644
--- a/docs/rtd/index.html
+++ b/docs/rtd/index.html
@@ -1564,7 +1564,7 @@ <h3 id="cash.z.wallet.sdk.rpc.PingResponse">PingResponse</h3>
         
       
         <h3 id="cash.z.wallet.sdk.rpc.RawTransaction">RawTransaction</h3>
-        <p>RawTransaction contains the complete transaction data. It also optionally includes </p><p>the block height in which the transaction was included, or, when returned</p><p>by GetMempoolStream(), the latest block height.</p>
+        <p>RawTransaction contains the complete transaction data. It also includes the</p><p>height for the block in which the transaction was included in the main</p><p>chain, if any (as detailed below).</p>
 
         
           <table class="field-table">
@@ -1577,14 +1577,31 @@ <h3 id="cash.z.wallet.sdk.rpc.RawTransaction">RawTransaction</h3>
                   <td>data</td>
                   <td><a href="#bytes">bytes</a></td>
                   <td></td>
-                  <td><p>exact data returned by Zcash &#39;getrawtransaction&#39; </p></td>
+                  <td><p>The serialized representation of the Zcash transaction. </p></td>
                 </tr>
               
                 <tr>
                   <td>height</td>
                   <td><a href="#uint64">uint64</a></td>
                   <td></td>
-                  <td><p>height that the transaction was mined (or -1) </p></td>
+                  <td><p>The height at which the transaction is mined, or a sentinel value.
+
+Due to an error in the original protobuf definition, it is necessary to
+reinterpret the result of the `getrawtransaction` RPC call. Zcashd will
+return the int64 value `-1` for the height of transactions that appear
+in the block index, but which are not mined in the main chain. Here, the
+height field of `RawTransaction` was erroneously created as a `uint64`,
+and as such we must map the response from the zcashd RPC API to be
+representable within this space. Additionally, the `height` field will
+be absent for transactions in the mempool, resulting in the default
+value of `0` being set. Therefore, the meanings of the `height` field of
+the `RawTransaction` type are as follows:
+
+* height 0: the transaction is in the mempool
+* height 0xffffffffffffffff: the transaction has been mined on a fork that
+  is not currently the main chain
+* any other height: the transaction has been mined in the main chain at the
+  given height </p></td>
                 </tr>
               
             </tbody>
diff --git a/walletrpc/service.pb.go b/walletrpc/service.pb.go
index 29799339..b3dc73bc 100644
--- a/walletrpc/service.pb.go
+++ b/walletrpc/service.pb.go
@@ -250,16 +250,35 @@ func (x *TxFilter) GetHash() []byte {
 	return nil
 }
 
-// RawTransaction contains the complete transaction data. It also optionally includes
-// the block height in which the transaction was included, or, when returned
-// by GetMempoolStream(), the latest block height.
+// RawTransaction contains the complete transaction data. It also includes the
+// height for the block in which the transaction was included in the main
+// chain, if any (as detailed below).
 type RawTransaction struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields
 
-	Data   []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`      // exact data returned by Zcash 'getrawtransaction'
-	Height uint64 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"` // height that the transaction was mined (or -1)
+	// The serialized representation of the Zcash transaction.
+	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
+	// The height at which the transaction is mined, or a sentinel value.
+	//
+	// Due to an error in the original protobuf definition, it is necessary to
+	// reinterpret the result of the `getrawtransaction` RPC call. Zcashd will
+	// return the int64 value `-1` for the height of transactions that appear
+	// in the block index, but which are not mined in the main chain. Here, the
+	// height field of `RawTransaction` was erroneously created as a `uint64`,
+	// and as such we must map the response from the zcashd RPC API to be
+	// representable within this space. Additionally, the `height` field will
+	// be absent for transactions in the mempool, resulting in the default
+	// value of `0` being set. Therefore, the meanings of the `height` field of
+	// the `RawTransaction` type are as follows:
+	//
+	//   - height 0: the transaction is in the mempool
+	//   - height 0xffffffffffffffff: the transaction has been mined on a fork that
+	//     is not currently the main chain
+	//   - any other height: the transaction has been mined in the main chain at the
+	//     given height
+	Height uint64 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
 }
 
 func (x *RawTransaction) Reset() {