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

go-filecoin show and go-filecoin chain should be combined #1587

Closed
rosalinekarr opened this issue Jan 10, 2019 · 8 comments
Closed

go-filecoin show and go-filecoin chain should be combined #1587

rosalinekarr opened this issue Jan 10, 2019 · 8 comments
Labels
C-ux Category: Anything related to user experience good first issue Call for participation: Well-suited to new project contributors

Comments

@rosalinekarr
Copy link
Contributor

rosalinekarr commented Jan 10, 2019

Description

The following commands have similar purposes but different and confusing names:

go-filecoin show block
go-filecoin chain ls
go-filecoin chain head

We should reduce them into the following commands and add support for verbose, human-readable output to all of them:

go-filecoin chain ls [optional cids for showing specific blocks]
go-filecoin chain head

Acceptance criteria

  • wiki must be updated to replace any instances of the old commands
  • readme must be scrubbed for any instances of the old commands

Risks + pitfalls

Where to begin

@rosalinekarr rosalinekarr added the C-ux Category: Anything related to user experience label Jan 10, 2019
@acruikshank acruikshank added the good first issue Call for participation: Well-suited to new project contributors label Jan 11, 2019
@mishmosh
Copy link
Contributor

Whoever picks this up, please make a proposal here in the issue first.

@deaswang
Copy link
Contributor

How about update like this:

go-filecoin chain block [-m] <CID>
because show block and chain ls call different Porcelain APIs, different logic process.

add optional -b, --begin num and -e, --end num to control the block height for go-filecoin chain ls, without end mean from head tipset, without begin mean to genesis.

@deaswang
Copy link
Contributor

how to commit Wiki repo? how about submit one patch file at here?

@deaswang
Copy link
Contributor

@mishmosh how is the proposal?

@deaswang
Copy link
Contributor

here is WIki patch file
0001-update-wiki-for-combine-chain-and-show-1587.zip

@eshon
Copy link

eshon commented Jul 23, 2019

We were thinking of moving the go-filecoin wiki to filecoin-project/docs/ to enable community PRs but not sure if this has been discussed with the go-filecoin dev team yet.

Also this update would depend on merging the PR and adding it to a later release. We can apply the wiki patch later on if that happens.

deaswang added a commit to filcloud/go-filecoin that referenced this issue Jul 31, 2019
deaswang added a commit to filcloud/go-filecoin that referenced this issue Aug 5, 2019
deaswang added a commit to filcloud/go-filecoin that referenced this issue Aug 8, 2019
@deaswang
Copy link
Contributor

#3196
Should this issue necessary now?
@rosalinekarr @mishmosh

@anorth
Copy link
Member

anorth commented Aug 15, 2019

Yes, this issue remains to clean up the organisation of the CLI actions, such that they read like chain show, messages show rather than show block. This will require moving much of that code around.

Maybe something like:

  • chain show [--full] <cid>...: prints block headers / full blocks
  • chain ls: prints block header cids for the whole chain
  • chain head: prints head tipset CIDs

I don't think I've made a complete proposal - I haven't addresses messages/receipts.

Regarding your proposal for arguments, I think we should defer that to a separate PR from this reorganisation, but I like the idea in general.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-ux Category: Anything related to user experience good first issue Call for participation: Well-suited to new project contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants