feat: add the api for querying next account number (backport #1011) (#…

…1026) * feat: add the api for querying next account number (#1011) * feat: add `NextAccountNumber` query api in cosmos.auth.v1beta1.query proto * feat: implement query account number in x/auth module * chore: update changelog. * fix: line error * fix: proto function typo (cherry picked from commit 94b5a52) * chore: update changelog * Update CHANGELOG.md Co-authored-by: Youngtaek Yoon <noreply@yoon.anonaddy.me> --------- Co-authored-by: Youngtaek Yoon <noreply@yoon.anonaddy.me>
Finschia · Jun 8, 2023 · 92d75cf · 92d75cf
1 parent 154d1aa
commit 92d75cf
Show file tree

Hide file tree

Showing 11 changed files with 799 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Features
 * (server/grpc) [\#1018](https://github.com/Finschia/finschia-sdk/pull/1018) support custom r/w gRPC options (backport #1017)
+* (x/auth) [\#1026](https://github.com/Finschia/finschia-sdk/pull/1026) add the api for querying next account number (backport #1011)
 
 ### Improvements
 

diff --git a/client/docs/statik/statik.go b/client/docs/statik/statik.go
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
@@ -1228,6 +1228,219 @@ paths:
           type: string
       tags:
         - Query
+  /cosmos/auth/v1beta1/next_account_number:
+    get:
+      summary: |-
+        NextAccountNumber queries the global account number.
+        Please be careful use this rpc. This rpc can be disappear whenever.
+        And backward compatibility is not guaranteed.
+      operationId: NextAccountNumber
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            type: object
+            properties:
+              next_account_number:
+                type: string
+                format: uint64
+                description: >-
+                  The next account number is the next value of global account
+                  number.
+            description: >-
+              QueryNextAccountNumberResponse is the response for the
+              Query/NextAccountNumber.
+        default:
+          description: An unexpected error response
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+              code:
+                type: integer
+                format: int32
+              message:
+                type: string
+              details:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    type_url:
+                      type: string
+                      description: >-
+                        A URL/resource name that uniquely identifies the type of
+                        the serialized
+
+                        protocol buffer message. This string must contain at
+                        least
+
+                        one "/" character. The last segment of the URL's path
+                        must represent
+
+                        the fully qualified name of the type (as in
+
+                        `path/google.protobuf.Duration`). The name should be in
+                        a canonical form
+
+                        (e.g., leading "." is not accepted).
+
+
+                        In practice, teams usually precompile into the binary
+                        all types that they
+
+                        expect it to use in the context of Any. However, for
+                        URLs which use the
+
+                        scheme `http`, `https`, or no scheme, one can optionally
+                        set up a type
+
+                        server that maps type URLs to message definitions as
+                        follows:
+
+
+                        * If no scheme is provided, `https` is assumed.
+
+                        * An HTTP GET on the URL must yield a
+                        [google.protobuf.Type][]
+                          value in binary format, or produce an error.
+                        * Applications are allowed to cache lookup results based
+                        on the
+                          URL, or have them precompiled into a binary to avoid any
+                          lookup. Therefore, binary compatibility needs to be preserved
+                          on changes to types. (Use versioned type names to manage
+                          breaking changes.)
+
+                        Note: this functionality is not currently available in
+                        the official
+
+                        protobuf release, and it is not used for type URLs
+                        beginning with
+
+                        type.googleapis.com.
+
+
+                        Schemes other than `http`, `https` (or the empty scheme)
+                        might be
+
+                        used with implementation specific semantics.
+                    value:
+                      type: string
+                      format: byte
+                      description: >-
+                        Must be a valid serialized protocol buffer of the above
+                        specified type.
+                  description: >-
+                    `Any` contains an arbitrary serialized protocol buffer
+                    message along with a
+
+                    URL that describes the type of the serialized message.
+
+
+                    Protobuf library provides support to pack/unpack Any values
+                    in the form
+
+                    of utility functions or additional generated methods of the
+                    Any type.
+
+
+                    Example 1: Pack and unpack a message in C++.
+
+                        Foo foo = ...;
+                        Any any;
+                        any.PackFrom(foo);
+                        ...
+                        if (any.UnpackTo(&foo)) {
+                          ...
+                        }
+
+                    Example 2: Pack and unpack a message in Java.
+
+                        Foo foo = ...;
+                        Any any = Any.pack(foo);
+                        ...
+                        if (any.is(Foo.class)) {
+                          foo = any.unpack(Foo.class);
+                        }
+
+                     Example 3: Pack and unpack a message in Python.
+
+                        foo = Foo(...)
+                        any = Any()
+                        any.Pack(foo)
+                        ...
+                        if any.Is(Foo.DESCRIPTOR):
+                          any.Unpack(foo)
+                          ...
+
+                     Example 4: Pack and unpack a message in Go
+
+                         foo := &pb.Foo{...}
+                         any, err := ptypes.MarshalAny(foo)
+                         ...
+                         foo := &pb.Foo{}
+                         if err := ptypes.UnmarshalAny(any, foo); err != nil {
+                           ...
+                         }
+
+                    The pack methods provided by protobuf library will by
+                    default use
+
+                    'type.googleapis.com/full.type.name' as the type URL and the
+                    unpack
+
+                    methods only use the fully qualified type name after the
+                    last '/'
+
+                    in the type URL, for example "foo.bar.com/x/y.z" will yield
+                    type
+
+                    name "y.z".
+
+
+
+                    JSON
+
+                    ====
+
+                    The JSON representation of an `Any` value uses the regular
+
+                    representation of the deserialized, embedded message, with
+                    an
+
+                    additional field `@type` which contains the type URL.
+                    Example:
+
+                        package google.profile;
+                        message Person {
+                          string first_name = 1;
+                          string last_name = 2;
+                        }
+
+                        {
+                          "@type": "type.googleapis.com/google.profile.Person",
+                          "firstName": <string>,
+                          "lastName": <string>
+                        }
+
+                    If the embedded message type is well-known and has a custom
+                    JSON
+
+                    representation, that representation will be embedded adding
+                    a field
+
+                    `value` which holds the custom JSON in addition to the
+                    `@type`
+
+                    field. Example (for message [google.protobuf.Duration][]):
+
+                        {
+                          "@type": "type.googleapis.com/google.protobuf.Duration",
+                          "value": "1.212s"
+                        }
+      tags:
+        - Query
   /cosmos/auth/v1beta1/params:
     get:
       summary: Params queries all parameters.
@@ -31624,6 +31837,16 @@ definitions:
     description: >-
       QueryModuleAccountByNameResponse is the response type for the
       Query/ModuleAccountByName RPC method.
+  cosmos.auth.v1beta1.QueryNextAccountNumberResponse:
+    type: object
+    properties:
+      next_account_number:
+        type: string
+        format: uint64
+        description: The next account number is the next value of global account number.
+    description: >-
+      QueryNextAccountNumberResponse is the response for the
+      Query/NextAccountNumber.
   cosmos.auth.v1beta1.QueryParamsResponse:
     type: object
     properties:

diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -23,6 +23,8 @@
     - [QueryAccountsResponse](#cosmos.auth.v1beta1.QueryAccountsResponse)
     - [QueryModuleAccountByNameRequest](#cosmos.auth.v1beta1.QueryModuleAccountByNameRequest)
     - [QueryModuleAccountByNameResponse](#cosmos.auth.v1beta1.QueryModuleAccountByNameResponse)
+    - [QueryNextAccountNumberRequest](#cosmos.auth.v1beta1.QueryNextAccountNumberRequest)
+    - [QueryNextAccountNumberResponse](#cosmos.auth.v1beta1.QueryNextAccountNumberResponse)
     - [QueryParamsRequest](#cosmos.auth.v1beta1.QueryParamsRequest)
     - [QueryParamsResponse](#cosmos.auth.v1beta1.QueryParamsResponse)
 
@@ -1221,6 +1223,31 @@ QueryModuleAccountByNameResponse is the response type for the Query/ModuleAccoun
 
 
 
+<a name="cosmos.auth.v1beta1.QueryNextAccountNumberRequest"></a>
+
+### QueryNextAccountNumberRequest
+QueryNextAccountNumberRequest is the request type for the Query/NextAccountNumber.
+
+
+
+
+
+
+<a name="cosmos.auth.v1beta1.QueryNextAccountNumberResponse"></a>
+
+### QueryNextAccountNumberResponse
+QueryNextAccountNumberResponse is the response for the Query/NextAccountNumber.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `next_account_number` | [uint64](#uint64) |  | The next account number is the next value of global account number. |
+
+
+
+
+
+
 <a name="cosmos.auth.v1beta1.QueryParamsRequest"></a>
 
 ### QueryParamsRequest
@@ -1265,6 +1292,7 @@ Since: cosmos-sdk 0.43 | GET|/cosmos/auth/v1beta1/accounts|
 | `Account` | [QueryAccountRequest](#cosmos.auth.v1beta1.QueryAccountRequest) | [QueryAccountResponse](#cosmos.auth.v1beta1.QueryAccountResponse) | Account returns account details based on address. | GET|/cosmos/auth/v1beta1/accounts/{address}|
 | `Params` | [QueryParamsRequest](#cosmos.auth.v1beta1.QueryParamsRequest) | [QueryParamsResponse](#cosmos.auth.v1beta1.QueryParamsResponse) | Params queries all parameters. | GET|/cosmos/auth/v1beta1/params|
 | `ModuleAccountByName` | [QueryModuleAccountByNameRequest](#cosmos.auth.v1beta1.QueryModuleAccountByNameRequest) | [QueryModuleAccountByNameResponse](#cosmos.auth.v1beta1.QueryModuleAccountByNameResponse) | ModuleAccountByName returns the module account info by module name | GET|/cosmos/auth/v1beta1/module_accounts/{name}|
+| `NextAccountNumber` | [QueryNextAccountNumberRequest](#cosmos.auth.v1beta1.QueryNextAccountNumberRequest) | [QueryNextAccountNumberResponse](#cosmos.auth.v1beta1.QueryNextAccountNumberResponse) | NextAccountNumber queries the global account number. Please be careful use this rpc. This rpc can be disappear whenever. And backward compatibility is not guaranteed. | GET|/cosmos/auth/v1beta1/next_account_number|
 
  <!-- end services -->
 

diff --git a/proto/cosmos/auth/v1beta1/query.proto b/proto/cosmos/auth/v1beta1/query.proto
@@ -33,6 +33,14 @@ service Query {
   rpc ModuleAccountByName(QueryModuleAccountByNameRequest) returns (QueryModuleAccountByNameResponse) {
     option (google.api.http).get = "/cosmos/auth/v1beta1/module_accounts/{name}";
   }
+
+  // NextAccountNumber queries the global account number.
+  // Please be careful use this rpc. This rpc can be disappear whenever.
+  // And backward compatibility is not guaranteed.
+  rpc NextAccountNumber(QueryNextAccountNumberRequest) returns (QueryNextAccountNumberResponse) {
+    option deprecated            = true;
+    option (google.api.http).get = "/cosmos/auth/v1beta1/next_account_number";
+  }
 }
 
 // QueryAccountsRequest is the request type for the Query/Accounts RPC method.
@@ -87,3 +95,16 @@ message QueryModuleAccountByNameRequest {
 message QueryModuleAccountByNameResponse {
   google.protobuf.Any account = 1 [(cosmos_proto.accepts_interface) = "ModuleAccountI"];
 }
+
+// QueryNextAccountNumberRequest is the request type for the Query/NextAccountNumber.
+message QueryNextAccountNumberRequest {
+  option deprecated = true;
+}
+
+// QueryNextAccountNumberResponse is the response for the Query/NextAccountNumber.
+message QueryNextAccountNumberResponse {
+  option deprecated = true;
+
+  // The next account number is the next value of global account number.
+  uint64 next_account_number = 1;
+}
diff --git a/x/auth/keeper/grpc_query.go b/x/auth/keeper/grpc_query.go
@@ -106,3 +106,16 @@ func (ak AccountKeeper) ModuleAccountByName(c context.Context, req *types.QueryM
 
 	return &types.QueryModuleAccountByNameResponse{Account: any}, nil
 }
+
+// NextAccountNumber implements the Query/NextAccountNumber gRPC method
+// nolint: staticcheck
+func (ak AccountKeeper) NextAccountNumber(c context.Context, req *types.QueryNextAccountNumberRequest) (*types.QueryNextAccountNumberResponse, error) {
+	if req == nil {
+		return nil, status.Errorf(codes.InvalidArgument, "empty request")
+	}
+
+	ctx := sdk.UnwrapSDKContext(c)
+	accNumber := ak.QueryNextAccountNumber(ctx)
+
+	return &types.QueryNextAccountNumberResponse{NextAccountNumber: accNumber}, nil //nolint: staticcheck
+}
diff --git a/x/auth/keeper/grpc_query_test.go b/x/auth/keeper/grpc_query_test.go
@@ -2,7 +2,6 @@ package keeper_test
 
 import (
 	"fmt"
-
 	"github.com/Finschia/finschia-sdk/testutil/testdata"
 	sdk "github.com/Finschia/finschia-sdk/types"
 	"github.com/Finschia/finschia-sdk/x/auth/types"
@@ -242,3 +241,37 @@ func (suite *KeeperTestSuite) TestGRPCQueryModuleAccountByName() {
 		})
 	}
 }
+
+func (suite *KeeperTestSuite) TestGRPCQueryNextAccountNumber() {
+	var req *types.QueryNextAccountNumberRequest
+
+	testCases := []struct {
+		msg      string
+		malleate func()
+		expPass  bool
+	}{
+		{
+			"success",
+			func() {
+				req = &types.QueryNextAccountNumberRequest{}
+			},
+			true,
+		},
+	}
+
+	for _, tc := range testCases {
+		suite.Run(fmt.Sprintf("Case %s", tc.msg), func() {
+			suite.SetupTest() // reset
+			tc.malleate()
+			ctx := sdk.WrapSDKContext(suite.ctx)
+			res, err := suite.queryClient.NextAccountNumber(ctx, req)
+			if tc.expPass {
+				suite.Require().NoError(err)
+				suite.Require().NotNil(res)
+			} else {
+				suite.Require().Error(err)
+				suite.Require().Nil(res)
+			}
+		})
+	}
+}