Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): add acc-address by id cli and grpc gateway api #12199

Merged
merged 36 commits into from
Jun 15, 2022
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
a5dacd7
feat: add account by id cli and grpc api
Jun 8, 2022
079672a
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 8, 2022
56cf063
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 9, 2022
1ffcd11
refactor: remove auth info and add acc-addr by id
Jun 9, 2022
cd01232
test: add test cases for acc-addr by id
Jun 9, 2022
96d3cef
add migration for map accAddr to accNum
Jun 9, 2022
905caf6
refactor: increase the consensus version for auth migration
Jun 9, 2022
aa7ff0b
chroe: address the pr comments
Jun 9, 2022
c828ca1
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 9, 2022
120608e
chore: address the pr comments
Jun 9, 2022
877a4ca
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 9, 2022
09b2be6
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 10, 2022
4cdb80b
chore: address the pr comments
Jun 10, 2022
a00e900
chore: address the pr comments++
Jun 10, 2022
3fd656b
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 10, 2022
455e023
Update x/auth/keeper/account.go
alexanderbez Jun 10, 2022
3d4d281
Update x/auth/keeper/account.go
alexanderbez Jun 10, 2022
74857f8
Update x/auth/client/cli/query.go
alexanderbez Jun 10, 2022
4bf1320
Update proto/cosmos/auth/v1beta1/query.proto
alexanderbez Jun 10, 2022
1eb42c9
Update proto/cosmos/auth/v1beta1/query.proto
alexanderbez Jun 10, 2022
743413a
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 10, 2022
4ec4d3d
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 11, 2022
021b8ea
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 14, 2022
fa633b1
chore: address the pr comments
gsk967 Jun 14, 2022
bde0701
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 14, 2022
2219c56
test: fix the test cases
gsk967 Jun 14, 2022
4f22f86
Merge branch 'sai/12155_add_account_by_id' of github.com:gsk967/cosmo…
gsk967 Jun 14, 2022
edf7846
Merge branch 'main' into sai/12155_add_account_by_id
alexanderbez Jun 14, 2022
e1dbedb
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 15, 2022
9da2cc3
Merge branch 'main' into sai/12155_add_account_by_id
gsk967 Jun 15, 2022
ce0d710
test: add state migration test cases
gsk967 Jun 15, 2022
858aba9
Merge branch 'sai/12155_add_account_by_id' of github.com:gsk967/cosmo…
gsk967 Jun 15, 2022
4bef7c2
chore: address the pr comments
gsk967 Jun 15, 2022
cf7e8cf
chore: address the pr comments++
gsk967 Jun 15, 2022
1b4b6e3
Merge branch 'main' into sai/12155_add_account_by_id
alexanderbez Jun 15, 2022
cd70f4c
Merge branch 'main' into sai/12155_add_account_by_id
alexanderbez Jun 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,181 changes: 1,063 additions & 118 deletions api/cosmos/auth/v1beta1/query.pulsar.go

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions api/cosmos/auth/v1beta1/query_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions proto/cosmos/auth/v1beta1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ service Query {
option (google.api.http).get = "/cosmos/auth/v1beta1/accounts/{address}";
}

// AccountAddressByID returns account address based on account id
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing a Since proto comment

rpc AccountAddressByID(QueryAccountAddressByIDRequest) returns (QueryAccountAddressByIDResponse) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AccountAddressByID seems like a weird name to me. Do people use the term "ID"?

I would call it AddressByAccountNumber or AddressByAccNum

option (google.api.http).get = "/cosmos/auth/v1beta1/address_by_id/{id}";
}

// Params queries all parameters.
rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
option (google.api.http).get = "/cosmos/auth/v1beta1/params";
Expand Down Expand Up @@ -152,3 +157,13 @@ message AddressStringToBytesRequest {
message AddressStringToBytesResponse {
bytes address_bytes = 1;
}

// QueryAccountAddressByIDRequest is the request type for AccountAddressById rpc method
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
message QueryAccountAddressByIDRequest{
int64 id = 1;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this int64, when account_number is uint64 everywhere?

}

// QueryAccountAddressByIDResponse is the response type for AccountAddressById rpc method
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
message QueryAccountAddressByIDResponse {
string account_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would rename this field to address simply, which makes it consistent with some other places

}
35 changes: 35 additions & 0 deletions x/auth/client/cli/query.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cli
import (
"context"
"fmt"
"strconv"
"strings"

"github.com/spf13/cobra"
Expand Down Expand Up @@ -41,6 +42,7 @@ func GetQueryCmd() *cobra.Command {

cmd.AddCommand(
GetAccountCmd(),
GetAccountAddressByIDCmd(),
GetAccountsCmd(),
QueryParamsCmd(),
QueryModuleAccountsCmd(),
Expand Down Expand Up @@ -124,6 +126,39 @@ func GetAccountCmd() *cobra.Command {
return cmd
}

// GetAccountAddressByIDCmd returns a query account address that will display the account address of a given account id.
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
func GetAccountAddressByIDCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "address-by-id [id]",
Short: "Query for account address by account id",
Args: cobra.ExactArgs(1),
Example: fmt.Sprintf("%s q auth address-by-id 1", version.AppName),
RunE: func(cmd *cobra.Command, args []string) error {
clientCtx, err := client.GetClientQueryContext(cmd)
if err != nil {
return err
}

id, err := strconv.ParseInt(args[0], 10, 64)
if err != nil {
return err
}

queryClient := types.NewQueryClient(clientCtx)
res, err := queryClient.AccountAddressByID(cmd.Context(), &types.QueryAccountAddressByIDRequest{Id: id})
if err != nil {
return err
}

return clientCtx.PrintProto(res)
},
}

flags.AddQueryFlagsToCmd(cmd)

return cmd
}

// GetAccountsCmd returns a query command that will display a list of accounts
func GetAccountsCmd() *cobra.Command {
cmd := &cobra.Command{
Expand Down
45 changes: 45 additions & 0 deletions x/auth/client/testutil/suite.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
"github.com/cosmos/cosmos-sdk/types/tx"
"github.com/cosmos/cosmos-sdk/types/tx/signing"
authcli "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
"github.com/cosmos/cosmos-sdk/x/auth/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
bank "github.com/cosmos/cosmos-sdk/x/bank/client/cli"
bankcli "github.com/cosmos/cosmos-sdk/x/bank/client/testutil"
Expand Down Expand Up @@ -281,6 +282,50 @@ func (s *IntegrationTestSuite) TestCLISignBatch() {
s.Require().Error(err)
}

func (s *IntegrationTestSuite) TestCliGetAccountAddressByID() {
require := s.Require()
val1 := s.network.Validators[0]
testCases := []struct {
name string
args []string
expectErr bool
}{
{
"not enough args",
[]string{fmt.Sprintf("--%s=json", tmcli.OutputFlag)},
true,
},
{
"invalid account id",
[]string{fmt.Sprint(-1), fmt.Sprintf("--%s=json", tmcli.OutputFlag)},
true,
},
{
"valid account id",
[]string{fmt.Sprint(0), fmt.Sprintf("--%s=json", tmcli.OutputFlag)},
false,
},
}

for _, tc := range testCases {
tc := tc
s.Run(tc.name, func() {
cmd := authcli.GetAccountAddressByIDCmd()
clientCtx := val1.ClientCtx

queryResJSON, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, tc.args)
if tc.expectErr {
s.Require().Error(err)
} else {
s.Require().NoError(err)
var res types.QueryAccountAddressByIDResponse
require.NoError(val1.ClientCtx.Codec.UnmarshalJSON(queryResJSON.Bytes(), &res))
require.NotNil(res.GetAccountAddress())
}
})
}
}

func (s *IntegrationTestSuite) TestCLISignAminoJSON() {
require := s.Require()
val1 := s.network.Validators[0]
Expand Down
20 changes: 20 additions & 0 deletions x/auth/keeper/account.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package keeper

import (
"github.com/cosmos/cosmos-sdk/internal/conv"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/cosmos/cosmos-sdk/x/auth/types"
)
Expand Down Expand Up @@ -31,6 +32,12 @@ func (ak AccountKeeper) HasAccount(ctx sdk.Context, addr sdk.AccAddress) bool {
return store.Has(types.AddressStoreKey(addr))
}

// HasAccountAddressByID checks account address exists by id.
func (ak AccountKeeper) HasAccountAddressByID(ctx sdk.Context, id uint64) bool {
store := ctx.KVStore(ak.key)
return store.Has(types.AccountNumberStoreKey(id))
}

// GetAccount implements AccountKeeperI.
func (ak AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.AccountI {
store := ctx.KVStore(ak.key)
Expand All @@ -42,6 +49,17 @@ func (ak AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.A
return ak.decodeAccount(bz)
}

// GetAccountAddressById returns account address by id.
func (ak AccountKeeper) GetAccountAddressByID(ctx sdk.Context, id int64) string {
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
store := ctx.KVStore(ak.key)
bz := store.Get(types.AccountNumberStoreKey(uint64(id)))
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
if bz == nil {
return ""
}

return conv.UnsafeBytesToStr(bz)
gsk967 marked this conversation as resolved.
Show resolved Hide resolved
}

// GetAllAccounts returns all accounts in the accountKeeper.
func (ak AccountKeeper) GetAllAccounts(ctx sdk.Context) (accounts []types.AccountI) {
ak.IterateAccounts(ctx, func(acc types.AccountI) (stop bool) {
Expand All @@ -63,6 +81,7 @@ func (ak AccountKeeper) SetAccount(ctx sdk.Context, acc types.AccountI) {
}

store.Set(types.AddressStoreKey(addr), bz)
store.Set(types.AccountNumberStoreKey(acc.GetAccountNumber()), conv.UnsafeStrToBytes(addr.String()))
}

// RemoveAccount removes an account for the account mapper store.
Expand All @@ -71,6 +90,7 @@ func (ak AccountKeeper) RemoveAccount(ctx sdk.Context, acc types.AccountI) {
addr := acc.GetAddress()
store := ctx.KVStore(ak.key)
store.Delete(types.AddressStoreKey(addr))
store.Delete(types.AccountNumberStoreKey(acc.GetAccountNumber()))
}

// IterateAccounts iterates over all the stored accounts and performs a callback function.
Expand Down
18 changes: 18 additions & 0 deletions x/auth/keeper/grpc_query.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,24 @@ import (

var _ types.QueryServer = AccountKeeper{}

func (ak AccountKeeper) AccountAddressByID(c context.Context, req *types.QueryAccountAddressByIDRequest) (*types.QueryAccountAddressByIDResponse, error) {
if req == nil {
return nil, status.Errorf(codes.InvalidArgument, "empty request")
}

if req.Id < 0 {
Fixed Show fixed Hide fixed
Fixed Show fixed Hide fixed
return nil, status.Error(codes.InvalidArgument, "Invalid account id")
}

ctx := sdk.UnwrapSDKContext(c)
address := ak.GetAccountAddressByID(ctx, req.GetId())
if len(address) == 0 {
return nil, status.Errorf(codes.NotFound, "account address not found with id %d", req.Id)
}

return &types.QueryAccountAddressByIDResponse{AccountAddress: address}, nil
}

func (ak AccountKeeper) Accounts(c context.Context, req *types.QueryAccountsRequest) (*types.QueryAccountsResponse, error) {
if req == nil {
return nil, status.Error(codes.InvalidArgument, "empty request")
Expand Down
63 changes: 63 additions & 0 deletions x/auth/keeper/grpc_query_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"bytes"
"context"
"fmt"
"math"
"sort"

"github.com/cosmos/cosmos-sdk/testutil/testdata"
Expand Down Expand Up @@ -153,6 +154,68 @@ func (suite *KeeperTestSuite) TestGRPCQueryAccount() {
}
}

func (suite *KeeperTestSuite) TestGRPCQueryAccountAddressByID() {
var req *types.QueryAccountAddressByIDRequest
_, _, addr := testdata.KeyTestPubAddr()

testCases := []struct {
msg string
malleate func()
expPass bool
posttests func(res *types.QueryAccountAddressByIDResponse)
}{
{
"invalid request",
func() {
req = &types.QueryAccountAddressByIDRequest{Id: -1}
},
false,
func(res *types.QueryAccountAddressByIDResponse) {},
},
{
"account address not found",
func() {
req = &types.QueryAccountAddressByIDRequest{Id: math.MaxInt64}
},
false,
func(res *types.QueryAccountAddressByIDResponse) {},
},
{
"valid request",
func() {
account := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, addr)
suite.app.AccountKeeper.SetAccount(suite.ctx, account)
req = &types.QueryAccountAddressByIDRequest{Id: int64(account.GetAccountNumber())}
},
true,
func(res *types.QueryAccountAddressByIDResponse) {
suite.Require().NotNil(res.AccountAddress)
},
},
}

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.AccountAddressByID(ctx, req)

if tc.expPass {
suite.Require().NoError(err)
suite.Require().NotNil(res)
} else {
suite.Require().Error(err)
suite.Require().Nil(res)
}

tc.posttests(res)
})
}
}

func (suite *KeeperTestSuite) TestGRPCQueryParameters() {
var (
req *types.QueryParamsRequest
Expand Down
6 changes: 6 additions & 0 deletions x/auth/keeper/migrations.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import (
"github.com/gogo/protobuf/grpc"

v043 "github.com/cosmos/cosmos-sdk/x/auth/migrations/v043"
v046 "github.com/cosmos/cosmos-sdk/x/auth/migrations/v046"

"github.com/cosmos/cosmos-sdk/x/auth/types"

sdk "github.com/cosmos/cosmos-sdk/types"
Expand Down Expand Up @@ -41,3 +43,7 @@ func (m Migrator) Migrate1to2(ctx sdk.Context) error {

return iterErr
}

func (m Migrator) MapAccAddrsToAccNum(ctx sdk.Context) error {
gsk967 marked this conversation as resolved.
Show resolved Hide resolved
return v046.MigrateStore(ctx, m.keeper.key, m.keeper.cdc)
}
Loading