feat: Add support for vm/qdoc

Signed-off-by: Jeff Thompson <[email protected]>

Author: jefft0

docs/reference/rpc-endpoints.md

@@ -459,6 +459,7 @@ Call with the `/abci_query` to get information via the ABCI Query.
 | `bank/balances/{ADDRESS}` | Returns the balance information about the account.                 |
 | `vm/qfuncs`               | Returns public facing function signatures as JSON.                 |
 | `vm/qfile`                | Returns the file bytes, or list of files if directory.             |
+| `vm/qdoc`                 | Returns the doc of a symbol, or list of symbols if a package.      |
 | `vm/qrender`              | Calls `.Render(<path>)` in readonly mode.                          |
 | `vm/qeval`                | Evaluates any expression in readonly mode and returns the results. |
 | `vm/store`                | (not yet supported) Fetches items from the store.                  |

gno.land/pkg/sdk/vm/handler.go

@@ -74,6 +74,7 @@ const (
 	QueryFuncs   = "qfuncs"
 	QueryEval    = "qeval"
 	QueryFile    = "qfile"
+	QueryDoc     = "qdoc"
 )
 
 func (vh vmHandler) Query(ctx sdk.Context, req abci.RequestQuery) abci.ResponseQuery {
@@ -95,6 +96,8 @@ func (vh vmHandler) Query(ctx sdk.Context, req abci.RequestQuery) abci.ResponseQ
 		res = vh.queryEval(ctx, req)
 	case QueryFile:
 		res = vh.queryFile(ctx, req)
+	case QueryDoc:
+		res = vh.queryDoc(ctx, req)
 	default:
 		return sdk.ABCIResponseQueryFromError(
 			std.ErrUnknownRequest(fmt.Sprintf(
@@ -197,6 +200,20 @@ func (vh vmHandler) queryFile(ctx sdk.Context, req abci.RequestQuery) (res abci.
 	return
 }
 
+// queryDoc returns the file bytes, or list of files if directory.
+// if file, res.Value is []byte("file").
+// if dir, res.Value is []byte("dir").
+func (vh vmHandler) queryDoc(ctx sdk.Context, req abci.RequestQuery) (res abci.ResponseQuery) {
+	filepath := string(req.Data)
+	result, err := vh.vm.QueryDoc(ctx, filepath)
+	if err != nil {
+		res = sdk.ABCIResponseQueryFromError(err)
+		return
+	}
+	res.Data = []byte(result)
+	return
+}
+
 // ----------------------------------------
 // misc
 

gno.land/pkg/sdk/vm/keeper.go

@@ -16,6 +16,7 @@ import (
 	"time"
 
 	"github.com/gnolang/gno/gnovm"
+	"github.com/gnolang/gno/gnovm/pkg/doc"
 	gno "github.com/gnolang/gno/gnovm/pkg/gnolang"
 	"github.com/gnolang/gno/gnovm/stdlibs"
 	"github.com/gnolang/gno/tm2/pkg/crypto"
@@ -843,6 +844,31 @@ func (vm *VMKeeper) QueryFile(ctx sdk.Context, filepath string) (res string, err
 	}
 }
 
+var rePkgPathAndSymbol = regexp.MustCompile(`^(.+)\.([a-zA-Z0-9_]+)$`)
+
+func (vm *VMKeeper) QueryDoc(ctx sdk.Context, input string) (res string, err error) {
+	store := vm.newGnoTransactionStore(ctx) // throwaway (never committed)
+	pkgPath := input
+	symbol := ""
+	match := rePkgPathAndSymbol.FindStringSubmatch(input)
+	if len(match) == 3 {
+		// The input is <pkgpath>[.<symbol>
+		pkgPath = match[1]
+		symbol = match[2]
+	}
+
+	memPkg := store.GetMemPackage(pkgPath)
+	doc, err := doc.NewDocumentableFromMemPkg(memPkg, true, symbol, "")
+	if err != nil {
+		return "", err
+	}
+	buf := &bytes.Buffer{}
+	if err = doc.WriteDocumentation(buf, nil); err != nil {
+		return "", err
+	}
+	return buf.String(), nil
+}
+
 // logTelemetry logs the VM processing telemetry
 func logTelemetry(
 	gasUsed int64,