-
Notifications
You must be signed in to change notification settings - Fork 217
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
Allow flexible SMASH selection wrt ADP-427 #2214
Conversation
bors try |
tryBuild failed: |
Buildkite won't build branches from forks, as a matter of policy. |
076f525
to
d969dfa
Compare
bors try |
tryBuild succeeded: |
d969dfa
to
4bf109c
Compare
description: | | ||
<p align="right">status: <strong>stable</strong></p> | ||
|
||
Overwrite current settings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think more detailed description would be handy explaining what are the possible values and behavior after updating the settings (like stated in #2163 in "Decision" section, if it is still up to date.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since settings should be as general as possible, I don't know how to describe the behavior. That depends on the setting. We can only reasonably document it for the pool_metadata_source
. That is already done in the appropriate places:
x-poolMetadataSource: &poolMetadataSource
description: |
Pool metadata source. This sets the metadata fetching strategy.
Possible values are
* null -> no fetching
* direct -> direct fetching
* uri -> use SMASH server
oneOf:
- type: string
enum:
- none
- direct
- title: URI
type: string
format: uri
example: https://smash.cardano-mainnet.iohk.io/
x-settings: &settings
description: Settings
type: object
required:
- pool_metadata_source
properties:
pool_metadata_source:
<<: *poolMetadataSource
description: How to fetch pool metadata
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, perhaps updating to something like:
properties:
pool_metadata_source:
<<: *poolMetadataSource
description: |
Select metadata fetching strategy:
- `none` - metadata is not fetched at all,
- `direct` - metadata is fetched directly from chain,
- `uri` - metadata is fetched from the external Stake-Pool Metadata Aggregation Server (SMASH)
After update existing metadata will be dropped forcing it to re-sync automatically with the new setting.
lib/core-integration/src/Test/Integration/Scenario/API/Shelley/Wallets.hs
Outdated
Show resolved
Hide resolved
<> showDefaultWith showT | ||
<> help "Pool Metadata fetching strategy. This setting will persist across restarts. Possible values: \ | ||
\ none, \ | ||
\ direct, \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the difference between "none" and "direct"? 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose:
- "none" - don't look for metadata at all
- "direct" - look for metadata on chain
- "uri" - look in the SMASH server
I imagine "none" would be picked rather seldom. (Only case I can think is some maintenance/testing purposes or maybe exchanges running wallet and don't care about metadata)
Perhaps better default value would be "direct"? Which is also a current default...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
none
was decided as the default in the ticket (ADP-427):
About (1), the command-line option should be removed altogether and the wallet should instead wait for a strategy to be provided. Without strategy, no metadata will be fetched whatsover.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per: https://input-output-rnd.slack.com/archives/GBT05825V/p1602080513063300
If nothing is provided we should default to the latest setting in use. If there was no previous setting in use, then it should default to "none".
Currently we always have "none" which erases any settings that were set in runtime.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure to address the few remaining comments before triggering bors 👍
4bf109c
to
50b9f9e
Compare
bors r+ |
bors r- |
Canceled. |
bors r+ |
bors r- |
Canceled. |
lib/cli/src/Cardano/CLI.hs
Outdated
\Stakepool Metadata Aggregation Server." | ||
<> long "pool-metadata-fetching" | ||
<> metavar "STRATEGY" | ||
<> value FetchNone |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suspect the issue is here? There shouldn't be any default value here. Do you concur?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
50b9f9e
to
be92684
Compare
bors r+ |
Build failed:
|
bors r+ |
Build failed:
Only one stake pool test failed:
So this seems different from #2196, where the worker had crashed and no pools at all were shown. |
bors r+ |
Build succeeded: |
2235: Fix extra-source-files not containing files used by TH r=hasufell a=hasufell 2239: WIP: Bump version from 2020.9.30 to 2020.10.13 r=KtorZ a=jonathanknowles <!-- Short optional summary --> Compatible with [`[email protected]`](https://github.com/input-output-hk/jormungandr/releases/tag/v0.9.0) and [`[email protected]`](https://github.com/input-output-hk/cardano-node/releases/tag/1.21.1). ## New Features - Adds the ability for users to select their own SMASH servers for stakepool listings. (#2214) - Adds transaction expiry slots for pending transactions. (#1879) ## Improvements - Adds a 100-wallet scenario to the latency benchmark. (#2223) - Adds an executable `shelley-test-cluster` which starts an integration test cluster that includes faucets. (#2178) - Extends `isOurs` to return the derivation path of an address. (#2219) ## Resolved Issues - Make pool garbage collection handle an unknown current epoch. (#2203) - Fixes incorrect mainnet network parameters returned from API. (#2226) ## Known Issues **_This section is a work in progress._** - Wallet restoration status reported incorrectly on mainnet. ([ADP-483](https://jira.iohk.io/browse/ADP-483)) ## Documentation <!-- A snapshot of the documentation at the time of releasing. --> Cardano (cardano-node) | ITN (Jörmungandr) --- | --- [API Documentation](https://input-output-hk.github.io/cardano-wallet/api/v2020-10-13) | [API Documentation](https://input-output-hk.github.io/cardano-wallet/api/v2020-10-13) [CLI Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-command-line-interface/f71ecb7ece3deaec5bf60f4a4beea1d3950e0d46) | [CLI Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-command-line-interface-jormungandr/f71ecb7ece3deaec5bf60f4a4beea1d3950e0d46) [Docker Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Docker/f71ecb7ece3deaec5bf60f4a4beea1d3950e0d46) | [Docker Manual](https://github.com/input-output-hk/cardano-wallet/wiki/Docker-jormungandr/f71ecb7ece3deaec5bf60f4a4beea1d3950e0d46) ## Installation Instructions ### Cardano (cardano-node) 1. Install [`[email protected]`](https://github.com/input-output-hk/cardano-node/releases/tag/1.21.1). 2. Download the provided `cardano-wallet` for your platform, and uncompress it in a directory that is on your `$PATH`, e.g. `/usr/local/bin`. Or `%PATH%` on Windows. 4. Start `cardano-wallet --help` and see available parameters. #### Docker Pull from DockerHub and verify the version matches 2020.10.13. ``` $ docker pull inputoutput/cardano-wallet:2020.10.13 $ docker run --rm inputoutput/cardano-wallet:2020.10.13 version ``` ### ITN (jormungandr) 1. Install [`[email protected]`](https://github.com/input-output-hk/jormungandr/releases/tag/v0.9.0). 2. Download the provided `cardano-wallet-jormungandr` for your platform, and uncompress it in a directory that is on your `$PATH`, e.g. `/usr/local/bin`. Or `%PATH%` on Windows. 3. (optional) Install the bash/zsh auto-completion script according to the [jormungandr cli manual](https://github.com/input-output-hk/cardano-wallet/wiki/Wallet-Command-Line-Interface/{{JORM_CLI_WIKI_COMMIT}}) 4. Start `cardano-wallet --help` and see available parameters. #### Docker Pull from DockerHub and verify the version matches 2020.10.13 ``` $ docker pull inputoutput/cardano-wallet:2020.10.13-jormungandr $ docker run --rm inputoutput/cardano-wallet:2020.10.13-jormungandr version ``` ## Signatures <!-- Signatures of people responsible for the release --> Name | Role | Approval --- | --- | ---: Matthias Benkort @KtorZ | Technical Team Lead | ⌛ Piotr Stachyra @piotr-iohk | QA Engineer | ⌛ Tatyana Valkevych @tatyanavych | Release Manager | ⌛ Co-authored-by: Julian Ospald <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]> Co-authored-by: Jonathan Knowles <[email protected]> Co-authored-by: IOHK <[email protected]>
Replaces #2156
I think there are some weird issued with buildkite, because it's from my fork repo.