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

Update documentation for PoolMetadataSource #93

Merged
merged 1 commit into from
Nov 3, 2020
Merged
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/cardanoWallet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import { DirPath } from './common';
* - `'direct'` - enables fetching stake pool metadata from
* the registered pool URL.
* - otherwise, the URL of a SMASH metadata proxy server
* can be supplied.
* can be supplied. This must not contain the endpoint path.
Copy link
Author

Choose a reason for hiding this comment

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

Probably no point in validating it here in the code, or should we?

Copy link
Contributor

Choose a reason for hiding this comment

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

Right, just have this option match the cardano-wallet CLI, and cardano-wallet can validate it if needed.

*/
export type PoolMetadataSource = 'none' | 'direct' | { smashUrl: string };

Expand Down