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

Revise documentation for NetworkParameters and related types. #1715

Merged
merged 8 commits into from
Jun 3, 2020

Conversation

jonathanknowles
Copy link
Contributor

Related Issues

#1693

Overview

PR #1700 changed the way that network parameters are defined.

This PR revises and adds documentation for the following types:

  • NetworkParameters
  • GenesisParameters
  • ProtocolParameters
  • TxParameters

"Network Parameters" represents the complete set of parameters that are
currently in use by the network.

This set includes parameters defined by the genesis block and also protocol
parameters that can be updated through the update system.
Copy link
Contributor

@rvl rvl left a comment

Choose a reason for hiding this comment

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

Better

lib/core/src/Cardano/Wallet/Primitive/Types.hs Outdated Show resolved Hide resolved
@jonathanknowles
Copy link
Contributor Author

bors r+

iohk-bors bot added a commit that referenced this pull request Jun 3, 2020
1715: Revise documentation for `NetworkParameters` and related types. r=jonathanknowles a=jonathanknowles

# Related Issues

#1693 

# Overview

PR #1700 changed the way that network parameters are defined.

This PR revises and adds documentation for the following types:

- [x] `NetworkParameters`
- [x] `GenesisParameters`
- [x] `ProtocolParameters`
- [x] `TxParameters`

Co-authored-by: Jonathan Knowles <[email protected]>
lib/core/src/Cardano/Wallet/Primitive/Types.hs Outdated Show resolved Hide resolved
@iohk-bors
Copy link
Contributor

iohk-bors bot commented Jun 3, 2020

Build failed

Point out that this type only includes parameters that are relevant to
the wallet.

In response to review feedback:

#1715 (comment)
@jonathanknowles
Copy link
Contributor Author

bors r+

iohk-bors bot added a commit that referenced this pull request Jun 3, 2020
1715: Revise documentation for `NetworkParameters` and related types. r=jonathanknowles a=jonathanknowles

# Related Issues

#1693 

# Overview

PR #1700 changed the way that network parameters are defined.

This PR revises and adds documentation for the following types:

- [x] `NetworkParameters`
- [x] `GenesisParameters`
- [x] `ProtocolParameters`
- [x] `TxParameters`

Co-authored-by: Jonathan Knowles <[email protected]>
@iohk-bors
Copy link
Contributor

iohk-bors bot commented Jun 3, 2020

Build failed

@jonathanknowles
Copy link
Contributor Author

bors r+

@rvl
Copy link
Contributor

rvl commented Jun 3, 2020

The PR #1716 should fix those ci/hydra-eval failures.

@iohk-bors
Copy link
Contributor

iohk-bors bot commented Jun 3, 2020

@iohk-bors iohk-bors bot merged commit b3cfd5f into master Jun 3, 2020
@iohk-bors iohk-bors bot deleted the jonathanknowles/network-parameter-docs branch June 3, 2020 05:39
@KtorZ KtorZ added the ADDING FEATURE Mark a PR as adding a new feature, for auto-generated CHANGELOG label Jun 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADDING FEATURE Mark a PR as adding a new feature, for auto-generated CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants