-
Notifications
You must be signed in to change notification settings - Fork 5k
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
feat(multichain): add block explorer format URLs #30085
Draft
ccharly
wants to merge
3
commits into
main
Choose a base branch
from
feat/multichain-block-explorer-format-urls
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+196
−41
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import { | ||
| formatBlockExplorerUrl, | ||
| formatBlockExplorerAddressUrl, | ||
| MultichainBlockExplorerFormatUrls, | ||
| } from './networks'; | ||
|
|
||
| describe('multichain - networks', () => { | ||
| it('formats a URL', () => { | ||
| const value = 'something-else'; | ||
|
|
||
| expect( | ||
| formatBlockExplorerUrl( | ||
| 'https://foo.bar/show/{foobar}/1', | ||
| '{foobar}', | ||
| value, | ||
| ), | ||
| ).toBe(`https://foo.bar/show/${value}/1`); | ||
| }); | ||
|
|
||
| it('formats a URL for an address', () => { | ||
| const address = 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k'; | ||
| const urls: MultichainBlockExplorerFormatUrls = { | ||
| url: 'https://foo.bar', | ||
| address: 'https://foo.bar/address/{address}?detail=true', | ||
| }; | ||
|
|
||
| expect(formatBlockExplorerAddressUrl(urls, address)).toBe( | ||
| `https://foo.bar/address/${address}?detail=true`, | ||
| ); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /** | ||
| * Base URL of a block explorer. | ||
| */ | ||
| export type MultichainBlockExplorerUrl = `https://${string}.${string}`; | ||
|
|
||
| /** | ||
| * Format URL of a block explorer for addresses. | ||
| * | ||
| * The format URLs can be used to "expand" some strings within the format string. (Similar | ||
| * to "string interpolation"). The "tags" are being identified with curly-braces. | ||
| */ | ||
| export type MultichainBlockExplorerFormatUrl<Tag extends string> = | ||
| `https://${string}.${string}/${string}{${Tag}}${string}`; | ||
|
|
||
| /** | ||
| * A group of URL and format URL for block explorers. | ||
| */ | ||
| export type MultichainBlockExplorerFormatUrls = { | ||
| /** | ||
| * Base URL of the block explorer. | ||
| */ | ||
| url: MultichainBlockExplorerUrl; | ||
|
|
||
| /** | ||
| * Format URL of the block explorer for addresses. | ||
| */ | ||
| address: MultichainBlockExplorerFormatUrl<'address'>; | ||
| }; | ||
|
|
||
| /** | ||
| * Format a URL by replacing a "tag" with a corresponding value. | ||
| * | ||
| * @param url - Format URL. | ||
| * @param tag - Format URL tag. | ||
| * @param value - The value to expand. | ||
| * @returns A formatted URL. | ||
| */ | ||
| export function formatBlockExplorerUrl<Tag extends string>( | ||
| url: MultichainBlockExplorerFormatUrl<Tag>, | ||
| tag: Tag, | ||
| value: string, | ||
| ) { | ||
| return url.replaceAll(tag, value); | ||
| } | ||
|
|
||
| /** | ||
| * Format a URL for addresses. | ||
| * | ||
| * @param urls - The group of format URLs for a given block explorer. | ||
| * @param address - The address to create the URL for. | ||
| * @returns The formatted URL for the given address. | ||
| */ | ||
| export function formatBlockExplorerAddressUrl( | ||
| urls: MultichainBlockExplorerFormatUrls, | ||
| address: string, | ||
| ) { | ||
| return formatBlockExplorerUrl(urls.address, '{address}', address); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
"Format" vs "Template"?