feat!: wrap ShareProof in ResultShareProof (#1313)

## Description

This PR wraps the `ShareProof` into a `ResultShareProof` in the API.
However, It doesn't change the custom query response since it's internal
data and there is no need to wrap it.

Closes #1306

(cherry picked from commit c89f6f9)

light/rpc/client.go

@@ -586,7 +586,7 @@ func (c *Client) ProveShares(
 	height uint64,
 	startShare uint64,
 	endShare uint64,
-) (types.ShareProof, error) {
+) (*ctypes.ResultShareProof, error) {
 	res, err := c.next.ProveShares(ctx, height, startShare, endShare)
 	return res, err
 }

rpc/client/http/http.go

@@ -555,18 +555,18 @@ func (c *baseRPCClient) ProveShares(
 	height uint64,
 	startShare uint64,
 	endShare uint64,
-) (types.ShareProof, error) {
-	result := new(types.ShareProof)
+) (*ctypes.ResultShareProof, error) {
+	result := new(ctypes.ResultShareProof)
 	params := map[string]interface{}{
 		"height":     height,
 		"startShare": startShare,
 		"endShare":   endShare,
 	}
 	_, err := c.caller.Call(ctx, "prove_shares", params, result)
 	if err != nil {
-		return types.ShareProof{}, err
+		return nil, err
 	}
-	return *result, nil
+	return result, nil
 }
 
 func (c *baseRPCClient) TxSearch(

rpc/client/interface.go

@@ -83,7 +83,7 @@ type SignClient interface {
 	Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error)
 	Tx(ctx context.Context, hash []byte, prove bool) (*ctypes.ResultTx, error)
 
-	ProveShares(_ context.Context, height uint64, startShare uint64, endShare uint64) (types.ShareProof, error)
+	ProveShares(_ context.Context, height uint64, startShare uint64, endShare uint64) (*ctypes.ResultShareProof, error)
 
 	// TxSearch defines a method to search for a paginated set of transactions by
 	// DeliverTx event search criteria.

rpc/client/local/local.go

@@ -215,7 +215,7 @@ func (c *Local) ProveShares(
 	height uint64,
 	startShare uint64,
 	endShare uint64,
-) (types.ShareProof, error) {
+) (*ctypes.ResultShareProof, error) {
 	return core.ProveShares(c.ctx, int64(height), startShare, endShare)
 }
 

rpc/core/tx.go

@@ -42,10 +42,11 @@ func Tx(ctx *rpctypes.Context, hash []byte, prove bool) (*ctypes.ResultTx, error
 
 	var shareProof types.ShareProof
 	if prove {
-		shareProof, err = proveTx(height, index)
+		proof, err := proveTx(height, index)
 		if err != nil {
 			return nil, err
 		}
+		shareProof = proof.Proof
 	}
 
 	return &ctypes.ResultTx{
@@ -125,10 +126,11 @@ func TxSearch(
 
 		var shareProof types.ShareProof
 		if prove {
-			shareProof, err = proveTx(r.Height, r.Index)
+			proof, err := proveTx(r.Height, r.Index)
 			if err != nil {
 				return nil, err
 			}
+			shareProof = proof.Proof
 		}
 
 		apiResults = append(apiResults, &ctypes.ResultTx{
@@ -144,32 +146,32 @@ func TxSearch(
 	return &ctypes.ResultTxSearch{Txs: apiResults, TotalCount: totalCount}, nil
 }
 
-func proveTx(height int64, index uint32) (types.ShareProof, error) {
+func proveTx(height int64, index uint32) (*ctypes.ResultShareProof, error) {
 	var (
 		pShareProof cmtproto.ShareProof
 		shareProof  types.ShareProof
 	)
 	env := GetEnvironment()
 	rawBlock, err := loadRawBlock(env.BlockStore, height)
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
 	res, err := env.ProxyAppQuery.QuerySync(abcitypes.RequestQuery{
 		Data: rawBlock,
 		Path: fmt.Sprintf(consts.TxInclusionProofQueryPath, index),
 	})
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
 	err = pShareProof.Unmarshal(res.Value)
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
 	shareProof, err = types.ShareProofFromProto(pShareProof)
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
-	return shareProof, nil
+	return &ctypes.ResultShareProof{Proof: shareProof}, nil
 }
 
 // ProveShares creates an NMT proof for a set of shares to a set of rows. It is
@@ -179,37 +181,37 @@ func ProveShares(
 	height int64,
 	startShare uint64,
 	endShare uint64,
-) (types.ShareProof, error) {
+) (*ctypes.ResultShareProof, error) {
 	var (
 		pShareProof cmtproto.ShareProof
 		shareProof  types.ShareProof
 	)
 	env := GetEnvironment()
 	rawBlock, err := loadRawBlock(env.BlockStore, height)
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
 	res, err := env.ProxyAppQuery.QuerySync(abcitypes.RequestQuery{
 		Data: rawBlock,
 		Path: fmt.Sprintf(consts.ShareInclusionProofQueryPath, startShare, endShare),
 	})
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
 	if res.Value == nil && res.Log != "" {
 		// we can make the assumption that for custom queries, if the value is nil
 		// and some logs have been emitted, then an error happened.
-		return types.ShareProof{}, errors.New(res.Log)
+		return nil, errors.New(res.Log)
 	}
 	err = pShareProof.Unmarshal(res.Value)
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
 	shareProof, err = types.ShareProofFromProto(pShareProof)
 	if err != nil {
-		return shareProof, err
+		return nil, err
 	}
-	return shareProof, nil
+	return &ctypes.ResultShareProof{Proof: shareProof}, nil
 }
 
 func loadRawBlock(bs state.BlockStore, height int64) ([]byte, error) {

rpc/core/types/responses.go

@@ -272,3 +272,8 @@ type ResultEvent struct {
 	Data   types.TMEventData   `json:"data"`
 	Events map[string][]string `json:"events"`
 }
+
+// ResultShareProof API proof response of a set of shares
+type ResultShareProof struct {
+	Proof types.ShareProof `json:"proof"`
+}