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

refactor: explored-types: update routes to match explored API changes #708

Merged
merged 1 commit into from
Aug 28, 2024
Merged

refactor: explored-types: update routes to match explored API changes #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/hip-seals-breathe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@siafoundation/explored-types': minor
---

Updated routes to match explored API changes.
20 changes: 11 additions & 9 deletions libs/explored-types/src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,21 +95,21 @@ export type ConsensusStateResponse = ConsensusState
// Block

// Returns the block with the specified ID.
export const blockByIDRoute = '/explorer/block/:id'
export const blockByIDRoute = '/blocks/:id'
export type BlockByIDParams = { id: BlockID }
export type BlockByIDPayload = void
export type BlockByIDResponse = ExplorerBlock

// Transaction

// Returns the transaction with the specified ID.
export const transactionByIDRoute = '/explorer/transactions/:id'
export const transactionByIDRoute = '/transactions/:id'
export type TransactionByIDParams = { id: TransactionID }
export type TransactionByIDPayload = void
export type TransactionByIDResponse = ExplorerTransaction

// Returns the transactions with the specified IDs.
export const transactionsByIDsRoute = '/explorer/transactions'
export const transactionsByIDsRoute = '/transactions'
export type TransactionsByIDsParams = void
export type TransactionsByIDsPayload = { ids: TransactionID[] }
export type TransactionsByIDsResponse = ExplorerTransaction[]
Expand Down Expand Up @@ -153,11 +153,13 @@ export type AddressBalancePayload = void
export type AddressBalanceResponse = AddressBalance

// Output
// Returns the specified siacoin output.
export const outputSiacoineRoute = '/outputs/siacoin/:siacoinoutputid'
export type OutputSiacoineParams = { siacoinOutputID: SiacoinOutputID }
export type OutputSiacoinePayload = void
export type OutputSiacoineResponse = ExplorerSiacoinOutput

// Returns the specified address' events.
export const outputSiafundeRoute = '/outputs/siafund/:siafundoutputid'
export type OutputSiafundeParams = { address: SiafundOutputID }
export type OutputSiafundePayload = void
Expand All @@ -166,41 +168,41 @@ export type OutputSiafundeResponse = ExplorerSiafundOutput
// Contract

// Returns the file contract with the specified ID.
export const contractByIDRoute = '/explorer/contracts/:id'
export const contractByIDRoute = '/contracts/:id'
export type ContractByIDParams = { id: FileContractID }
export type ContractByIDPayload = void
export type ContractByIDResponse = ExplorerFileContract

// Returns the file contracts with the specified IDs.
export const contractsByIDsRoute = '/exporer/contracts/'
export const contractsByIDsRoute = '/contracts'
export type ContractsByIDsParams = void
export type ContractsByIDsPayload = { ids: FileContractID[] }
export type ContractsByIDsResponse = ExplorerFileContract[]

// Returns the file contracts for a particular ed25519 key.
export const contractByPubkeyRoute = '/explorer/pubkey/:pubkey/contracts'
export const contractByPubkeyRoute = '/pubkey/:pubkey/contracts'
export type ContractByPubkeyParams = { key: number }
export type ContractByPubkeyPayload = void
export type ContractByPubkeyResponse = ExplorerFileContract

// Metrics

// Returns the most recent metrics about Sia.
export const metricsRoute = '/explorer/metrics'
export const metricsRoute = '/metrics/block'
export type MetricsParams = void
export type MetricsPayload = void
export type MetricsResponse = Metrics

// Returns various metrics about Sia at the time of the given block ID.
export const metricsByIDRoute = '/explorer/metrics/:id'
export const metricsByIDRoute = '/metrics/block/:id'
export type MetricsByIDParams = { id: BlockID }
export type MetricsByIDPayload = void
export type MetricsByIDResponse = Metrics

// Search

// Returns what type of object an ID is.
export const searchResultTypeRoute = '/explorer/search/:id'
export const searchResultTypeRoute = '/search/:id'
export type SearchResultTypeParams = { id: Hash256 }
export type SearchResultTypePayload = void
export type SearchResultTypeResponse = SearchResultType
Loading