From 515a2b44ca307271d3edf2b2e4f27b99d8e47fc2 Mon Sep 17 00:00:00 2001 From: chuangjinglu Date: Sat, 25 Jan 2025 12:06:21 +0800 Subject: [PATCH] chore: fix some function names in interface comment Signed-off-by: chuangjinglu --- .changelog/5945.trivial.md | 3 +++ go/consensus/cometbft/api/api.go | 2 +- go/ias/api/api.go | 2 +- go/roothash/api/api.go | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 .changelog/5945.trivial.md diff --git a/.changelog/5945.trivial.md b/.changelog/5945.trivial.md new file mode 100644 index 00000000000..51c70fac39b --- /dev/null +++ b/.changelog/5945.trivial.md @@ -0,0 +1,3 @@ +chore: fix some function names in interface comment + +Fix some function names in interface comment. \ No newline at end of file diff --git a/go/consensus/cometbft/api/api.go b/go/consensus/cometbft/api/api.go index 2e3bdbecfc8..881d4b63f96 100644 --- a/go/consensus/cometbft/api/api.go +++ b/go/consensus/cometbft/api/api.go @@ -211,7 +211,7 @@ type Backend interface { // ABCI multiplexer. SetTransactionAuthHandler(TransactionAuthHandler) error - // GetBlock returns the CometBFT block at the specified height. + // GetCometBFTBlock returns the CometBFT block at the specified height. GetCometBFTBlock(ctx context.Context, height int64) (*cmttypes.Block, error) // GetBlockResults returns the ABCI results from processing a block diff --git a/go/ias/api/api.go b/go/ias/api/api.go index 05a1225f941..a2c314fefa5 100644 --- a/go/ias/api/api.go +++ b/go/ias/api/api.go @@ -15,7 +15,7 @@ type Endpoint interface { // certificate chain respectively. VerifyEvidence(ctx context.Context, evidence *Evidence) (*ias.AVRBundle, error) - // GetSPID returns the SPID and associated info used by the endpoint. + // GetSPIDInfo returns the SPID and associated info used by the endpoint. GetSPIDInfo(ctx context.Context) (*SPIDInfo, error) // GetSigRL returns the Signature Revocation List for a given EPID group. diff --git a/go/roothash/api/api.go b/go/roothash/api/api.go index eaa6019dc63..73539bdc32a 100644 --- a/go/roothash/api/api.go +++ b/go/roothash/api/api.go @@ -121,7 +121,7 @@ type Backend interface { // GetRuntimeState returns the given runtime's state. GetRuntimeState(ctx context.Context, request *RuntimeRequest) (*RuntimeState, error) - // GetPastRoundRoots returns the stored state and I/O roots for the given runtime and round. + // GetRoundRoots returns the stored state and I/O roots for the given runtime and round. GetRoundRoots(ctx context.Context, request *RoundRootsRequest) (*RoundRoots, error) // GetPastRoundRoots returns the stored past state and I/O roots for the given runtime.