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.

Sign up for GitHub

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

Jump to bottom

Define APIs to for the search feature in the mirror node explorer #445

Closed
SimiHunjan opened this issue Feb 14, 2023 · 10 comments · Fixed by #753
Closed

Define APIs to for the search feature in the mirror node explorer #445

SimiHunjan opened this issue Feb 14, 2023 · 10 comments · Fixed by #753
Assignees
@Sheng-Long
Labels
enhancement New feature or request P2 Required to be completed in the assigned milestone, but may or may not impact the release schedule

Comments

@SimiHunjan
Copy link
Collaborator

Problem

Applications would like to use an API to display information about a transaction or entity in the network. The defined API would be maintained and would not break in the future.

Solution

Define API.

Alternatives

No response
@SimiHunjan SimiHunjan added enhancement New feature or request P2 Required to be completed in the assigned milestone, but may or may not impact the release schedule labels Feb 14, 2023
@SimiHunjan
Copy link
Collaborator Author

Linking issue: #338

@SimiHunjan
Copy link
Collaborator Author

Research the options for having these kind of APIs to be supported

@SimiHunjan
Copy link
Collaborator Author

Linking issue: #450

@SimiHunjan
Copy link
Collaborator Author

Linking issue: #444

@SimiHunjan
Copy link
Collaborator Author

Create HIP that references the design that will be used for the APIs.

@SimiHunjan
Copy link
Collaborator Author

  • Swagger document to formalize the APIs
  • Testing requirements to not break the URLs

@Sheng-Long Sheng-Long self-assigned this Oct 16, 2023
@SimiHunjan
Copy link
Collaborator Author

Schedule time to review with the team

@SimiHunjan SimiHunjan linked a pull request Nov 16, 2023 that will close this issue
create route documentation #753
Merged
2 tasks
@SimiHunjan
Copy link
Collaborator Author

SimiHunjan commented Dec 1, 2023 •
edited
Loading

Document a subset of URLs that are committed URLs vs all existing URLs

URLs to document:

  • EIP 3091 block explorer API routes
  • Review if others need to be documented

@ericleponner
Copy link
Collaborator

ericleponner commented Dec 12, 2023 •
edited
Loading

After reviewing various threads and issues (#338, #444, #450), here are URLs currently exposed by Explorer.

URLs from EIP 3091:

  • <BLOCK_EXPLORER_URL>/block/<BLOCK_HASH_OR_HEIGHT>
  • <BLOCK_EXPLORER_URL>/tx/<TX_HASH>
  • <BLOCK_EXPLORER_URL>/address/<ACCOUNT_ADDRESS>
  • <BLOCK_EXPLORER_URL>/token/<TOKEN_ADDRESS>

Additional URLs:

  • <HEDERA_EXPLORER_URL>/<NETWORK>
  • <HEDERA_EXPLORER_URL>/<NETWORK>/account/<ACCOUNT_LOC>
  • <HEDERA_EXPLORER_URL>/<NETWORK>/contract/<CONTRACT_LOC>
  • <HEDERA_EXPLORER_URL>/<NETWORK>/transaction/<TRANSACTION_LOC>

where:

  • <HEDERA_EXPLORER_URL> = https://hashscan.io
  • <NETWORK> = mainnet | testnet | previewnet
  • <BLOCK_EXPLORER> = <HEDERA_EXPLORER_URL>/<NETWORK>
  • <ACCOUNT_LOC> : account id | account address
  • <CONTRACT_LOC> : contract id | contract address
  • <TRANSACTION_LOC> : consensus timestamp | transaction id | ethereum hash
  • <BLOCK_HASH_OR_HEIGHT> : block hash or number
  • <TX_HASH>: ethereum hash
  • <ACCOUNT_ADDRESS> : account address
  • <TOKEN_ADDRESS> : token address

@ericleponner
Copy link
Collaborator

To support URL: <HEDERA_EXPLORER_URL>/<NETWORK>/contract/<CONTRACT_LOC> we'll need to implement #432.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Sheng-Long Sheng-Long

Labels
enhancement New feature or request P2 Required to be completed in the assigned milestone, but may or may not impact the release schedule
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

create route documentation hashgraph/hedera-mirror-node-explorer
3 participants
@Sheng-Long @SimiHunjan @ericleponner