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

improve README #587

Merged
merged 9 commits into from
Jun 2, 2023
Merged

improve README #587

merged 9 commits into from
Jun 2, 2023

Conversation

niklasad1
Copy link
Member

@niklasad1 niklasad1 commented Jun 1, 2023

Close #451

@niklasad1 niklasad1 mentioned this pull request Jun 1, 2023
@niklasad1 niklasad1 requested review from gpestana, jsdw and lexnv June 1, 2023 16:46
Copy link
Contributor

@gpestana gpestana left a comment

Choose a reason for hiding this comment

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

A few nits bit lgtm!

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
```
### Dry run

It's possible to mine a solution locally without submitting anything to the chain but
Copy link
Contributor

Choose a reason for hiding this comment

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

Out of context of this PR, but in substrate-etl we pull all the data from EPM and staking and re-calculate the snapshot if it does not exist. I wonder if that would be useful here or just over-engineering and not used.

Copy link
Member Author

@niklasad1 niklasad1 Jun 2, 2023

Choose a reason for hiding this comment

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

I added a link under "related projects" instead.

"Dry-running" here is tricky but using substrate-etl won't work unless we had some glue code to feed in the "snapshot" or just fetching the state ourselves.

I reckon that the easiest would just be to find the event in from subscan etc but open to other ideas ofc :)

README.md Outdated Show resolved Hide resolved
niklasad1 and others added 4 commits June 2, 2023 08:42
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
The library is a re-write of [polkadot staking miner](https://github.com/paritytech/polkadot/tree/master/utils/staking-miner) using [subxt](https://github.com/paritytech/subxt)
to avoid hard dependency to each runtime version. It's using a static metadata (metadata.scale) file to generate rust types, instructions how to update metadata can be found [here](#update-metadata)
The binary itself embeds [static metadata](./artifacts/metadata.scale) to
generate a rust codegen at compile-time that
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit; the line lengths are a bit all over the place (but I know it doesn't make a difference to the output)

Copy link
Contributor

@jsdw jsdw left a comment

Choose a reason for hiding this comment

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

Couple of nits but a definite improvement :)

niklasad1 and others added 2 commits June 2, 2023 11:41
Co-authored-by: James Wilson <james@jsdw.me>
Co-authored-by: James Wilson <james@jsdw.me>
@niklasad1 niklasad1 merged commit 956ada5 into main Jun 2, 2023
@niklasad1 niklasad1 deleted the update-readme branch June 2, 2023 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

improve README
4 participants