Skip to content

cmd/clef add listAccounts to CLI #26080

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.

Sign up for GitHub

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

Merged
merged 14 commits into from
Nov 2, 2022
Merged

cmd/clef add listAccounts to CLI #26080

Changes from 6 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
b240834
add clef listaccounts to cli
jmcook1186 Oct 31, 2022
4682074
add keystore flag
jmcook1186 Oct 31, 2022
a1ed588
use internal api to call ListAccounts
jmcook1186 Nov 1, 2022
01588bb
add list-wallet command
jmcook1186 Nov 1, 2022
65db9b1
Update cmd/clef/main.go
jmcook1186 Nov 2, 2022
61c2e77
Update cmd/clef/main.go
jmcook1186 Nov 2, 2022
b8e04dd
init internal api logic --> func
jmcook1186 Nov 2, 2022
aa42247
move listAccounts and listWallets
jmcook1186 Nov 2, 2022
4c0a16c
check err
jmcook1186 Nov 2, 2022
248d762
print account.URL
jmcook1186 Nov 2, 2022
d579c56
output to render as markdown
jmcook1186 Nov 2, 2022
a899f41
fix func order and wallet info
jmcook1186 Nov 2, 2022
364efad
Update cmd/clef/main.go
jmcook1186 Nov 2, 2022
e20ed96
fix goimports
jmcook1186 Nov 2, 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
91 changes: 88 additions & 3 deletions cmd/clef/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,16 +203,41 @@ The delpw command removes a password for a given address (keyfile).
},
Description: `
The newaccount command creates a new keystore-backed account. It is a convenience-method
which can be used in lieu of an external UI.`,
}

which can be used in lieu of an external UI.
`}
gendocCommand = &cli.Command{
Action: GenDoc,
Name: "gendoc",
Usage: "Generate documentation about json-rpc format",
Description: `
The gendoc generates example structures of the json-rpc communication types.
`}
listAccountsCommand = &cli.Command{
Action: listAccounts,
Name: "list-accounts",
Usage: "List accounts in the keystore",
Flags: []cli.Flag{
logLevelFlag,
keystoreFlag,
utils.LightKDFFlag,
acceptFlag,
},
Description: `
Lists the accounts in the keystore.
`}
listWalletsCommand = &cli.Command{
Action: listWallets,
Name: "list-wallets",
Usage: "List wallets known to Clef",
Flags: []cli.Flag{
logLevelFlag,
keystoreFlag,
utils.LightKDFFlag,
acceptFlag,
},
Description: `
Lists the wallets known to Clef.
`}
)

var app = flags.NewApp("Manage Ethereum account operations")
Expand Down Expand Up @@ -249,6 +274,8 @@ func init() {
delCredentialCommand,
newAccountCommand,
gendocCommand,
listAccountsCommand,
listWalletsCommand,
}
}

Expand Down Expand Up @@ -351,6 +378,64 @@ func attestFile(ctx *cli.Context) error {
return nil
}

func listAccounts(c *cli.Context) error {
if err := initialize(c); err != nil {
return err
}
// listaccounts is meant for users using the CLI.
var (
ui = core.NewCommandlineUI()
pwStorage storage.Storage = &storage.NoStorage{}
ksLoc = c.String(keystoreFlag.Name)
lightKdf = c.Bool(utils.LightKDFFlag.Name)
)
am := core.StartClefAccountManager(ksLoc, true, lightKdf, "")
// Access external API and call List()
api := core.NewSignerAPI(am, 0, true, ui, nil, false, pwStorage)
internalApi := core.NewUIServerAPI(api)
Copy link
Contributor

@holiman holiman Nov 2, 2022

Choose a reason for hiding this comment

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

This chunk of code is now repeated at least three times. I suggest moving this to it's own function, with the signature

func initInternal(c *cli.Context) (*core.UIServerAPI, error) {

or maybe initInternalApi.
And then shorten the three methods , e.g

func newAccount(c *cli.Context) error {
	internalApi, err := initInternal(c)
	if err != nil {

And then move these two new methods down, so they appear after newAccount within the file.

accs, err := internalApi.ListAccounts(context.Background())
if err != nil {
return err
}
if len(accs) == 0 {
fmt.Println("\nThe keystore is empty.")
}
fmt.Println()
for _, account := range accs {
fmt.Printf("%v (%v)\n", account.Address, account.URL)
}
return err
}

func listWallets(c *cli.Context) error{
if err := initialize(c); err != nil {
return err
}
// listaccounts is meant for users using the CLI.
var (
ui = core.NewCommandlineUI()
pwStorage storage.Storage = &storage.NoStorage{}
ksLoc = c.String(keystoreFlag.Name)
lightKdf = c.Bool(utils.LightKDFFlag.Name)
)
am := core.StartClefAccountManager(ksLoc, true, lightKdf, "")
// Access external API and call List()
api := core.NewSignerAPI(am, 0, true, ui, nil, false, pwStorage)
internalApi := core.NewUIServerAPI(api)
wallets := internalApi.ListWallets()
if len(wallets) == 0 {
fmt.Println("\nThere are no wallets.")
}
fmt.Println()
for i, wallet := range wallets {
fmt.Printf("%d. Keystore at %v (%v %v)\n", i, wallet.URL, wallet.Status, wallet.Failure)
for _, acc := range wallet.Accounts {
fmt.Printf("\t%v (%v)\n", acc.Address, acc.URL)
}
}
return nil
}

func setCredential(ctx *cli.Context) error {
if ctx.NArg() < 1 {
utils.Fatalf("This command requires an address to be passed as an argument")
Expand Down